diagnose

Name

olm:diagnose

Synopsis

/olm:diagnose [operator-name] [namespace] [--fix] [--cluster]

Description

The olm:diagnose command diagnoses common OLM and operator issues, including orphaned CRDs, stuck namespaces, failed installations, and catalog source problems. It can optionally attempt to fix detected issues automatically.

This command helps you:

• Detect and clean up orphaned CRDs from deleted operators
• Fix namespaces stuck in Terminating state
• Identify and resolve failed operator installations
• Detect conflicting OperatorGroups
• Check catalog source health
• Identify resources preventing clean uninstallation
• Generate comprehensive troubleshooting reports

Implementation

The command performs the following steps:

1. Parse Arguments:

   • $1: Operator name (optional) - Specific operator to diagnose
   • $2: Namespace (optional) - Specific namespace to check
   • $3+: Flags (optional):
     • --fix: Automatically attempt to fix detected issues (requires confirmation)
     • --cluster: Run cluster-wide diagnostics (catalog sources, global CRDs, etc.)

2. Prerequisites Check:

   • Verify oc CLI is installed: which oc
   • Verify cluster access: oc whoami
   • Check if user has cluster-admin or sufficient privileges
   • Warn if running without --fix flag (dry-run mode)

3. Determine Scope:

   • Operator-specific: If operator name provided, focus on that operator
   • Namespace-specific: If namespace provided, check all operators in that namespace
   • Cluster-wide: If --cluster flag or no arguments, check entire cluster

4. Scan for Orphaned CRDs:

   • Get all CRDs in the cluster:

     oc get crd -o json
     

   • For each CRD, check if there's a corresponding operator:
     • Look for CSVs that own this CRD
     • Look for active Subscriptions related to this CRD
   • Identify orphaned CRDs (no owning operator found):

     # Find CRDs without active operators
     # This is a simplified check - actual implementation should verify operator ownership
     oc get crd -o json | jq -r '.items[] | 
       select(.metadata.annotations["operators.coreos.com/owner"] // "" | length == 0) | 
       .metadata.name'
     

   • Check if CRs exist for orphaned CRDs:

     oc get <crd-kind> --all-namespaces --ignore-not-found
     

   • Report findings:

     ⚠️  Orphaned CRDs Detected
     
     The following CRDs have no active operator:
     - certificates.cert-manager.io (3 CR instances in 2 namespaces)
     - issuers.cert-manager.io (5 CR instances in 3 namespaces)
     
     These CRDs may be leftovers from uninstalled operators.
     
     [If --fix flag:]
     Do you want to delete these CRDs and their CRs? (yes/no)
     WARNING: This will delete all custom resources of these types!