uninstall

Name

olm:uninstall

Synopsis

/olm:uninstall <operator-name> [namespace] [--remove-crds] [--remove-namespace]

Description

The olm:uninstall command uninstalls a day-2 operator from an OpenShift cluster by removing its Subscription, ClusterServiceVersion (CSV), and optionally its Custom Resource Definitions (CRDs) and namespace.

This command provides a comprehensive uninstallation workflow:

• Removes the operator's Subscription
• Deletes the ClusterServiceVersion (CSV)
• Optionally removes operator-managed deployments
• Optionally deletes Custom Resource Definitions (CRDs)
• Optionally removes the operator's namespace
• Provides detailed feedback on each step

The command is designed to safely clean up operators installed via OLM, with optional flags for thorough cleanup of all operator-related resources.

Implementation

The command performs the following steps:

1. Parse Arguments:

   • $1: Operator name (required) - The name of the operator to uninstall
   • $2: Namespace (optional) - The namespace where operator is installed. If not provided, defaults to {operator-name}-operator
   • $3+: Flags (optional):
     • --remove-crds: Remove Custom Resource Definitions after uninstalling
     • --remove-namespace: Remove the operator's namespace after cleanup
     • --force: Skip confirmation prompts

2. Prerequisites Check:

   • Verify oc CLI is installed: which oc
   • Verify cluster access: oc whoami
   • Check if user has cluster-admin or sufficient privileges

3. Verify Operator Installation:

   • Check if namespace exists:

     oc get namespace {namespace} --ignore-not-found
     

   • Check if subscription exists:

     oc get subscription {operator-name} -n {namespace} --ignore-not-found
     

   • If not found, display error: "Operator {operator-name} is not installed in namespace {namespace}"
   • List what will be uninstalled

4. Display Uninstallation Plan:

   • Show operator details:

     oc get subscription {operator-name} -n {namespace} -o yaml
     oc get csv -n {namespace}
     

   • Display what will be removed:
     • Subscription name and namespace
     • CSV name and version
     • Deployments (if any)
     • CRDs (if --remove-crds flag is set)
     • Namespace (if --remove-namespace flag is set)