The edas-jenkins-plugin deploys applications from Jenkins to Enterprise Distributed Application Service (EDAS). This topic describes the plugin parameters for four deployment scenarios:
Deploy to an ECS cluster -- update an existing application on Elastic Compute Service (ECS) instances
Create and deploy in an ECS cluster -- create a new application and deploy it to ECS instances
Deploy to an ACK cluster -- update an existing application in a Container Service for Kubernetes (ACK) cluster
Create and deploy in an ACK cluster -- create a new application and deploy it to an ACK cluster
Prerequisites
Before you begin, make sure that you have:
The edas-jenkins-plugin installed in Jenkins
An Alibaba Cloud AccessKey pair with EDAS permissions
The AccessKey pair configured as credentials in Jenkins (Manage Jenkins > Credentials)
An EDAS application or cluster ready, depending on your scenario
Common parameters
All deployment scenarios share the following parameters.
| Parameter | Type | Description |
|---|---|---|
| EDAS Credentials | String | The AccessKey ID configured in Jenkins credentials. |
| EDAS Namespace | String | The EDAS microservices namespace where the application resides. Format: <Region ID>:<Namespace ID>, for example, cn-hangzhou:doc. |
| Target Object | String | The URL of the deployment package (WAR, JAR, or FatJar) or container image. The package type must match the one used for the initial deployment. |
Deploy to an ECS cluster
Update and deploy an existing application in an ECS cluster.
Configure the common parameters and the following scenario-specific parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
| Application ID | Yes | String | The ID of the application. Find this on the Applications page in the EDAS console. |
| Group | Yes | String | The application group. Set to all to deploy to all groups. |
| Version Label Format | No | String | The version number for this deployment. |
| Version Description Format | No | String | A description for this version. |
| Batch | No | Integer | The number of deployment phases. |
| Batch Wait Time | No | Integer | The interval between consecutive deployment phases. |
| Release Type | No | String | How the next deployment phase starts. Valid values: Manual, Automatic. |
Create and deploy in an ECS cluster
Create a new application and deploy it to an ECS cluster.
Configure the common parameters and the following scenario-specific parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
| Application Name | Yes | String | The name of the new application. |
| Package Type | Yes | String | The deployment package type. Valid values: WAR, JAR. |
| Cluster ID | Yes | String | The ID of the target ECS cluster. Find this on the Clusters page in the EDAS console. |
| Ecu Info | No | String | The elastic compute unit (ECU) ID of the ECS instance. For more information, see ListScaleOutEcu. |
| Version Label Format | No | String | The version number for this deployment. |
| Version Description Format | No | String | A description for this version. |
| Build Pack ID | No | String | The build package number of EDAS Container. |
| Health Check Url | No | String | The health check URL for the application. |
Deploy to an ACK cluster
Update and deploy an existing application in an ACK cluster.
To obtain deployment parameters for a Spring Boot application in an ACK cluster: 1. In the EDAS console, go to Applications and click the application name. 2. On the Application Overview page, choose Deploy > Deploy. 3. In the Phased Release section, click Start Deployment. 4. On the Phased Release page, click Copy Deployment Parameters and save the output to a file named UpdateStrategy Json.
Configure the common parameters and the following scenario-specific parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
| Application ID | Yes | String | The ID of the application. |
| Whether target imageUrl | No | Boolean | Select this check box if Target Object is a container image URL instead of a deployment package URL. |
| Application Environment | No | JSON | Environment variables for the application. For more information, see DeployK8sApplication. |
| Startup Command | No | String | A custom startup command. For more information, see DeployK8sApplication. |
| Resource Quota | No | String | CPU and memory resource limits for the application. |
| Application Management | No | String | Application lifecycle management settings. |
Create and deploy in an ACK cluster
Create a new application and deploy it to an ACK cluster.
Configure the common parameters and the following scenario-specific parameters:
| Parameter | Required | Type | Description |
|---|---|---|---|
| Cluster ID | Yes | String | The ID of the target ACK cluster. |
| K8s Namespace | Yes | String | The Kubernetes namespace for the application. Namespaces provide logical isolation within a cluster. Select default unless a specific namespace is required. |
| Application Name | Yes | String | The name of the new application. |
| Application Description | No | String | A description of the application. |
| Package Type | Yes | String | The deployment method. Valid values: FatJar, WAR, Image. |
| EDAS Container Version | No | String | The EDAS Container version. Required for High-Speed Service Framework (HSF) applications deployed with WAR packages. Not applicable to image-based deployments. |
| Web Container | No | String | The Tomcat container version. Required for Spring Cloud and Dubbo applications deployed with WAR packages. Not applicable to image-based deployments. |
| JDK Version | No | String | The Java Development Kit (JDK) version, for example, Open JDK 8. |
| Version Label Format | No | String | The version number for this deployment. |
| Environments Json | No | JSON | Environment variables for the application. Specify as a JSON array. |
| Startup Command | No | String | A custom startup command. For more information, see DeployK8sApplication. |
| Resource Quota | No | String | CPU and memory resource limits for the application. |
| Application Management | No | String | Application lifecycle management settings. |