This site will be decommissioned on January 30th 2025. After that date content will be available at techdocs.broadcom.com.

aks-cluster

The aks-cluster is an organizational object that manages AWS AKS clusters.

Usage

tanzu mission-control aks-cluster [command]

Commands

  create        Create an aks cluster
  delete        Delete an aks cluster
  get           Get details from an aks cluster
  list          List aks clusters
  nodepool      Group of nodes within an aks cluster with the same configuration
  options       Options for the aks cluster resource
  template      AKS Cluster template
  update        Update (overwrite) an aks cluster
  upgrade       Upgrade a aks cluster

create

Create an AKS cluster.

Usage

tanzu mission-control aks-cluster create [flags]

Flags

  -v, --data-values-file string   data values file to use
      --dry-run                   create the data model only, do not apply to server
  -f, --file string               Resource file from which to create a cluster
  -h, --help                      help for create
  -t, --template string           template to use (default "default")

Example

To use the default template for creating an AKS cluster and update values:

1) First, use the following command to get all default template data values

tanzu tmc aks-cluster template get default -o sample

2) Place sample values in a file and make the required changes:

**test-cluster.values** :
  SubscriptionId: <azure-subscription-UUID>
  CredentialName: <tmc-credentials-name>
  Name: test-aks
  ResourceGroup: <azure-resource-group>
  Version: 1.26.6
  Description: Test aks cluster

3) Run the following command and provide the path to your values file:

  tanzu mission-control aks-cluster create --template default --data-values-file test-cluster.values

4) Create first node pool for this cluster to trigger the cluster creation.

delete

Delete an AKS cluster.

Usage

  tanzu mission-control aks-cluster delete <cluster-name> [flags]

Flags

  -c, --credential-name string   Credential name of the aks cluster
  -f, --force                    force delete an aks cluster
  -h, --help                     help for delete
  -r, --resource-group string    resource group name of the aks cluster
  -s, --subscription-id string   subscription id of the aks cluster

Example

To delete an AKS cluster named test-aks with credential name cred-aks, subscription sub-id, and resource group test-aks-rg:

tanzu mission-control aks-cluster delete test-aks -c cred-aks -s sub-id -r test-aks-rg

get

Get an AKS cluster.

Usage

tanzu mission-control aks-cluster get <cluster-name> [flags]

Flags

  -c, --credential-name string   credential name of the aks cluster
  -h, --help                     help for get
  -o, --output string            Output format (yaml | json) (default "yaml")
  -r, --resource-group string    resource group name of the aks cluster
  -s, --subscription-id string   subscription id of the aks cluster

Example

To get the contents of the test-aks aks cluster with credential name cred-aks, subscription sub-id, and resource group test-aks-rg in YAML format:

tanzu mission-control aks-cluster get test-aks -c cred-aks -s sub-id -r test-aks-rg -o yaml

list

List AKS clusters.

Usage

  tanzu mission-control aks-cluster list [flags]

Flags

  -c, --credential-name string   scope search to the specified credential name
  -h, --help                     help for list
      --max-size uint            number of records to return
      --name string              scope search to the specified name
      --offset uint              offset at which to start returning records
  -o, --output string            output format (yaml|json)
  -r, --resource-group string    resource group name of the aks cluster
  -s, --subscription-id string   subscription id of the aks cluster

template

AKS cluster template.

Usage

  tanzu mission-control aks-cluster template [command]

Commands

  get         Get Template for aks cluster
  list        List Templates for aks cluster

template get

Get template for AKS cluster

Usage

  tanzu mission-control aks-cluster template get TEMPLATE_NAME [flags]

Flags

  -o, --output string       template and data-values output format (yaml|table|sample) (default "yaml")

template list

List templates for AKS cluster

Usage

  tanzu mission-control aks-cluster template list

update

Update (overwrite) an AKS cluster.

Usage

  tanzu mission-control aks-cluster update [flags]

Flags

  -f, --file string   resource file from which to update the aks cluster
  -h, --help          help for update

Example

To update an AKS cluster:
Fetch the resource file using the tanzu aks-cluster get command.
Update the required fields in the resource file.
Then run the tanzu aks-cluster update command using the updated resource file.

upgrade

Upgrade an AKS cluster

Usage

  tanzu aks-cluster upgrade CLUSTER_NAME VERSION [flags]

Flags

  -c, --credential-name string   Credential name of the aks cluster
  -h, --help                     help for upgrade
  -r, --resource-group string    resource group name of the aks cluster
  -s, --subscription-id string   subscription id of the aks cluster

Example

To upgrade an AKS cluster named test-aks with credential name cred-aks, subscription sub-id, and resource group test-aks-rg:

tanzu mission-control aks-cluster upgrade test-aks -c cred-aks -s sub-id -r test-aks-rg

nodepool

Group of nodes within an AKS cluster with the same configuration.

Usage

  tanzu mission-control aks-cluster nodepool [command]

Commands

  create      Create a nodepool object
  delete      Delete a nodepool
  get         Get details from a nodepool
  list        Return a list of nodepools
  template    Nodepool template
  update      Update (overwrite) an aks cluster nodepool

create

Create a nodepool object.

Usage

tanzu mission-control aks-cluster nodepool create [flags]

Flags

  -v, --data-values-file string   data values file to use
      --dry-run                   create the data model only, do not apply to server
  -f, --file string               configuration file from which to create a nodepool
  -h, --help                      help for create
  -t, --template string           template to use (default "default")

Example

To use the default template for creating a nodepool for an AKS cluster and update values:

1) First, use the following command to get all default template data values

tanzu tmc aks-cluster nodepool template get default -o sample

2) Place sample values in a file and make the required changes:

**test-nodepool.values** :
  SubscriptionId: <azure-subscription-UUID>
  CredentialName: <tmc-credentials-name>
  ResourceGroup: <azure-resource-group>
  AksClusterName: test-aks
  Name: test-nodepool
  Labels: env:staging
  Description: Test nodepool

3) Run the following command and provide the path to your nodepool values file:

  tanzu mission-control aks-cluster nodepool create --template default --data-values-file test-nodepool.values

delete

Delete a nodepool.

Usage

  tanzu mission-control aks-cluster nodepool delete <nodepool-name> [flags]

Flags

      --cluster-name string      name of the cluster
  -c, --credential-name string   name of the credential
  -h, --help                     help for delete
  -r, --resource-group string    resource group name of the aks cluster
  -s, --subscription-id string   subscription id of the aks cluster

Example

To delete a nodepool named test-nodepool for the test-aks AKS cluster with credential name cred-aks, subscription sub-id, and resource group test-aks-rg:

tanzu mission-control aks-cluster delete test-nodepool --cluster-name test-aks -c cred-aks -s sub-id -r test-aks-rg

get

Get details from a nodepool.

Usage

tanzu mission-control aks-cluster nodepool get <nodepool-name> [flags]

Flags

      --cluster-name string      name of the aks cluster
  -c, --credential-name string   name of the specified credential
  -h, --help                     help for get
  -o, --output string            output format (yaml | json) (default "yaml")
  -r, --resource-group string    resource group name of the aks cluster
  -s, --subscription-id string   subscription id of the aks cluster

Example

To get the contents of the test-nodepool for the test-aks AKS cluster with credential name cred-aks, subscription sub-id and resource group test-aks-rg in YAML format:

tanzu mission-control aks-cluster get test-aks --cluster-name test-aks -c cred-aks -s sub-id -r test-aks-rg -o yaml

list

Return a list of nodepools.

Usage

  tanzu mission-control aks-cluster nodepool list [flags]

Flags

      --cluster-name string      scope search to the specified aks cluster name
  -c, --credential-name string   scope search to the specified credential name
  -h, --help                     help for list
      --max-size uint            number of records to return
      --name string              scope search to the specified nodepool name
      --offset uint              offset at which to start returning records
  -o, --output string            output format (yaml|json)
  -r, --resource-group string    resource group name of the aks cluster
  -s, --subscription-id string   subscription id of the aks cluster

template

Nodepool template.

Usage

  tanzu mission-control aks-cluster nodepool template [command]

Commands

  get         Get Template for nodepool
  list        List Templates for nodepool

template get

Get template for nodepool

Usage

  tanzu mission-control aks-cluster nodepool template get TEMPLATE_NAME [flags]

Flags

  -o, --output string       template and data-values output format (yaml|table|sample) (default "yaml")

template list

List templates for nodepool

Usage

  tanzu mission-control aks-cluster template list

update

Update (overwrite) an AKS cluster nodepool.

Usage

  tanzu mission-control aks-cluster nodepool update [flags]

Flags

  -f, --file string   config file from which to update the nodepool

Example

To update an AKS cluster nodepool:
Fetch the resource file using the tanzu mission-control aks-cluster nodepool get command.
Update the required fields in the resource file.
Then run the tanzu mission-control aks-cluster nodepool update command using the updated resource file.

check-circle-line exclamation-circle-line close-line
Scroll to top icon