135-1821-9792

GitLabCI模板库的流水线优化实践

GitLabCI模板库的流水线优化实践

作者：Lizeyang 2021-12-24 08:02:48

云计算 还是按照之前的目录结构完成的，jobs目录用于存放作业模板。templates目录用于存放流水线模板。这次使用default-pipeline.yml作为所有作业的基础模板。

成都创新互联主要从事网站建设、网站设计、网页设计、企业做网站、公司建网站等业务。立足成都服务农安,10多年网站建设经验,价格优惠、服务专业,欢迎来电咨询建站服务:18980820575

[[441815]]

还是按照之前的目录结构完成的，jobs目录用于存放作业模板。templates目录用于存放流水线模板。这次使用default-pipeline.yml作为所有作业的基础模板。

作业模板

作业分为Build、test、codeanalysis、artifactory、deploy部分，在每个作业中配置了rules功能开关，由变量控制最终作业的运行。

jobs/build.yml 构建作业模板

包含两个作业模板，分别是普通的构建模板(maven/npm/gradle)和docker 镜像构建模板。

  
 
 
 
    
   
  
  
  
  1. ## build相关作业 
    2.    
  
  
  
  2.  
    3.    
  
  
  
  3. .build: 
    4.    
  
  
  
  4.   stage: build 
    5.    
  
  
  
  5.   script:  
    6.    
  
  
  
  6.     - | 
    7.    
  
  
  
  7.       ${BUILD_SHELL} 
    8.    
  
  
  
  8.   variables: 
    9.    
  
  
  
  9.     GIT_CHECKOUT: "true" 
    10.    
  
  
  
  10.   rules: 
    11.    
  
  
  
  11.     - if: " $RUN_PIPELINE_BUILD == 'no' " 
    12.    
  
  
  
  12.       when: never 
    13.    
  
  
  
  13.     - when: always 
    14.    
  
  
  
  14.  
    15.    
  
  
  
  15.  
    16.    
  
  
  
  16. ## 构建镜像 
    17.    
  
  
  
  17. .build-docker: 
    18.    
  
  
  
  18.   stage: buildimage 
    19.    
  
  
  
  19.   script: 
    20.    
  
  
  
  20.     - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWD  $CI_REGISTRY 
    21.    
  
  
  
  21.     - docker build -t ${IMAGE_NAME} -f ${DOCKER_FILE_PATH} . 
    22.    
  
  
  
  22.     - docker push ${IMAGE_NAME}  
    23.    
  
  
  
  23.     - docker rmi ${IMAGE_NAME}  
    24.    
  
  
  
  24.   rules: 
    25.    
  
  
  
  25.     - if: " $RUN_BUILD_IMAGE == 'no' " 
    26.    
  
  
  
  26.       when: never 
    27.    
  
  
  
  27.     - when: always 
    28.

jobs/test.yml 测试作业模板

主要用于运行项目单元测试，例如maven、gradle、npm单元测试。

  
 
 
 
    
   
  
  
  
  1. #单元测试 
    2.    
  
  
  
  2. .test: 
    3.    
  
  
  
  3.   stage: test 
    4.    
  
  
  
  4.   script: 
    5.    
  
  
  
  5.     - $TEST_SHELL 
    6.    
  
  
  
  6.   artifacts: 
    7.    
  
  
  
  7.     reports: 
    8.    
  
  
  
  8.       junit: ${JUNIT_REPORT_PATH} 
    9.    
  
  
  
  9.   rules: 
    10.    
  
  
  
  10.     - if: " $RUN_PIPELINE_TEST == 'no' " 
    11.    
  
  
  
  11.       when: never 
    12.    
  
  
  
  12.     - when: always 
    13.

jobs/codeanalysis.yml 代码扫描模板

包含两个作业模板，分别为扫描作业和获取扫描结果。这里面将扫描参数进行了分类，通用的项目参数、特殊的合并请求参数、自定义的项目参数。

  
 
 
 
    
   
  
  
  
  1. ##代码扫描 
    2.    
  
  
  
  2. ## 
    3.    
  
  
  
  3. ## 
    4.    
  
  
  
  4. ## 
    5.    
  
  
  
  5.  
    6.    
  
  
  
  6. .code_analysis: 
    7.    
  
  
  
  7.   variables: 
    8.    
  
  
  
  8.     GLOBAL_PROJECT_ARGS: "-Dsonar.projectKey=${CI_PROJECT_NAME}  
    9.    
  
  
  
  9.                           -Dsonar.projectName=${CI_PROJECT_NAME}  
    10.    
  
  
  
  10.                           -Dsonar.projectVersion=${CI_COMMIT_REF_NAME}  
    11.    
  
  
  
  11.                           -Dsonar.projectDescription=${CI_PROJECT_TITLE}" 
    12.    
  
  
  
  12.     GLOBAL_SERVER_ARGS:  "-Dsonar.ws.timeout=30  
    13.    
  
  
  
  13.                           -Dsonar.links.homepage=${CI_PROJECT_URL}  
    14.    
  
  
  
  14.                           -Dsonar.host.url=${SONAR_SERVER_URL}  
    15.    
  
  
  
  15.                           -Dsonar.login=${SONAR_SERVER_LOGIN} 
    16.    
  
  
  
  16.                           -Dsonar.sourceEncoding=UTF-8 " 
    17.    
  
  
  
  17.     GLOBAL_MR_ARGS: " -Dsonar.pullrequest.key=${CI_MERGE_REQUEST_IID}  
    18.    
  
  
  
  18.                       -Dsonar.pullrequest.branch=${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME}  
    19.    
  
  
  
  19.                       -Dsonar.pullrequest.base=${CI_MERGE_REQUEST_TARGET_BRANCH_NAME}  
    20.    
  
  
  
  20.                       -Dsonar.gitlab.ref_name=${CI_COMMIT_REF_NAME}  
    21.    
  
  
  
  21.                       -Dsonar.gitlab.commit_sha=${CI_COMMIT_SHA}  
    22.    
  
  
  
  22.                       -Dsonar.gitlab.project_id=${CI_PROJECT_PATH}  
    23.    
  
  
  
  23.                       -Dsonar.pullrequest.gitlab.repositorySlug=${CI_PROJECT_ID} " 
    24.    
  
  
  
  24.     MULTI_BRANCH_ARGS: "-Dsonar.branch.name=${CI_COMMIT_REF_NAME}" 
    25.    
  
  
  
  25.   stage: code_analysis 
    26.    
  
  
  
  26.   script: 
    27.    
  
  
  
  27.     - echo ${GLOBAL_PROJECT_ARGS} ${GLOBAL_SERVER_ARGS} ${SONAR_SCAN_ARGS} ${GLOBAL_MR_ARGS} 
    28.    
  
  
  
  28.     #sonar-scanner $GLOBAL_PROJECT_ARGS $GLOBAL_SERVER_ARGS $SCAN_JAVA_ARGS 
    29.    
  
  
  
  29.     - | 
    30.    
  
  
  
  30.         if [ $CI_PIPELINE_SOURCE == 'merge_request_event' ]  
    31.    
  
  
  
  31.          
    32.    
  
  
  
  32.         then 
    33.    
  
  
  
  33.            echo "sonar-scanner ${GLOBAL_PROJECT_ARGS} ${GLOBAL_SERVER_ARGS} ${SONAR_SCAN_ARGS} "  
    34.    
  
  
  
  34.            sonar-scanner ${GLOBAL_PROJECT_ARGS} ${GLOBAL_SERVER_ARGS} ${SONAR_SCAN_ARGS}  
    35.    
  
  
  
  35.         else  
    36.    
  
  
  
  36.            echo "sonar-scanner ${GLOBAL_PROJECT_ARGS} ${GLOBAL_SERVER_ARGS} ${SONAR_SCAN_ARGS} ${MULTI_BRANCH_ARGS}" 
    37.    
  
  
  
  37.            sonar-scanner ${GLOBAL_PROJECT_ARGS} ${GLOBAL_SERVER_ARGS} ${SONAR_SCAN_ARGS}  ${MULTI_BRANCH_ARGS} 
    38.    
  
  
  
  38.         fi  
    39.    
  
  
  
  39.   rules: 
    40.    
  
  
  
  40.     - if: " $RUN_CODE_ANALYSIS == 'no' " 
    41.    
  
  
  
  41.       when: never 
    42.    
  
  
  
  42.     - when: always 
    43.    
  
  
  
  43.  
    44.    
  
  
  
  44.  
    45.    
  
  
  
  45. #### 获取代码扫描结果 
    46.    
  
  
  
  46. .get_analysis_result: 
    47.    
  
  
  
  47.   stage: get_analysis_result 
    48.    
  
  
  
  48.   script: 
    49.    
  
  
  
  49.     - | 
    50.    
  
  
  
  50.         SONAR_REPORT_URL=$(grep "ceTaskUrl" .scannerwork/report-task.txt  | awk -F = '{OFS="=";print $2,$3}') 
    51.    
  
  
  
  51.         echo ${SONAR_REPORT_URL} 
    52.    
  
  
  
  52.          
    53.    
  
  
  
  53.          
    54.    
  
  
  
  54.         for i in {1..10} 
    55.    
  
  
  
  55.         do 
    56.    
  
  
  
  56.           curl -k -u "${SONAR_SERVER_LOGIN}":"" ${SONAR_REPORT_URL}  -o sonar_result.txt -s 
    57.    
  
  
  
  57.           grep '"status":"SUCCESS"' sonar_result.txt  && SONAR_SCAN_RESULT='SUCCESS' 
    58.    
  
  
  
  58.          
    59.    
  
  
  
  59.           if [ ${SONAR_SCAN_RESULT} == 'SUCCESS' ] 
    60.    
  
  
  
  60.             then 
    61.    
  
  
  
  61.               echo "${SONAR_SCAN_RESULT}" 
    62.    
  
  
  
  62.               SONAR_SCAN_RESULT=SUCCESS 
    63.    
  
  
  
  63.  
    64.    
  
  
  
  64.               curl -k -u "${SONAR_SERVER_LOGIN}":"" "${SONAR_SERVER_URL}/api/qualitygates/project_status?projectKey=$CI_PROJECT_NAME&branch=$CI_COMMIT_REF_NAME" -o result.txt  -s 
    65.    
  
  
  
  65.               echo "result info ---->>>>>" 
    66.    
  
  
  
  66.               cat result.txt 
    67.    
  
  
  
  67.               result=`cat result.txt | awk -F ':' '{print $3}' | awk -F '"' '{print$2}'` 
    68.    
  
  
  
  68.                
    69.    
  
  
  
  69.               echo $result 
    70.    
  
  
  
  70.  
    71.    
  
  
  
  71.               if [ $result == 'ERROR' ]                  
    72.    
  
  
  
  72.                 then  
    73.    
  
  
  
  73.                   echo "${result}" 
    74.    
  
  
  
  74.                   exit 122 
    75.    
  
  
  
  75.                   break; 
    76.    
  
  
  
  76.               else 
    77.    
  
  
  
  77.                   echo "success!" 
    78.    
  
  
  
  78.                   break; 
    79.    
  
  
  
  79.               fi 
    80.    
  
  
  
  80.              
    81.    
  
  
  
  81.           else 
    82.    
  
  
  
  82.             SONAR_SCAN_RESULT='ERROR' 
    83.    
  
  
  
  83.             echo "第$i次获取结果信息，不是成功状态，睡眠10秒！" 
    84.    
  
  
  
  84.             cat sonar_result.txt 
    85.    
  
  
  
  85.             sleep 10 
    86.    
  
  
  
  86.           fi 
    87.    
  
  
  
  87.         done 
    88.    
  
  
  
  88.          
    89.    
  
  
  
  89.   rules: 
    90.    
  
  
  
  90.     - if: " $RUN_CODE_ANALYSIS == 'no' " 
    91.    
  
  
  
  91.       when: never 
    92.    
  
  
  
  92.     - when: always 
    93.

jobs/artifactory.yml 制品管理作业

包含两个作业，制品上传与下载。使用artifactory制品库接口。

  
 
 
 
    
   
  
  
  
  1. ## 制品库相关 
    2.    
  
  
  
  2. ## 
    3.    
  
  
  
  3.  
    4.    
  
  
  
  4. .deploy-artifact: 
    5.    
  
  
  
  5.   stage: deploy-artifact 
    6.    
  
  
  
  6.   script: 
    7.    
  
  
  
  7.     - echo "curl -u${ARTIFACT_USER}:${ARTIFACT_PASSWD} -T ${ARTIFACT_PATH} $ARTIFACTORY_URL/$ARTIFACTORY_NAME/$TARGET_FILE_PATH/$TARGET_ARTIFACT_NAME" 
    8.    
  
  
  
  8.     - curl -u${ARTIFACT_USER}:${ARTIFACT_PASSWD} -T ${ARTIFACT_PATH} "$ARTIFACTORY_URL/$ARTIFACTORY_NAME/$TARGET_FILE_PATH/$TARGET_ARTIFACT_NAME" 
    9.    
  
  
  
  9.   rules: 
    10.    
  
  
  
  10.     - if: " $RUN_DEPLOY_ARTIFACTS == 'no' " 
    11.    
  
  
  
  11.       when: never 
    12.    
  
  
  
  12.     - when: always 
    13.    
  
  
  
  13.  
    14.    
  
  
  
  14.  
    15.    
  
  
  
  15. .down-artifact: 
    16.    
  
  
  
  16.   stage: down-artifact 
    17.    
  
  
  
  17.   script: 
    18.    
  
  
  
  18.     - curl -u${ARTIFACT_USER}:${ARTIFACT_PASSWD} -O "$ARTIFACTORY_URL/$ARTIFACTORY_NAME/$TARGET_FILE_PATH/$TARGET_ARTIFACT_NAME" 
    19.    
  
  
  
  19.     - ls 
    20.

jobs/deploy.yml 发布作业模板

发布基于k8s的发布和回滚配置。

  
 
 
 
    
   
  
  
  
  1. ## 应用发布 
    2.    
  
  
  
  2.  
    3.    
  
  
  
  3.  
    4.    
  
  
  
  4. ## 使用kubectl镜像发布 
    5.    
  
  
  
  5. .deploy_k8s: 
    6.    
  
  
  
  6.   stage: deploy 
    7.    
  
  
  
  7.   script: 
    8.    
  
  
  
  8.     - echo $KUBE_TOKEN 
    9.    
  
  
  
  9.     - kubectl config set-cluster my-cluster --server=${KUBE_URL} --certificate-authority="${KUBE_CA_PEM_FILE}" 
    10.    
  
  
  
  10.     - kubectl config set-credentials admin --token=${KUBE_TOKEN} 
    11.    
  
  
  
  11.     - ls -a  
    12.    
  
  
  
  12.     - sed -i "s#__namespace__#${NAMESPACE}#g" ${DEPLOY_FILE} 
    13.    
  
  
  
  13.     - sed -i "s#__appname__#${APP_NAME}#g" ${DEPLOY_FILE} 
    14.    
  
  
  
  14.     - sed -i "s#__containerport__#${CONTAINER_PORT}#g" ${DEPLOY_FILE}  
    15.    
  
  
  
  15.     - sed -i "s#__nodeport__#${NODE_PORT}#g" ${DEPLOY_FILE}  
    16.    
  
  
  
  16.     - sed -i "s#__imagename__#${IMAGE_NAME}#g" ${DEPLOY_FILE}  
    17.    
  
  
  
  17.     - sed -i "s#__CI_ENVIRONMENT_SLUG__#${CI_ENVIRONMENT_SLUG}#g" ${DEPLOY_FILE} 
    18.    
  
  
  
  18.     - sed -i "s#__CI_PROJECT_PATH_SLUG__#${CI_PROJECT_PATH_SLUG}#g" ${DEPLOY_FILE} 
    19.    
  
  
  
  19.     - sed -i "s#__ingressdomain__#${ENV_URL}#g" ${DEPLOY_FILE} 
    20.    
  
  
  
  20.     - cat ${DEPLOY_FILE} 
    21.    
  
  
  
  21.     - "kubectl create secret docker-registry ${APP_NAME} \ 
    22.    
  
  
  
  22.             --docker-server=${CI_REGISTRY} \ 
    23.    
  
  
  
  23.             --docker-username=$CI_REGISTRY_USER \ 
    24.    
  
  
  
  24.             --docker-password=${CI_REGISTRY_PASSWD} \ 
    25.    
  
  
  
  25.             --docker-email=test@test.com -n ${NAMESPACE} || echo 'secrets already exists'" 
    26.    
  
  
  
  26.     - kubectl apply -f ${DEPLOY_FILE} 
    27.    
  
  
  
  27.   rules: 
    28.    
  
  
  
  28.     - if: " $RUN_DEPLOY_K8S == 'no'" 
    29.    
  
  
  
  29.       when: never 
    30.    
  
  
  
  30.     - when: manual 
    31.    
  
  
  
  31.   environment: 
    32.    
  
  
  
  32.     name: "${ENV_NAME}" 
    33.    
  
  
  
  33.     url: "http://${ENV_NAME}.${CI_PROJECT_NAMESPACE}.${CI_PROJECT_NAME}.devops.com" 
    34.    
  
  
  
  34.  
    35.    
  
  
  
  35.    
    36.    
  
  
  
  36.  
    37.    
  
  
  
  37.  
    38.    
  
  
  
  38. ## 回滚 
    39.    
  
  
  
  39. .rollout_k8s: 
    40.    
  
  
  
  40.   stage: deploy 
    41.    
  
  
  
  41.   script: 
    42.    
  
  
  
  42.     - rm -rf $HOME/.kube 
    43.    
  
  
  
  43.     - kubectl config set-cluster my-cluster --server=${KUBE_URL} --certificate-authority="${KUBE_CA_PEM_FILE}" 
    44.    
  
  
  
  44.     - kubectl config set-credentials admin --token=${KUBE_TOKEN} 
    45.    
  
  
  
  45.     - kubectl rollout history deployment ${APP_NAME} -n ${NAMESPACE} 
    46.    
  
  
  
  46.     - kubectl rollout undo deployment ${APP_NAME} -n ${NAMESPACE} 
    47.    
  
  
  
  47.   rules: 
    48.    
  
  
  
  48.     - if: " $RUN_DEPLOY_K8S == 'no' " 
    49.    
  
  
  
  49.       when: never 
    50.    
  
  
  
  50.     - when: manual 
    51.    
  
  
  
  51.   environment: 
    52.    
  
  
  
  52.     name: "${ENV_NAME}" 
    53.    
  
  
  
  53.     action: stop 
    54.

default流水线模板

templates/default-pipeline.yml 模板分成个部分：

  • include导入作业模板
  • variables 定义全局变量
  • workflow 定义流水线控制
  • jobs 构建与发布作业

include导入作业模板

  
 
 
 
    
   
  
  
  
  1. include: 
    2.    
  
  
  
  2.   - project: 'cidevops/cidevops-newci-service' 
    3.    
  
  
  
  3.     ref: master 
    4.    
  
  
  
  4.     file: 'jobs/build.yml' 
    5.    
  
  
  
  5.   - project: 'cidevops/cidevops-newci-service' 
    6.    
  
  
  
  6.     ref: master 
    7.    
  
  
  
  7.     file: 'jobs/test.yml' 
    8.    
  
  
  
  8.   - project: 'cidevops/cidevops-newci-service' 
    9.    
  
  
  
  9.     ref: master 
    10.    
  
  
  
  10.     file: 'jobs/codeanalysis.yml' 
    11.    
  
  
  
  11.   - project: 'cidevops/cidevops-newci-service' 
    12.    
  
  
  
  12.     ref: master 
    13.    
  
  
  
  13.     file: 'jobs/deploy.yml' 
    14.    
  
  
  
  14.   - project: 'cidevops/cidevops-newci-service' 
    15.    
  
  
  
  15.     ref: master 
    16.    
  
  
  
  16.     file: 'jobs/artifactory.yml' 
    17.

variables 定义全局变量

  
 
 
 
    
   
  
  
  
  1. variables: 
    2.    
  
  
  
  2.   ## 全局配置 
    3.    
  
  
  
  3.   GIT_CLONE_PATH: ${CI_BUILDS_DIR}/builds/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/${CI_PIPELINE_ID}     
    4.    
  
  
  
  4.   GIT_CHECKOUT: "false" 
    5.    
  
  
  
  5.   CACHE_DIR: "" 
    6.    
  
  
  
  6.  
    7.    
  
  
  
  7.   ## 作业控制 
    8.    
  
  
  
  8.   RUN_PIPELINE_BUILD: ""     #是否运行构建 yes/no  
    9.    
  
  
  
  9.   RUN_PIPELINE_TEST: ""      #是否运行测试 yes/no  
    10.    
  
  
  
  10.   RUN_CODE_ANALYSIS: ""      #是否代码扫描 yes/no  
    11.    
  
  
  
  11.   RUN_BUILD_IMAGE: ""        #是否生成镜像 yes/no 
    12.    
  
  
  
  12.   RUN_DEPLOY_ARTIFACTS: ""   #是否上传制品 yes/no 
    13.    
  
  
  
  13.   RUN_DEPLOY_K8S: ""         #是否发布K8S yes/no 
    14.    
  
  
  
  14.  
    15.    
  
  
  
  15.   ## 依赖容器镜像 
    16.    
  
  
  
  16.   BUILD_IMAGE: "" 
    17.    
  
  
  
  17.   CURL_IMAGE: "curlimages/curl:7.70.0" 
    18.    
  
  
  
  18.   SONAR_IMAGE: "sonarsource/sonar-scanner-cli:latest" 
    19.    
  
  
  
  19.   KUBECTL_IMAGE: "lucj/kubectl:1.17.2" 
    20.    
  
  
  
  20.    
    21.    
  
  
  
  21.    
    22.    
  
  
  
  22.   ## 构建测试参数 
    23.    
  
  
  
  23.   MAVEN_OPTS: ""                #maven构建参数  
    24.    
  
  
  
  24.   GRADLE_OPTS: ""               #gradle构建参数 
    25.    
  
  
  
  25.   BUILD_SHELL: ''               #构建命令 
    26.    
  
  
  
  26.  
    27.    
  
  
  
  27.   ## 单元测试参数 
    28.    
  
  
  
  28.   TEST_SHELL : 'mvn test  --settings=./settings.xml '       #测试命令 
    29.    
  
  
  
  29.   JUNIT_REPORT_PATH: 'target/surefire-reports/TEST-*.xml'   #单元测试报告 
    30.    
  
  
  
  30.  
    31.    
  
  
  
  31.   ## 代码扫描 
    32.    
  
  
  
  32.   SONAR_SOURCE_DIR : "src"                                          #项目源码目录 
    33.    
  
  
  
  33.   SONAR_SERVER_URL: "http://192.168.1.200:30090"                    #SonarQube服务器信息 
    34.    
  
  
  
  34.   SONAR_SERVER_LOGIN: "ee2bcb37deeb6dfe3a07fe08fb529559b00c1b7b"    #Sonar Token最好在项目中定义。 
    35.    
  
  
  
  35.   SONAR_SCAN_ARGS: "-Dsonar.sources=${SONAR_SOURCE_DIR}"            #项目扫描参数 
    36.    
  
  
  
  36.  
    37.    
  
  
  
  37.   ## 构建镜像 
    38.    
  
  
  
  38.   CI_REGISTRY: 'registry.cn-beijing.aliyuncs.com'               #镜像仓库地址               
    39.    
  
  
  
  39.   CI_REGISTRY_USER: 'xxxxxx'                               #仓库用户信息 
    40.    
  
  
  
  40.   #CI_REGISTRY_PASSWD: 'xxxxxxxx.'                              #仓库用户密码 
    41.    
  
  
  
  41.   IMAGE_NAME: "${CI_REGISTRY}/${CI_PROJECT_PATH}:${CI_COMMIT_REF_NAME}-${CI_COMMIT_SHORT_SHA}"     #镜像名称 
    42.    
  
  
  
  42.   DOCKER_FILE_PATH: "./Dockerfile"                              #Dockerfile位置 
    43.    
  
  
  
  43.  
    44.    
  
  
  
  44.   ## 上传制品库(artifactory) 
    45.    
  
  
  
  45.   ARTIFACTORY_URL: "http://192.168.1.200:30082/artifactory"     #制品库地址 
    46.    
  
  
  
  46.   ARTIFACTORY_NAME: "${CI_PROJECT_NAMESPACE}"                   #制品库名称 
    47.    
  
  
  
  47.   ARTIFACT_PACKAGE: "jar"                                       #制品类型 
    48.    
  
  
  
  48.   ARTIFACT_PATH: "target/*.${ARTIFACT_PACKAGE}"                 #制品位置 
    49.    
  
  
  
  49.   TARGET_FILE_PATH: "${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/${CI_COMMIT_REF_NAME}-${CI_COMMIT_SHORT_SHA}"   #目标制品位置(目录结构) 
    50.    
  
  
  
  50.   TARGET_ARTIFACT_NAME: "${CI_PROJECT_NAME}-${CI_COMMIT_REF_NAME}-${CI_COMMIT_SHORT_SHA}.${ARTIFACT_PACKAGE}"   #目标制品名称 
    51.    
  
  
  
  51.  
    52.    
  
  
  
  52.   ## 部署应用k8s 
    53.    
  
  
  
  53.   APP_NAME: "$CI_PROJECT_NAME"                #应用名称 <--> deploymentName 
    54.    
  
  
  
  54.   CONTAINER_PORT: "8081"                      #服务端口 <--> servicesPort 
    55.    
  
  
  
  55.   NAMESPACE: "$CI_PROJECT_NAME-$CI_PROJECT_ID-$CI_ENVIRONMENT_SLUG"             #名称空间 
    56.    
  
  
  
  56.   ENV_URL: "${ENV_NAME}.${CI_PROJECT_NAMESPACE}.${CI_PROJECT_NAME}.devops.com"  #IngressHosts 
    57.

流水线设置

  
 
 
 
    
   
  
  
  
  1. ## 流水线控制 
    2.    
  
  
  
  2. workflow: 
    3.    
  
  
  
  3.   rules: 
    4.    
  
  
  
  4.     - if: "$CI_MERGE_REQUEST_ID"          #过滤合并请求 
    5.    
  
  
  
  5.       when: never 
    6.    
  
  
  
  6.     - if: "$CI_PIPELINE_SOURCE == 'web'"    #允许在web页面发布 
    7.    
  
  
  
  7.     - if: "$CI_COMMIT_REF_NAME =~ /^RELEASE-*/ || $CI_COMMIT_REF_NAME =~ /master/ "  #过滤版本分支和主干分支提交代码触发 
    8.    
  
  
  
  8.       when: never 
    9.    
  
  
  
  9.     - if: "$CI_COMMIT_BEFORE_SHA == '0000000000000000000000000000000000000000'"     #过滤分支创建请求 
    10.    
  
  
  
  10.       when: never 
    11.    
  
  
  
  11.     ### 默认策略 
    12.    
  
  
  
  12.     - when: always 
    13.    
  
  
  
  13.  
    14.    
  
  
  
  14.  
    15.    
  
  
  
  15. ## 运行阶段   
    16.    
  
  
  
  16. stages: 
    17.    
  
  
  
  17.   - build 
    18.    
  
  
  
  18.   - test 
    19.    
  
  
  
  19.   - parallel01 
    20.    
  
  
  
  20.   - get_analysis_result 
    21.    
  
  
  
  21.   - deploy-artifact 
    22.    
  
  
  
  22.   - deploy-feature 
    23.    
  
  
  
  23.   - rollout-feature 
    24.    
  
  
  
  24.   - deploy-uat 
    25.    
  
  
  
  25.   - rollout-uat 
    26.    
  
  
  
  26.   - deploy-stag 
    27.    
  
  
  
  27.   - rollout-stag 
    28.    
  
  
  
  28.   - deploy-prod 
    29.    
  
  
  
  29.   - rollout-prod 
    30.    
  
  
  
  30.  
    31.    
  
  
  
  31. cache: 
    32.    
  
  
  
  32.   paths: 
    33.    
  
  
  
  33.     - ${CACHE_DIR} 
    34.    
  
  
  
  34.      
    35.    
  
  
  
  35. before_script: 
    36.    
  
  
  
  36.   - export 
    37.

构建作业配置

  
 
 
 
    
   
  
  
  
  1. ################# Jobs Configure ##################### 
    2.    
  
  
  
  2. ## 构建作业 
    3.    
  
  
  
  3. build: 
    4.    
  
  
  
  4.   image: ${BUILD_IMAGE} 
    5.    
  
  
  
  5.   extends: .build 
    6.    
  
  
  
  6.  
    7.    
  
  
  
  7. ## 测试作业 
    8.    
  
  
  
  8. test: 
    9.    
  
  
  
  9.   image: ${BUILD_IMAGE} 
    10.    
  
  
  
  10.   extends: .test 
    11.    
  
  
  
  11.   before_script: 
    12.    
  
  
  
  12.     - ls  
    13.    
  
  
  
  13.     - ls ${CACHE_DIR} 
    14.    
  
  
  
  14.  
    15.    
  
  
  
  15. ## 代码扫描 
    16.    
  
  
  
  16. code_analysis: 
    17.    
  
  
  
  17.   stage: parallel01 
    18.    
  
  
  
  18.   image: ${SONAR_IMAGE} 
    19.    
  
  
  
  19.   extends: .code_analysis 
    20.    
  
  
  
  20.  
    21.    
  
  
  
  21. ## 获取构建结果 
    22.    
  
  
  
  22. get_analysis_result: 
    23.    
  
  
  
  23.   image: ${CURL_IMAGE} 
    24.    
  
  
  
  24.   extends: .get_analysis_result 
    25.    
  
  
  
  25.   needs: 
    26.    
  
  
  
  26.     - code_analysis 
    27.    
  
  
  
  27.  
    28.    
  
  
  
  28.  
    29.    
  
  
  
  29. ## 构建镜像 
    30.    
  
  
  
  30. build_image: 
    31.    
  
  
  
  31.   image: docker:latest 
    32.    
  
  
  
  32.   services: 
    33.    
  
  
  
  33.     - name: docker:dind 
    34.    
  
  
  
  34.   stage: parallel01 
    35.    
  
  
  
  35.   extends: .build-docker 
    36.    
  
  
  
  36.  
    37.    
  
  
  
  37.  
    38.    
  
  
  
  38. ## 上传制品 
    39.    
  
  
  
  39. deploy_artifact: 
    40.    
  
  
  
  40.   image: ${CURL_IMAGE} 
    41.    
  
  
  
  41.   stage: deploy-artifact 
    42.    
  
  
  
  42.   extends: .deploy-artifact 
    43.    
  
  
  
  43.  
    44.    
  
  
  
  44. ## 下载制品   
    45.    
  
  
  
  45. #down_artifact:   
    46.    
  
  
  
  46. #  image: ${CURL_IMAGE} 
    47.    
  
  
  
  47. #  stage: down_artifact 
    48.    
  
  
  
  48. #  extends: .down-artifact 
    49.

发布部署作业配置

  
 
 
 
    
   
  
  
  
  1. #################Deploy Feature Jobs Configure ##################### 
    2.    
  
  
  
  2. ## feature发布应用 
    3.    
  
  
  
  3. deploy_feature: 
    4.    
  
  
  
  4.   variables: 
    5.    
  
  
  
  5.     DEPLOY_FILE: 'deployment.yaml' 
    6.    
  
  
  
  6.     ENV_NAME: 'feature' 
    7.    
  
  
  
  7.   stage: deploy-feature 
    8.    
  
  
  
  8.   image: ${KUBECTL_IMAGE} 
    9.    
  
  
  
  9.   extends: .deploy_k8s 
    10.    
  
  
  
  10.   environment: 
    11.    
  
  
  
  11.     on_stop: "rollout_feature" 
    12.    
  
  
  
  12.   rules: 
    13.    
  
  
  
  13.     - if: $RUN_DEPLOY_K8S == 'no' 
    14.    
  
  
  
  14.       when: never 
    15.    
  
  
  
  15.     - if: $CI_COMMIT_REF_NAME =~ /^RELEASE-*/ || $CI_COMMIT_REF_NAME =~ /master/ || $CI_COMMIT_TAG 
    16.    
  
  
  
  16.       when: never 
    17.    
  
  
  
  17.     - when: manual 
    18.    
  
  
  
  18.      
    19.    
  
  
  
  19. ## 应用回滚 
    20.    
  
  
  
  20. rollout_feature: 
    21.    
  
  
  
  21.   variables: 
    22.    
  
  
  
  22.     DEPLOY_FILE: 'deployment.yaml' 
    23.    
  
  
  
  23.     ENV_NAME: 'feature' 
    24.    
  
  
  
  24.   stage: rollout-feature 
    25.    
  
  
  
  25.   image: ${KUBECTL_IMAGE} 
    26.    
  
  
  
  26.   extends: .rollout_k8s 
    27.    
  
  
  
  27.   needs: 
    28.    
  
  
  
  28.     - deploy_feature 
    29.    
  
  
  
  29.   rules: 
    30.    
  
  
  
  30.     - if: $RUN_DEPLOY_K8S == 'no' 
    31.    
  
  
  
  31.       when: never 
    32.    
  
  
  
  32.     - if: $CI_COMMIT_REF_NAME =~ /^RELEASE-*/ || $CI_COMMIT_REF_NAME =~ /master/ || $CI_COMMIT_TAG 
    33.    
  
  
  
  33.       when: never 
    34.    
  
  
  
  34.     - when: on_failure 
    35.    
  
  
  
  35.  
    36.    
  
  
  
  36.  
    37.    
  
  
  
  37. #################Deploy UAT Jobs Configure ##################### 
    38.    
  
  
  
  38. ## UAT 
    39.    
  
  
  
  39. deploy_uat: 
    40.    
  
  
  
  40.   variables: 
    41.    
  
  
  
  41.     DEPLOY_FILE: 'config/deployment-uat.yaml' 
    42.    
  
  
  
  42.     ENV_NAME: 'uat' 
    43.    
  
  
  
  43.   stage: deploy-uat 
    44.    
  
  
  
  44.   image: ${KUBECTL_IMAGE} 
    45.    
  
  
  
  45.   extends: .deploy_k8s 
    46.    
  
  
  
  46.   environment: 
    47.    
  
  
  
  47.     on_stop: "rollout_uat" 
    48.    
  
  
  
  48.   rules: 
    49.    
  
  
  
  49.     - if: $RUN_DEPLOY_K8S == 'no' 
    50.    
  
  
  
  50.       when: never 
    51.    
  
  
  
  51.     - if: $CI_COMMIT_REF_NAME =~ /^RELEASE-*/ || $CI_COMMIT_REF_NAME =~ /master/ || $CI_COMMIT_TAG 
    52.    
  
  
  
  52.       when: manual 
    53.    
  
  
  
  53.     - when: never 
    54.    
  
  
  
  54.  
    55.    
  
  
  
  55. ## UAT应用回滚 
    56.    
  
  
  
  56. rollout_uat: 
    57.    
  
  
  
  57.   variables: 
    58.    
  
  
  
  58.     DEPLOY_FILE: 'config/deployment-uat.yaml' 
    59.    
  
  
  
  59.     ENV_NAME: 'uat' 
    60.    
  
  
  
  60.   stage: rollout-uat 
    61.    
  
  
  
  61.   image: ${KUBECTL_IMAGE} 
    62.    
  
  
  
  62.   extends: .rollout_k8s 
    63.    
  
  
  
  63.   needs: 
    64.    
  
  
  
  64.     - deploy_uat 
    65.    
  
  
  
  65.   rules: 
    66.    
  
  
  
  66.     - if: $RUN_DEPLOY_K8S == 'no' 
    67.    
  
  
  
  67.       when: never 
    68.    
  
  
  
  68.     - if: $CI_COMMIT_REF_NAME =~ /^RELEASE-*/ || $CI_COMMIT_REF_NAME =~ /master/ || $CI_COMMIT_TAG 
    69.    
  
  
  
  69.       when: on_failure 
    70.    
  
  
  
  70.     - when: never 
    71.    
  
  
  
  71.  
    72.    
  
  
  
  72. #################Deploy STAG Jobs Configure ##################### 
    73.    
  
  
  
  73. ## STAG 
    74.    
  
  
  
  74. deploy_stag: 
    75.    
  
  
  
  75.   variables: 
    76.    
  
  
  
  76.     DEPLOY_FILE: 'config/deployment-stag.yaml' 
    77.    
  
  
  
  77.     ENV_NAME: 'stag' 
    78.    
  
  
  
  78.   stage: deploy-stag 
    79.    
  
  
  
  79.   image: ${KUBECTL_IMAGE} 
    80.    
  
  
  
  80.   extends: .deploy_k8s 
    81.    
  
  
  
  81.   environment: 
    82.    
  
  
  
  82.     on_stop: "rollout_stag" 
    83.    
  
  
  
  83.   needs: 
    84.    
  
  
  
  84.     - deploy_uat 
    85.    
  
  
  
  85.   rules: 
    86.    
  
  
  
  86.     - if: $RUN_DEPLOY_K8S == 'no' 
    87.    
  
  
  
  87.       when: never 
    88.    
  
  
  
  88.     - if: $CI_COMMIT_REF_NAME =~ /^RELEASE-*/ || $CI_COMMIT_REF_NAME =~ /master/ || $CI_COMMIT_TAG 
    89.    
  
  
  
  89.       when: manual 
    90.    
  
  
  
  90.     - when: never 
    91.    
  
  
  
  91.  
    92.    
  
  
  
  92. ## STAG应用回滚 
    93.    
  
  
  
  93. rollout_stag: 
    94.    
  
  
  
  94.   variables: 
    95.    
  
  
  
  95.     DEPLOY_FILE: 'config/deployment-stag.yaml' 
    96.    
  
  
  
  96.     ENV_NAME: 'stag' 
    97.    
  
  
  
  97.   stage: rollout-stag 
    98.    
  
  
  
  98.   image: ${KUBECTL_IMAGE} 
    99.    
  
  
  
  99.   extends: .rollout_k8s 
    100.    
  
  
  
  100.   needs: 
    101.    
  
  
  
  101.     - deploy_stag 
    102.    
  
  
  
  102.   rules: 
    103.    
  
  
  
  103.     - if: $RUN_DEPLOY_K8S == 'no' 
    104.    
  
  
  
  104.       when: never 
    105.    
  
  
  
  105.     - if: $CI_COMMIT_REF_NAME =~ /^RELEASE-*/ || $CI_COMMIT_REF_NAME =~ /master/ || $CI_COMMIT_TAG 
    106.    
  
  
  
  106.       when: on_failure 
    107.    
  
  
  
  107.     - when: never 
    108.    
  
  
  
  108.  
    109.    
  
  
  
  109. #################Deploy PROD Jobs Configure ##################### 
    110.    
  
  
  
  110. ## PROD 
    111.    
  
  
  
  111. deploy_prod: 
    112.    
  
  
  
  112.   variables: 
    113.    
  
  
  
  113.     DEPLOY_FILE: 'config/deployment-prod.yaml' 
    114.    
  
  
  
  114.     ENV_NAME: 'prod' 
    115.    
  
  
  
  115.   stage: deploy-prod 
    116.    
  
  
  
  116.   image: ${KUBECTL_IMAGE} 
    117.    
  
  
  
  117.   extends: .deploy_k8s 
    118.    
  
  
  
  118.   environment: 
    119.    
  
  
  
  119.     on_stop: "rollout_prod" 
    120.    
  
  
  
  120.   needs: 
    121.    
  
  
  
  121.     - deploy_stag 
    122.    
  
  
  
  122.   rules: 
    123.    
  
  
  
  123.     - if: $RUN_DEPLOY_K8S == 'no' 
    124.    
  
  
  
  124.       when: never 
    125.    
  
  
  
  125.     - if: $CI_COMMIT_REF_NAME =~ /^RELEASE-*/ || $CI_COMMIT_REF_NAME =~ /master/ || $CI_COMMIT_TAG 
    126.    
  
  
  
  126.       when: manual 
    127.    
  
  
  
  127.     - when: never 
    128.    
  
  
  
  128.  
    129.    
  
  
  
  129. ## PROD应用回滚 
    130.    
  
  
  
  130. rollout_prod: 
    131.    
  
  
  
  131.   variables: 
    132.    
  
  
  
  132.     DEPLOY_FILE: 'config/deployment-prod.yaml' 
    133.    
  
  
  
  133.     ENV_NAME: 'prod' 
    134.    
  
  
  
  134.   stage: rollout-prod 
    135.    
  
  
  
  135.   image: ${KUBECTL_IMAGE} 
    136.    
  
  
  
  136.   extends: .rollout_k8s 
    137.    
  
  
  
  137.   needs: 
    138.    
  
  
  
  138.     - deploy_prod 
    139.    
  
  
  
  139.   rules: 
    140.    
  
  
  
  140.     - if: $RUN_DEPLOY_K8S == 'no' 
    141.    
  
  
  
  141.       when: never 
    142.    
  
  
  
  142.     - if: $CI_COMMIT_REF_NAME =~ /^RELEASE-*/ || $CI_COMMIT_REF_NAME =~ /master/ || $CI_COMMIT_TAG 
    143.    
  
  
  
  143.       when: on_failure 
    144.    
  
  
  
  144.     - when: never 
    145.

JAVA项目交付流水线

导入作业模板

  
 
 
 
    
   
  
  
  
  1. include: 
    2.    
  
  
  
  2.   - project: 'cidevops/cidevops-newci-service' 
    3.    
  
  
  
  3.     ref: master 
    4.    
  
  
  
  4.     file: 'templates/default-pipeline.yml' 
    5.

配置项目参数

  
 
 
 
    
   
  
  
  
  1. variables: 
    2.    
  
  
  
  2.   ## 全局配置 
    3.    
  
  
  
  3.   GIT_CLONE_PATH: ${CI_BUILDS_DIR}/builds/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/${CI_PIPELINE_ID}     
    4.    
  
  
  
  4.   GIT_CHECKOUT: "false" 
    5.    
  
  
  
  5.   CACHE_DIR: "target/" 
    6.    
  
  
  
  6.  
    7.    
  
  
  
  7.   ## 作业控制 
    8.    
  
  
  
  8.   RUN_PIPELINE_BUILD:   "yes"     #是否运行构建 yes/no  
    9.    
  
  
  
  9.   RUN_PIPELINE_TEST:    "yes"      #是否运行测试 yes/no  
    10.    
  
  
  
  10.   RUN_CODE_ANALYSIS:    "yes"     #是否代码扫描 yes/no  
    11.    
  
  
  
  11.   RUN_BUILD_IMAGE:      "yes"     #是否生成镜像 yes/no 
    12.    
  
  
  
  12.   RUN_DEPLOY_ARTIFACTS: "no"      #是否上传制品 yes/no 
    13.    
  
  
  
  13.   RUN_DEPLOY_K8S:       "yes"     #是否发布K8S yes/no 
    14.    
  
  
  
  14.  
    15.    
  
  
  
  15.   ## 依赖容器镜像 
    16.    
  
  
  
  16.   BUILD_IMAGE: "maven:3.6.3-jdk-8" 
    17.    
  
  
  
  17.   CURL_IMAGE: "curlimages/curl:7.70.0" 
    18.    
  
  
  
  18.   SONAR_IMAGE: "sonarsource/sonar-scanner-cli:latest" 
    19.    
  
  
  
  19.   KUBECTL_IMAGE: "lucj/kubectl:1.17.2" 
    20.    
  
  
  
  20.    
    21.    
  
  
  
  21.    
    22.    
  
  
  
  22.   ## 构建测试参数 
    23.    
  
  
  
  23.   MAVEN_OPTS: "-Dmaven.repo.local=/home/gitlab-runner/ci-build-cache/maven "  #maven构建参数 
    24.    
  
  
  
  24.   BUILD_SHELL: 'mvn clean package  -DskipTests  --settings=./settings.xml '   #构建命令 
    25.    
  
  
  
  25.   #GRADLE_OPTS: ""               #gradle构建参数 
    26.    
  
  
  
  26.  
    27.    
  
  
  
  27.   ## 单元测试参数 
    28.    
  
  
  
  28.   TEST_SHELL : 'mvn test  --settings=./settings.xml   '       #测试命令 
    29.    
  
  
  
  29.   JUNIT_REPORT_PATH: 'target/surefire-reports/TEST-*.xml'   #单元测试报告 
    30.    
  
  
  
  30.  
    31.    
  
  
  
  31.   ## 代码扫描 
    32.    
  
  
  
  32.   SONAR_SOURCE_DIR : "src"                                          #项目源码目录 
    33.    
  
  
  
  33.   SONAR_SERVER_URL: "http://192.168.1.200:30090"                    #SonarQube服务器信息 
    34.    
  
  
  
  34.   SONAR_SERVER_LOGIN: "ee2bcb37deeb6dfe3a07fe08fb529559b00c1b7b"    #Sonar Token最好在项目中定义。 
    35.    
  
  
  
  35.   SONAR_SCAN_ARGS: "-Dsonar.sources=${SONAR_SOURCE_DIR}  
    36.    
  
  
  
  36.                    -Dsonar.java.binaries=target/classes &            
    
            新闻名称：GitLabCI模板库的流水线优化实践            
    
            文章来源：http://wtcwzsj.com/article/dhgiggc.html

其他资讯


关于我们
我们的服务
网站建设案例
新闻动态
联系我们

135-1821-9792

公司服务热线
友情链接： 锦江区公司注册   成都网站维护公司   cdganxi.cn   户外太阳伞大伞   成都静音发电机   眉山服务器托管   武侯区知识产权   四川鸿达   绵阳主机托管   sxjierui.cn   

Copyright © 2009-2022 www.wtcwzsj.com 青羊区广皓图文设计工作室（个体工商户） 版权所有　蜀ICP备19037934号