Viewing the operator custom resource status

Common custom resource status allows clients to interact with custom resources both manually and programmatically. A clear and standard set of custom resource status allows a static and single location for understanding the endpoints that the operator is managing. Inconsistent custom resource status creates confusion and needs extra development time to programmatically interact with custom resources.

About this task

Custom resource helps you to define and manage the resource types such as operator and operand configurations, databases, storage configurations, and more. Following methods are used for capturing the custom resource statuses:

Procedure

  1. To get the status of the Engineering Lifecycle Management instance
    • By using the Red Hat® OpenShift® Container Platform web console method
      1. Go to the namespace where Engineering Lifecycle Management is installed by using Home > Projects > Your Project Name
      2. Click Operators from the left page and select Operators > Installed Operators > Provided APIs > ELM
    • By using the CLI method
      1. By using the Red Hat OpenShift CLI method 
        oc get ELM <ELM_INSTANCE_NAME> -o custom-columns="Name:.metadata.name, Status:.status.conditions[?(@.status=='True')].type"
      2. By using the Kubernetes CLI method 
        kubectl get ELM <ELM_INSTANCE_NAME> -o custom-columns="Name:.metadata.name, Status:.status.conditions[?(@.status=='True')].type"

      The following table explains different custom resource statuses for Engineering Lifecycle Management instance:

      Condition type Status Scenario
      Progressing True ELM set up is in progress
      Progressing False -
      Upgradeable True Post ELM setup is successful, and a new version is available for upgrade
      Upgradeable False Current ELM available version is the latest
      Available True JTS setup is completed and ELM installation is successful
      Available False ELM installation is in progress or failed
      Degraded True Pr-requisites/creating Kubernetes resources/ ELMOperation failed with errors
      Degraded False -
  2. To get the status of the ELMOperation instance
    • By using the Red Hat OpenShift Container Platform web console method
      1. Go to the namespace where Engineering Lifecycle Management is installed by using Home > Projects > Your Project Name
      2. Click Operators from the left page and select Operators > Installed Operators > Provided APIs > ELMOperation
    • By using the CLI methods
      1. Red Hat OpenShift CLI 
        oc get ELMOperation <ELM_OPERATIONS_INSTANCE_NAME> -o custom-columns="Name:.metadata.name, Status:.status.conditions[?(@.status=='True')].type"
      2. Kubernetes CLI 
        kubectl get ELMOperation <ELM_OPERATIONS_INSTANCE_NAME> -o custom-columns="Name:.metadata.name, Status:.status.conditions[?(@.status=='True')].type"

      The following table explains different custom resource statuses for ELMOperation instance:

      Condition type Status Scenario
      Progressing True ELMOperation is in the execution phase and is incomplete or failed
      Progressing False -
      Successful True ELMOperation execution is completed successfully
      Successful False -
      Failed True ELMOperation execution failed with errors
      Failed False -
  3. To get the status of the Engineering Lifecycle Management Serviceability instance
    • By using the Red Hat OpenShift Container Platform web console method
      1. Go to the namespace where Engineering Lifecycle Management is installed by using Home > Projects > Your Project Name
      2. Click Operators from the left page and select Operators > Installed Operators > Provided APIs > Serviceability
    • By using the CLI methods
      1. Red Hat OpenShift CLI method 
        oc get ELMOperation <SERVICEABILITY_INSTANCE_NAME> -o custom-columns="Name:.metadata.name, Status:.status.conditions[?(@.status=='True')].type"
      2. Kubernetes CLI method 
        kubectl get ELMOperation <SERVICEABILITY_INSTANCE_NAME> -o custom-columns="Name:.metadata.name, Status:.status.conditions[?(@.status=='True')].type"

      The following table explains different custom resource statuses for Serviceability instance:

      Condition type Status Scenario
      Progressing True A Serviceability job creation is in progress
      Progressing False -
      Successful True A serviceability job is successfully created and gathering is completed
      Successful False -
      Failed True A Serviceability job creation failed with errors
      Failed False -