Create and manage deployment scenarios

Available in Classic and VPC

This section describes how to create and manage deployment scenarios for each deployment target.

There are different methods of creating deployment scenarios, depending on the deployment target.

See the creation method for the deployment scenario's deployment target you want to create.

• Create Server deployment scenario
• Create Auto Scaling deployment scenario
• Create Ncloud Kubernetes Service deployment scenario
• Create Object Storage deployment scenario

Create Server deployment scenario

To create a deployment scenario with Server as the deployment target, follow these steps:

1. From the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceDeploy.
2. Click a deployment project where you want to create a scenario, and then click a deployment stage with Server as the deployment target.
3. Click [Create].
4. When the Create deployment scenario page appears, proceed with the following steps in order:
   • 1. Basic settings
   • 2. Set deployment strategy
   • 3. Set deployment file
   • 4. Set deployment commands
   • 5. Final confirmation

1. Basic settings

Enter the deployment scenario's name and description, and click the [Next] button.

2. Set deployment strategy

Select the deployment strategy and process, and click the [Next] button.

• Only the Basic deployment strategy is provided. Deploy on the deployment server set.
• The available deployment process options are Consecutive deployment and Simultaneous deployment.
  • Consecutive deployment: perform a consecutive deployment for the specified deployment server.
  • Simultaneous deployment: perform a simultaneous deployment for the specified deployment server.

3. Set deployment file

Select the deployment file location and build project, and click the [Next] button.

• The options available for deployment file location are Source Build, Object Storage, and Set later.
  • If you have selected Source build, select a build project. If the last build result is a fail or the build output is not uploaded, the deployment is not executed.
  • If you have selected Object Storage, select a deployment file among the buckets in your Object Storage. Only the deployment file zipped as a .zip file can be deployed.
  • If you have selected Set later, you can set up the deployment file when deploying the scenario.

4. Set deployment commands

• You can enter multiple commands, which will be run in the order they were added.
• Run before deployment: set up the command to run in the server before the deployment, and click the [Add] button.
  • Run as account: enter the server account to run the command.
  • Run command: enter the command to run on the server.
• File deployment: set up the path to deploy the file, and click the [Add] button.
  • Source file path: enter the file path to deploy.
  • Deployment path: enter the entire path of the server to deploy.
  • If you have set the deployment file location to Set later in 3. Set deployment file, or there is no last build output from SourceBuild, Set later or No last build output is displayed in File deployment.
• Run after deployment: set up the command to run in the server after the deployment, and click the [Add] button.
  • Run as account: enter the server account to run the command.
  • Run command: enter the command to run on the server.
• Click the [Delete] button to delete the added command.
• Click Use to select it if you want to use the rollback feature in case of failed deployment.
  • If the rollback feature is enabled, the deployment is automatically rolled back to the previous version when it fails.
  • Rollback is performed by running the last successful deployment of the stage again.
  • If the previous deployment file does not exist in Object Storage or there is not a last successful deployment, the rollback fails.

5. Final confirmation

View the information for the deployment scenario configured, and click the [Create deployment scenario] button.

Create Auto Scaling deployment scenario

To create a deployment scenario with Auto Scaling as the deployment target, follow these steps:

1. From the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceDeploy.
2. Click a deployment project where you want to create the scenario, and click a deployment stage with Auto Scaling as the deployment target.
3. Click [Create].
4. When the Create deployment scenario page appears, proceed with the following steps in order:
   • 1. Basic settings
   • 2. Set deployment strategy
   • 3. Set deployment file
   • 4. Set deployment commands
   • 5. Final confirmation

1. Basic settings

Enter the deployment scenario's name and description, and click the [Next] button.

2. Set deployment strategy

Select the deployment strategy and process, and click the [Next] button.

• The available deployment strategy options are Basic and Blue/Green.

  Note

  Only the Basic option is provided in the Classic environment. The Basic and Blue/Green options are both provided in the VPC environment.

  • Basic: deploy in consecutive order for the servers in the specified Auto Scaling Group.
  • Blue/green: copy the specified Auto Scaling Group to create a new Auto Scaling Group, then deploy to the group.
    • Once the deployment is successfully completed, the server in the new Auto Scaling Group is connected to the Load Balancer Target Group, and then the traffic is routed to the group. The interruption time due to deployment can be minimized with the blue/green strategy.

• The available deployment process options are Consecutive deployment and Simultaneous deployment.

  • Consecutive deployment: perform a consecutive deployment for the specified deployment server.
  • Simultaneous deployment: perform a simultaneous deployment for the specified deployment server.

• If you have selected the Blue/Green deployment strategy, set up the following:

  • Select a Load Balancer Target Group to connect to the new Auto Scaling Group.
    • You can select from a target group connected to the Auto Scaling Group specified as the deployment target.
    • Click the [View status] button to view the target's health check status.
  • After the blue/green deployment completion, select whether to delete and return the existing Auto Scaling Group.
    • Maintain: the existing Auto Scaling Group will not be returned even after the completion of the blue/green deployment
    • Delete/Return: after the blue/green deployment is completed, the existing Auto Scaling Group will be returned, and the servers in the Auto Scaling Group will be automatically returned as well
  • If you have selected to Maintain the Existing Auto Scaling Group, select how to handle servers in the existing Auto Scaling Group after completing the blue/green deployment.
    • Maintain: after the blue/green deployment is completed, the servers in the existing Auto Scaling Group will not be returned, but they will be disconnected from the Load Balancer Target Group
    • Return: after the blue/green deployment is completed, the servers in the existing Auto Scaling Group will be automatically returned
  Note

  If a Cloud Insight monitoring event is set in Auto Scaling Group, the Auto Scaling Group cannot be returned.

Therefore, if a Cloud Insight monitoring event is set in an existing Auto Scaling Group in the stage of blue/green deployment, the existing Auto Scaling Group cannot be automatically returned after completing the deployment. If the existing Auto Scaling Group is no longer needed, manually return it from the respective service.

:::

3. Set deployment file

Select the deployment file location and build project, and click the [Next] button.

• The options available for deployment file location are Source Build, Object Storage, and Set later.
  • If you have selected Source build, select a build project. If the last build result is a fail or the build output is not uploaded, the deployment is not executed.
  • If you have selected Object Storage, select a deployment file among the buckets in your Object Storage. Only the deployment file zipped as a .zip file can be deployed.
  • If you have selected Set later, you can set up the deployment file when deploying the scenario.

4. Set deployment commands

Set the deployment commands, and click the [Next] button.

• You can enter multiple commands, which will be run in the order they were added.
• Run before deployment: set up the command to run in the server before the deployment, and click the [Add] button.
  • Run as account: enter the server account to run the command.
  • Run command: enter the command to run on the server.
• File deployment: set up the path to deploy the file, and click the [Add] button.
  • Source file path: enter the file path to deploy.
  • Deployment path: enter the entire path of the server to deploy.
  • If you have set the deployment file location to Set later in 3. Set deployment file, or there is no last build output from SourceBuild, Set later or No last build output is displayed in File deployment.
• Run after deployment: set up the command to run in the server after the deployment, and click the [Add] button.
  • Run as account: enter the server account to run the command.
  • Run command: enter the command to run on the server.
• Click the [Delete] button to delete the added command.
• Click Use to select it if you want to use the rollback feature in case of failed deployment.
  • If the rollback feature is enabled, the deployment is automatically rolled back to the previous version when it fails.
  • Rollback is performed by running the last successful deployment of the stage again.
  • If the previous deployment file does not exist in Object Storage or there is not a last successful deployment, the rollback fails.

5. Final confirmation

View the information for the deployment scenario configured, and click the [Create deployment scenario] button.

Create Ncloud Kubernetes Service deployment scenario

To create a deployment scenario with Ncloud Kubernetes Service as the deployment target, follow these steps:

1. From the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceDeploy.
2. Click a deployment project where you want to create the scenario, and select a deployment stage with Ncloud Kubernetes Service as the deployment target.
3. Click [Create].
4. When the Create deployment scenario page appears, proceed with the following steps in order:
   • 1. Basic settings
   • 2. Manifest settings
   • 3. Set deployment strategy
   • 4. Final confirmation

1. Basic settings

Enter the deployment scenario's name and description, and click the [Next] button.

2. Manifest settings

Set the repository and path where the manifest file is and click the [Next] button.

• Select the manifest file repository type and then set the details needed.

  • When selecting SourceCommit, set the following items:

    • Repository: select the repository where the manifest file is saved.
    • Branch: select the branch of the repository where the manifest file is saved.

  • When selecting Github Enterprise Server, click the [Login] button and set the following items:

    • Enter one of the following authentication information and click the [Github Enterprise Server Login] button:
      • OAuth: enter the Github Enterprise Server URL for importing the repository and enter the Client Id and Client Secret of OAuth App created in the relevant server.
      • Personal Access Token: enter the Github Enterprise Server URL for importing the repository and the Personal Access Token created on the relevant server.
      • Username/Password: enter the Github Enterprise Server URL for importing the repository and the User account information of the relevant server.
      • SSH Key: enter the Git Repository URL of SSH protocol format and SSH Private Key and Passphrase for authentication (enter the Passphrase when it is set in SSH Key).
    Note

    • If communication with the Github Enterprise Server is not possible due to firewall settings, etc., you cannot use the relevant storage type.
    • The Github Enterprise Server URL can be entered with IP and host name, and the environment must be public.
    • SSH Key login, unlike other logins, can access only the repository of the Git repository URL entered.
    • GitHub Enterprise Server official guide
      • OAuth APP creation guide
        • When setting up an OAuth app, set the callback URL suitable to platform and Region. Each URL is as follows:
          • KR(Classic) : https://devtools.ncloud.com/ghes/sourcedeploy
          • KR(VPC) : https://devtools.ncloud.com/ghes/vpc/sourcedeploy
          • SGN(VPC) : https://devtools-sg.ncloud.com/ghes/vpc/sourcedeploy
          • JPN(VPC) : https://devtools-jp.ncloud.com/ghes/vpc/sourcedeploy
      • Personal Access Token creation guide
      • SSH key settings guide
    • Owner: select the owner of the repository where the manifest file is saved.
    • Repository: select the repository where the manifest file is saved.
    • Branch: select the branch of the repository where the manifest file is saved.
• Enter the manifest file's path to deploy, and click the [Add] button.
  • You can delete the added path by clicking the [Delete] button.

3. Set deployment strategy

Select a deployment strategy, and click the [Next] button.

• Rolling: new objects are deployed if there are no previously deployed objects.
  • When you deploy new objects, rather than updating objects, select Rolling.
• Blue/Green/Canary: the deployment will fail if there are no previously deployed objects.
  • You cannot deploy new objects with the blue/green or canary strategy.
  • When deploying with the blue/green strategy, a new version (green) of objects is deployed, so the object names are changed. Even if the object names are changed, you can continue to deploy through SourceDeploy without editing the manifest files. However, if an object with the existing name is created with the manual deployment through kubectl apply using the relevant manifest file, you cannot deploy continuously through SourceDeploy because you cannot specify the object to be updated.
• If you have selected the Canary deployment strategy, see Canary manual analysis settings or Canary automatic analysis settings depending on the analysis method.

Canary manual analysis settings

• Number of baselines and canary pods: enter the number of replicas to be applied to applications that are the Baseline and Canary versions.
  • You can set between 1 and 10.
• Canary analysis method: select Manual.
  • You can manually analyze the Baseline and Canary version applications to determine whether to approve or cancel the deployment.
• Time out: enter the maximum time for you to determine to proceed or cancel a Canary deployment.
  • It can range between 1 and 360 minutes.
  • If the set time is exceeded, the deployment will be automatically canceled, and the Baseline and Canary applications will be ended.

Canary automatic analysis settings

• Number of Baselines and Canary pods: enter the number of replicas to be applied to applications that are the Baseline and Canary versions.
  • You can set between 1 and 10.
• Select Canary analysis method as Automatic.
  • The Baseline and Canary version applications are analyzed automatically to determine whether to deploy according to the analysis result.
• Prometheus URL: enter the Prometheus endpoint to request the Prometheus collection log.
  • To automatically analyze the application, Prometheus must be installed in the Ncloud Kubernetes Service cluster.
  • Set the endpoint as a public IP, so SourceDeploy can access it.
    • Set the Prometheus service as Load Balancer type.
• Analysis environment variables: enter the variables for distinguishing between Baseline and Canary when performing Prometheus analysis.
  • The entered value can be used as ${basecanary} in a PromQL syntax.
  • The analysis environment variables are specified as ncp_sourcedeploy_canary="baselineenv"/ncp_sourcedeploy_canary="canaryenv" in each pod label of Baseline and Canary, and you can use the values when analyzing Canary.
• Create a metric to be evaluated, and select it.
  • For more information on how to create metrics, see Create metric.
  • If you want to change metric settings, select the metric of which you want to change settings, and click the [Change settings] button. For more information on each item, see Create metric.
  • To delete a metric, select the metric to delete and click the [Delete] button.
  • The sum of the weights of all metrics must be 100.
• Configure analysis settings.
  • Analysis delay time: enter the time to start the analysis after the Baseline or Canary version application deployment.
    • The analysis begins after the time entered, and the range available is between 0 and 60 minutes.
  • Analysis time: enter the total time during which an analysis will take place.
    • It can range between 10 and 360 minutes.
  • Analysis cycle: enter the time cycle to perform the analysis.
    • The range available is between 1 and 360 minutes, and cannot be greater than the analysis time.
  • Metric collection cycle: enter the cycle to sample the collected metric values during analysis.
    • The range available is between 1 and 360 seconds.
• Analysis success score: enter the analysis score for all metrics during an analysis.
  • You can set between 1 and 100.
  • Deployment is performed only when the score is satisfied for each analysis step.
  • If the score is not satisfied for an analysis step, the analysis stops immediately and the Baseline or Canary version application will be ended.
  • This is the sum of all metric scores registered.
    • For more information on metric scores, see Create metric.

Create metric

If you have selected your deployment strategy as Canary and analysis method as Automatic in 3. Set deployment strategy, to create a metric, follow these steps:

1. Click the [Create] button under Metric settings.
2. Enter the metric information in the Create metric popup window.
   
   • Enter the name of the metric.
   • Select the Success criteria.
     • It is the success criteria for the query result of registered queries, and it is analyzed as succeeded or failed.
     • There can be multiple query results, and succeeded/failed is determined for each query result.
     • The score of the registered metric is calculated with the (succeeded query results/all query results) weight.
     • Baseline < Canary: succeeded if the value of the baseline version is greater than that of the Canary version (succeeded if the value of deviation is negative or equal).
     • Baseline > Canary: succeeded if the value of the Canary version is greater than that of the Baseline version (succeeded if the value of deviation is positive or equal).
   • Select Query type.

     • Default: available only when you use Label selector.

       • Metric: select the metric set for the Prometheus URL entered when configuring Canary automatic analysis settings.
       • Filter: enter the desired label conditions.
         Example:

         kubernetes_namespace="dev" , ncp_sourcedeploy_canary="${basecanary}"
         

       • Filter's ${basecanary} is provided as a reserved word to compare and analyze Baseline and Canary. When you analyze a query with the reserved word, the query is made by substituting it with an analysis environment variable.
         Example: Metric: requests_total
         Filter: ncp_sourcedeploy_canary=${basecanary}
         Canary: canaryenv, Baseline: baselineenv (see Analysis environment variables in Canary automatic analysis settings).
         Baseline version query requests_total{ncp_sourcedeploy_canary="baselineenv"}
         Canary version query requests_total{ncp_sourcedeploy_canary="canaryenv"}

     • PromQL: use it by manually entering PromQL in Query.
       Example: success rate of web application requests PromQL

       sum(requests_total{kubernetes_namespace="dev",custom_status="good", ncp_sourcedeploy_canary="${basecanary}"})/sum(requests_total{kubernetes_namespace="dev", ncp_sourcedeploy_canary="${basecanary}"})
       

   • Weight: enter the metric's weight.
     • You can set between 1 and 100.

4. Final confirmation

View the information for the deployment scenario configured, and click the [Create deployment scenario] button.

Build CI/CD environment

Using SourceDeploy, you can build a CI/CD environment for continuous deployment in a Ncloud Kubernetes Service cluster.

To build a CI/CD environment, follow these steps:

1. From the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceDeploy.
2. Click the [Create registry] button to create a registry.
   • For more information on how to create registries, see Container Registry user guides.
3. Click the Services > Developer Tools > SourceBuild in order.
4. Click the [Create build project] button to create a build project.
   • For more information on how to create build projects, see SourceBuild user guides.
   • Use the docker image build feature to save the Docker image in the build and Container Registry.
     • At the build environment settings step, click to select Build Docker image, and set Docker image build settings to Enabled in the build command configuration step.
     • Click to select Set as latest with the Image tag.
       • As SourceDeploy automatically changes the latest tag to digest form and attempts to deploy it, continuous deployment can be performed normally, even if the image settings are not changed.
       • You can use it together with image version control and you can always build the latest image.
5. Click Services > Developer Tools > SourceDeploy in order.
6. Click the [Create deployment project] button to create a new deployment project with Ncloud Kubernetes Service as the deployment target.
   • For more information on how to create deployment projects, see Create deployment project.
7. To create a deployment scenario, see Create Ncloud Kubernetes Service deployment scenario.
8. Click Services > Developer Tools > SourcePipeline in order.
9. Click the [Create pipeline] button to create a pipeline.
   • For more information on how to create pipelines, see SourcePipeline user guides.
     • You can configure SourceBuild projects set with the Docker image build and SourceDeploy projects set with the Ncloud Kubernetes Service deployment as a pipeline to build a CI/CD environment.
     • By clicking Set trigger, you can push SourceCommit while deploying new objects to clusters of Docker image and Ncloud Kubernetes Service to operate your service.

Create Object Storage deployment scenario

To create a deployment scenario with Object Storage as the deployment target, follow these steps:

1. From the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceDeploy.
2. Click a deployment project where you want to create the scenario, and click a deployment stage with Object Storage as the deployment target.
3. Click [Create].
4. When the Create deployment scenario page appears, proceed with the following steps in order:
   • 1. Basic settings
   • 2. Set deployment file
   • 3. Set deployment path
   • 4. Final confirmation

1. Basic settings

Enter the deployment scenario's name and description, and click the [Next] button.

2. Set deployment file

Select the deployment file location and build project, and click the [Next] button.

• The options available for deployment file location are Source Build, Object Storage, and Set later.
  • If you have selected Source build, select a build project. If the last build result is a fail or the build output is not uploaded, the deployment is not executed.
  • If you have selected Object Storage, select a deployment file among the buckets in your Object Storage. Only the deployment file zipped as a .zip file can be deployed.
  • If you have selected Set later, you can set up the deployment file when deploying the scenario.

3. Set deployment path

Set the file's deployment path, and then click the [Next] button.

• Enter source file path and deployment path, and click the [Add] button.
  • You can enter and add multiple paths.
  • Source file path: enter the file path to deploy.
  • Deployment path: enter the path of the bucket to deploy.
• In the case of locked buckets, files already uploaded will be locked. It will not be correctly deployed if the same file name (deployment path) is entered.
• If you have set the deployment file location to Set later in 2. Set deployment file, or there is no last build output from SourceBuild, Set later or No last build output is displayed.
• Click the [Delete] button to delete the added path.
• Click Use to select it if you want to use the file backup feature in the predetermined deployment path.
  • If the backup feature is enabled, all files in the predetermined deployment path will be backed up.

4. Final confirmation

View the information for the deployment scenario configured, and click the [Create deployment scenario] button.

Change deployment scenario settings

To change deployment scenario settings, follow these steps:

1. From the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceDeploy.
2. Click the deployment project and deployment stage you want to change scenario settings for in order.
3. Select the scenario to change the settings, and click the [Change settings] button.
4. Apply the changes in the Set deployment scenario popup window and click the [Apply] button.
   • You can change all items except the scenario name set upon creation of the deployment scenario.
   • For more information on each item, by deployment target, see the following:
     • Create Server deployment scenario
     • Create Auto Scaling deployment scenario
     • Create Ncloud Kubernetes Service deployment scenario
     • Create Object Storage deployment scenario

Delete deployment scenario

To delete a deployment scenario, follow these steps:

1. From the NAVER Cloud Platform console, navigate to > Services > Developer Tools > SourceDeploy.
2. Click the deployment project and deployment stage you want to delete the scenario from.
3. Select the scenario to delete, and click the [Delete] button.
4. Click the [Delete] button in the Delete deployment scenario popup window.
   • The deployment scenario will be deleted.