Using SourcePipeline

Prev Next

Available in Classic and VPC

Once you've reviewed the SourcePipeline specifications, quickstart, and glossary, you're ready to start using the service. Your first step is subscribing to SourcePipeline and composing a pipeline project. The creation, execution, and management of SourcePipeline are conducted from the NAVER Cloud Platform console.

User permissions

Check the SourcePipeline permissions for your login account and set the sub account permissions in i_menu > Services > Management & Governance > Sub Account from the console as needed.

  • Your account: You can use all SourcePipeline features without limits.
  • Your sub account: Requires one of the following permissions to use SourcePipeline:
    • NCP_INFRA_MANAGER: Permission to access all services, except that access to the console menu My Account > Manage billing information and expense > Manage billing and payment is restricted
    • NCP_SOURCE_PIPELINE_MANAGER / NCP_VPC_SOURCE_PIPELINE_MANAGER: Full access to all SourcePipeline features
Note

Prepare to create SourcePipeline

To create and use SourcePipeline, you need to use the SourceCommit, SourceBuild, SourceDeploy, and Object Storage services first.
For more detailed usage instructions, see each service's user guides.

Item Description Guide
SourceCommit A private Git repository service for secure storage and management of source code and files. SourceCommit
SourceBuild A service that allows you to create an independent build server in real-time to simultaneously handle multiple build requests. SourceBuild
SourceDeploy A deployment service that automates deployment for server groups. SourceDeploy
Object Storage A service that provides a file storage space for users to store and explore the data they want, anytime and anywhere. Object Storage

Create SourcePipeline

To create a pipeline:

  1. Access the NAVER Cloud Platform console.
  2. Click Region and Platform at the top right of the console screen.
  3. Select the region and platform currently in use, and then click [Apply].
  4. Click i_menu at the top left of the console screen.
  5. Navigate to Services > Developer Tools > SourcePipeline.
  6. Click [Create pipeline] to create a new pipeline.
  7. When the pipeline creation page appears, proceed with the following steps in order:

1. Basic settings

Enter basic settings information and click [Next].

  • Pipeline name can only contain English letters, numbers, and special characters (- and _).
  • Pipeline description should have less than 500 characters.

2. Pipeline configuration

You can build a pipeline by setting up tasks to be integrated.

Note
  • If you are using a deployment approval stage in the SourceDeploy service, you can use the approval stage as is when you build a pipeline. However, the approval stage cannot be used if you run the pipeline with a trigger.
  • When configuring a pipeline, the email and SMS transfer feature related to deployment approval is provided (planned).

The configuration page is laid out as follows:

SourcePipeline-create_ko

Component Description
① Add task Set up tasks to integrate (see Step 2 in the following procedure).
② Unset component Tasks added by ① above are displayed (Refer to Steps 3 and 4 in the following procedure).
  • Tasks here are not yet set up to be run as a pipeline.
  • The tasks set up to be in the pipeline are moved to ③ Settings component.
③ Settings component Settings component where the tasks are connected (See Step 5 in the following procedure).
  • Tasks are displayed in a chain, according to the execution order of the pipeline.
  • If a task is deleted from the pipeline, it moves to ② Unset component.
④ Set trigger Set trigger events (see Step 6 below).

To build a pipeline:

  1. Click [Add task] on the pipeline configuration page.
  2. Enter the settings information in the task configuration popup, and click [OK].
    • Name: The name of a task must be unique within the current pipeline.
    • Type: Select SourceBuild or SourceDeploy. The service type you selected determines the entry items subsequently displayed.
    • [If you have selected SourceBuild]
      • Project: Select a SourceBuild project. Connection information is displayed underneath when you select it.
      • Connection information component
        • Type: When creating a SourceBuild project or changing settings, the type selected in the Build target item (SourceCommit, Github, Bitbucket, or Github Enterprise Server).
        • Repository: Displays information for the repository connected.
        • Branch: Displays branch information for the repository connected. You can change it to a branch needed for configuring the pipeline.
    • [If you have selected SourceDeploy]
      • Project: Select a SourceDeploy project.
      • Stage: Select a stage for the selected SourceDeploy project.
      • Scenario: Select a scenario for the selected SourceDeploy project. Scenarios that can be executed are exposed in the list. Connection information is displayed underneath when you select it.
      • Connection information component
        • Type: Displays the type selected from the Deployment file location item when creating a deployment scenario or changing settings (SourceBuild or Object Storage).
        • Information: Displays the build project name or Object Storage path information set according to the selected type from the Deployment file location item of the deployment scenario.
  3. Click i-SourcePipeline-add of the task you want to set among the tasks in the Unset component on the pipeline configuration page.
    • To view the task's settings status in detail or edit it, click i-SourcePipeline-set of the task to view or edit its settings. (See Step 2 of the procedure above.)
    • To delete a task, click i-SourcePipeline-delete-02, and click [Delete] in the popup.
  4. Select a preceding task in the preceding task selection popup, and click [OK].
    • The tasks you set will move to the Settings component on the right.
    • If No preceding task is selected, the task is set as the first task.
    • If a preceding task is selected, the task is set to be placed after the preceding task.
  5. Check if the task order is configured correctly in the pipeline in the Settings component.
    • To view the task's settings status in detail or edit it, click i-SourcePipeline-set of the task to view or edit its settings. (See Step 2 of the procedure above.)
    • To change the order of a task, click i-SourcePipeline-add of the task, select the preceding task to move, and then click [OK].
    • To set the task as the first task in the pipeline, click the selected preceding task to deselect it, select No preceding task, and then click [OK].
    • If there are 2 or more first tasks (tasks marked as No preceding task) in the Settings field, the pipeline cannot be configured. Select a preceding task to get the tasks ordered, or delete a task if unnecessary.
    • To delete a task, click i-SourcePipeline-delete-02of the task, and then click [Delete] in the popup. A task deleted from the Settings field is not removed completely from the project but moved to the Unset component.
  6. Click and select a checkbox of the Type item to configure a trigger event.
    • Push trigger
      • If a push event occurs in the repository/branch (SourceCommit), the pipeline runs automatically. It will also run when a commit event such as web editing occurs on the console of the SourceCommit service.
      • To add a push trigger event, select a repository and branch registered to SourceCommit in the Repository and Branch items, and then click [Add].
      • To delete a trigger event you have set, click i-SourcePipeline-delete-01 to delete it from the trigger list.
    • Pipeline trigger
      • Once the execution of a triggered pipeline is completed, the pipeline runs automatically.
      • To add a pipeline trigger, select a project registered in SourcePipeline from the Pipeline item and click [Add].
      • When configured recursively, the pipeline may run consecutively.
    • Scheduled trigger
      • The pipeline runs automatically at the scheduled time.
      • To set a schedule:
          1. Click [Create] on the schedule setting page.
          1. Enter the settings information in the scheduling popup and click [OK].
          • Repeat: Select the day of the week to repeat. When you click Every day, it will select all days of the week.
          • Time: Enter the time for the pipeline to run automatically. It can be entered in the [HH:mm] format, and the pipeline will run according to the selected TimeZone.
          • Whether to execute: The pipeline will run if there are additional commits in the SourceBuild project at the time when the SourcePipeline is set and in the SourceCommit repository set in the SourceDeploy scenario, or if there is no success run after the settings of the SourcePipeline are changed.
  7. Once the pipeline configuration is completed, click [Next].

3. Final confirmation

After checking the settings details, click [Create pipeline].

SourcePipeline interface

To check the basic information of a pipeline:

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Developer Tools > SourcePipeline.
  2. View the pipeline's basic information from the pipeline list.

The following are the descriptions for each item of the pipeline list page:

SourcePipeline-screen_ko

Component Description
① Menu name Shows the current menu name and number of SourcePipelines in operation.
② Create pipeline Create a new pipeline.
③ Go to pipeline Go to the Run pipeline page.
④ Change settings Change pipeline settings.
⑤ Delete Delete pipeline.
⑥ Search component Display the number of items to be shown in the search bar and list.
⑦ Pipeline list View the basic information of the pipelines created.
⑧ View trigger View trigger events set in the pipeline.

View trigger events

To view trigger events:

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Developer Tools > SourcePipeline.
  2. From the pipeline list, click the [View] button of the Trigger row of the pipeline name to be viewed.
  3. Check the trigger events set in the trigger information popup.

Run SourcePipeline

To run a pipeline:

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Developer Tools > SourcePipeline.
  2. Click the pipeline name to be run from the pipeline list.
    • Alternatively, select the checkbox on the left of the pipeline name and click the [Go to pipeline] button.
  3. From the Pipeline tab page, check the information and settings for the pipeline.
    • You can change the repository's branch and deployment scenario before running a pipeline. However, the new settings only apply for the current run of the pipeline.
  4. Check the SourceBand issue connection information.
  5. To connect this pipeline run to a SourceBand issue, select Connection.
    • To select a SourceBand issue to connect, click the [Select issue] button.
    • In the SourceBand issue connection popup, search for and add the issue to connect.
    Note
    • To connect a SourceBand issue, you need to subscribe the SourceBand product.
    • The SourceBand issue connection information is not saved and only applies to this pipeline run.
  6. From the Pipeline tab page, click the [Run pipeline] button.
    • When the pipeline runs, you are transferred to the Task result tab and the task status will change from Ready to Running in the task result list.
  7. Check the progress in the Task result tab screen.
    • To cancel a task while a pipeline is running, click the [Cancel] button on the task. Upon cancellation, the task status will be displayed as Canceled.
    • If the task status is Failed, Canceled, or Error, the [Rerun] button will be displayed. The [Rerun] button is only shown on the last task executed.
    • For more information about task results, see View SourcePipeline task result.

View SourcePipeline task result

To check a pipeline task result:

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Developer Tools > SourcePipeline.
  2. Click the pipeline name you want to see the task result of from the pipeline list.
    • Alternatively, select the checkbox of the pipeline name and click the [Go to pipeline] button.
  3. From the pipeline details page, click the Task result tab.
  4. Click the task you want to see from the pipeline task result list and check the task result.
    SourcePipeline-result-detail_ko
    • Click i-SourcePipeline-log to view the result in detail for each task. You will be directed to the task result page of the SourceBuild or SourceDeploy service. If you do not have the permission to use SourceBuild or SourceDeploy, checking logs may be restricted.
    • If the task status is Failed, Canceled, or Error, you can Rerun SourcePipeline.
    • For how to use SourceBuild and SourceDeploy, see each service user guides.

Rerun SourcePipeline

You can rerun the most recent pipeline task where a cancellation, failure, or error has occurred.
You can rerun it even if the pipeline's task configuration has not changed.

To rerun a pipeline:

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Developer Tools > SourcePipeline.
  2. Click the pipeline name to be rerun from the pipeline list.
    • Alternatively, select the checkbox of the pipeline name and click the [Go to pipeline] button.
  3. From the pipeline details page, click the Task result tab.
  4. Click the [Rerun] button in the pipeline task result list.
    • If the task status is Failed, click i-SourcePipeline-log of the task to understand the cause of the failure from the task result page of the SourceBuild or SourceDeploy service. Configure the task again and click the [Rerun] button.
  5. If the task fails again, repeat the Step 5 above and eliminate the causes for failure.

Change SourcePipeline settings

To change pipeline settings:

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Developer Tools > SourcePipeline.
  2. From the pipeline list, select the checkbox of the pipeline name you want to change settings for and click the [Change settings] button.
    • Be careful with the selection, because clicking the name of a created pipeline will direct you to the Run pipeline page.
  3. Edit the pipeline description in the Basic information field.
  4. In the Pipeline configuration and Trigger settings components, change the settings for the connected tasks in the pipeline and trigger events.
  5. Click [Apply] after changing the settings.
Note

To change pipeline settings, you must log in with the customer account or a sub account with the NCP_INFRA_MANAGER permission, or the pipeline user account (sub account) must have the changeProject permission, one of the detailed permissions for pipeline, for the selected pipeline.

Delete SourcePipeline

To delete a pipeline:

  1. From the NAVER Cloud Platform console, navigate to i_menu > Services > Developer Tools > SourcePipeline.
  2. Select the pipeline you want to delete from the pipeline list and click [Delete].
    • Be careful with the selection, because clicking the name of a created pipeline will direct you to the Run pipeline page.
  3. Check the details in the pipeline project deletion confirmation popup and click [Delete].
Note

To delete a pipeline, you must log in with the customer account or a sub account with the NCP_INFRA_MANAGER permission, or the pipeline user account (sub account) must have the deleteProject permission, one of the detailed permissions for pipeline, for the selected pipeline.