mirror of
https://github.com/kubesphere/website.git
synced 2025-12-28 04:42:47 +00:00
162 lines
8.3 KiB
Markdown
162 lines
8.3 KiB
Markdown
---
|
||
title: "Deploy Apps in a Multi-cluster Project Using a Jenkinsfile"
|
||
keywords: 'Kubernetes, KubeSphere, Docker, DevOps, Jenkins, Multi-cluster'
|
||
description: 'Learn how to deploy apps in a multi-cluster project using a Jenkinsfile-based pipeline.'
|
||
linkTitle: "Deploy Apps in a Multi-cluster Project Using a Jenkinsfile"
|
||
weight: 11420
|
||
---
|
||
|
||
## Prerequisites
|
||
|
||
- You need to [enable the multi-cluster feature](../../../../docs/multicluster-management/) and create a workspace with your multiple clusters.
|
||
- You need to have a [Docker Hub](https://hub.docker.com/) account.
|
||
- You need to [enable the KubeSphere DevOps System](../../../../docs/pluggable-components/devops/) on your Host Cluster.
|
||
- You need to use an account (for example, `project-admin`) with the role of `workspace-self-provisioner` to create a multi-cluster project and a DevOps project on the Host Cluster. This tutorial creates a multi-cluster project on the Host Cluster and one Member Cluster.
|
||
- You need to invite an account (for example, `project-regular`) to the DevOps project and grant it the role of `operator`. For more information, see [Create Workspaces, Projects, Accounts and Roles](../../../quick-start/create-workspace-and-project/), [Multi-cluster Management](../../../multicluster-management/) and [Multi-cluster Projects](../../../project-administration/project-and-multicluster-project/#multi-cluster-projects).
|
||
|
||
## Create a Docker Hub Access Token
|
||
|
||
1. Log in to [Docker Hub](https://hub.docker.com/) and select **Account Settings** from the menu in the top-right corner.
|
||
|
||
|
||
|
||
2. Click **Security** and **New Access Token**.
|
||
|
||
|
||
|
||
3. Enter the token name and click **Create**.
|
||
|
||
|
||
|
||
4. Click **Copy and Close** and remember to save the access token.
|
||
|
||
|
||
|
||
## Create Credentials
|
||
|
||
You need to create credentials in KubeSphere for the access token created so that the pipeline can interact with Docker Hub for pushing images. Besides, you also need to create kubeconfig credentials for the access to the Kubernetes cluster.
|
||
|
||
1. Log in to the web console of KubeSphere as `project-regular`. Go to your DevOps project and click **Create** in **Credentials**.
|
||
|
||
|
||
|
||
2. In the dialog that appears, set a **Credential ID**, which will be used later in the Jenkinsfile, and select **Account Credentials** for **Type**. Enter your Docker Hub account name for **Username** and the access token just created for **Token/Password**. When you finish, click **OK**.
|
||
|
||
|
||
|
||
{{< notice tip >}}
|
||
|
||
For more information about how to create credentials, see [Credential Management](../../../devops-user-guide/how-to-use/credential-management/).
|
||
|
||
{{</ notice >}}
|
||
|
||
3. Log out of the KubeSphere web console and log back in as `project-admin`. Go to your DevOps project and click **Create** in **Credentials**. Select **kubeconfig** for **Type**. Note that KubeSphere automatically populates the **Content** field, which is the kubeconfig of the current account. Set a **Credential ID** and click **OK**.
|
||
|
||
|
||
|
||
{{< notice note >}}
|
||
|
||
In future releases, you will be able to invite the account `project-regular` to your multi-cluster project and grant it the necessary role to create the kubeconfig credentials.
|
||
|
||
{{</ notice >}}
|
||
|
||
## Create a Pipeline
|
||
|
||
With the above credentials ready, you can use the account `project-regular` to create a pipeline with an example Jenkinsfile as below.
|
||
|
||
1. To create a pipeline, click **Create** on the **Pipelines** page.
|
||
|
||
|
||
|
||
2. Set a name in the pop-up window and click **Next** directly.
|
||
|
||
|
||
|
||
3. In this tutorial, you can use default values for all the fields. In **Advanced Settings**, click **Create** directly.
|
||
|
||
|
||
|
||
## Edit the Jenkinsfile
|
||
|
||
1. In the pipeline list, click this pipeline to go to its detail page. Click **Edit Jenkinsfile** to define a Jenkinsfile and your pipeline runs based on it.
|
||
|
||
|
||
|
||
2. Copy and paste all the content below to the pop-up window as an example Jenkinsfile for your pipeline. You must replace the value of `DOCKERHUB_USERNAME`, `DOCKERHUB_CREDENTIAL`, `KUBECONFIG_CREDENTIAL_ID`, `MULTI_CLUSTER_PROJECT_NAME`, and `MEMBER_CLUSTER_NAME` with yours. When you finish, click **OK**.
|
||
|
||
```groovy
|
||
pipeline {
|
||
agent {
|
||
node {
|
||
label 'maven'
|
||
}
|
||
|
||
}
|
||
|
||
environment {
|
||
REGISTRY = 'docker.io'
|
||
// Docker Hub username
|
||
DOCKERHUB_USERNAME = 'Your Docker Hub username'
|
||
APP_NAME = 'devops-go-sample'
|
||
// ‘dockerhub-go’ is the Docker Hub credentials ID you created on the KubeSphere console
|
||
DOCKERHUB_CREDENTIAL = credentials('dockerhub-go')
|
||
// the kubeconfig credentials ID you created on the KubeSphere console
|
||
KUBECONFIG_CREDENTIAL_ID = 'dockerhub-go-kubeconfig'
|
||
// mutli-cluster project name under your own workspace
|
||
MULTI_CLUSTER_PROJECT_NAME = 'demo-multi-cluster'
|
||
// the name of the Member Cluster where you want to deploy your app
|
||
// in this tutorial, the apps are deployed on Host Cluster and only one Member Cluster
|
||
// for more Member Clusters, please edit manifest/multi-cluster-deploy.yaml
|
||
MEMBER_CLUSTER_NAME = 'Your Member Cluster name'
|
||
}
|
||
|
||
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: 'dockerhub-go-kubeconfig',
|
||
variable: 'KUBECONFIG')
|
||
]) {
|
||
sh 'envsubst < devops-go-sample/manifest/multi-cluster-deploy.yaml | kubectl apply -f -'
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
{{< notice note >}}
|
||
|
||
If your pipeline runs successfully, images will be pushed to Docker Hub. If you are using Harbor, you cannot pass the parameter to `docker login -u` via the Jenkins credential with environment variables. This is because every Harbor robot account username contains a `$` character, which will be converted to `$$` by Jenkins when used by environment variables. [Learn more](https://number1.co.za/rancher-cannot-use-harbor-robot-account-imagepullbackoff-pull-access-denied/).
|
||
|
||
{{</ notice >}}
|
||
|
||
## Run the Pipeline
|
||
|
||
After you save the Jenkinsfile, click **Run**. If everything goes well, you will see the Deployment workload in your multi-cluster project.
|
||
|
||
 |