The page has been translated by Gen AI.

Build Pipeline

Reference
For detailed information about the Jenkins pipeline, refer to the official site.

Users can group consecutive tasks into a single pipeline. The pipeline configured here is created as a Jenkins pipeline.

Starting the Build Pipeline

To start using the build pipeline, follow these steps.

  1. Click the Project card on the Main page. You will be taken to the Project Dashboard page.
  2. In the left menu, click the Build/Deploy > Build Pipeline menu. You will be taken to the Build Pipeline page.

Add Build Pipeline

To add a build pipeline, follow these steps.

  1. On the Main page, click the Project card. You will be taken to the Project Dashboard page.
  2. In the left menu, click the Build/Deploy > Build Pipeline menu. You will be taken to the Build Pipeline page.
  3. Build Pipeline page, click the Add Pipeline button at the top right. You will be taken to the Add Pipeline page.
  4. Add Pipeline Enter or configure each field on the page.
  5. Click the Next button.
    ItemExplanation
    CategorySelect Development or Operations
    Jenkins URLSelect Jenkins from the list to add a build pipeline.
    Build AgentSelect the agent (build environment) on which 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 already created 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 a new folder to create.
    Pipeline namePlease enter the pipeline name.
    Parameter settingSet the parameters to be used in the pipeline.
    Environment variable configurationSet the environment variables to be used in the pipeline.
    Stage SettingsConfigure the stage to be used in the pipeline.
    Configure email recipients for build resultsSet the recipients who will receive the result email after the pipeline completes (success/failure).
    Table. Additional Build Pipeline Settings

Setting Parameters

Follow these steps to set the parameters used when running the pipeline.

  1. Click the Parameter card.
  2. Click the Add button to add a parameter.
  3. Click the Apply button to complete the parameter settings.

Setting Environment Variables

Follow these steps to set environment variables for use in the pipeline.

  1. Click the Environment Variable area. The Environment Variable Registration page opens on the right.
  2. A list of pre-registered environment variables appears, and select the checkboxes for the environment variables you want to use.
  3. Check the selected environment variable and click the Apply button to complete the environment variable configuration.

Setting up the stage

To set up the 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 required information according to the stage type and click the Apply button to complete the stage configuration.
Reference
Click the Add icon to add a stage.
For detailed information about stage configuration, see Stage.

Configure email recipients for build results

To set the recipients who will receive the build results by email, follow these steps.

  1. Click the Mail Recipient area. The Add Mail Recipient page opens on the right.
  2. In the Search area, search for the recipient and add them.
  3. Click the Apply button to complete the mail recipient settings.

Check the final pipeline script

  1. Check the build pipeline script that will actually be generated. If needed, edit the script directly.
  2. Click the Complete button to finish adding the pipeline.

Pipeline addition result

  1. The added result appears on the Build Pipeline page.
Note
The added pipeline does not run automatically. If execution is required, run the pipeline manually.

Managing Build Pipelines

Build pipeline list

ItemExplanation
statusDisplays the build pipeline status.
  • Green: Completed successfully
  • Blue (blinking): Running
  • Red: Failed
  • Gray: Others
URLGo to the Build Pipeline page of Jenkins.
Recent build execution history URLNavigate to the Build Execution History page of Jenkins.
logpipeline log The popup window opens.
RunRun the build pipeline.
View moreDisplays additional menu.
  • Edit pipeline
  • Duplicate pipeline
  • Delete pipeline
  • Build history
View pipeline stageWhen you click the Expand icon, the stage view expands.
Table. Build pipeline list view feature

Build Pipeline Credentials

When performing build pipeline actions (run, stop, edit, delete, etc.), user credentials are required, so you may request them from the user as needed.

When integrating IDP with Jenkins

If you are not registered as a Jenkins user, when the User Registration Guide popup appears, click the Go to Jenkins link to sign up or perform your first Jenkins login.

For Jenkins without IDP integration

Jenkins credentials are not stored; when the Add Account popup appears, select Use Existing User or Create New User in Account Type to add credentials.

Run Build Pipeline

To run the build pipeline, follow these steps.

  1. On the Build pipeline page, click the Run button of the build pipeline you want to execute.
  2. If there are parameters, the Pipeline Execution Parameter Input popup window opens.
  3. After entering the required fields, click the Confirm button.
Caution

If the Number of executors setting for the Built-In Node in Jenkins system configuration is set to 1 or higher, a security issue may arise, preventing the pipeline from running.

  • In this case, you need to contact the Jenkins administrator to change the settings.
    • In the Jenkins administration menu, you can enable it by changing the Number of executors item of the Built-In Node to 0.
  • Note Jenkins officially recommends avoiding running builds on the Controller Node.

View build pipeline execution logs

Follow these steps to view the build pipeline execution logs.

  1. On the Build Pipeline page, click the Log button of the build pipeline you want to run.
  2. pipeline log A popup window opens, allowing you to view the execution log.
Reference
If a build pipeline is running, the Pipeline Log popup window refreshes periodically to display the latest logs.

Build pipeline build history view

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

  1. On the Build pipeline page, click the More icon of the build pipeline you want to view.
  2. Click the Build History menu. The Build History page opens.
    ItemExplanation
    Config DiffConfig Diff The popup window opens.
    logPipeline Log The popup window opens.
    Additional menuNavigate to the Build Details page.
    View pipeline stageClick the Expand icon to expand the stage view.
    Table. Build Pipeline List View Feature

Compare configuration information

You can compare the configuration information with previous build history using the Config Diff button.

Log View

Through the Log button, you can view the logs of the build history.

Build Details

You can view detailed build information via the More icon.

Modify Build Pipeline

To modify the build pipeline, follow these steps.

  1. On the Build pipeline page, click the More icon of the build pipeline you want to edit.
  2. Click the Edit Pipeline button. You will be taken to the Edit Pipeline page.

Edit the script directly

To edit the pipeline script directly, follow these steps.

  1. In the script editor window of the Pipeline Edit page, directly enter a script that conforms to the syntax supported by Jenkins.
  2. After completing the input, click the Save button to finish editing the pipeline.

Modify using the Script Generator feature

Reference
In the Script Generator feature, only one stage can be set. If you want to edit multiple stages, perform it multiple times.

Follow these steps to modify the pipeline script using the Script Generator feature.

  1. On the Pipeline Edit page, change Script Generator to ON.
  2. Select the build agent and script type.
  3. After completing Stage Setup, click the Create Script 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.
    ItemExplanation
    Script GeneratorTurn the Script Generator feature ON/OFF.
    Script Basic InformationSelect the basic information for script generation.
    Existing scriptThis is an existing script.
    New scriptThis is a new script generated by the Script Generator.
    Script modificationRefer to the newly created script and directly edit the existing script on the left.
    Update Jenkins CredentialIf the newly created script contains new credentials, click the Jenkins Credential Update button. This updates (saves) the credentials in Jenkins.
    K8S Secret updateDeploy to K8S stage: when changing the K8S Secret, click the K8S Secret Update button. Update (save) it for use during Secret creation and deployment.
    Table. Script Generator feature

Clone Build Pipeline

To duplicate the build pipeline, follow these steps.

  1. Click the More icon of the build pipeline you want to clone.
  2. Click the Clone Pipeline menu. The Clone Pipeline popup window opens.
  3. After completing the information entry, click the Save button to finish replicating the pipeline.
    ItemExplanation
    Pipeline replication informationEnter the information for the pipeline to be cloned.
    Pipeline modificationModify the pipeline to be cloned.
    Table. Build Pipeline Replication Feature

Delete 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 Delete Pipeline menu. The Delete Pipeline popup window opens.
  3. Delete Pipeline In the popup window, click the Confirm button to complete the pipeline deletion.
Note

Also delete the pipeline in Jenkins

  • Selection: The pipeline is actually deleted from Jenkins.
  • Unselected: Build pipeline is deleted only from the list and remains in Jenkins.
Project Members
Stage