Archive an OpenShift Container Platform cluster from OpenShift Cluster Manager

In OpenShift Cluster Manager, you can archive an OpenShift Container Platform cluster to remove it from subscription management and from your cluster list.

Before you begin
Copy link

  • A Red Hat login
  • An OpenShift Container Platform cluster
  • The Cluster Owner or Cluster Editor role on the cluster, or Organization Administrator privileges in your Red Hat account

About this task
Copy link

You can't delete an OpenShift Container Platform cluster from your infrastructure by using OpenShift Cluster Manager. You can only archive one.

Note

To fully delete an OpenShift Container Platform cluster, follow the uninstall instructions for your platform, starting from Installation overview.

Procedure
Copy link

  1. On the Clusters page, click the name of the cluster you want to archive.
    The cluster Overview tab opens.
  2. From the Actions menu, select Archive cluster.
  3. Click Archive cluster to confirm.

Results
Copy link

Your cluster no longer displays on the Cluster List tab. You can view it, along with all other archived clusters, on the Cluster Archives page.

Note

To restore an archived cluster, click Unarchive next to it on the Cluster Archives page, then confirm. It displays on the Cluster List tab again.

Delete an OpenShift Dedicated cluster from OpenShift Cluster Manager
Copy link

You can permanently delete OpenShift Dedicated clusters using OpenShift Cluster Manager. This action cannot be undone.

Before you begin
Copy link

  • You must have a Red Hat login.
  • You must have an OpenShift Dedicated cluster.
  • You must have the Cluster Owner or Cluster Editor role, or Organization Administrator privileges in your Red Hat account.

Procedure
Copy link

  1. In OpenShift Cluster Manager, select the cluster that you want to delete.
  2. Open the Options menu, then click Delete cluster to open the Delete cluster dialog.
    Warning

    This action cannot be undone. It uninstalls the cluster, and all data is deleted.
  3. In the Delete cluster dialog, enter the cluster name to confirm, and then click Delete.

Results
Copy link

  • Your cluster shows Uninstalling in the Status column on the Clusters page.
  • While the cluster deletion is in progress, you can view Uninstallation logs by opening the cluster details Overview page.

When the deletion is complete, your cluster no longer displays in the Clusters list in OpenShift Cluster Manager.

To view your deleted clusters, open the Options menu on the Clusters list, then click View cluster archives.

Delete a Red Hat OpenShift Service on AWS cluster from OpenShift Cluster Manager
Copy link

In OpenShift Cluster Manager, you can permanently delete Red Hat OpenShift Service on AWS clusters.

Before you begin
Copy link

  • A Red Hat login
  • A Red Hat OpenShift Service on AWS cluster
  • The Cluster Owner or Cluster Editor role on the cluster, or Organization Administrator privileges in your Red Hat account

Procedure
Copy link

  1. On the Clusters page, click the name of the cluster you want to delete.
    The cluster Overview tab opens.
  2. From the Actions menu, select Delete cluster.
    Warning

    You can't undo this action. It uninstalls the cluster and deletes all of its data.
  3. In the Delete cluster dialog, enter the cluster name, and then click Delete.

Results
Copy link

Your cluster's status changes to Uninstalling on the Cluster List tab. While deletion runs, the uninstallation log displays on the cluster's Overview tab. When deletion completes, the cluster no longer displays on the Cluster List tab.

To view your deleted clusters, click View cluster archives on the Clusters page.

View archived and deleted clusters
Copy link

On the Cluster Archives page in OpenShift Cluster Manager, you can view all archived and deleted clusters in your organization.

Before you begin
Copy link

  • A Red Hat login

About this task
Copy link

In OpenShift Cluster Manager, you can delete managed clusters, such as OpenShift Dedicated and Red Hat OpenShift Service on AWS clusters. You can only archive OpenShift Container Platform clusters, which removes them from your cluster list and from subscription management.

Procedure
Copy link

On the Clusters page, click View cluster archives.
Note

To restore an archived OpenShift Container Platform cluster, click Unarchive next to it, and then confirm. It displays on the Cluster List tab again.

Delete a cluster by using the ocm-cli tool
Copy link

You can delete managed clusters, such as OpenShift Dedicated clusters, by using the ocm-cli tool.

Before you begin
Copy link

Procedure
Copy link

  1. Log in to OpenShift Cluster Manager with your offline access token: 
    $ ocm login --token=<offline_access_token>

    The ocm-cli tool uses your token to request OpenID access and refresh tokens from sso.redhat.com, and then saves them to the .ocm.json file in your home directory for future use.

  2. Delete the cluster by using its ID:
    Warning

    This command deletes the cluster and all virtual machines, disks, and other resources it uses.

     
    $ ocm delete cluster <cluster_id>

Results
Copy link

Cluster deletion runs asynchronously and takes some time to complete. To check the cluster status, run the following command:

$ ocm list cluster <cluster_id>

When deletion completes, the command no longer returns any information about the cluster.