×

You can remove a cluster that you deployed to IBM Cloud.

Removing a cluster that uses installer-provisioned infrastructure

You can remove a cluster that uses installer-provisioned infrastructure from your cloud.

After uninstallation, check your cloud provider for any resources not removed properly, especially with User Provisioned Infrastructure (UPI) clusters. There might be resources that the installer did not create or that the installer is unable to access.

Prerequisites
  • Have a copy of the installation program that you used to deploy the cluster.

  • Have the files that the installation program generated when you created your cluster.

  • You have configured the ccoctl binary.

  • You have installed the IBM Cloud CLI and installed or updated the VPC infrastructure service plug-in. For more information see "Prerequisites" in the IBM Cloud VPC CLI documentation.

Procedure
  1. If the following conditions are met, this step is required:

    • The installer created a resource group as part of the installation process.

    • You or one of your applications created persistent volume claims (PVCs) after the cluster was deployed.

    In which case, the PVCs are not removed when uninstalling the cluster, which might prevent the resource group from being successfully removed. To prevent a failure:

    1. Log in to the IBM Cloud using the CLI.

    2. To list the PVCs, run the following command:

      $ ibmcloud is volumes --resource-group-name <infrastructure_id>

      For more information about listing volumes, see the IBM Cloud VPC CLI documentation.

    3. To delete the PVCs, run the following command:

      $ ibmcloud is volume-delete --force <volume_id>

      For more information about deleting volumes, see the IBM Cloud VPC CLI documentation.

  2. Export the IBM Cloud API key that was created as part of the installation process.

    $ export IC_API_KEY=<api_key>

    You must set the variable name exactly as specified. The installation program expects the variable name to be present to remove the service IDs that were created when the cluster was installed.

  3. From the directory that contains the installation program on the computer that you used to install the cluster, run the following command:

    $ ./openshift-install destroy cluster \
    --dir <installation_directory> --log-level info  (1) (2)
    1 For <installation_directory>, specify the path to the directory that you stored the installation files in.
    2 To view different details, specify warn, debug, or error instead of info.

    You must specify the directory that contains the cluster definition files for your cluster. The installation program requires the metadata.json file in this directory to delete the cluster.

  4. Remove the manual CCO credentials that were created for the cluster:

    $ ccoctl ibmcloud delete-service-id \
        --credentials-requests-dir <path_to_credential_requests_directory> \
        --name <cluster_name>

    If your cluster uses Technology Preview features that are enabled by the TechPreviewNoUpgrade feature set, you must include the --enable-tech-preview parameter.

  5. Optional: Delete the <installation_directory> directory and the OKD installation program.