您正在查看 KubeSphere 版本的文档:v3.0.0
KubeSphere v3.0.0 版本的文档已不再维护。您现在看到的版本来自于一份静态的快照。如需查阅最新文档,请点击 最新版本。
使用 Jenkinsfile 在多集群项目中部署应用
准备工作
- 您需要启用多集群功能。
- 您需要有一个 Docker Hub 帐户。
- 您需要启用 KubeSphere DevOps 系统。
- 您需要创建一个多集群企业空间,在 Host 集群上创建一个 DevOps 工程,创建一个多集群项目(本教程中,该多集群项目创建于 Host 集群和一个 Member 集群上),并创建一个帐户 (
project-regular
),需要邀请该帐户至 DevOps 工程和多集群项目中,并赋予operator
角色。有关更多信息,请参见创建企业空间、项目、帐户和角色、多集群管理和多集群项目。
创建 Docker Hub 访问令牌 (Token)
-
登录 Docker Hub 并在右上角的菜单中选择 Account Settings。
-
在左侧点击 Security,然后点击 New Access Token。
-
输入令牌名称,点击 Create。
-
点击 Copy and Close 并务必保存该访问令牌。
创建凭证
您需要在 KubeSphere 中为已创建的访问令牌创建凭证,以便流水线能够向 Docker Hub 推送镜像。此外,您还需要创建 kubeconfig 凭证,用于访问 Kubernetes 集群。
-
以
project-regular
身份登录 KubeSphere Web 控制台,转到您的 DevOps 工程,在凭证页面点击创建。 -
在弹出对话框中,设置凭证 ID,稍后会用于 Jenkinsfile 中,类型选择帐户凭证。用户名输入您的 Docker Hub 帐户名称,token / 密码中输入刚刚创建的访问令牌。操作完成后,点击确定。
提示
有关如何创建凭证的更多信息,请参见凭证管理。 -
再次点击创建,类型选择 kubeconfig。KubeSphere 会自动填充 Content 字段,即当前用户帐户的 kubeconfig。设置凭证 ID,然后点击确定。
创建流水线
创建完上述凭证后,您可以按照以下步骤使用示例 Jenkinsfile 创建流水线。
-
要创建流水线,请在流水线页面点击创建。
-
在弹出窗口中设置名称,然后点击下一步。
-
在本教程中,您可以为所有字段使用默认值。在高级设置页面,直接点击创建。
编辑 Jenkinsfile
-
在流水线列表中,点击该流水线进入其详情页面。点击编辑 Jenkinsfile 定义一个 Jenkinsfile,流水线会基于它来运行。
-
将以下所有内容复制并粘贴到弹出窗口中,用作流水线的示例 Jenkinsfile。您必须将
DOCKERHUB_USERNAME
、DOCKERHUB_CREDENTIAL
、KUBECONFIG_CREDENTIAL_ID
、MULTI_CLUSTER_PROJECT_NAME
和MEMBER_CLUSTER_NAME
的值替换成您自己的值。操作完成后,点击确定。pipeline { agent { node { label 'maven' } } environment { REGISTRY = 'docker.io' // username of dockerhub DOCKERHUB_USERNAME = 'yuswift' APP_NAME = 'devops-go-sample' // ‘dockerhubid’ is the dockerhub credential id you created on ks console DOCKERHUB_CREDENTIAL = credentials('dockerhubid') // the kubeconfig credential id you created on ks console KUBECONFIG_CREDENTIAL_ID = 'multi-cluster' // mutli-cluster project name under your own workspace MULTI_CLUSTER_PROJECT_NAME = 'devops-with-go' // the member cluster name you want to deploy app on // in this tutorial, you are assumed to deploy app on host and only one member cluster // for more member clusters, please edit manifest/multi-cluster-deploy.yaml MEMBER_CLUSTER_NAME = 'c9' } stages { stage('docker login') { steps { container('maven') { sh 'echo $DOCKERHUB_CREDENTIAL_PSW | docker login -u $DOCKERHUB_CREDENTIAL_USR --password-stdin' } } } stage('build & push') { steps { container('maven') { sh 'git clone https://github.com/yuswift/devops-go-sample.git' sh 'cd devops-go-sample && docker build -t $REGISTRY/$DOCKERHUB_USERNAME/$APP_NAME .' sh 'docker push $REGISTRY/$DOCKERHUB_USERNAME/$APP_NAME' } } } stage('deploy app to multi cluster') { steps { container('maven') { script { withCredentials([ kubeconfigFile( credentialsId: 'multi-cluster', variable: 'KUBECONFIG') ]) { sh 'envsubst < devops-go-sample/manifest/multi-cluster-deploy.yaml | kubectl apply -f -' } } } } } } }
备注
如果您的流水线成功运行,将会推送镜像至 Docker Hub。如果您使用 Harbor,则无法通过 Jenkins 凭证使用环境变量将参数传送到docker login -u
。这是因为每个 Harbor Robot 帐户的用户名都包含一个$
字符,当用于环境变量时,Jenkins 会将其转换为$$
。了解更多信息。
运行流水线
保存 Jenkinsfile 后,点击运行。如果一切顺利,您会在您的多集群项目中看到部署 (Deployment) 工作负载。