Skip to main content

ack

Manage ACK clusters

Run ecctl ack <action> -h for usage, or ecctl schema ack.ack.<action> --full for the complete, agent-readable spec of every parameter and behavior.

create

ecctl ack create [flags]

Create ACK cluster

  • Kind: mutation · Risk: medium
  • Synchronous: waits for running (waiter running_after_create, timeout 1800s); use --no-wait to skip.
APIWhen calledPurpose
CreateClusterEvery time the command runs.Perform the resource operation.
DescribeClusterDetailWhen --no-wait is not specified.Poll until the resource reaches the target state. (repeated)
DescribeClusterDetailWhen --no-wait is not specified.Return the final resource view. (cached; no additional request)
ParameterTypeRequiredDescription
--namestringcluster name
--regionstringAlibaba Cloud region
--typestringcluster type
--api-server-publicbooleanexpose the API server through a public endpoint
--editionstringcluster edition or specification; common values include ack.standard, ack.pro.small, ack.pro.xlarge, ack.pro.2xlarge, ack.pro.4xlarge
--pod-cidrcidrPod network CIDR; sent to ACK CreateCluster as container_cidr
--profilestringACK cluster scenario profile. To use both config and ACK profiles, put the config profile before the resource command, for example ecctl --profile prod ack create --profile Serverless.
--resource-groupstringresource group ID
--service-cidrcidrService network CIDR
--snat-entrybooleancreate an SNAT entry for cluster outbound access where ACK supports it
--tagkey_valuetag assignment key=value
--versionstringtarget Kubernetes version
--vpcstringVPC ID
--vswitchstring_arrayVSwitch IDs for cluster networking
--zonestring_arrayzone IDs for ACK CreateCluster zone_ids

update

ecctl ack update <id> [flags]

Update ACK cluster

  • Kind: mutation · Risk: medium
  • Synchronous: waits for running (waiter running_after_update, timeout 1800s); use --no-wait to skip.
APIWhen calledPurpose
ModifyClusterWhen --name is specified or --api-server-public is specified or --api-server-eip-id is specified or --resource-group is specified or --maintenance-window is specified.Perform the resource operation.
DescribeClusterDetailWhen (--name is specified or --api-server-public is specified or --api-server-eip-id is specified or --resource-group is specified or --maintenance-window is specified) and --no-wait is not specified.Poll until the resource reaches the target state. (repeated)
MigrateClusterWhen --to-edition is specified.Perform the resource operation.
DescribeClusterDetailWhen --to-edition is specified and --no-wait is not specified.Poll until the resource reaches the target state. (repeated)
ModifyClusterTagsWhen --tag-replace is specified.Perform the resource operation.
TagResourcesWhen --tag is specified.Perform the resource operation.
UntagResourcesWhen --remove-tag is specified.Perform the resource operation.
DescribeClusterDetailWhen --no-wait is not specified.Read the resource view.
ListTagResourcesWhen --no-wait is not specified.Read the resource view.
ParameterTypeRequiredDescription
--regionstringAlibaba Cloud region
--api-server-eip-idstringEIP ID to bind when exposing the API server publicly
--api-server-publicbooleanexpose the API server through a public endpoint
--maintenance-windowobjectmaintenance window as JSON or @file using ACK field names
--namestringcluster name
--remove-tagstring_arraytag keys to remove
--resource-groupstringresource group ID
--tagkey_valuetag assignment key=value
--tag-replacekey_valuecomplete replacement tag set key=value
--to-editionstringtarget cluster edition for migration

delete

ecctl ack delete <id> [flags]

Delete ACK cluster

  • Kind: mutation · Risk: high
  • Synchronous: waits for absent (waiter deleted_after_delete, timeout 1800s); use --no-wait to skip.
APIWhen calledPurpose
DeleteClusterEvery time the command runs.Perform the resource operation.
DescribeClustersV1When --no-wait is not specified.Poll until the resource reaches the target state. (repeated)
ParameterTypeRequiredDescription
--regionstringAlibaba Cloud region
--delete-optionsobjectACK delete_options JSON or @file
--forcebooleandelete cluster resources instead of retaining them (default: false)
--retain-all-resourcesbooleanretain all cloud resources when deleting the cluster
--retain-resourcesstring_arraycloud resource IDs to retain during deletion

get

ecctl ack get <id> [flags]

Get ACK cluster

  • Kind: read · Risk: low
APIWhen calledPurpose
DescribeClusterDetailEvery time the command runs.Read the resource view.
DescribeClusterResourcesWhen --with-resources is specified.Read the resource view.
ListTagResourcesWhen --with-tags is specified.Read the resource view.
DescribePolicyGovernanceInClusterWhen --with-policy-governance is specified.Read the resource view.
ParameterTypeRequiredDescription
--regionstringAlibaba Cloud region
--fieldsstringcomma-separated resource fields to include
--with-policy-governancebooleaninclude policy governance summary
--with-resourcesbooleaninclude cloud resources associated with the cluster
--with-tagsbooleaninclude cluster tags

list

ecctl ack list [<ids>...] [flags]

List ACK clusters

  • Kind: read · Risk: low
APIWhen calledPurpose
DescribeClustersForRegionWhen --cross-account is specified.Read the resource view.
DescribeClustersV1When --cross-account is not specified.Read the resource view.
ParameterTypeRequiredDescription
--regionstringAlibaba Cloud region
--cross-accountbooleanuse the regional cross-account cluster list API
--fieldsstringcomma-separated resource fields to include
--filterkey_valuefilter expression key=value
--limitintegermaximum clusters to return (default: 100)
--pageintegerresults page to return (default: 1)

upgrade

ecctl ack upgrade <id> [flags]

Upgrade ACK cluster

  • Kind: mutation · Risk: medium
  • Synchronous: waits for success (waiter upgrade_task_succeeded, timeout 3600s); use --no-wait to skip.
APIWhen calledPurpose
UpgradeClusterEvery time the command runs.Perform the resource operation.
DescribeTaskInfoWhen --no-wait is not specified.Poll until the resource reaches the target state. (repeated)
DescribeClusterDetailWhen --no-wait is not specified.Poll until the resource reaches the target state. (repeated)
DescribeClusterDetailWhen --no-wait is not specified.Return the final resource view. (cached; no additional request)
ParameterTypeRequiredDescription
--regionstringAlibaba Cloud region
--versionstringtarget Kubernetes version
--master-onlybooleanupgrade master nodes only
--max-parallelismintegermaximum nodes upgraded in parallel
--rolling-policyobjectupgrade rolling policy JSON or @file using ACK field names