This section details useful commands you can reference during Kubernetes Cluster Management in vcd cse
.
Tenant organization administrators and tenant users use the
vcd cse
commands to perform the following actions:
- List templates
- Get VMware Cloud Director Container Service Extension server status
- Create, list, info, delete clusters and nodes
To view templates, and manage clusters and nodes, the following table details the summary of commands available.
Command | Description | Native | TKG |
---|---|---|---|
vcd cse template list |
List templates that a Kubernetes cluster can be deployed from. | Yes | Yes |
vcd cse cluster apply CLUSTER_CONFIG.YAML |
Create or update a Kubernetes cluster. | Yes | Yes |
vcd cse cluster list |
List available Kubernetes clusters. | Yes | Yes |
vcd cse cluster info CLUSTER_NAME |
Retrieve detailed information of a Kubernetes cluster. | Yes | Yes |
vcd cse cluster config CLUSTER_NAME |
Retrieve the kubectl configuration file of the Kubernetes cluster. | Yes | Yes |
vcd cse cluster delete CLUSTER_NAME |
Delete a Kubernetes cluster. | Yes | Yes |
vcd cse cluster delete CLUSTER_NAME --force |
Delete a Kubernetes cluster even if they are in an unrecoverable state. | Yes | Yes |
vcd cse cluster upgrade-plan CLUSTER_NAME |
Retrieve the allowed path for upgrading Kubernetes software on the custer. | Yes | No |
vcd cse cluster upgrade CLUSTER_NAME TEMPLATE_NAME TEMPLATE_REVISION |
Upgrade cluster software to specified template’s software versions. | Yes | No |
vcd cse cluster delete-nfs CLUSTER_NAME NFS_NODE_NAME |
Delete NFS node of a given Kubernetes cluster | Yes | No |
vcd cse cluster share --name CLUSTER_NAME --acl FullControl USER1 |
Share cluster mycluster with FullControl access with user1 |
Yes | No |
vcd cse cluster share-list --name CLUSTER_NAME |
View the acl info for a cluster. | Yes | No |
vcd cse cluster unshare --name CLUSTER_NAME USER1 |
Unshare the cluster with the user1 . |
Yes | No |
Command | Description |
---|---|
vcd cse template list |
List templates that a Kubernetes cluster can be deployed from. |
vcd cse cluster create CLUSTER_NAME |
Create a new Kubernetes cluster. |
vcd cse cluster create CLUSTER_NAME --enable-nfs |
Create a new Kubernetes cluster with NFS Persistent Volume support. |
vcd cse cluster list |
List available Kubernetes clusters. |
vcd cse cluster info CLUSTER_NAME |
Retrieve detailed information of a Kubernetes cluster. |
vcd cse cluster resize CLUSTER_NAME |
Grow a Kubernetes cluster by adding new nodes. |
vcd cse cluster config CLUSTER_NAME |
Retrieve the kubectl configuration file of the Kubernetes cluster. |
vcd cse cluster upgrade-plan CLUSTER_NAME |
Retrieve the allowed path for upgrading Kubernetes software on the custer. |
vcd cse cluster upgrade CLUSTER_NAME TEMPLATE_NAME TEMPLATE_REVISION |
Upgrade cluster software to specified template’s software versions. |
vcd cse cluster delete CLUSTER_NAME |
Delete a Kubernetes cluster. |
vcd cse node create CLUSTER_NAME --nodes n |
Add n nodes to a Kubernetes cluster. |
vcd cse node create CLUSTER_NAME --nodes n --enable-nfs |
Add an NFS node to a Kubernetes cluster. |
vcd cse node list CLUSTER_NAME |
List nodes of a cluster. |
vcd cse node info CLUSTER_NAME NODE_NAME |
Retrieve detailed information of a node in a Kubernetes cluster. |
vcd cse node delete CLUSTER_NAME NODE_NAME |
Delete nodes from a cluster. |
vcd cse node list CLUSTER_NAME |
List nodes of a cluster. |
vcd cse node info CLUSTER_NAME NODE_NAME |
Retrieve detailed information of a node in a Kubernetes cluster. |
vcd cse node delete CLUSTER_NAME NODE_NAME |
Delete nodes from a cluster. |
Cluster share
Command
This section details how to use the vcd cse cluster share
command with native clusters. Sharing native clusters share both the corresponding RDE and the backing vApp with the other users.
Command usage examples:
# Share cluster 'mycluster' with FullControl access with 'user1' and 'user2' vcd cse cluster share --name mycluster --acl FullControl user1 user2 # View the acl info for a cluster; for each user the cluster is shared with, # the user's access level, member id, and user name are listed. vcd cse cluster share-list --name cluster1 # Unshare the cluster with a given user. vcd cse cluster unshare --name CLUSTER_NAME USER1