Edit Pipeline¶

After creating a custom pipeline, the pipeline stages need to be defined manually. Currently supports defining execution stages for pipelines by editing the Jenkinsfile or via GUI forms. In addition, if you need to change the configuration of each stage of the pipeline, you can also refer to this article to adjust the configuration.

Note

For the concepts involved in editing pipelines, refer to Concepts in pipelines
For the parameters involved in editing the pipeline, refer to Graphic Task Template Parameter Description

Prerequisites¶

Create Workspace, Create User.
Add the user to the workspace with workspace editor or higher privileges.
Create three credentials that can access the code warehouse, mirror warehouse, and cluster, refer to [credential management] (credential.md).

Create a custom pipeline, and need to add two string parameters in the build parameters. These parameters will be used in the image build command. The parameters are described as follows:

Parameter Type	Parameter Name	Description
String	registry	Mirror registry address. In this example use release-ci.daocloud.io
string	project	The project name in the registry. In this example use demo
string	name	The name of the image. This example uses http-hello

Edit the pipeline through the interface form¶

Workbench has designed a graphical pipeline editing view, which is compatible with editing most of the custom operations in the Jenkinsfile, making it easy to view or define each [stage (Stage)] of the pipeline (https://www.jenkins.io/ doc/book/pipeline/#stage) and each Step (Step), to achieve a WYSIWYG pipeline editing experience .

Interface layout description¶

Click a created custom pipeline. Click Edit Pipeline in the upper right corner to enter the graphical editing page.
The graphical editing page includes two areas: Canvas (left) and Stage Settings (right).
- After clicking +Add Stage , a serial stage will be generated. After clicking, a new stage will be generated, and pipeline steps can be added to this stage. By selecting the step type, you can quickly create the pipeline steps in the current stage.
- After clicking + Add Parallel Stage , a parallel stage will be generated. After clicking, a new stage will be generated, and pipeline steps can be added to this stage. By selecting the step type, you can quickly create the pipeline steps in the current stage.
- After the stage is created, click Stage , you can use the stage to configure the stage. Support setting the name, agent, trigger condition and steps of the stage.

Configure global settings¶

Click Global Settings , select node from the Type drop-down list, and select go 16 from the label drop-down list.

Add stage - pull source code¶

Click Add Stage in the canvas. In the stage settings on the right set the name: git clone.
Click Add Step , select git clone under the step type in the pop-up dialog box, and refer to the table below to configure the relevant parameters.
- Warehouse URL: Enter the warehouse address.
- Branch: do not fill in, the default is the master branch.
- Credentials: If your warehouse is a private warehouse, you need to provide a credential.

Add Phase - Unit Test¶

Click Add Stage in the canvas. In the stage settings on the right set the name: unit test.
In the step module, select to open specify container , fill in the container name: go in the pop-up dialog box, and then click OK .
Click Add step to unit test the code and generate a test report , select shell under the step type in the pop-up dialog box, and enter the following command in the command line, and then click OK .
```
go test -coverprofile=coverage.out
```

Add stage - build and push image¶

Click Add Stage in the canvas. Set the name in the stage settings on the right: build & push.
In the step module, select to open specify container , fill in the container name: go in the pop-up dialog box, and then click OK .
Select to enable Use Credentials in the step module, fill in the relevant parameters in the pop-up dialog box, and then click OK .
- Credentials: Select the created docker hub credentials to allow users to access the mirror warehouse. Select the created "docker-credential" credential.
- Password variable: PASS
- Username variable: USER
Click Add Step to build the code, select shell under the step type in the pop-up dialog box, enter the following command in the command line, and click OK .
```
go build -o simple-http-server main.go
```
Click Add Step to build a Docker image according to the Dockerfile in the source code, select shell under the step type in the pop-up dialog box, enter the following command in the command line, and click OK .
```
docker build -f Dockerfile . -t $REGISTRY/$PROJECT/$NAME:latest
```
Click Add Step to log in to the mirror warehouse and push the image to the mirror warehouse. In the pop-up dialog box, select shell under the step type, enter the following command in the command line, and click OK .
```
docker login $REGISTRY -u $USER -p $PASS
```
Click Add Step to push the image to the mirror warehouse, select shell under the step type in the pop-up dialog box, enter the following command in the command line, and click OK .
```
docker push $REGISTRY/$PROJECT/$NAME:latest
```

Note

After the image is updated, the trigger pipeline can also be implemented. For specific operations, refer to Trigger Pipeline

Add stage - review¶

Click Add Stage in the canvas. In the stage settings on the right set the name: review.
Click Add Step , select Audit under the step type in the pop-up dialog box, fill in @admin in the message field, that is, the admin account will be audited when the pipeline runs to this stage, and then Click OK .

Add stage - deploy to cluster¶

Click Add Stage in the canvas. In the stage settings on the right set the name: deploy.
In the step module, select to open specify container , fill in the container name: go in the pop-up dialog box, and then click OK .
Select to enable Use Credentials in the step module, fill in the relevant parameters in the pop-up dialog box, and then click OK .
- Credentials: Choose a credential of type kubeconfig.
- kubeconfig variable: If you are using the kubectl apply deployment method, the variable value must be KUBECONFIG.
Click Add Step to perform the cluster deployment operation, select shell under the step type in the pop-up dialog box, enter the following command in the command line, and then click OK .
```
kubectl apply -f deploy.yaml
```

Run the pipeline¶

Click Run Now on the transaction details page. In the pop-up dialog box, set the three string parameters defined in the prerequisites, and click OK to run the pipeline.
After the operation is successfully started, the page will automatically switch to the pipeline details page, click the record of the currently running pipeline.
After entering the pipeline record details page, you can view the running process of the current pipeline. The admin or platform administrator is required to review the pipeline. After the audit is successful, the resources will be deployed to the cluster.

Verify cluster resources¶

If each stage of the pipeline runs successfully, a Docker image is automatically built and pushed to your Docker Hub repository. Eventually, the pipeline will automatically create a deployment in the project you set up beforehand.
Go to the container management platform, click Workload under the cluster, and you can see deployments displayed in the list.

Edit pipeline via Jenkinsfile¶

The various stages of the pipeline can be quickly defined through the Jenkinsfile.

On the pipeline list page, find the pipeline to be created, and click Edit Jenkinsfile on the right.

You can also click the name of the pipeline and click Edit Jenkinsfile in the upper right corner of the page.
Enter or paste the Jenkinsfile prepared in advance, and click OK .