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

ekscluster

The ekscluster is an organizational object that manages AWS EKS clusters.

Usage

tanzu mission-control ekscluster [command]

Commands

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

create

Create an EKS cluster.

Usage

tanzu mission-control ekscluster 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 workspace
  -t, --template string           template to use (default "default")

Example

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

1) Create a YAML file with the fields to be changed like this:

**test_values.yaml** :
  Name: test-eks
  Labels: env:staging
  Description: Test eks cluster

2) Run the following command and provide the path to your YAML file:

  tanzu mission-control ekscluster create --template default --data-values-file test_values.yaml

delete

Delete an EKS cluster.

Usage

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

Flags

  -c, --credential-name string   Credential name of the eks cluster
  -f, --force                    force delete an eks cluster
  -r, --region string            region of the eks cluster

Example

To delete an EKS cluster named test-eks with credential name cred-eks and region region-eks:

tanzu mission-control ekscluster delete test-eks -c cred-eks -r region-eks

get

Get an EKS cluster.

Usage

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

Flags

  -c, --credential-name string   credential name of the eks cluster
  -o, --output string            Output format (yaml | json) (default "yaml")
  -r, --region string            region of the eks cluster

Example

To get the contents of the test-eks eks cluster with credential name cred-eks and region region-eks in YAML format:

tanzu mission-control ekscluster get test-eks -c cred-eks -r region-eks -o yaml

list

List EKS clusters.

Usage

  tanzu mission-control ekscluster list [flags]

Flags

  -c, --credential-name string   scope search to the specified credential name
  --max-size uint                Number of records to return
  --name string                  scope search to the specified name (default "*")
  --offset uint                  Offset at which to start returning records
  -o, --output string            Output format (yaml|json)
  -r, --region string            scope search to the specified region

template

EKS cluster template.

Usage

  tanzu mission-control ekscluster template [command]

Commands

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

update

Update (overwrite) an EKS cluster.

Usage

  tanzu mission-control ekscluster update [flags]

Flags

  -f, --file string   resource file from which to update the eks cluster

Example

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

nodepool

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

Usage

  tanzu mission-control ekscluster nodepool [command]

Commands

  get         Get Template for eks cluster
  list        List Templates for eks cluster
  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 eks cluster nodepool

create

Create a nodepool object.

Usage

tanzu mission-control ekscluster 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
  -t, --template string           template to use (default "default")

Example

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

1) Create a YAML file with the fields to be changed like this:

**test_values.yaml** :
  Name: test-nodepool
  Labels: env:staging
  Description: Test nodepool

2) Run the following command and provide the path to your YAML file:

  tanzu mission-control ekscluster nodepool create --template default --data-values-file test_values.yaml

delete

Delete a nodepool.

Usage

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

Flags

      --cluster-name string      name of the cluster
  -c, --credential-name string   name of the credential
  -r, --region string            name of the region

Example

To delete a nodepool named test-nodepool for the test-eks EKS cluster with credential name cred-eks and region region-eks:

tanzu mission-control ekscluster delete test-nodepool --cluster-name test-eks -c cred-eks -r region-eks

get

Get details from a nodepool.

Usage

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

Flags

      --cluster-name string      name of the eks cluster
  -c, --credential-name string   name of the specified credential
  -o, --output string            output format (yaml | json) (default "yaml")
  -r, --region string            name of the specified region

Example

To get the contents of the test-nodepool for the test-eks EKS cluster with credential name cred-eks and region region-eks in YAML format:

tanzu mission-control ekscluster get test-eks --cluster-name test-eks -c cred-eks -r region-eks -o yaml

list

Return a list of nodepools.

Usage

  tanzu mission-control ekscluster nodepool list [flags]

Flags

      --cluster-name string      scope search to the specified eks cluster name
  -c, --credential-name string   scope search to the specified credential name
      --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, --region string            scope search to the specified region

template

Nodepool template.

Usage

  tanzu mission-control ekscluster nodepool template [command]

Commands

  get         Get Template for nodepool
  list        List Templates for nodepool

update

Update (overwrite) an EKS cluster nodepool.

Usage

  tanzu mission-control ekscluster nodepool update [flags]

Flags

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

Example

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

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