使用 Jenkinsfile 在多集群项目中部署应用

准备工作

创建 Docker Hub 访问令牌 (Token)

  1. 登录 Docker Hub 并在右上角的菜单中选择 Account Settings。

    dockerhub 设置

  2. 在左侧点击 Security，然后点击 New Access Token。

    dockerhub 创建令牌

  3. 输入令牌名称，点击 Create。

    dockerhub 令牌创建完成

  4. 点击 Copy and Close 并务必保存该访问令牌。

    dockerhub 复制令牌

创建凭证

您需要在 KubeSphere 中为已创建的访问令牌创建凭证，以便流水线能够向 Docker Hub 推送镜像。此外，您还需要创建 kubeconfig 凭证，用于访问 Kubernetes 集群。

  1. 以 project-regular 身份登录 KubeSphere Web 控制台，转到您的 DevOps 工程，在凭证页面点击创建。

    创建 dockerhub ID

  2. 在弹出对话框中，设置凭证 ID，稍后会用于 Jenkinsfile 中，类型选择帐户凭证。用户名输入您的 Docker Hub 帐户名称，token / 密码中输入刚刚创建的访问令牌。操作完成后，点击确定。

    创建 Docker 凭证

    提示

    有关如何创建凭证的更多信息，请参见凭证管理。

  3. 再次点击创建，类型选择 kubeconfig。KubeSphere 会自动填充 Content 字段，即当前用户帐户的 kubeconfig。设置凭证 ID，然后点击确定。

    创建 kubeconfig

创建流水线

创建完上述凭证后，您可以按照以下步骤使用示例 Jenkinsfile 创建流水线。

  1. 要创建流水线，请在流水线页面点击创建。

    创建流水线

  2. 在弹出窗口中设置名称，然后点击下一步。

    设置流水线名称

  3. 在本教程中，您可以为所有字段使用默认值。在高级设置页面，直接点击创建。

    创建流水线-2

编辑 Jenkinsfile

  1. 在流水线列表中，点击该流水线进入其详情页面。点击编辑 Jenkinsfile 定义一个 Jenkinsfile，流水线会基于它来运行。

    编辑 jenkinsfile

  2. 将以下所有内容复制并粘贴到弹出窗口中，用作流水线的示例 Jenkinsfile。您必须将 DOCKERHUB_USERNAME、DOCKERHUB_CREDENTIAL、KUBECONFIG_CREDENTIAL_ID、MULTI_CLUSTER_PROJECT_NAME 和 MEMBER_CLUSTER_NAME 的值替换成您自己的值。操作完成后，点击确定。

    1. pipeline {
    2.   agent {
    3.     node {
    4.       label 'maven'
    5.     }
    7.   }
    9.   environment {
    10.     REGISTRY = 'docker.io'
    11.     // username of dockerhub
    12.     DOCKERHUB_USERNAME = 'yuswift'
    13.     APP_NAME = 'devops-go-sample'
    14.     // ‘dockerhubid’ is the dockerhub credential id you created on ks console
    15.     DOCKERHUB_CREDENTIAL = credentials('dockerhubid')
    16.     // the kubeconfig credential id you created on ks console
    17.     KUBECONFIG_CREDENTIAL_ID = 'multi-cluster'
    18.     // mutli-cluster project name under your own workspace
    19.     MULTI_CLUSTER_PROJECT_NAME = 'devops-with-go'
    20.     // the member cluster name you want to deploy app on
    21.     // in this tutorial, you are assumed to deploy app on host and only one member cluster
    22.     // for more member clusters, please edit manifest/multi-cluster-deploy.yaml
    23.     MEMBER_CLUSTER_NAME = 'c9'
    24.   }  
    26.   stages {
    27.     stage('docker login') {
    28.       steps {
    29.         container('maven') {
    30.           sh 'echo $DOCKERHUB_CREDENTIAL_PSW  | docker login -u $DOCKERHUB_CREDENTIAL_USR --password-stdin'
    31.         }
    33.       }
    34.     }
    36.     stage('build & push') {
    37.       steps {
    38.         container('maven') {
    39.           sh 'git clone https://github.com/yuswift/devops-go-sample.git'
    40.           sh 'cd devops-go-sample && docker build -t $REGISTRY/$DOCKERHUB_USERNAME/$APP_NAME .'
    41.           sh 'docker push $REGISTRY/$DOCKERHUB_USERNAME/$APP_NAME'
    42.         }
    43.       }
    44.     }
    46.     stage('deploy app to multi cluster') {
    47.       steps {
    48.         container('maven') {
    49.           script {
    50.             withCredentials([
    51.               kubeconfigFile(
    52.                 credentialsId: 'multi-cluster',
    53.                 variable: 'KUBECONFIG')
    54.               ]) {
    55.               sh 'envsubst < devops-go-sample/manifest/multi-cluster-deploy.yaml | kubectl apply -f -'
    56.               }
    57.             }
    58.           }
    59.         }
    60.       }
    61.     }
    62.   }

    备注

    如果您的流水线成功运行，将会推送镜像至 Docker Hub。如果您使用 Harbor，则无法通过 Jenkins 凭证使用环境变量将参数传送到 docker login -u。这是因为每个 Harbor Robot 帐户的用户名都包含一个 $ 字符，当用于环境变量时，Jenkins 会将其转换为 $$。了解更多信息。

运行流水线

保存 Jenkinsfile 后，点击运行。如果一切顺利，您会在您的多集群项目中看到部署 (Deployment) 工作负载。

Deployment