The page has been translated by Gen AI.

Build Pipeline

Note
For more information about 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.

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. 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.

  1. Main page, click the Project card. Move to the Project Dashboard page.
  2. Click the Build/Deployment > Build Pipeline menu in the left menu. Move to the Build Pipeline page.
  3. On the Build Pipeline page, click the Add Pipeline button at the top right. Move to the Add Pipeline page.
  4. Enter/set each item on the Add Pipeline page.
  5. Click the Next button.
ItemDescription
ClassificationSelect development or operation classification
Jenkins URLSelect Jenkins to add a build pipeline from the list.
Build AgentSelect 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 OSDisplays the OS information of the environment where the build agent runs.
Folder TypeSelect the folder type.
  • Existing folder: Add a pipeline under an existing folder in Jenkins.
  • New folder: Create a new folder in Jenkins and add a pipeline under it.
FolderSelect a folder from the list or enter the name of the new folder to be created.
Pipeline NameEnter the pipeline name.
Parameter SettingSet the parameters to be used in the pipeline.
Environment Variable SettingSet the environment variables to be used in the pipeline.
Stage SettingSet the stages to be used in the pipeline.
Build Result Email Recipient SettingSet the recipient to receive the result email after the pipeline is completed (success/failure).
Table. Build Pipeline Addition Setting Items

Setting Parameters

To set parameters to use when running a pipeline, follow these steps:

  1. Parameters card should be clicked.
  2. Add button should be clicked to add parameters.
  3. 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.

  1. Environment Variables section, click. The Environment Variable Registration page opens on the right.
  2. A list of pre-registered Environment Variables appears, and select the checkbox of the environment variable to be used.
  3. 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.

  1. Click the New Stage card. The Stage area appears on the right.
  2. In the Stage area, select the Tool and Stage type.
  3. Enter the necessary information according to the stage type and click the Apply button to complete the stage setup.
Note
You can add stages by clicking the Add icon.
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.

  1. Email Recipient area, click. The Add Email Recipient page opens on the right.
  2. In the Search area, search for and add the recipient.
  3. Click the Apply button to complete the email recipient setting.

Checking the Final Pipeline Script

  1. Check the actual build pipeline script to be created. Modify the script directly if necessary.
  2. Click the Complete button to complete adding the pipeline.

Pipeline Addition Result

  1. The added result appears on the Build Pipeline page.
Note
The added pipeline will not be executed automatically. If execution is required, run the pipeline directly.

Managing Build Pipelines

Build Pipeline List

ItemDescription
StatusDisplays the status of the build pipeline.
  • Green: Normal execution completed
  • Blue (flashing): Running
  • Red: Failed
  • Gray: Others
URLMoves to the Jenkins Build Pipeline page.
Recent Build Execution History URLMoves to the Jenkins Build Execution History page.
LogOpens the Pipeline Log popup window.
RunRuns the build pipeline.
MoreDisplays additional menus.
  • Edit Pipeline
  • Clone Pipeline
  • Delete Pipeline
  • Build history
Pipeline Stage ViewClick the Expand icon to expand the stage view.
Table. Build Pipeline List View Function

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.

  1. On the Build Pipeline page, click the Run button of the build pipeline you want to run.
  2. If there are parameters (parameters), the Pipeline Run Parameter Input popup window opens.
  3. Enter the necessary items and click the OK button.
Caution

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.

  1. On the Build Pipeline page, click the Log button of the build pipeline you want to run.
  2. The Pipeline Log popup window opens, and you can check the execution log.
Note
If the build pipeline is running, the Pipeline Log popup window is refreshed periodically to display the latest log.

Viewing Build Pipeline Build History

To view the entire build history of a build pipeline, follow these steps.

  1. On the Build Pipeline page, click the More icon of the build pipeline you want to check.
  2. Click the Build History menu. The Build History page opens.
ItemDescription
Config DiffOpens the Config Diff popup window.
LogOpens the Pipeline Log popup window.
More MenuMoves to the Build Details page.
Pipeline Stage ViewClick the Expand icon to expand the stage view.
Table. Build Pipeline List View Function

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.

  1. On the Build Pipeline page, click the More icon of the build pipeline you want to modify.
  2. Click the Pipeline Modification button. Move to the Pipeline Modification page.

Modifying the Script Directly

To modify the pipeline script directly, follow these steps.

  1. In the script editor window on the Pipeline Modification page, enter the script directly in the syntax supported by Jenkins.
  2. After entering, click the Save button to complete the pipeline modification.

Modifying Using the Script Generator Function

Note
The Script Generator function can only set one stage at a time. If you want to modify multiple stages, perform multiple times.

To modify the pipeline script using the Script Generator function, follow these steps.

  1. On the Pipeline Modification page, change the Script Generator to ON.
  2. Select the Build Agent and Script Type.
  3. Proceed with the Stage Setting and click the Script Generation button to generate the script.
  4. Refer to the generated script to modify the pipeline and click the Save button to complete the pipeline modification.
ItemDescription
Script GeneratorTurn the Script Generator function ON/OFF.
Script Basic InformationSelect the basic information for script generation.
Existing ScriptExisting script.
New ScriptNew script generated through the Script Generator.
Script ModificationModify the existing script on the left by referring to the new script generated.
Jenkins Credential UpdateIf 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 UpdateIn 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.
Table. Script Generator Function

Cloning a Build Pipeline

To clone a build pipeline, follow these steps.

  1. Click the More icon of the build pipeline you want to clone.
  2. Click the Clone Pipeline menu. Opens the Clone Pipeline popup window.
  3. Enter the information and click the Save button to complete the pipeline clone.
ItemDescription
Pipeline Clone InformationEnter the information of the pipeline to be cloned.
Pipeline ModificationModify the pipeline to be cloned.
Table. Build Pipeline Clone Function

Deleting a Build Pipeline

To delete a build pipeline, follow these steps.

  1. On the Build Pipeline page, click the More icon of the build pipeline you want to delete.
  2. Click the Pipeline Deletion menu. The Pipeline Deletion popup window opens.
  3. In the Pipeline Deletion popup window, click the OK button to complete the pipeline deletion.
Note

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.
Project Members
Stage