- Print
- PDF
Deployment and deployment management
- Print
- PDF
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
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.
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:
Access NAVER Cloud Platform console.
Click Services > Developer Tools > SourceDeploy in order.
Select a deployment project that contains the scenario to deploy, and then click the [Go to deployment] button or click the deployment project name.
Click the scenario to deploy.
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.
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.
- To connect this deploy run to a SourceBand issue, select Connection.
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.
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
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.
Deployment approval requests can't be canceled. Request approval only when a deployment is necessary.
To request deployment approval, follow these steps:
Access NAVER Cloud Platform console.
Click Services > Developer Tools > SourceDeploy in order.
Select a deployment project that contains the scenario to deploy, and then click the [Go to deployment] button or click the deployment project name.
Click the scenario to deploy.
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.
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).
An email or SMS notification feature for deployment approval requests is not provided.
Approve/Reject deployment
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:
Access NAVER Cloud Platform console.
Click Services > Developer Tools > SourceDeploy in order.
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.
Click the [Result] tab.
Click the [Approve] button of the scenario whose status is Deployment approval pending.
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:
Access NAVER Cloud Platform console.
Click Services > Developer Tools > SourceDeploy in order.
Select a deployment project to check the result, and then click the [Go to deployment] button or click the deployment project name.
Click the [Result] tab.
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.
CautionDeployment log is saved under the
/var/sourcedeploy/log
path. If you delete this path, then the deployment log can't be viewed.- You can view the deployment summary and deployment log information.
Deployment result page
The deployment result page is laid out as follows.
Area | Description |
---|---|
① Project name | Displays the deployment project's name |
② Information of result list | The information displayed in the result list (deployment scenario name, deployment stage, deployment requested by, deployment request time, deployment status)
|
③ Deployment summary | The 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 log | Displays the logs collected in each deployment stage |
- 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.
Server or Auto Scaling (default) | Server name | Check deployment agent status |
Execute before deployment | Execute command before deployment | |
Deploy files | Deploy files to the set path | |
Execute after deployment | Execute command after deployment | |
Auto Scaling (Blue/Green) | Prepare to deploy | Perform preparations for blue/green deployment |
Deploy to a new group | Check deployment agent status for servers in a new Auto Scaling Group | |
Verify a new group | Verify a new Auto Scaling Group | |
Finalize deployment | Finalize blue/green deployment | |
Ncloud Kubernetes Service | Prepare to deploy | Prepare to deploy |
Deploy | Proceed with deployment | |
Object Storage | Prepare to deploy | Prepare to deploy |
Deploy | Proceed with deployment |
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.
Area | Description |
---|---|
① Analysis stage | <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 score | Analysis stage score is displayed |
③ Analysis information | Displays analysis time, analysis success score (Pass), and metric collection cycle (Step) |
④ Metrics information | Metric and weight set in Canary automatic analysis settings are displayed |
⑤ Analysis result list | Canary analysis result displayed |
⑥ Element result | Element value of the data from the query result is displayed |
⑦ Deviation | Displays increase/decrease rate for values of canary compared to those of baseline |
⑧ Result | Displays the result calculated with deviation of Baseline-based canary
|
- 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
- Metric Name: success_rate1
- Metric score: (Successful query results / All query results)* (Metric weights)