Updated on 2025-08-05 GMT+08:00

Basic Concepts

Host Cluster

Hosts basic resources such as hosts to be deployed. You can import created resources to an application for deployment.

Target Host

Final object for deployment in host deployment. This service deploys your resources such as artifacts to the target host in the environment.

Proxy Host

Provides access channels for other target hosts that do not have public IP addresses. In CodeArts Deploy, proxy hosts are basically ECSs bound to public IP addresses unless otherwise specified.

Environment

Collection of one or more hosts running the same OS. Deployment applications can be performed in batches on multiple hosts.

Connectivity Verification

Verifies whether the remote access between the executor of the service and the target host is normal.

Service Endpoint

A plug-in of CodeArts. It provides the capability of connecting to third-party services. For example, in a custom cluster deployment scenario of Kubernetes, a service endpoint stores Kubeconfig authentication information used for cluster authentication and remote control during container deployment.

Official Agent Pool

Default execution environment provided by CodeArts, which can be accessed by all users.

Self-hosted Agent Pool

You can use your own hosts as executors and connect them to CodeArts as the execution environment for deployment. In the host deployment scenario, you can deploy CodeArts on the internal network of the target host using a self-hosted agent pool for application deployment.

Kubernetes

An open-source project used to manage containerized applications on multiple hosts on the cloud platform. Deployments of Kubernetes clusters offline are supported.

Deployment Template

Template instance formed after multiple deployment actions are orchestrated based on service scenarios. Templates are classified into system templates and custom templates. System templates are also called preset templates and visible to all users. Custom templates are orchestrated and saved by users based on deployment scenarios and visible to project members.

Deployment Action

Minimum executable unit (which may also be understood as encapsulated extension of a deployment) in a deployment application. One deployment action achieves a specific function, and one deployment application may include one or more deployment actions.

Parameter

Parameters represent the deployment actions in CodeArts Deploy after parameters are set. During deployment, the parameter values can be dynamically changed.

Runtime Parameter

Parameters that can be reset when a deployment application is executed. Parameters can be classified into custom parameters and predefined parameters by attribute. Enumeration, string, and environment are supported.