Deployment and deployment management
    • PDF

    Deployment and deployment management

    • PDF

    Article Summary

    Available in Classic and VPC

    Deployment and deployment management explains how to deploy deployment scenarios created to deployment targets. Depending on the permission, a deployment can be done directly or by requesting deployment approval and its subsequent approval.

    Deployment execution

    Note

    To execute deployment, a customer account or a sub account with the doDeploy permission is required. For permission setting instructions, see Sub Account user guide.

    Caution

    If the deployment target is Ncloud Kubernetes Service and deployment strategy is Rolling or blue/green, then a deployment can't be canceled midway. Deploy only when it is necessary.

    To execute a deployment, follow these steps:

    1. Access NAVER Cloud Platform console.

    2. Click Services > Developer Tools > SourceDeploy in order.

    3. Select a deployment project that contains the scenario to deploy, and then click the [Go to deployment] button or click the deployment project name.

    4. Click the scenario to deploy.

    5. Check the deployment scenario's information and settings.

      • Click the [OK] button to check the details for the deployment target.
      • Click the deployment file's [Change settings] button to change settings for the deployment file.
      • Click the deployment commands's [Change settings] button to change deployment commands.
      • Click the deployment path's [Change settings] button to change the deployment path.
      • Click the [Show file] button to check the manifest file.
      • Enable or disable the rollback on failed deployment.
      Note
      • The different scenario settings that can be viewed and changed depend on the deployment target.
      • Changes made to the settings in the page are not saved, and they are applied to this deployment only.
    6. Check the SourceBand issue connection information for this deploy run.

      • To connect this deploy run to a SourceBand issue, select Connection.
        • To select a SourceBand issue to connect, click the [Select Issue] button.
        • In the SourceBand issue connection pop-up window, search for and add the issue to connect.
      Note
      • To connect a SourceBand issue, you must apply for the SourceBand product.
      • The SourceBand issue connection information is not saved and only applies to this deploy run.
    7. Click the [Start deployment] button.

      • The deployment will start, and you'll be directed to the deployment result page.
      • To cancel the deployment, click the [Cancel] button.
    Note

    When deploying objects to the Ncloud Kubernetes Service cluster

    • When updating objects, the update can only be done to the same namespace.
    • SourceDeploy performs deployment according to the mechanism of the deployment strategy, regardless of the kind of manifest files.
      • Pod, Deployment, ReplicaSet, ReplicationController, DaemonSet, and StatefulSet perform verification if deployment is conducted normally.
    • If one of the manifest files fails among multiple manifests, then all objects are rolled back.
    • For objects like Replica Set and Replication Controller, the images are not updated according to Kubernetes spec, even if they're updated. Make sure to check the following Kubernetes recommendations when you deploy.

    Requesting deployment approval

    Note

    To request a deployment approval, a sub account that doesn't have the doDeploy permission, but has the requestDeploy permission, is required. For permission setting instructions, see Sub Account user guide.

    Caution

    Deployment approval requests can't be canceled. Request approval only when a deployment is necessary.

    To request deployment approval, follow these steps:

    1. Access NAVER Cloud Platform console.

    2. Click Services > Developer Tools > SourceDeploy in order.

    3. Select a deployment project that contains the scenario to deploy, and then click the [Go to deployment] button or click the deployment project name.

    4. Click the scenario to deploy.

    5. Check the information and settings for the deployment scenario, and then click the [Request deployment approval] button.

      • Click the [OK] button to check the details for the deployment target.
      • Click the deployment file's [Change settings] button to change settings for the deployment file.
      • Click the deployment commands's [Change settings] button to change deployment commands.
      • Click the deployment path's [Change settings] button to change the deployment path.
      • Click the [Show file] button to check the manifest file.
      • Enable or disable the rollback on failed deployment.
      Note
      • The different scenario settings that can be viewed and changed depend on the deployment target.
      • Changes made to the settings in the page are not saved, and they are applied to this deployment only.
    6. Click the [OK] button in the deployment approval request pop-up window.

      • A deployment approval will be requested to the user with the deployment approval permission (approveDeploy).
    Caution

    An email or SMS notification feature for deployment approval requests is not provided.

    Approve/Reject deployment

    Note

    To approve or reject a deployment approval request, a customer account or a sub account with the approveDeploy permission is required. For permission setting instructions, see Sub Account user guide.

    To approve or reject a deployment approval request, follow these steps:

    1. Access NAVER Cloud Platform console.

    2. Click Services > Developer Tools > SourceDeploy in order.

    3. Select a deployment project that contains the scenario to approve or reject a deployment, and then click the [Go to deployment] button or click the deployment project name.

    4. Click the [Result] tab.

    5. Click the [Approve] button of the scenario whose status is Deployment approval pending.

    6. Click the [Approve] or [Reject] button in the deployment approval pop-up window, according to whether you approve the scenario's deployment.

      • The deployment will start.
      • To cancel the deployment, click the [Cancel] button.

    Check deployment result

    To check the deployment result, follow these steps:

    1. Access NAVER Cloud Platform console.

    2. Click Services > Developer Tools > SourceDeploy in order.

    3. Select a deployment project to check the result, and then click the [Go to deployment] button or click the deployment project name.

    4. Click the [Result] tab.

    5. Click the details for which you want to see the result.

      • You can view the deployment summary and deployment log information.
        • The logs are stored up to 30 days.
      Caution

      Deployment log is saved under the /var/sourcedeploy/log path. If you delete this path, then the deployment log can't be viewed.

    Deployment result page

    The deployment result page is laid out as follows.

    sourcedepoy-deploy_result_ko

    AreaDescription
    ① Project nameDisplays the deployment project's name
    ② Information of result listThe information displayed in the result list (deployment scenario name, deployment stage, deployment requested by, deployment request time, deployment status)
  • A button is displayed according to the deployment status
      • The [Cancel] button is shown if the status is Deployment in progress. You can click this button to cancel the deployment.
      • The **[Approve]**button is shown if the status is Deployment approval pending. You can click the button to approve the deployment. (You can only approve the deployment if you have the permission to approve deployment.)
  • Deployment summaryThe deployment summary information (deployment status, deployment request time, deployment end time, deployment file, canary analysis report, backup file) is displayed according to the deployment target
  • Deployment status
      • Waiting for deployment approval: status in which a deployment approval is requested by a user without the deployment permission
      • Deployment approval rejected: status in which the deployment approval request is rejected
      • Deploying: status in which it is being deployed
      • Deployment canceled: status in which the deployment is canceled halfway
      • Deployment complete: status in which the deployment is complete
      • Deployment failed: status in which the deployment failed
  • Deployment logDisplays the logs collected in each deployment stage
    Note
    • If the deployment is canceled, then the current stage proceeds until it is finished. Then the remaining stages that have yet to run are canceled.
    • Auto Scaling Groups or servers created with blue/green deployment are not terminated automatically in case of cancellation or deployment failure. If you no longer need the Auto Scaling Group or server, then terminate or delete directly in the corresponding service.
    • If you cancel a manual canary deployment, then the canary version will not be deployed, and the baseline and canary version applications will be closed.

    Deployment stages in detail

    The following shows deployment stages for each deployment target.

    Deployment target
    Deployment stage
    Description
    Server or
    Auto Scaling (default)
    Server nameCheck deployment agent status
    Execute before deploymentExecute command before deployment
    Deploy filesDeploy files to the set path
    Execute after deploymentExecute command after deployment
    Auto Scaling (Blue/Green)Prepare to deployPerform preparations for blue/green deployment
  • Create a new Auto Scaling Group
  • Wait for the creation of servers in the new Auto Scaling Group
  • Deploy to a new groupCheck deployment agent status for servers in a new Auto Scaling Group
    Verify a new groupVerify a new Auto Scaling Group
  • Connect the servers created in the new Auto Scaling Group to the load balancer
  • Verify that load balancer health check is normal (all health checks must be successful to proceed to the next step; if any health check fails within the timeout (1 hour), the deployment ends in failure)
  • Finalize deploymentFinalize blue/green deployment
  • Process the server in the existing Auto Scaling Group according to the values set for the server in the existing group
  • Copy events if there are Cloud Insight events connected to an existing Auto Scaling Group
  • Ncloud Kubernetes ServicePrepare to deployPrepare to deploy
  • Load kubectl
  • Access the cluster
  • Download the manifest file
  • Load the manifest file
  • DeployProceed with deployment
    Object StoragePrepare to deployPrepare to deploy
  • Download backup files
  • Zip backup files
  • Upload backup files
  • DeployProceed with deployment
  • Download deployment file
  • Unzip the deployment file
  • Upload the deployment file
  • Check canary analysis report

    You can view canary analysis reports if your deployment strategy is Canary and analysis method is automatic.

    Click Report under Canary analysis report in the Deployment result page. The canary analysis page will appear.

    The canary analysis page is laid out as follows.

    sourcedeploy-use-deploy_canary_ko

    AreaDescription
    ① Analysis stage
  • Analysis stages are determined with the analysis time and cycle set in Canary automatic analysis settings
  • Analysis data are accumulated for analysis
    <example> If the analysis time is 10 minutes and analysis cycle is 3 minutes, then a total of 4 analysis stage scores will be calculated, every 3 minutes for 10 minutes. The last analysis stage will run for 1 minute
  • ② Analysis scoreAnalysis stage score is displayed
  • The analysis is only successful if the score meets the analysis success score or higher. If the analysis is a fail, then the next analysis will not run
  • ③ Analysis informationDisplays analysis time, analysis success score (Pass), and metric collection cycle (Step)
    ④ Metrics informationMetric and weight set in Canary automatic analysis settings are displayed
  • Click the metric to see the canary analysis result
  • ⑤ Analysis result listCanary analysis result displayed
  • Type: Baseline (Baseline version queries’ result),Canary(Canary version queries’ result)
  • Start time/End time: analysis start time/complete time
  • Count: number of actual data during the analysis time
  • Avg: data average value
  • Max: data maximum value
  • Min: data minimum value
  • Element resultElement value of the data from the query result is displayed
  • The analysis is run normally only if the baseline and canary query result elements are the same
  • Click to view the element
  • DeviationDisplays increase/decrease rate for values of canary compared to those of baseline
    ResultDisplays the result calculated with deviation of Baseline-based canary
  • Determines the result (success/failure) in accordance with the success criteria set when Creating metric
      • When the result of baseline version equals the result of canary version, it is a success (an error range of 5%)
        <example> It's deemed successful if -5 ≤ deviation ≤ +5
  • Note
    • You can view canary analysis reports only within the retention cycle set in Prometheus.
    • How to calculate analysis stage scores
      • Metric score: (Successful query results / All query results)* (Metric weights)
        <example>
        • Metric Name: success_rate1
          Successful query results: 2 (#1, #3)
          Total query results: 3 (#1, #2, #3)
          Weight: 30
          Metric score: (2/3)*30=20
        • Metric Name: success_rate2
          Successful query results: 1 (#1)
          Total query results: 1 (#1)
          Weight: 70
          Metric score: (1/1)*70=70
        • Analysis stage score: 20+70=90

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.