status

Name

olm:status

Synopsis

/olm:status <operator-name> [namespace]

Description

The olm:status command provides comprehensive health and status information for a specific operator in an OpenShift cluster. It displays detailed information about the operator's CSV, Subscription, InstallPlan, deployments, and pods to help diagnose issues and verify proper operation.

This command helps you:

• Check if an operator is running correctly
• Diagnose installation or upgrade problems
• View operator version and available updates
• Inspect operator deployments and pods
• Review recent events and conditions
• Identify resource issues or configuration problems

Implementation

The command performs the following steps:

1. Parse Arguments:

   • $1: Operator name (required) - Name of the operator to inspect
   • $2: Namespace (optional) - Namespace where operator is installed
     • If not provided, searches for the operator across all namespaces
     • If multiple instances found, prompts user to specify namespace

2. Prerequisites Check:

   • Verify oc CLI is installed: which oc
   • Verify cluster access: oc whoami
   • If not installed or not authenticated, provide clear instructions

3. Locate Operator:

   • If namespace provided, verify operator exists in that namespace:

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

   • If no namespace provided, search across all namespaces:

     oc get subscription --all-namespaces -o json | jq -r '.items[] | select(.spec.name=="{operator-name}") | .metadata.namespace'
     

   • If not found, display error with suggestions
   • If multiple instances found, list them and ask user to specify namespace

4. Gather Subscription Information:

   • Get Subscription details:

     oc get subscription {operator-name} -n {namespace} -o json
     

   • Extract:
     • Channel: .spec.channel
     • Install Plan Approval: .spec.installPlanApproval
     • Source: .spec.source
     • Source Namespace: .spec.sourceNamespace
     • Installed CSV: .status.installedCSV
     • Current CSV: .status.currentCSV
     • State: .status.state
     • Conditions: .status.conditions[]