list

Name

olm:list

Synopsis

/olm:list [namespace] [--all-namespaces]

Description

The olm:list command lists all installed operators in an OpenShift cluster, showing their status, version, and namespace. This command provides a quick overview of the operator landscape in your cluster.

This command helps you:

• Discover what operators are currently installed
• Check operator versions and status at a glance
• Identify operators that may need attention (failed, upgrading, etc.)
• Get a comprehensive view across namespaces

The command presents information in an easy-to-read table format with key details about each operator's ClusterServiceVersion (CSV) and Subscription.

Implementation

The command performs the following steps:

1. Parse Arguments:

   • $1: Namespace (optional) - Target namespace to list operators from
   • $2: Flag (optional):
     • --all-namespaces or -A: List operators across all namespaces (default behavior if no namespace specified)

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. Determine Scope:

   • If namespace is specified: List operators only in that namespace
   • If --all-namespaces flag or no arguments: List operators cluster-wide
   • Default behavior: Show all operators across all namespaces

4. Fetch Operator Data:

   • Get all ClusterServiceVersions (CSVs):

     # For specific namespace
     oc get csv -n {namespace} -o json
     
     # For all namespaces
     oc get csv --all-namespaces -o json
     

   • Get all Subscriptions:

     # For specific namespace
     oc get subscription -n {namespace} -o json
     
     # For all namespaces
     oc get subscription --all-namespaces -o json
     

5. Parse and Correlate Data:

   • For each CSV, extract:
     • Name: .metadata.name
     • Namespace: .metadata.namespace
     • Display Name: .spec.displayName
     • Version: .spec.version
     • Phase/Status: .status.phase (e.g., "Succeeded", "Installing", "Failed")
     • Install Time: .metadata.creationTimestamp
   • For each Subscription, extract:
     • Operator Name: .spec.name
     • Channel: .spec.channel
     • Source: .spec.source
     • Installed CSV: .status.installedCSV
     • Current CSV: .status.currentCSV
   • Correlate Subscriptions with CSVs to show complete operator information