Skip to main content

ack addon

Manage ACK cluster addons

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

create

ecctl ack addon create <name> [flags]

Install addon on a cluster

  • Kind: mutation · Risk: medium
  • Synchronous: waits for success (waiter task_succeeded, timeout 3600s); use --no-wait to skip.
APIWhen calledPurpose
InstallClusterAddonsEvery 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)
GetClusterAddonInstanceWhen --no-wait is not specified.Read the resource view.
ParameterTypeRequiredDescription
--clusterstringACK cluster ID
--regionstringAlibaba Cloud region
--versionstringaddon version
--configstringaddon config as JSON/YAML text or @file

update

ecctl ack addon update <name> [flags]

Update addon config

  • Kind: mutation · Risk: medium
  • Synchronous: waits for matched (waiter modify_task_visible, timeout 600s); use --no-wait to skip.
APIWhen calledPurpose
DescribeClusterTasksWhen --no-wait is not specified.Read the resource view.
ModifyClusterAddonEvery time the command runs.Perform the resource operation.
DescribeClusterTasksWhen --no-wait is not specified.Poll until the resource reaches the target state. (repeated)
DescribeClusterTasksWhen --no-wait is not specified.Return the final resource view. (cached; no additional request)
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)
GetClusterAddonInstanceWhen --no-wait is not specified.Read the resource view.
ParameterTypeRequiredDescription
--clusterstringACK cluster ID
--configstringaddon config as JSON/YAML text or @file
--regionstringAlibaba Cloud region

delete

ecctl ack addon delete [<names>...] [flags]

Uninstall addon from a cluster

  • Kind: mutation · Risk: high
  • Synchronous: waits for success (waiter task_succeeded, timeout 3600s); use --no-wait to skip.
APIWhen calledPurpose
UnInstallClusterAddonsEvery 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)
ListClusterAddonInstancesWhen --no-wait is not specified.Poll until the resource reaches the target state. (repeated)
ParameterTypeRequiredDescription
--clusterstringACK cluster ID
--regionstringAlibaba Cloud region
--forcebooleanclean up addon-related cloud resources during uninstall (default: false)

get

ecctl ack addon get <name> [flags]

Get addon instance or catalog metadata

  • Kind: read · Risk: low
APIWhen calledPurpose
DescribeAddonWhen --catalog is specified.Read the resource view.
GetClusterAddonInstanceWhen --catalog is not specified.Read the resource view.
ListClusterAddonInstanceResourcesWhen --with-resources is specified and --catalog is not specified.Read the resource view.
ParameterTypeRequiredDescription
--regionstringAlibaba Cloud region
--catalogbooleanquery the installable addon catalog
--clusterstringACK cluster ID
--cluster-profilestringcluster profile filter for catalog queries
--cluster-specstringcluster spec filter for catalog queries
--cluster-typestringcluster type filter for catalog queries
--cluster-versionstringKubernetes version filter for catalog queries
--fieldsstringcomma-separated resource fields to include
--versionstringaddon version
--with-resourcesbooleaninclude Kubernetes resources owned by the addon instance

list

ecctl ack addon list [flags]

List addon instances or catalog metadata

  • Kind: read · Risk: low
APIWhen calledPurpose
ListAddonsWhen --catalog is specified.Read the resource view.
ListClusterAddonInstancesWhen --catalog is not specified.Read the resource view.
ParameterTypeRequiredDescription
--regionstringAlibaba Cloud region
--catalogbooleanquery the installable addon catalog
--clusterstringACK cluster ID
--cluster-profilestringcluster profile filter for catalog queries
--cluster-specstringcluster spec filter for catalog queries
--cluster-typestringcluster type filter for catalog queries
--cluster-versionstringKubernetes version filter for catalog queries
--fieldsstringcomma-separated resource fields to include

upgrade

ecctl ack addon upgrade <name> [flags]

Upgrade addon version

  • Kind: mutation · Risk: medium
  • Synchronous: waits for success (waiter task_succeeded, timeout 3600s); use --no-wait to skip.
APIWhen calledPurpose
UpgradeClusterAddonsEvery 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)
GetClusterAddonInstanceWhen --no-wait is not specified.Read the resource view.
ParameterTypeRequiredDescription
--clusterstringACK cluster ID
--regionstringAlibaba Cloud region
--versionstringaddon version
--configstringaddon config as JSON/YAML text or @file
--policystringaddon upgrade policy