使用图形编辑面板创建流水线

KubeSphere 中的图形编辑面板包含用于 Jenkins 阶段 (Stage)步骤 (Step) 的所有必要操作。您可以直接在交互式面板上定义这些阶段和步骤,无需创建任何 Jenkinsfile。

本教程演示如何在 KubeSphere 中使用图形编辑面板创建流水线。KubeSphere 在整个过程中将根据您在编辑面板上的设置自动生成 Jenkinsfile,您无需手动创建 Jenkinsfile。待流水线成功运行,它会相应地在您的开发环境中创建一个部署 (Deployment) 和一个服务 (Service),并将镜像推送至 Docker Hub。

准备工作

流水线概述

本示例流水线包括以下六个阶段。

Pipeline

备注

  • 阶段 1:Checkout SCM:从 GitHub 仓库拉取源代码。
  • 阶段 2:单元测试:待该测试通过后才会进行下一阶段。
  • 阶段 3:代码分析:配置 SonarQube 用于静态代码分析。
  • 阶段 4:构建并推送:构建镜像并附上标签 snapshot-$BUILD_NUMBER 推送至 Docker Hub,其中 $BUILD_NUMBER 是流水线活动列表中的记录的序列号。
  • 阶段 5:制品:生成一个制品(JAR 文件包)并保存。
  • 阶段 6:部署至开发环境:在开发环境中创建一个部署和一个服务。该阶段需要进行审核,部署成功运行后,会发送电子邮件通知。

动手实验

步骤 1:创建凭证

  1. project-regular 身份登录 KubeSphere 控制台。转到您的 DevOps 工程,在工程管理下的凭证页面创建以下凭证。有关如何创建凭证的更多信息,请参见凭证管理

    备注

    如果您的帐户或密码中有任何特殊字符,例如 @$,可能会因为无法识别而在流水线运行时导致错误。在这种情况下,您需要先在一些第三方网站(例如 urlencoder)上对帐户或密码进行编码,然后将输出结果复制粘贴作为您的凭证信息。
    凭证 ID类型用途
    dockerhub-id帐户凭证Docker Hub
    demo-kubeconfigkubeconfigKubernetes
  2. 您还需要为 SonarQube 创建一个凭证 ID (sonar-token),用于上述的阶段 3(代码分析)。请参考为新工程创建 SonarQube 令牌 (Token),在下图所示的密钥字段中输入令牌。点击确定完成操作。

    Sonar 令牌

  3. 您可以在列表中看到已创建的三个凭证。

    凭证列表

步骤 2:创建项目

在本教程中,示例流水线会将 sample 应用部署至一个项目。因此,您必须先创建一个项目(例如 kubesphere-sample-dev)。待流水线成功运行,会在该项目中自动创建该应用的部署和服务。

您可以使用 project-admin 帐户创建项目。此外,该帐户也是 CI/CD 流水线的审核员。请确保将 project-regular 帐户邀请至该项目并授予 operator 角色。有关更多信息,请参见创建企业空间、项目、帐户和角色

步骤 3:创建流水线

  1. 请确保以 project-regular 身份登录 KubeSphere 控制台,转到您的 DevOps 工程。在流水线页面点击创建

    创建流水线

  2. 在弹出对话框中,将它命名为 graphical-pipeline,点击下一步

    基本信息

  3. 高级设置页面,点击添加参数,添加以下三个字符串参数。这些参数将用于流水线的 Docker 命令。添加完成后,点击创建

    添加参数

    参数类型名称描述信息
    字符串REGISTRYdocker.io镜像仓库地址。本示例使用 docker.io
    字符串DOCKERHUB_NAMESPACEDocker ID您的 Docker Hub 帐户或该帐户下的组织名称。
    字符串APP_NAMEdevops-sample应用名称。

    备注

    有关其他字段,请直接使用默认值或者参考流水线设置以自定义配置。
  4. 创建的流水线会显示在列表中。

    流水线列表

步骤 4:编辑流水线

点击流水线进入其详情页面。要使用图形编辑面板,请点击流水线选项卡下的编辑流水线。在弹出对话框中,点击自定义流水线。该流水线包括六个阶段,请按照以下步骤设置每个阶段。

编辑流水线

备注

流水线详情页面会显示同步状态,它是 KubeSphere 和 Jenkins 之间的同步结果。若同步成功,您会看到成功图标。您也可以点击编辑 Jenkinsfile 手动为流水线创建一个 Jenkinsfile。

click-custom-pipeline

备注

您也可以点击持续集成 (CI)持续集成&交付 (CI/CD) 来使用 KubeSphere 提供的内置流水线模板

阶段 1:拉取源代码 (Checkout SCM)

图形编辑面板包括两个区域:左侧的画布和右侧的内容。它会根据您对不同阶段和步骤的配置自动生成一个 Jenkinsfile,为开发者提供更加用户友好的操作体验。

备注

流水线包括声明式流水线脚本化流水线。目前,您可以使用该面板创建声明式流水线。有关流水线语法的更多信息,请参见 Jenkins 文档
  1. 在图形编辑面板上,从类型下拉列表中选择 node,从 Label 下拉列表中选择 maven

    备注

    agent 用于定义执行环境。agent 指令指定 Jenkins 执行流水线的位置和方式。有关更多信息,请参见选择 Jenkins Agent

    图形面板

  2. 请点击左侧的加号图标来添加阶段。点击添加步骤上方的文本框,然后在右侧的名称字段中为该阶段设置名称(例如 Checkout SCM)。

    编辑面板

  3. 点击添加步骤。在列表中选择 git,以从 GitHub 拉取示例代码。在弹出对话框中,填写必需的字段。点击确定完成操作。

    • URL:输入 GitHub 仓库地址 https://github.com/kubesphere/devops-java-sample.git。请注意,这里是示例地址,您需要使用您自己的仓库地址。
    • 凭证 ID:本教程中无需输入凭证 ID。
    • 分支:如果您将其留空,则默认为 master 分支。请输入 sonarqube,或者如果您不需要代码分析阶段,请将其留空。

    输入仓库 URL

  4. 第一阶段设置完成。

    第一阶段设置完成

阶段 2:单元测试

  1. 点击阶段 1 右侧的加号图标添加新的阶段,以在容器中执行单元测试。将它命名为 Unit Test

    单元测试

  2. 点击添加步骤,在列表中选择指定容器。将其命名为 maven 然后点击确定

    指定容器

  3. 点击添加嵌套步骤,在 maven 容器下添加一个嵌套步骤。在列表中选择 shell 并在命令行中输入以下命令。点击确定保存操作。

    mvn clean -o -gs `pwd`/configuration/settings.xml test
    

    备注

    您可以在图形编辑面板上指定在给定阶段指令中执行的一系列步骤

    shell

    单元测试设置完成

阶段 3:代码分析(可选)

本阶段使用 SonarQube 来测试您的代码。如果您不需要代码分析,可以跳过该阶段。

  1. 点击 Unit Test 阶段右侧的加号图标添加一个阶段,以在容器中进行 SonarQube 代码分析。将它命名为 Code Analysis

    代码分析阶段

  2. Code Analysis 中,点击任务下的添加步骤,选择指定容器。将其命名为 maven 然后点击确定

    Maven 容器

  3. 点击 maven 容器下的添加嵌套步骤,以添加一个嵌套步骤。点击添加凭证并从凭证 ID 列表中选择 SonarQube 令牌 (sonar-token)。在文本变量中输入 SONAR_TOKEN,然后点击确定

    SonarQube 凭证

  4. 添加凭证步骤下,点击添加嵌套步骤为其添加一个嵌套步骤。

    嵌套步骤

  5. 点击 Sonarqube 配置,在弹出对话框中保持默认名称 sonar 不变,点击确定保存操作。

    sonar

  6. Sonarqube 配置步骤下,点击添加嵌套步骤为其添加一个嵌套步骤。

    添加嵌套步骤

  7. 点击 shell 并在命令行中输入以下命令,用于 sonarqube 分支和认证,点击确定完成操作。

    mvn sonar:sonar -o -gs `pwd`/configuration/settings.xml -Dsonar.login=$SONAR_TOKEN
    

    新的 SonarQube shell

  8. 点击指定容器步骤下的添加嵌套步骤(第三个),选择超时。在时间中输入 1 并将单位选择为小时,点击确定完成操作。

    添加嵌套步骤-2

    超时

  9. 点击超时步骤下的添加嵌套步骤,选择代码质量检查 (SonarQube)。在弹出对话框中选择检查通过后开始后续任务。点击确定保存操作。

    waitforqualitygate

    sonar 就绪

阶段 4:构建并推送镜像

  1. 点击前一个阶段右侧的加号图标添加一个新的阶段,以构建并推送镜像至 Docker Hub。将其命名为 Build and Push

    构建并推送镜像

  2. 点击任务下的添加步骤,选择指定容器,将其命名为 maven,然后点击确定

    maven 设置完成

  3. 点击 maven 容器下的添加嵌套步骤添加一个嵌套步骤。在列表中选择 shell 并在弹出窗口中输入以下命令,点击确定完成操作。

    mvn -o -Dmaven.test.skip=true -gs `pwd`/configuration/settings.xml clean package
    

    maven 嵌套步骤

  4. 再次点击添加嵌套步骤,选择 shell。在命令行中输入以下命令,以根据 Dockerfile 构建 Docker 镜像。点击确定确认操作。

    备注

    请勿遗漏命令末尾的点 .
    docker build -f Dockerfile-online -t $REGISTRY/$DOCKERHUB_NAMESPACE/$APP_NAME:SNAPSHOT-$BUILD_NUMBER .
    

    shell 命令

  5. 再次点击添加嵌套步骤,选择添加凭证。在弹出对话框中填写以下字段,点击确定确认操作。

    • 凭证 ID:选择您创建的 Docker Hub 凭证,例如 dockerhub-id
    • 密码变量:输入 DOCKER_PASSWORD
    • 用户名变量:输入 DOCKER_USERNAME

    备注

    出于安全原因,帐户信息在脚本中显示为变量。

    docker 凭证

  6. 添加凭证步骤中点击添加嵌套步骤(第一个)。选择 shell 并在弹出窗口中输入以下命令,用于登录 Docker Hub。点击确定确认操作。

    echo "$DOCKER_PASSWORD" | docker login $REGISTRY -u "$DOCKER_USERNAME" --password-stdin
    

    Docker 登录命令

  7. 添加凭证步骤中点击添加嵌套步骤。选择 shell 并输入以下命令,将 SNAPSHOT 镜像推送至 Docker Hub。点击确定完成操作。

    docker push $REGISTRY/$DOCKERHUB_NAMESPACE/$APP_NAME:SNAPSHOT-$BUILD_NUMBER
    

    推送 snapshot 至 Docker

阶段 5:生成制品

  1. 点击 Build and Push 阶段右侧的加号图标添加一个新的阶段,以保存制品,将其命名为 Artifacts。本示例使用 JAR 文件包。

    添加制品阶段

  2. 选中 Artifacts 阶段,点击任务下的添加步骤,选择保存制品。在弹出对话框中输入 target/*.jar,用于设置 Jenkins 中制品的保存路径。点击确定完成操作。

    制品信息

阶段 6:部署至开发环境

  1. 点击 Artifacts 阶段右侧的加号图标添加最后一个阶段,将其命名为 Deploy to Dev。该阶段用于将资源部署至您的开发环境(即 kubesphere-sample-dev 项目)。

    部署至开发环境

  2. 点击 Deploy to Dev 阶段下的添加步骤,在列表中选择审核,然后在消息字段中填入 @project-admin,即 project-admin 帐户在流水线运行到该阶段时会进行审核。点击确定保存操作。

    输入信息

    备注

    在 KubeSphere 3.1 中,能够运行流水线的帐户也能够继续或终止该流水线。此外,流水线创建者、拥有该工程管理员角色的帐户或者您指定的帐户也有权限继续或终止流水线。
  3. 再次点击 Deploy to Dev 阶段下的添加步骤。在列表中选择 kubernetesDeploy 并在弹出对话框中填写以下字段。点击确定保存操作。

    • Kubeconfig:选择您创建的 Kubeconfig,例如 demo-kubeconfig
    • 配置文件路径:输入 deploy/no-branch-dev/**,即代码仓库中 Kubernetes 资源 YAML 文件的相对路径。

    kubernetesDeploy

  4. 如果您想在流水线成功运行时接收电子邮件通知,请点击添加步骤,选择邮件,以添加电子邮件信息。请注意,配置电子邮件服务器是可选操作,如果您跳过该步骤,依然可以运行流水线。

    备注

    有关配置电子邮件服务器的更多信息,请参见为 KubeSphere 流水线设置电子邮件服务器
  5. 待您完成上述步骤,请在右下角点击确认保存。随后,您可以看到该流水线有完整的工作流,并且每个阶段也清晰列示。当您用图形编辑面板定义流水线时,KubeSphere 会自动创建相应的 Jenkinsfile。点击编辑 Jenkinsfile 查看该 Jenkinsfile。

    流水线设置完成

    备注

    流水线页面,您可以点击该流水线右侧的三个点,然后选择复制流水线来创建该流水线的副本。如果您需要同时运行多个不包含多分支的流水线,您可以全部选中这些流水线,然后点击运行来批量运行它们。

步骤 5:运行流水线

  1. 您需要手动运行使用图形编辑面板创建的流水线。点击运行,您可以在弹出对话框中看到步骤 3 中已定义的三个字符串参数。点击确定来运行流水线。

    运行流水线

  2. 要查看流水线的状态,请转到活动选项卡,点击您想查看的记录。

  3. 稍等片刻,流水线如果成功运行,则会在 Deploy to Dev 阶段停止。project-admin 作为流水线的审核员,需要进行审批,然后资源才会部署至开发环境。

    流水线成功运行

  4. 登出 KubeSphere 控制台,以 project-admin 身份重新登录。转到您的 DevOps 工程,点击 graphical-pipeline 流水线。在活动选项卡下,点击要审核的记录。要批准流水线,请点击继续

步骤 6:查看流水线详情

  1. project-regular 身份重新登录控制台。转到您的 DevOps 工程,点击 graphical-pipeline 流水线。在活动选项卡下,点击状态下标记为成功的记录。

  2. 如果所有配置都成功运行,您可以看到所有阶段都已完成。

    完成

  3. 在右上角点击查看日志,查看所有日志。点击每个阶段查看其详细日志。您可以根据日志排除故障和问题,也可以将日志下载到本地进行进一步分析。

    查看日志

步骤 7:下载制品

点击制品选项卡,然后点击右侧的图标下载该制品。

下载制品

步骤 8:查看代码分析结果

代码质量页面,可以查看由 SonarQube 提供的本示例流水线的代码分析结果。如果您没有事先配置 SonarQube,则该部分不可用。有关更多信息,请参见将 SonarQube 集成到流水线

SonarQube 详细结果

步骤 9:验证 Kubernetes 资源

  1. 如果流水线的每个阶段都成功运行,则会自动构建一个 Docker 镜像并推送至您的 Docker Hub 仓库。最终,流水线将在您事先设置的项目中自动创建一个部署和一个服务。

  2. 前往该项目(本教程中即 kubesphere-sample-dev),请点击应用负载下的工作负载,您可以看到列表中显示的部署。

    查看部署

  3. 服务页面,您可以看到示例服务通过 NodePort 暴露其端口号。要访问服务,请访问 <Node IP>:<NodePort>

    服务暴露

    访问服务

    备注

    访问服务前,您可能需要配置端口转发规则并在安全组中放行该端口。
  4. 现在流水线已成功运行,将会推送一个镜像至 Docker Hub。登录 Docker Hub 查看结果。

    DockerHub 镜像

  5. 该应用的名称为 devops-sample,即 APP_NAME 的值,标签即 SNAPSHOT-$BUILD_NUMBER 的值。$BUILD_NUMBER活动选项卡列示的记录的序列号。

  6. 如果您在最后一个阶段设置了电子邮件服务器并添加了电子邮件通知的步骤,您还会收到电子邮件消息。

另请参见

使用 Jenkinsfile 创建流水线

选择 Jenkins Agent

为 KubeSphere 流水线设置电子邮件服务器


感谢您的反馈。如果您有关于如何使用 KubeSphere 的具体问题,请在 Slack 上提问。如果您想报告问题或提出改进建议,请在 GitHub 存储库中打开问题。