Page last updated:
Warning: Pivotal Container Service (PKS)
v1.5 is no longer supported because it has reached the End
of General Support (EOGS) phase as defined by the
Support Lifecycle Policy.
To stay up to date with the latest software and security updates, upgrade to a supported version.
This topic describes how to delete a Kubernetes cluster deployed by Enterprise Pivotal Container Service (Enterprise PKS). Running the
pks delete-cluster command automatically deletes all cluster objects.
If you are using Enterprise PKS with NSX-T, see vSphere with NSX-T Cluster Objects for a list of vSphere and NSX-T objects that will be deleted as part of the cluster deletion process.
Follow the steps below to delete a cluster using the PKS CLI.
On the command line, run the following command to log in to Enterprise PKS:
pks login -a PKS-API -u USERNAME -kWhere:
PKS-APIis the domain name for the PKS API that you entered in Ops Manager > Enterprise PKS > PKS API > API Hostname (FQDN). For example,
USERNAMEis your user name.
See Logging in to Enterprise PKS for more information about the
Note: If your operator has configured Enterprise PKS to use a SAML identity provider, you must include an additional SSO flag to use the above command. For information about the SSO flags, see the section for the above command in PKS CLI. For information about configuring SAML, see Connecting Enterprise PKS to a SAML Identity Provider
pks delete-cluster CLUSTER-NAMEto delete a cluster. Replace
CLUSTER-NAMEwith the unique name for your cluster. For example:
$ pks delete-cluster my-cluster
Confirm cluster deletion by entering
y, or cancel cluster deletion by entering
Are you sure you want to delete cluster my-cluster? (y/n)
Follow the steps below to verify cluster deletion using the PKS CLI.
To verify cluster deletion, run
pks cluster CLUSTER-NAME. Replace
CLUSTER-NAMEwith the unique name for your cluster.
$ pks cluster my-cluster Name: my-cluster Plan Name: small UUID: 106aabc7-5ecb-4c54-a800-a32eef57a593 Last Action: DELETE Last Action State: in progress Last Action Description: Instance deletion in progress Kubernetes Master Host: my-cluster.pks.local Kubernetes Master Port: 8443 Worker Nodes: 3 Kubernetes Master IP(s): 10.196.219.88 Network Profile Name:While Enterprise PKS is deleting the cluster, the value for
Last Action Descriptionis
Instance deletion in progress.
Continue running the
pks cluster CLUSTER-NAMEcommand to track cluster deletion. The cluster is deleted when the CLI returns
Error: Cluster CLUSTER-NAME not found.
pks clusters. The cluster you deleted should not appear in the list of Enterprise PKS clusters.
Note: If the cluster is not deleted, see Cluster Deletion Fails in Troubleshooting.
If you do not want the PKS CLI to prompt you to confirm cluster deletion, use the
$ pks delete-cluster my-cluster --non-interactive
Note: If you use the
--non-interactive flag to delete multiple clusters, delete each cluster one by one. Do not create a script that deletes multiple clusters using the
--non-interactive flag. If you do, the BOSH Director may hang and become unusable until you log in to BOSH and cancel each deletion task.
Please send any feedback you have to firstname.lastname@example.org.