Deleting Operators from a cluster

The following describes how to delete Operators that were previously installed using Operator Lifecycle Manager (OLM) on your OKD cluster.

Deleting Operators from a cluster using the web console

Cluster administrators can delete installed Operators from a selected namespace by using the web console.

Prerequisites

  • Access to an OKD cluster web console using an account with cluster-admin permissions.

Procedure

  1. From the Operators → Installed Operators page, scroll or type a keyword into the Filter by name to find the Operator you want. Then, click on it.

  2. On the right-hand side of the Operator Details page, select Uninstall Operator from the Actions drop-down menu.

    An Uninstall Operator? dialog box is displayed, reminding you that:

    Removing the Operator will not remove any of its custom resource definitions or managed resources. If your Operator has deployed applications on the cluster or configured off-cluster resources, these will continue to run and need to be cleaned up manually.

    This action removes the Operator as well as the Operator deployments and pods, if any. Any Operands, and resources managed by the Operator, including CRDs and CRs, are not removed. The web console enables dashboards and navigation items for some Operators. To remove these after uninstalling the Operator, you might need to manually delete the Operator CRDs.

  3. Select Uninstall. This Operator stops running and no longer receives updates.

Deleting Operators from a cluster using the CLI

Cluster administrators can delete installed Operators from a selected namespace by using the CLI.

Prerequisites

  • Access to an OKD cluster using an account with cluster-admin permissions.

  • oc command installed on workstation.

Procedure

  1. Check the current version of the subscribed Operator (for example, jaeger) in the currentCSV field:

    1. $ oc get subscription jaeger -n openshift-operators -o yaml | grep currentCSV

    Example output

    1.   currentCSV: jaeger-operator.v1.8.2

  2. Delete the subscription (for example, jaeger):

    1. $ oc delete subscription jaeger -n openshift-operators

    Example output

    1. subscription.operators.coreos.com "jaeger" deleted

  3. Delete the CSV for the Operator in the target namespace using the currentCSV value from the previous step:

    1. $ oc delete clusterserviceversion jaeger-operator.v1.8.2 -n openshift-operators

    Example output

    1. clusterserviceversion.operators.coreos.com "jaeger-operator.v1.8.2" deleted

Refreshing failing subscriptions

In Operator Lifecycle Manager (OLM), if you subscribe to an Operator that references images that are not accessible on your network, you can find jobs in the openshift-marketplace namespace that are failing with the following errors:

Example output

  1. ImagePullBackOff for
  2. Back-off pulling image "example.com/openshift4/ose-elasticsearch-operator-bundle@sha256:6d2587129c846ec28d384540322b40b05833e7e00b25cca584e004af9a1d292e"

Example output

  1. rpc error: code = Unknown desc = error pinging docker registry example.com: Get "https://example.com/v2/": dial tcp: lookup example.com on 10.0.0.1:53: no such host

As a result, the subscription is stuck in this failing state and the Operator is unable to install or upgrade.

You can refresh a failing subscription by deleting the subscription, cluster service version (CSV), and other related objects. After recreating the subscription, OLM then reinstalls the correct version of the Operator.

Prerequisites

  • You have a failing subscription that is unable to pull an inaccessible bundle image.

  • You have confirmed that the correct bundle image is accessible.

Procedure

  1. Get the names of the Subscription and ClusterServiceVersion objects from the namespace where the Operator is installed:

    1. $ oc get sub,csv -n <namespace>

    Example output

    1. NAME                                                       PACKAGE                  SOURCE             CHANNEL
    2. subscription.operators.coreos.com/elasticsearch-operator   elasticsearch-operator   redhat-operators   5.0
    4. NAME                                                                         DISPLAY                            VERSION    REPLACES   PHASE
    5. clusterserviceversion.operators.coreos.com/elasticsearch-operator.5.0.0-65   OpenShift Elasticsearch Operator   5.0.0-65              Succeeded

  2. Delete the subscription:

    1. $ oc delete subscription <subscription_name> -n <namespace>

  3. Delete the cluster service version:

    1. $ oc delete csv <csv_name> -n <namespace>

  4. Get the names of any failing jobs and related config maps in the openshift-marketplace namespace:

    1. $ oc get job,configmap -n openshift-marketplace

    Example output

    1. NAME                                                                        COMPLETIONS   DURATION   AGE
    2. job.batch/1de9443b6324e629ddf31fed0a853a121275806170e34c926d69e53a7fcbccb   1/1           26s        9m30s
    4. NAME                                                                        DATA   AGE
    5. configmap/1de9443b6324e629ddf31fed0a853a121275806170e34c926d69e53a7fcbccb   3      9m30s

  5. Delete the job:

    1. $ oc delete job <job_name> -n openshift-marketplace

    This ensures pods that try to pull the inaccessible image are not recreated.

  6. Delete the config map:

    1. $ oc delete configmap <configmap_name> -n openshift-marketplace

  7. Reinstall the Operator using OperatorHub in the web console.

Verification

  • Check that the Operator has been reinstalled successfully:

    1. $ oc get sub,csv,installplan -n <namespace>