- What's New
- Function Overview
- Service Overview
- Getting Started
-
User Guide
- CodeArts Deploy Overview
- Purchasing and Authorizing CodeArts Deploy
- Accessing CodeArts Deploy Homepage
- Configuring a Host Cluster for CodeArts Deploy
-
Creating and Deploying an Application with a Blank Template
- Creating an Application with a Blank Template
-
Configuring Application Deployment Actions
- Configuring Deployment Actions for Software Installation
-
Configuring Deployment Actions for Containers
- Deploying on Kubernetes
- Deploying an Application in Kubernetes (CCE Cluster) Using Manifest
- Deploying an Application in Kubernetes (CCE Cluster) Quickly
- Deploying an Application with a Custom Kubernetes Cluster
- Kubernetes Nginx-Ingress Grayscale Deployment (CCE Cluster)
- Deploying with Helm3
- Deploying an Application on ServiceStage 2.0
- Rolling Back ServiceStage Components
- Configure Deployment Actions for Starting or Stopping a Service
- Configuring Deployment Actions for File Operations
- Configuring Deployment Actions for Running Commands
- Configuring Other Deployment Actions
- Editing the Deployment Actions of the CodeArts Deploy Application
- Configuring Parameters of an Application
- Configuring an Environment
- Configuring Permissions for Different Roles
- Deploying an Application and Viewing the Result
- Configuring System Notifications
-
Creating and Deploying an Application Using a Preset Template
- Introduction to CodeArts Deploy Templates
- Creating and Deploying an Application Using ServiceStage
- Creating and Deploying an Application Using a Kubernetes Template
- Creating and Deploying an Application Using the Function Deployment Template
- Creating and Deploying an Application Using the Tomcat Template
- Creating and Deploying an Application Using the Spring Boot Deployment Template
- Creating and Deploying an Application Using the Docker Deployment Template (Linux)
- Creating and Deploying an Application Using the Django Template
- Creating and Deploying an Application Using the Node.js Template
- Creating and Deploying a Common Application by Running the Shell Script
- Creating and Deploying an Application Using the Go Application Deployment Template
- Creating and Deploying an Application Using the Vue Deployment Template
- Creating and Deploying an Application Using a Custom Template
- Querying Audit Logs (Optional)
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
-
APIs
-
Managing Host Clusters
- Creating a Host Cluster
- Querying a Host Cluster List
- Deleting a Host Cluster
- Querying a Host Cluster
- Modifying a Host Cluster
- Creating a Host Cluster (Recommended)
- Querying a Host Cluster List (Recommended)
- Querying a Host Cluster (Recommended)
- Editing a Host Cluster
- Deleting a Host Cluster (Recommended)
- Querying Information About the Environment Associated with a Host Cluster
- Querying the Basic Environment Information List of an Application
-
Managing Hosts
- Creating a Host
- Querying a Host List
- Querying Host Details
- Modifying a Host
- Deleting a Host
- Creating a Host (Recommended)
- Querying a Host List (Recommended)
- Querying Host Details (Recommended)
- Editing Host Information in a Host Cluster
- Deleting a Host from a Host Cluster
- Cloning Hosts to the Target Host Cluster in Batches
- Deleting Hosts from a Host Cluster in Batches
-
Managing Applications
- Obtaining an Application List
- Creating an Application Using a Template
- Deploying an Application
- Obtaining the Details of an Application
- Deleting an Application
- Querying the Historical Deployment Records of a Specified Application in a Project by the Start Time and End Time
- Obtaining an Application List (Recommended)
- Creating an Application (Recommended)
- Updating an Application
- Obtaining Application Details (Recommended)
- Deleting an Application (Recommended)
- Querying the Execution Parameters of a Deployment Record
- Cloning an Application
- Deleting Applications from a Project in Batches
- Checking Whether an Application with the Same Name Exists in a Project
- Disabling and Enabling an Application
- Managing Application Groups
- Managing Application Permissions
- Measuring Deployment Record
-
Managing Environments
- Creating an Environment for an Application
- Querying an Environment List of an Application
- Editing an Environment in an Application
- Deleting an Environment from an Application
- Querying Environment Details
- Importing a Host to an Environment
- Deleting a Host from an Environment
- Querying a Host List in an Environment
- Managing Host Cluster Permissions
- Managing Environment Permissions
-
Managing Host Clusters
- Application Examples
- Appendixes
-
FAQs
-
Host Management
- What Are the Troubleshooting Methods for Host and Proxy Connectivity Verification Failures
- What Should I Do If Application Deployment Fails with "tomcat | Download War in url path" Displayed in Logs?
- Why Does a Task Fail on an Ubuntu Host After Being Successfully Run on a CentOS Host?
- What Should I Do If the No Host or Environment Whose Connectivity Has Been Verified?
- What Are Possible Causes of a Host verification failure?
- What Should I Do If the Connection Times Out Occasionally During a Deployment on a Windows Host?
-
Application Deployment
- What Should I Do If a Draft Application Cannot Be Deployed?
- What Are Error Messages Displayed During Application Deployment?
- How Do I Find the Cause of an Application Deployment Error in Logs?
- What Should I Do If Application Deployment Fails, with the Message "AnsibleUndefinedVariable: 'xxxx' is undefined" Displayed?
- What Should I Do If Application Deployment Fails Due to a DNS Resolution Error?
- What Should I Do If JDK Has Been Installed and Environment Variables Have Been Configured, But Application Deployment Fails with the Error Message "please configure JDK environment variables" Displayed?
- What Should I Do If Error 403 Is Displayed During Application Deployment That Requires CCE Resources?
- How Do I Roll Back a Deployed Version?
- What Should I Do If an Application Deployment Times Out?
- Does CodeArts Deploy Provide Batch and Incremental Deployment Policies?
- Do I Need to Upload a Software Package to CodeArts Artifact Before Deployment?
- Can I Deploy Web Pages Written in HTML or JS?
- How Do I Upload an Image for Container Deployment?
- What Should I Do If Application Deployment Succeeds But the Application Verification URL Cannot Be Accessed?
- What Should I Do If Squid Fails to Be Started?
-
Common FAQs
- Can I Use a Host to Deploy Multiple Projects?
- Do I Need to Install a Running Environment (Tomcat, Python) on the Target Host Before Deploying an Application?
- What Should I Do If the Log Indicating Insufficient Permissions Is Displayed?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should I Do If the File Path Does Not Exist?
- What Should I Do If the System Displays a Message Indicating That No Hosts Are Found in the Environment?
- What Should I Do If the Log Contains "The file or file path does not exist"?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If I Have Insufficient Permissions?
- What Should I Do If the Action "Create and Start Container" Fails on Ubuntu 22 OS When Using Template "Deploy a Docker Application for Linux"?
-
Software Installation Actions
-
Installing IIS
- Host Not Restarted
- How Should I Check the IIS Function on the Local Host?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
-
Installing JDK
- What Should I Do If the Log "The JDK of the Same Version Has Been Installed on the Target Host" Is Displayed?
- What Should I Do If the Java Environment Is Not Installed on the Host?
- What Should I Do If the JDK Decompression Error Is Displayed?
- What Should I Do If OpenJDK 8 Cannot Be Installed on Ubuntu 14 or Earlier Versions?
- What Should I Do If the Deployment Result Is "Openjdk does not support arm"?
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing Tomcat
- Deployment Failure
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing Nginx
- No sudo Permissions
- No Permission to Access the Path
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing Go
- Invalid Installation Path
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing PHP
- Error Returned When Installing PHP as a Common User
- Some Dependency Packages Do Not Exist in the CentOS Yum Repository
- Download Fails Due to Network Disconnection from the CentOS Yum Source
- Download Fails Because Some Software Dependency Packages Are Missing for apt-get in Ubuntu
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing Node.js
- Cannot Decompress Node Packages
- Installation Path Fails to Be Created
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing Python
- No sudo Permissions
- No Permission to Access the Path
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Version Running on the Windows Host Is Incompatible with the New Version?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing/Uninstalling Docker
- Error Returned During the Deployment of the Action for Installing or Uninstalling Docker as a Common User
- Error Returned Even Though the Action for Installing or Uninstalling Docker Is Successfully Deployed
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Installing IIS
-
Container-based Deployment Actions
-
FAQs About Kubernetes Deployment Tasks
- Parameter Referenced by {{}} in the Manifest File Is Not Defined in the Application
- Target File Does Not Exist in CodeArts Artifact
- Path of the Manifest File in CodeArts Artifact Is Incorrect
- kubeconfig File Is Incorrectly Configured
- kubectl Command Fails to Be Deployed
- Failed to Deploy Applications on Kubernetes
- Log Contains "Too many files to unzip" When CodeArts Repo Is Selected as the Manifest File Source During Kubernetes Deployment
- Error Message "File is too large" Displayed During Manifest File Source Selection for Kubernetes Deployment
- FAQs About ServiceStage
-
FAQs About Kubernetes Deployment Tasks
-
Stopping or Starting Deployment Actions
-
Stopping a Service
- Incorrect Port Number
- Action Stop Service Deployed Successfully, But the Service Is Still in Started State
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Starting or Stopping Tomcat
- Invalid Tomcat Path
- Stopping Failed
- Startup Failed
- Environment Variables Are Not Configured
- Service Is Not Started Despite Successful Action Deployment
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Starting/Stopping Go Service
- The Go Service Path Is Incorrect
- Startup Failed
- Deployment Is Successful, But the Service Is Not Started
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- No Host in the Environment
- Environment Does Not Exist
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Starting or Stopping Spring Boot
- Start/Stop Spring Boot
- Invalid Spring Boot Path
- Startup Failed
- Environment Variables Are Not Configured
- Service Is Not Started Despite Successful Action Deployment
- Spring Boot Can Still Be Detected After Being Stopped (on Windows)
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Starting or Stopping Nginx
- Nginx Gets Restarted Repeatedly
- Invalid Windows Host Path
- Deploying the Command for Stopping Nginx When Nginx Is Not Started
- Incorrect Format of the Nginx Configuration File
- Configuration File Backup Path Does Not Exist
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
-
Starting or Stopping IIS
- Startup or Stopping Failed
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
-
Starting or Stopping Node.js
- Node.js Fails to Be Started or Stopped on a Linux Host
- Node.js Fails to Be Started or Stopped on a Windows Host
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Stopping a Service
-
File Operation Deployment Actions
-
Copying a File
- File to Be Copied Does Not Exist
- Invalid File Path
- File or File Path Does Not Exist
- Action Copy Files Deployed Successfully, But the Expected Result Is Not Achieved
- Insufficient Permissions
- Log Contains "copy File Failed" When Copying Files Between Linux Environment
- Log Contains "Windows does not support copying files between hosts" When Copying Files Between Windows Environment
- Log Contains "Hosts using secret key credit do not support copying files between" When Copying Files Between Environment
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Decompressing a File
- File to Be Decompressed Does Not Exist
- Backslashes (\) Are Used as Path Separators in the Native Command Compress-Archive
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Deleting a File
- Cannot Delete Files on a Linux Host
- File Path Does Not Exist on a Windows Host
- Incorrect File Path on a Windows Host
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Modifying a Configuration File
- File Path Does Not Exist
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Copying a File
-
Command Execution for Deployment Actions
-
Running Shell Commands
- A Message Indicating an Operation Failure Is Displayed
- Service Is Not Started But the Log Shows That Shell Commands Are Successfully Executed
- Unidentified Shell Commands Are Used
- Shell Command References a File or Folder That Does Not Exist
- How Does a Shell Command Reference Parameters?
- Deployment of the Action Run Shell Commands Times Out
- Interactive Shell Commands Are Used
- Shell Command Deployment Times Out After the su Command Is Executed to Switch the User
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
- Other FAQs
-
Running Shell Scripts
- Running Shell Scripts Failed
- Deployment Is Successful But Does Not Achieve the Expected Result
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Running PowerShell Commands
- Deployment of the Action Run PowerShell Commands Times Out
- Unidentified PowerShell Commands Are Used
- PowerShell Command References a File or Folder That Does Not Exist
- How Does a PowerShell Command Reference Parameters?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
-
Running PowerShell Scripts
- Running PowerShell Scripts Failed
- Deployment Is Successful But Does Not Achieve the Expected Result
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
-
Running Docker Commands
- What Should I Do If Docker Is Not Installed?
- What Should I Do If Parameters Are Incorrect?
- What Should I Do If I Do Not Have the Deployment Permissions?
- What Should I Do If the Image Does Not Exist?
- What Should I Do If the login Command Fails to Be Executed?
- What Should I Do If the build Command Fails to Be Executed?
- What Should I Do If the tag Command Fails to Be Executed?
- What Should I Do If the push Command Fails to Be Executed?
- What Should I Do If the run Command Fails to Be Executed?
- What Should I Do If the Commands (start, restart, stop, and rm) Fail to Be Executed?
- What Should I Do If the rmi Command Fails to Be Executed?
- What Should I Do If the pull Command Fails to Be Executed?
- What Should I Do If the Error Message You cannot remove a running container Is Displayed When the rm Command Is Executed?
- What Should I Do If the Network Connection Times Out?
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Running Shell Commands
-
Other Deployment Actions
-
Health Test via URLs
- Incorrect URL
- URL Does Not Exist
- Invalid URL
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Selecting Deployment Sources
- Software Package Not Found in CodeArts Artifact
- No Software Package Available for a Build Task
- URL Domain Name Resolution Failure
- File Download Times Out
- Inconsistent SHA256 Values in a File
- Inconsistent MD5 Values in a File
- Error "More than 100 build files"
- "HTTP Error 403" Is Displayed When the CodeArts Artifact Software Package Is Downloaded
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Pending Execution
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Ansible
- Invalid Entry File Path
- Entry File Not Found
- Copy Module Error
- JSON Parameter Parsing Error
- Service Module in Playbook Scripts Fails to Start or Stop Services
- Ansible Application Deployment Fails
- What Should I Do When the "Do not use the delegate_to, connection, hosts command in the Ansible PlayBook script for executing the local computer" message Is displayed When Running Ansible?
- What Should I Do If the Application Deployment Is Interrupted?
- What Should I Do If the Permission Is Insufficient?
- What Should I Do If Parameters Contain Backslashes (\)?
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If an Error Is Reported When the sudo Permission Is Used?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- What Should If Do If a Network Error Occurs During Software Installation on CentOS?
- What Should If Do If a Network Error Occurs During Software Installation on Ubuntu OS?
- What Should I Do If a Windows Path Is Not Allowed on a Linux Host?
-
Creating an IIS Site
- Port Error
- Physical Path of an Application Does Not Exist
- IIS Not Installed on the Host
- What Should I Do If the Log Message "No Host in the Environment" Is Displayed?
- What Should I Do If the Log Message "Environment Cannot Be Found" Is Displayed?
- What Should I Do If the Application Deployment Failed on a Windows Host?
- What Should I Do If the Deployment Process Is Intercepted by Third-Party Antivirus Software?
- What Should I Do If the Log Indicating an Invalid Path Is Displayed?
- How Should I Check the IIS Function on the Local Host?
- Grayscale Release with Istio
-
Health Test via URLs
-
Host Management
- Videos
- General Reference
Copied.
Using Kubernetes Nginx-Ingress for Gray Release
Application Scenario
This practice implements gray release based on native Kubernetes features. When you upgrade a new system, services may be stopped or gray verification may fail. The native Kubernetes service features help you upgrade system smoothly without affecting services.
Solution Architecture
During system upgrade, a group of gray loads are created when developers deploy applications for the first time. In this case, the system version in the gray loads is the new version. The Service forwards some traffic to the gray loads, and the testers verify the version in the gray loads. After the version verification is complete, the developers start to deploy the application for the second time to upgrade the services on the live network. In this case, the Service forwards all traffic to the gray loads and upgrades the services to the latest version on the live network. After the upgrade is complete, the Service forwards all traffic back to the live network load and releases the gray loads. Now, the new system is released.

Prerequisites
- A project is available. If there is no project, create one first.
- You have the permission to create applications. For details, see Editing Permissions.
- The service contains the following resources and they are defined as version 1:
- A CCE cluster, for example, cce-demo, is available.
- A deployment, for example, deployment-doc, has been created in the CCE cluster.
- A Service, for example, service-doc, has been created in the CCE cluster.
- A route, for example, ingress-doc, has been created in the CCE cluster.
- The nginx-ingress plug-in has been installed in the CCE cluster.
Process

- Create an application.
- Go to the CodeArts homepage and click the target project name to access the project.
- Choose CICD > Deploy and click Create Application. The Set Basic Information page is displayed.
- You can modify the following basic information as required:
Parameter
Mandatory
Description
Name
Yes
Name of an application. Example: Kubernetes_Nginx-Ingress_Gray_Deployment
Project
Yes
Retain the default value. Project to which an application belongs.
Description
No
Description of an application. Example: None
Execution Resource Pool
No
A resource pool is a collection of physical environments where commands are executed during software package deployment. You can use the official resource pool hosted by Huawei Cloud or host your own servers as a self-hosted resource pool on Huawei Cloud. For details about how to host your own servers, see Self-hosted Resource Pool. Example: Official
Deploy from pipeline
No
After this function is enabled, the app can be executed only by the pipeline driver and cannot be executed independently.
- After editing the basic application information, click Next. On the Select Template page, select Blank Template and click OK.
- Edit the application.
On the Deployment Actions tab page, add Kubernetes Nginx-Ingress Gray Deployment (CCE cluster) and modify the parameters described in the following table.Table 1 Parameter description
Parameter
Description
Example
Action Name
Name of an action displayed in Deployment Actions area.
Retain the default value.
Tenant
- Current tenant: The software package is deployed in your CCE cluster for release.
Select Current tenant. You must have the CCE cluster operation permission. If you do not have it, select Authorized User for deployment.
- Other tenant: The software package is deployed in the CCE cluster of another tenant for release in IAM authorization mode.
If you select Other tenant, you must select an authorized tenant to deploy the CCE cluster.
Select Current tenant.
Authorized User
If you do not have the permission to execute an API, this parameter enables you to obtain the temporary AK/SK of the parent user to execute the CCE API through IAM.
Deselect it.
Region
Select the region for deployment.
Retain the default value.
Cluster Name
Select the Kubernetes cluster applied on CCE.
cce-ldf
Namespace
Select the namespace of the Kubernetes cluster on CCE.
Retain the default value.
Workload
Select the target deployment.
deployment-doc
Service
Name of the service bound to the target workload.
service-doc
Ingress
Select the name of the route bound to the target service.
ingress-doc
Container
Select the name of the CCE container to be deployed.
container-1
Image
Select the image to be deployed.
Retain the default value.
Image Tag
Select the tag of the image to be deployed.
v2
Enabling grayscale configuration
Gray Strategy:- Header
Header-Key: You can enter the key of a custom header.
Header-Value: You can enter a custom header value. The value can be a character string or a regular expression. The regular expression format is ^....$.
Gray Traffic Weight (%): Traffic can be customized.
- Cookie
Cookie: Custom cookie content can be entered.
Gray Traffic Weight (%): Traffic can be customized.
Length limit for Header and Cookie: 500 characters each.
Selected
Gray Strategy: Header
Header-Key: foo
Header-Value: bar
Gray Traffic Weight(%): 30
- Current tenant: The software package is deployed in your CCE cluster for release.
- Deploy an application (create a gray version).
Click Save & Deploy to deploy the application. CodeArts Deploy has created the following gray version resources in the CCE cluster and diverts 30% of the live network traffic to the gray load.
- Workload: deployment-doc-v2. The image version is V2.
Figure 3 Adding a workload whose image version is V2
- Service: service-doc-v2
- Route: ingress-doc-v2
In this case, you can add a data record (the value of Key is foo and the value of Value is bar) to the header to verify the latest version in the gray load.
- Workload: deployment-doc-v2. The image version is V2.
- Edit the application (deploy the latest version).
Go to the application created in Step 1 and modify the following parameters.
Table 2 Parameter descriptionParameter
Mandatory
Example
Enabling grayscale configuration
No
Deselect it.
- Deploy the application (deploy the latest version).
Click Save & Deploy to deploy the application. CodeArts Deploy has deleted the following gray environment resources from the CCE cluster and replaced the V1 image with the V2 image:
- Workload: deployment-doc-v2
- Service: service-doc-v2
- Route: ingress-doc-v2
Figure 4 The image version is upgraded to V2.You can check whether the system is the latest version on the live network. For more deployment problems, see Application Deployment FAQs.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot