Deploy Apps in a Multi-cluster Project Using a Jenkinsfile

    • You need to enable the multi-cluster feature and create a workspace with your multiple clusters.
    • You need to on your host cluster.
    • You need to use a user (for example, ) 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 a user (for example, project-regular) to the DevOps project and grant it the role of operator. For more information, see Create Workspaces, Projects, Users and Roles, and Multi-cluster Projects.

    Create a Docker Hub Access Token

    2. Click Security in the left navigation pane and then click New Access Token.

    3. In the displayed dialog box, enter a token name (go-project-token) and click Create.

    4. Click Copy and Close and make sure you save the access token.

    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. In the displayed dialog box, set a Name, which is used later in the Jenkinsfile, and select Username and password for Type. Enter your Docker Hub account name for Username and the access token just created for Password/Token. When you finish, click OK.

      For more information about how to create credentials, see Credential Management.

    2. 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 Name and click OK.

      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.

    Create a Pipeline

    With the above credentials ready, you can use the user project-regular to create a pipeline with an example Jenkinsfile as below.

    1. To create a pipeline, click Create on the Pipelines page.

    3. In this tutorial, you can use default values for all the fields. On the Advanced Settings tab, click Create.

    1. In the pipeline list, click this pipeline to go to its details 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 displayed dialog box as an example Jenkinsfile for your pipeline. You must replace the value of DOCKERHUB_USERNAME, , KUBECONFIG_CREDENTIAL_ID, MULTI_CLUSTER_PROJECT_NAME, and MEMBER_CLUSTER_NAME with yours. When you finish, click OK.

      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.

    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.