First version of Gitlab pipeline template. #221

monvora · 2024-02-20T08:46:03Z

This is the first version of Gitlab pipeline template along with the documentation.

dennis-behm

@monvora Can you please check out the comments?

dennis-behm · 2024-02-21T10:59:17Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+    GIT_STRATEGY: none
+    GIT_CHECKOUT: "false"
+    application: "CBSA"
+    wdEnvironmentFileIntegration: ${WAZI_DEPLOY_SAMPLES}/plum-samples/external-repos/environment-conf/python/EOLEB7-CBSA-Integration.yml


I don't find an explanation for the variable WAZI_DEPLOY_SAMPLES . Is this an environment variable configured for the service account running the pipeline steps?

From my understanding, this is just installation path of Wazi Deploy. It's point to /var/WaziDeploy/wazi-deploy-samples-0.10.0/wazi-deploy-sample. right?

WAZI_DEPLOY_SAMPLES is a CI/CD variable defined at the group level. It points to the Wazi Deploy samples location on z/OS. This is where the samples are installed and customized (actually in our setup, it is where the Wazi Deploy repository that contains our customization is cloned).

@M-DLB that is what I thought at first this is only a sample file. I only document that it should be customized the path to the deployment configuration file but did not mention about the WAZI_DEPLOY_SAMPLES variable. How should we handle this in this document?

We are passing an absolute path, while the Azure Devops pipeline is passing a relative path. So either, we switch to a relative path and specify the absolute folder path in the wdEnvironmentConfigurations variable of the pipelineBackend.config file, or we just leave it like this.
Also, please consider changing the path in the template since there is no existence of plum-samples anymore (replaced by wazideploy-samples, like in https://github.com/jbyibm/cics-genapp/tree/main/wazideploy-samples).

dennis-behm · 2024-02-21T11:00:41Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+# Working directory on Linux machine
+    buildOutputDirectory: ${CI_PROJECT_DIR}/BUILD-OUTPUT
+    deployOutputDirectory: ${CI_PROJECT_DIR}/DEPLOY-OUTPUT
+    baselineReferenceFile: $CI_PROJECT_DIR/CBSA/application-conf/baselineReference.config


Can we replace the concrete application nameCBSA with an environment variable for the application?

@dennis-behm this is actually the $CI_PROJECT_DIR already contains the name of application. CBSA is a sub-directory for source code under "CICS-Bank-Sample-Application" repository. Do you think we still need to change the this?

@dennis-behm Can you please help confirm this. Than you.

We could use the $CI_PROJECT_NAME variable, but in our case it's CICS-Bank-Sample-Application, not CBSA. But I agree it shouldn't hardcoded like this.

dennis-behm · 2024-02-21T12:45:48Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+            tar -xvf "${destinationLogsFile}" -C "${buildOutputDirectory}/" --strip-components 1
+            echo [INFO] Extracted log.tar file to ${buildOutputDirectory}
+        else
+            echo [WARNING] Tar file containing the logs was not found


The above condition checks if the variable is defined, not if the log file exists. Could be renamed.

my bad, I meant to check if the file exist. I updated to the following.
if [ -f "${sourceLogsFile}" ]; then

Oh!! I cannot check this from the definition file since the files are on USS. I would to assume it is created if the script successfully execute. With the updated ZOWE CI, we should be able to trust the RC returned.

Updated to not checking any condition since the "sourceLogsFile" will always be defined and assigned the path.

Templates/GitlabCIPipeline/.gitlab-ci.yml

dennis-behm · 2024-02-21T12:49:55Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+
+        # Creates the git tag using the CLI REST interface and the automation token
+            curl --request POST --header "PRIVATE-TOKEN: ${AutomationToken}" "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/repository/tags?tag_name=${newVersionTag}&ref=${CI_COMMIT_REF_NAME}"
+


Can we check the return code of the curl request? If is successful?

Templates/GitlabCIPipeline/.gitlab-ci.yml

dennis-behm · 2024-02-21T12:59:05Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+            if [ "${releaseType}" == "major" ]; then
+                export newVersionTag=`echo ${baselineRef} | sed 's/^["refs\/tags\/rel-]*//g' | sed 's/-[a-zA-Z0-9]*//g' | awk -F. -v OFS=. '{$1 += 1 ; $2 = 0; $3 = 0; print}'`
+            fi
+            echo [INFO} New verion == ${newVersionTag}


Similar comment like above.

dennis-behm · 2024-02-21T12:59:36Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+    tags: [shell]
+    script: |
+
+        echo [INFO] Retrieve baseline reference information from ${baselineReferenceFile}.


Instead of calculating the git tag again, can we access the variable from the previous step?

@dennis-behm I tested we need to re-calculating the git tag again. The value is not passing to the downstream job. T T

Thanks for looking into this!

dennis-behm · 2024-02-21T13:01:55Z

Templates/GitlabCIPipeline/README.md

+### Variables configuration
+The following variables need to be defined and configured as the environment variables in the GitLab group or project setting:
+
+Veriables | Description


Variables instead of Veriables

dennis-behm · 2024-02-21T13:08:46Z

Templates/GitlabCIPipeline/README.md

+wdEnvironmentFileIntegration | Path to a Wazi Deploy configuration file for integration environment.
+wdEnvironmentFileAcceptance | Path to a Wazi Deploy configuration file for acceptance environment.
+wdEnvironmentFileProduction | Path to a Wazi Deploy configuration file for production environment.
+baselineReferenceFile | Path to baselineRefer0ence.config file of your application.


A typo in baselineReference.config.

dennis-behm

@monvora

I made a couple of comments about the messages the script writes.
I think we can be clear that Deployment failed ..., instead of saying Unsuccessfully ... .
Also there is some messages with all in upper case, that can be adjusted.

I might not have added comments to all occurrences .

dennis-behm · 2024-02-29T13:10:55Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+        if [ ${RC} -eq 0 ]; then
+            echo [INFO] Completed build application job.
+        else
+             echo [ERROR] Incompleted build application job with exit code ${RC}.


Instead of

Incompleted build application job with exit code

Maybe something like

Build step failed. Exit code: ${RC}

dennis-behm · 2024-02-29T13:11:47Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+        if [ ${RC} -eq 0 ]; then
+            echo [INFO] Successfully prepare log files.
+
+            echo START TRANSFER LOGS FILE = ${sourceLogsFile} to ${destinationLogsFile}


Can we also have the [INFO] prefix for this echo?

dennis-behm · 2024-02-29T13:12:28Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

@@ -196,16 +230,22 @@ Clone:
            if [ -z "${releaseCandidate}" ]; then
            # initial version tag
                export newVersionTag="${newVersionTag}_rc00"
-                echo [INFO] 1 Update New release condidate tag == ${newVersionTag}
+                echo [INFO] Updated release condidate tag == ${newVersionTag}


Typo - condidate > candidate

dennis-behm · 2024-02-29T13:13:13Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+            if [ ${RC} -eq 0 ]; then
+                echo [INFO] Release candidate tag is successfully created as ${newVersionTag}.
+            else
+                echo [ERROR] Release candidate tag is unsuccessfully created.


Failed to create release candidate tag

dennis-behm · 2024-02-29T13:17:42Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+            # Create integration report directory
+            mkdir ${integrationReportDir}
+            echo [INFO] Create integration report directory = ${integrationReportDir}
+            # Transfer deployment report and evidence report
            echo [INFO] TRANSFER OUTPUT FILES = ${sourceOutputFile} to ${integrationReportDir}/deployment-report.html


This all message all in upper case output stands out. Maybe we can be updated to something like this:
echo [INFO] Loading deployment report ${sourceOutputFile} to ${integrationReportDir}/deployment-report.html

dennis-behm · 2024-02-29T13:18:03Z

Templates/GitlabCIPipeline/.gitlab-ci.yml

+            if [ ${RC} -eq 0 ]; then
+                echo [INFO] Successfully transfer deployment report file.
+            else
+                echo [ERROR] Unsuccessfully transfer deployment report file with exit code ${RC}.


Similar to above comment

monvora · 2024-03-01T04:16:02Z

@monvora

I made a couple of comments about the messages the script writes. I think we can be clear that Deployment failed ..., instead of saying Unsuccessfully ... . Also there is some messages with all in upper case, that can be adjusted.

I might not have added comments to all occurrences .

@dennis-behm Ok, I'll clean up the output message.

M-DLB

One comment!

M-DLB · 2024-03-01T08:23:17Z

Templates/GitlabCIPipeline/README.md

+RSEAPI_USER | Username for Zowe RSEAPI server authentication. This username is used when issue shell script command through Zowe.
+RSEAPI_PASSWORD | Password for Zowe RSEAPI server authentication. This password is used when issue shell script command through Zowe.
+PIPELINE_WORKSPACE | Root directory on z/OS Unix System services to perform builds. E.g. /u/gitlab/workspace
+WAZI_DEPLOY_CONFIGDIR | Path to a directory of Wazi Deploy configuration files.


I think we should say this WAZI_DEPLOY_CONFIGDIR directory is on USS and can be populated with the samples available in https://github.com/jbyibm/cics-genapp/tree/main/wazideploy-samples

dennis-behm

@monvora Can you please update the table located at https://github.com/IBM/dbb/tree/main/Templates ?

…eline/README.md about WAZI_DEPLOY_CONFIGDIR.

Signed-off-by: Monvorath Phongpaibul <145766235+monvora@users.noreply.github.com>

dennis-behm

@monvora Thank you. Great work!

monvora added 2 commits February 20, 2024 15:39

First version of Gitlab pipeline template.

71d0a9a

Update readme file.

9a32731

dennis-behm requested changes Feb 21, 2024

View reviewed changes

dennis-behm reviewed Feb 21, 2024

View reviewed changes

monvora added 2 commits February 29, 2024 15:49

updated based on Dennis's review comments.

b5d991f

Updated based on review comments.

8594bb1

dennis-behm requested changes Feb 29, 2024

View reviewed changes

Cleaned up output messages.

fb6dc3e

M-DLB reviewed Mar 1, 2024

View reviewed changes

dennis-behm requested changes Mar 1, 2024

View reviewed changes

monvora and others added 3 commits March 4, 2024 10:57

Updated Templates/README.md to add Gitlab CI Pipeline and GitlabCIPip…

ac54a34

…eline/README.md about WAZI_DEPLOY_CONFIGDIR.

Updated teamplates/README.md file.

af064bb

Signed-off-by: Monvorath Phongpaibul <145766235+monvora@users.noreply.github.com>

Minor update to README.md

5400170

Signed-off-by: Monvorath Phongpaibul <145766235+monvora@users.noreply.github.com>

dennis-behm approved these changes Mar 4, 2024

View reviewed changes

dennis-behm merged commit 97b1cd1 into IBM:main Mar 4, 2024
1 check failed


		# Creates the git tag using the CLI REST interface and the automation token
		curl --request POST --header "PRIVATE-TOKEN: ${AutomationToken}" "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/repository/tags?tag_name=${newVersionTag}&ref=${CI_COMMIT_REF_NAME}"

First version of Gitlab pipeline template. #221

First version of Gitlab pipeline template. #221

Conversation

monvora commented Feb 20, 2024

dennis-behm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monvora Feb 23, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dennis-behm Feb 21, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dennis-behm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monvora commented Mar 1, 2024

M-DLB left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dennis-behm left a comment

Choose a reason for hiding this comment

dennis-behm left a comment

Choose a reason for hiding this comment

monvora Feb 23, 2024 •

edited

Loading

dennis-behm Feb 21, 2024 •

edited

Loading