Using Jenkins to Automatically Build and Perform Rolling Upgrade on Components Deployed on ServiceStage

Creating a GitLab Credential

Use the account and password with the GitLab code repository permission to create a credential in Jenkins for pulling GitLab code.

1. Enter http://{IP address of the Linux VM where Jenkins is installed}:8080 in the address box of the browser to log in to Jenkins.
2. Choose Manage Jenkins > Jenkins Configuration. In Configuration, select Gitlab.
3. Click Add under Credentials and select Jenkins.
4. Configure the GitLab account password and click Add to save the configuration.
5. Choose Manage Jenkins > Manage Credentials to view the configured credentials.

   The unique ID is used in Configuring a Pipeline Script.

Creating a Pipeline Task

1. Enter http://{IP address of the Linux VM where Jenkins is installed}:8080 in the address box of the browser to log in to Jenkins.
2. Click New Item.
3. Enter the task name, for example, test-upgrade, select Pipeline, and click OK.

Configuring a Build Trigger

1. Configure the Jenkins build trigger.
   1. Select Build when a change is pushed to GitLab, save the GitLab webhook URL (required when configuring GitLab webhook), and click Advanced in the lower right corner.
   2. Select Filter branches by regex and configure the build task to be triggered after the specified branch is changed. In the example, the branch name is main. Click Generate to generate a secret token and save it. The token will be used for configuring GitLab webhook.

2. Configure GitLab webhook.
   1. Log in to GitLab and go to the code repository. In the example, the repository name is test. Select Webhooks in settings, and set URL and Secret token to the GitLab webhook URL and secret token obtained in 1.
   2. Deselect Enable SSL verification for SSL verification and click Add webhook.

Configuring a Pipeline Script

A pipeline script is a build command run during build.

1. Click the Pipeline tab and select Pipeline script from the drop-down list.
2. Configure the following pipeline script. In the example, the JAR package is used.
   • Replace the parameters in the script with the actual parameters in your environment. For details about script parameters, see Table 1.
   • The upgrade.sh script is invoked when the pipeline script is running. For details about the script, see upgrade.sh.
   • Set upgrade.sh as an executable file.

   node {
       //Code repository address, for example, http://10.95.156.58:8090/zmg/test.git.
       def git_url = '{Code repository address}'
       //GitLab credential ID.
       def credentials_id = '{GitLab credential ID}'
       //Name of the Git code repository branch, for example, main.
       def branch_name = '{Git code repository branch name}'
       //Path of the executable file for Maven installation, for example, /root/app/maven/apache-maven-3.8.6/bin/mvn.
       def maven = '{Path of the executable file for Maven installation}'
       //Path for storing the upgrade.sh script, for example, /root/jar/upgrade.sh.
       def upgrade_shell = '{Path for storing the upgrade.sh script}'
   
       stage('Clone sources') {
           git branch: branch_name, credentialsId: credentials_id, url: git_url
       }
       stage('Build') {
           //Build a JAR package.
           sh "'$maven' clean package -Dmaven.test.failure.ignore=true -Dmaven.wagon.http.ssl.insecure=true -Dmaven.wagon.http.ssl.allowall=true"
       }
       stage('upgrade') {
           //Execute the script and use the JAR package uploaded to OBS to upgrade the ServiceStage component. The timeout period is 5 minutes.
           sh "timeout 300s '$upgrade_shell'"
       }
   }

   Table 1 Pipeline script parameters

   Parameter	Mandatory	Type	Description
   git_url	Yes	String	Address of the GitLab code repository.
   credentials_id	Yes	String	GitLab credential ID configured using the account password. For details, see Creating a GitLab Credential.
   branch_name	Yes	String	Name of the GitLab code repository branch.
   maven	Yes	String	Path of the executable file for Maven installation, for example, /root/app/maven/apache-maven-3.8.6/bin/mvn.
   upgrade_shell	Yes	String	Path for storing the upgrade.sh script on the VM where Jenkins is deployed, for example, /root/jar/upgrade.sh. For details about the script content, see upgrade.sh.

3. Execute the build and verify the build result. For details, see Build Verification.

upgrade.sh

Replace the parameters in the script with the actual parameters in your environment.

#!/bin/bash
#Project ID
project_id='{Project ID}'
#Application ID
application_id='{Application ID}'
#Component ID
component_id='{Component ID}'
#Batch information
rolling_release_batches=1
#Deployment type
deploy_type="package"


### Description:
### 1. Search for a string, as shown in key in the following code. If no string is found, defaultValue is returned.
### 2. Search for the nearest colon (:). The content following the colon is the value.
### 3. If there are multiple keys with the same name, only the first value is printed.
###
### 4. params: json, key, defaultValue
function getJsonValuesByAwk() {
    awk -v json="$1" -v key="$2" -v defaultValue="$3" 'BEGIN{
        foundKeyCount = 0
        pos = match(json, "\""key"\"[ \\t]*?:[ \\t]*");
        if (pos == 0) {if (foundKeyCount == 0) {print defaultValue;} exit 0;}

        ++foundKeyCount;
        start = 0; stop = 0; layer = 0;
        for (i = pos + length(key) + 1; i <= length(json); ++i) {
            lastChar = substr(json, i - 1, 1)
            currChar = substr(json, i, 1)

            if (start <= 0) {
                if (lastChar == ":") {
                    start = currChar == " " ? i + 1: i;
                    if (currChar == "{" || currChar == "[") {
                        layer = 1;
                    }
                }
            } else {
                if (currChar == "{" || currChar == "[") {
                    ++layer;
                }
                if (currChar == "}" || currChar == "]") {
                    --layer;
                }
                if ((currChar == "," || currChar == "}" || currChar == "]") && layer <= 0) {
                    stop = currChar == "," ? i : i + 1 + layer;
                    break;
                }
            }
        }

        if (start <= 0 || stop <= 0 || start > length(json) || stop > length(json) || start >= stop) {
            if (foundKeyCount == 0) {print defaultValue;} exit 0;
        } else {
            print substr(json, start, stop-start);
        }
    }'
}

#Query component information.
function getComponentInfo() {
    #Query component information.
    component_details=`hcloud ServiceStage ShowComponentInfo/v3 --project_id="$project_id" --application_id="$application_id" --component_id="$component_id"`

    #Print component information.
    echo "$component_details"

    #Obtain the component name.
    test_name=`getJsonValuesByAwk  "$component_details" "name" "defaultValue"`
    lenj=${#test_name}
    component_name=${test_name:1:lenj-2}
    echo "name : $component_name"


    data_time=$(date +%Y.%m%d.%H%M)
    seconds=$(date +%S)
    component_version="${data_time}${seconds:1:1}"
    echo "version: $component_version"
}

#Image deployment scenario
function swr_image_upgrade() {

      #Image generated after project packaging: Image name:Version name
      machine_image_name='java-test:v1'
      #Path of the SWR image repository to which the image is uploaded
      swr_image_url='{Image repository address}/{Organization name}/{Image name}:{Version}'
      #AK, which is used to log in to the SWR image repository.
      AK='BMCKUPO9HZMI6BRDJGBD'
      #SWR login key, which is used to log in to the SWR image repository
      SK='{SWR login key}'
      #SWR image repository address
      swr_url='{SWR image repository address}'
      #Region
      region="{Region}"

      echo "upload image to swr"
      docker tag "$machine_image_name" "$swr_image_url"

      login_secret=`printf "$AK" | openssl dgst -binary -sha256 -hmac "$SK" | od -An -vtx1 | sed 's/[ \n]//g' | sed 'N;s/\n//'`

      login_result=`docker login -u "$region"@"$AK" -p "$login_secret" "$swr_url"`
      #Print the result of logging in to the SWR image repository.
      echo "$login_result"
      push_result=`docker push "$swr_image_url"`
      #Print the image push result.
      #echo "$push_result"
      logout_result=`docker logout "$swr_url"`
      #Print the result of logging out of the SWR image repository.
      echo "$logout_result"
      #Clear all historical records. They may contain SWR login key information.
      #history -c

    echo "upgrade component"

    action_result=`hcloud ServiceStage ModifyComponent/v3 --project_id="$project_id" --application_id="$application_id" --component_id="$component_id" --version="$component_version" --runtime_stack.name="Docker" --runtime_stack.type="Docker" --source.kind="image" --source.storage="swr" --source.url="$swr_image_url" --name="$component_name" --deploy_strategy.rolling_release.batches=$rolling_release_batches --deploy_strategy.type="RollingRelease" `

}

#JAR package deployment scenario
function obs_jar_upgrade() {

    #Absolute path of the executable file for installing obsutil
    obsutil='/root/tools/obsutil/obsutil_linux_amd64_5.4.6/obsutil'
    #OBS bucket name
    bucket='obs://{OBS bucket name}'
    echo "upload jar to obs"
    #Upload the JAR package generated in the project to OBS.
    obs_result=`"$obsutil" cp ./target/*.jar "$bucket"`
    #Print the upload result.
    echo "$obs_result"
    #Link of the JAR package uploaded to OBS
    obs_jar_url='obs://{OBS bucket name}/{Jar package name}'

    echo "upgrade component"

    action_result=`hcloud ServiceStage ModifyComponent/v3 --project_id="$project_id" --application_id="$application_id" --component_id="$component_id" --version="$component_version" --runtime_stack.name="OpenJDK8" --runtime_stack.type="Java" --source.kind="package" --source.storage="obs" --source.url="$obs_jar_url" --name="$component_name" --deploy_strategy.rolling_release.batches=$rolling_release_batches --deploy_strategy.type="RollingRelease" `

}

#Query the job status every 15 seconds until the job is complete.
function waitDeployFinish() {
    sleep 10s
    id="$1"
    leni=${#id}
    id=${id:1:leni-2}
    echo "job_id= $id"
    job_status=""
    while [[ "$job_status" != "SUCCEEDED" ]]; do
        job_status_result=`hcloud ServiceStage ShowJobDetail/v2 --project_id="$project_id" --job_id="$id"`
        job_status=`getJsonValuesByAwk  "$job_status_result" "EXECUTION_STATUS" "defaultValue"`
        lenj=${#job_status}
        job_status=${job_status:1:lenj-2}
        echo "$job_status"
        if [[ "$job_status" != "RUNNING" && "$job_status" != "SUCCEEDED" ]]; then
            echo'Deployment failed'
            echo "$job_status_result"
            return
        fi
        sleep 15s
    done
    echo'Deployment succeeded'
}

function upgradeTask() {

    if [[ "$deploy_type" == "package" ]]; then
        obs_jar_upgrade
    elif [[ "$deploy_type" == "image" ]]; then
        swr_image_upgrade
    else
        return
    fi
    #Print the component upgrade result.
    echo "$action_result"
    #Obtain the job_id in the result.
    job_id=`getJsonValuesByAwk  "$action_result" "job_id" "defaultValue"`
    echo "$job_id"
    #Wait until the upgrade is complete.
    waitDeployFinish "$job_id"
}
function main() {
    getComponentInfo
    upgradeTask
}
main

Script Parameters

Obtaining Values

• Obtain region and project_id.
  1. Log in to ServiceStage.
  2. Move the cursor to the username in the upper right corner and select My Credentials from the drop-down list.
  3. View the project and project ID of the region, that is, the values of region and project_id.
• Obtain application_id and component_id.
  1. Log in to ServiceStage.
  2. Choose Component Management.
  3. Click the corresponding component.
  4. In the Configurations area on the Overview page, choose Container Settings > Environment Variable.

     View CAS_APPLICATION_ID and CAS_COMPONENT_ID, that is, the values of application_id and component_id.