Configure the following parameters in your pom.xml to deploy or upgrade applications with toolkit-maven-plugin. Parameters are organized into three categories:
Environment (
env) -- Region, package path, and endpoint settings.Application (
app) -- Application identity, release strategy, and batch controls.Storage (
oss) -- Object Storage Service (OSS) bucket and upload settings.
Environment parameters
Environment parameters control where and how the plug-in connects.
| Parameter | Required | Description |
|---|---|---|
region_id | Yes | Region where the application is deployed. Example: cn-hangzhou. |
jar_path | No | Path to the deployment package. Accepts absolute or relative paths. When specified, Maven does not need to package the application. Example: target/demo.jar. |
endpoint | No | Gateway point of presence (POP) for applications deployed on Apsara Stack. Not required for public cloud deployments. |
Application parameters
Application parameters define the identity, release strategy, and batch behavior of a deployment.
| Parameter | Required | Description |
|---|---|---|
app_id | Yes | EDAS application ID. |
release_type | No | Phased release mode. Valid values: 0 (automatic phased release), 1 (manual phased release). |
package_version | No | Version label for the deployment package. Default: a string composed of the pom.xml version and the creation timestamp, for example 1.0 (2018-09-27 19:00:00). |
desc | No | Free-text description attached to this deployment. |
group_id | No | Application instance group to deploy to. Default: all groups. |
batch | No | Number of release batches. Default: 1. Maximum: 5. |
batch_wait_time | No | Wait time between consecutive batches, in minutes. Default: 0 (no wait). |
stage_timeout | No | Timeout per stage of the change process, in minutes. Default: 5. If batch_wait_time is set, its value is automatically added to stage_timeout. The plug-in exits when any single stage exceeds this threshold. |
How stage_timeout and batch_wait_time interact
The effective timeout per stage equals stage_timeout + batch_wait_time. For example, if stage_timeout is 5 and batch_wait_time is 2, each stage times out after 7 minutes. The plug-in terminates automatically when any stage exceeds this threshold.
Storage parameters
Storage parameters configure the OSS bucket used to upload your deployment package. EDAS provides a free OSS bucket by default, so these parameters are optional unless you use your own bucket.
| Parameter | Required | Description |
|---|---|---|
region_id | No | Region of the OSS bucket. Default: same as the application region_id. |
bucket | No | Bucket name. Default: the free OSS bucket provided by EDAS. Specify this parameter only when you use your own bucket. |
key | No | Upload path inside the bucket. Supports the variables {region_id}, {app_id}, and {version}. Default: {region_id}/{app_id}/{version}. Example: pkgs/petstore/{version}/store.war. |
access_key_id | No | AccessKey ID for uploading to the specified OSS bucket. Not required when you use the free EDAS bucket. |
access_key_secret | No | AccessKey secret for uploading to the specified OSS bucket. Not required when you use the free EDAS bucket. |
use_vpc_endpoint | No | Upload through the internal VPC endpoint instead of the public endpoint. Set to true to enable. Default: public endpoint. |