本文档演示如何将 Harbor 集成到 KubeSphere 企业版流水线。

前提条件

  • KubeSphere 企业版平台需要安装并启用 DevOps 扩展组件。

  • 已有一个企业空间、一个 DevOps 项目和一个用户 (例如 project-regular)，并已邀请该用户至 DevOps 项目且授予 operator 角色。

安装 Harbor

执行以下命令，使用 Helm 3 安装 Harbor。

  1. helm repo add harbor https://helm.goharbor.io
  2. # 如需快速安装，您可以通过 NodePort 暴露 Harbor 并禁用 tls。
  3. # 请将 externalURL 设置为您的一个节点 IP，并确保 Jenkins 能够访问它。
  4. helm install harbor-release harbor/harbor --set expose.type=nodePort,externalURL=http://$ip:30002,expose.tls.enabled=false

获取 Harbor 凭证

  1. 安装 Harbor 后，访问 <NodeIP>:30002 并使用默认账户和密码 (admin/Harbor12345) 登录 Web 控制台。

  2. 在左侧导航栏中点击项目，然后点击新建项目。

  3. 在弹出的对话框中，设置项目名称 ks-devops-harbor 并点击确定。

  4. 点击刚刚创建的项目，在机器人账户页签下点击添加机器人账户。

  5. 在弹出的对话框中，为机器人账户设置名称 robot-test 并点击添加。请确保在权限中勾选推送制品的权限选框。

  6. 在弹出的对话框中，点击导出到文件中，保存该令牌。

启用 Insecure Registry

配置 Docker，使其忽略您 Harbor 仓库的安全性。

  1. 在您的主机上运行 vim /etc/docker/daemon.json 命令以编辑 daemon.json 文件，输入以下内容并保存更改。

    1. {
    2.   "insecure-registries" : ["103.61.38.55:30002"]
    3. }
    说明

    请将 103.61.38.55:30002 替换为您自己的 Harbor 仓库地址。对于 Linux，daemon.json 文件的路径为 /etc/docker/daemon.json；对于 Windows，该文件的路径为 C:\ProgramData\docker\config\daemon.json。

  2. 运行以下命令重启 Docker，使更改生效。

    1. sudo systemctl daemon-reload
    3. sudo systemctl restart docker
    说明

    建议您在隔离的测试环境或者严格控制的离线环境中使用该方案。有关更多信息，请参阅 Deploy a plain HTTP registry。完成上述操作后，即可在项目中部署工作负载时使用您 Harbor 仓库中的镜像。您需要为自己的 Harbor 仓库创建一个镜像密钥，然后在容器镜像页签下的容器设置中，选择您的 Harbor 仓库并输入镜像的绝对路径以搜索您的镜像。

创建凭证

  1. 以 project-regular 用户登录 KubeSphere 企业版 Web 控制台。

  2. 点击企业空间管理并进入您的 DevOps 项目。

  3. 在 DevOps 项目设置下的凭证页面为 Harbor 创建凭证。

  4. 在创建凭证页面，设置凭证 ID (robot-test)，类型选择用户名和密码，用户名字段必须和您刚刚下载的 JSON 文件中 name 的值相同，并在密码/令牌中输入 Harbor 令牌文件中 token 的值。

  5. 点击确定以保存。

创建流水线

  1. 转到流水线页面，点击创建。

  2. 在基本信息页签，输入名称 demo-pipeline，然后点击下一步。

  3. 高级设置中使用默认值，点击创建。

编辑 Jenkinsfile

  1. 点击该流水线进入其详情页面，然后点击编辑 Jenkinsfile。

  2. 将以下内容复制粘贴至 Jenkinsfile。注意，必须将 REGISTRY、HARBOR_NAMESPACE、APP_NAME 和 HARBOR_CREDENTIAL 替换为您自己的值。

    1. pipeline {
    2.   agent {
    3.     node {
    4.       label 'maven'
    5.     }
    6.   }
    8.   environment {
    9.     // 您 Harbor 仓库的地址。
    10.     REGISTRY = '103.61.38.55:30002'
    11.     // 项目名称。
    12.     // 请确保您的机器人账户具有足够的项目访问权限。
    13.     HARBOR_NAMESPACE = 'ks-devops-harbor'
    14.     // Docker 镜像名称。
    15.     APP_NAME = 'docker-example'
    16.     // ‘robot-test’是您在{ks_product_both} Web 控制台上创建的凭证 ID。
    17.     HARBOR_CREDENTIAL = credentials('robot-test')
    18.   }
    20.   stages {
    21.     stage('docker login') {
    22.       steps{
    23.         container ('maven') {
    24.           // 请替换 -u 后面的 Docker Hub 用户名，不要忘记加上 ''。您也可以使用 Docker Hub 令牌。
    25.           sh '''echo $HARBOR_CREDENTIAL_PSW|docker login $REGISTRY -u 'robot$robot-test' --password-stdin'''
    26.         }
    27.       }
    28.     }
    30.      stage('build & push') {
    31.        steps {
    32.          container ('maven') {
    33.            sh 'git clone https://github.com/kstaken/dockerfile-examples.git'
    34.            sh 'cd dockerfile-examples/rethinkdb && docker build -t $REGISTRY/$HARBOR_NAMESPACE/$APP_NAME:devops-test .'
    35.            sh 'docker push$REGISTRY/$HARBOR_NAMESPACE/$APP_NAME:devops-test'
    36.          }
    37.        }
    38.      }
    39.   }
    40. }
    说明

    您可以通过带有环境变量的 Jenkins 凭证来传送参数至 docker login -u。但是，每个 Harbor 机器人账户的用户名都包含一个 $ 字符，当用于环境变量时，Jenkins 会将其转换为 $$。（Harbor v2.2以后可以自定义机器人后缀，避免此类问题）了解更多。

运行流水线

保存 Jenkinsfile 后，KubeSphere 企业版会自动在图形编辑面板上创建所有阶段和步骤。点击运行来运行该流水线。如果一切运行正常，Jenkins 将推送镜像至您的 Harbor 仓库。