Build Pipeline
Jenkins pipeline, please refer to the official website.Users can combine a series of tasks into a pipeline. The pipeline configured here is created as a Jenkins pipeline.
Getting Started with Build Pipeline
To start using the build pipeline, follow these steps.
- Main page, click the Project card. Move to the Project Dashboard page.
- Click the Build/Deploy > Build Pipeline menu on the left. Move to the Build Pipeline page.
Adding a Build Pipeline
To add a build pipeline, follow the procedure below.
- Main page, click the Project card. Move to the Project Dashboard page.
- Click the Build/Deployment > Build Pipeline menu in the left menu. Move to the Build Pipeline page.
- On the Build Pipeline page, click the Add Pipeline button at the top right. Move to the Add Pipeline page.
- Enter/set each item on the Add Pipeline page.
- Click the Next button.
| Item | Description |
|---|---|
| Classification | Select development or operation classification
|
| Jenkins URL | Select Jenkins to add a build pipeline from the list. |
| Build Agent | Select the agent (build environment) where the build pipeline will run. Click the Info icon to view the list of tools provided by the agent. |
| Build Environment OS | Displays the OS information of the environment where the build agent runs. |
| Folder Type | Select the folder type.
|
| Folder | Select a folder from the list or enter the name of the new folder to be created. |
| Pipeline Name | Enter the pipeline name. |
| Parameter Setting | Set the parameters to be used in the pipeline. |
| Environment Variable Setting | Set the environment variables to be used in the pipeline. |
| Stage Setting | Set the stages to be used in the pipeline. |
| Build Result Email Recipient Setting | Set the recipient to receive the result email after the pipeline is completed (success/failure). |
Setting Parameters
To set parameters to use when running a pipeline, follow these steps:
- Parameters card should be clicked.
- Add button should be clicked to add parameters.
- Apply button should be clicked to complete parameter settings.
Setting Environment Variables
To set environment variables to be used in the pipeline, follow the procedure below.
- Environment Variables section, click. The Environment Variable Registration page opens on the right.
- A list of pre-registered Environment Variables appears, and select the checkbox of the environment variable to be used.
- Check the Selected Environment Variables and click the Apply button to complete the environment variable setting.
Setting Stages
To set up stages to be used in the pipeline, follow these steps.
- Click the New Stage card. The Stage area appears on the right.
- In the Stage area, select the Tool and Stage type.
- Enter the necessary information according to the stage type and click the Apply button to complete the stage setup.
For more information about stage settings, see Stage.
Setting Build Result Email Recipients
To set up the recipient to receive the build result by email, follow the procedure below.
- Email Recipient area, click. The Add Email Recipient page opens on the right.
- In the Search area, search for and add the recipient.
- Click the Apply button to complete the email recipient setting.
Checking the Final Pipeline Script
- Check the actual build pipeline script to be created. Modify the script directly if necessary.
- Click the Complete button to complete adding the pipeline.
Pipeline Addition Result
- The added result appears on the Build Pipeline page.
Managing Build Pipelines
Build Pipeline List
| Item | Description |
|---|---|
| Status | Displays the status of the build pipeline.
|
| URL | Moves to the Jenkins Build Pipeline page. |
| Recent Build Execution History URL | Moves to the Jenkins Build Execution History page. |
| Log | Opens the Pipeline Log popup window. |
| Run | Runs the build pipeline. |
| More | Displays additional menus.
|
| Pipeline Stage View | Click the Expand icon to expand the stage view. |
Build Pipeline Authentication
When performing build pipeline actions (execution, stop, modification, deletion, etc.), user authentication information may be required, so it may be requested from the user in some cases.
IDP-Linked Jenkins
If you are not registered as a Jenkins user, a User Registration Guide popup window opens, click the Go to Jenkins link to proceed with User Registration or Jenkins Initial Login.
IDP-Unlinked Jenkins
If Jenkins authentication information is not stored, a Add Account popup window opens, select Existing User Use or New User Creation in Account Type to add authentication information.
Running a Build Pipeline
To run a build pipeline, follow these steps.
- On the Build Pipeline page, click the Run button of the build pipeline you want to run.
- If there are parameters (parameters), the Pipeline Run Parameter Input popup window opens.
- Enter the necessary items and click the OK button.
If the Number of executors item in the Built-In Node of Jenkins system settings is set to 1 or more, pipeline execution may not be possible due to security issues.
- In this case, you need to contact the Jenkins administrator to change the settings.
- You can use it by changing the Number of executors item of the Built-In Node in the Jenkins management menu to 0.
- Note Jenkins officially recommends avoiding build execution on the Controller Node.
Viewing Build Pipeline Execution Logs
To view the build pipeline execution log, follow these steps.
- On the Build Pipeline page, click the Log button of the build pipeline you want to run.
- The Pipeline Log popup window opens, and you can check the execution log.
Viewing Build Pipeline Build History
To view the entire build history of a build pipeline, follow these steps.
- On the Build Pipeline page, click the More icon of the build pipeline you want to check.
- Click the Build History menu. The Build History page opens.
| Item | Description |
|---|---|
| Config Diff | Opens the Config Diff popup window. |
| Log | Opens the Pipeline Log popup window. |
| More Menu | Moves to the Build Details page. |
| Pipeline Stage View | Click the Expand icon to expand the stage view. |
Comparing Settings
You can compare settings with previous build history using the Config Diff button.
Viewing Logs
You can check the log of the build history using the Log button.
Viewing Build Details
You can check the build details by clicking the More icon.
Modifying a Build Pipeline
To modify a build pipeline, follow these steps.
- On the Build Pipeline page, click the More icon of the build pipeline you want to modify.
- Click the Pipeline Modification button. Move to the Pipeline Modification page.
Modifying the Script Directly
To modify the pipeline script directly, follow these steps.
- In the script editor window on the Pipeline Modification page, enter the script directly in the syntax supported by
Jenkins. - After entering, click the Save button to complete the pipeline modification.
Modifying Using the Script Generator Function
To modify the pipeline script using the Script Generator function, follow these steps.
- On the Pipeline Modification page, change the Script Generator to ON.
- Select the Build Agent and Script Type.
- Proceed with the Stage Setting and click the Script Generation button to generate the script.
- Refer to the generated script to modify the pipeline and click the Save button to complete the pipeline modification.
| Item | Description |
|---|---|
| Script Generator | Turn the Script Generator function ON/OFF. |
| Script Basic Information | Select the basic information for script generation. |
| Existing Script | Existing script. |
| New Script | New script generated through the Script Generator. |
| Script Modification | Modify the existing script on the left by referring to the new script generated. |
| Jenkins Credential Update | If there is new authentication information in the newly generated script, click the Jenkins Credential Update button. Update (save) the authentication information to Jenkins. |
| K8S Secret Update | In the case of the Deploy to K8S stage, if the K8S Secret is changed, click the K8S Secret Update button. Update (save) the Secret to be used when creating and deploying. |
Cloning a Build Pipeline
To clone a build pipeline, follow these steps.
- Click the More icon of the build pipeline you want to clone.
- Click the Clone Pipeline menu. Opens the Clone Pipeline popup window.
- Enter the information and click the Save button to complete the pipeline clone.
| Item | Description |
|---|---|
| Pipeline Clone Information | Enter the information of the pipeline to be cloned. |
| Pipeline Modification | Modify the pipeline to be cloned. |
Deleting a Build Pipeline
To delete a build pipeline, follow these steps.
- On the Build Pipeline page, click the More icon of the build pipeline you want to delete.
- Click the Pipeline Deletion menu. The Pipeline Deletion popup window opens.
- In the Pipeline Deletion popup window, click the OK button to complete the pipeline deletion.
Jenkins pipeline is also deleted together
- Selected: The pipeline is actually deleted from
Jenkins. - Not selected: Only deleted from the Build Pipeline list and remains in
Jenkins.