Validating installation

You can validate the WebSphere Automation installation and instance with Red Hat® OpenShift® CLI (oc) commands.

Before you begin

Set the environment variables for the WebSphere Automation operator and instance namespace. These values might be the same, or they might be different. For example, the default steps for installation in the Red Hat OpenShift console use the following namespaces:
WSA_OPERATOR_NAMESPACE=openshift-operators
WSA_INSTANCE_NAMESPACE=websphere-automation
  1. Log in to the Red Hat OpenShift cluster as a cluster administrator.
  2. Validate the WebSphere Automation installation.
  3. Validate the WebSphere Automation instance.

For more information about status conditions from validation of WebSphere Automation instance deployment, see Custom resource status conditions.

Validating the WebSphere Automation installation

To validate the WebSphere Automation operator installation, run oc commands that list information about the WebSphere Automation operator. Be sure that the WSA_OPERATOR_NAMESPACE environment variable is set.

  • Verify whether the operator subscription exists.
    oc -n $WSA_OPERATOR_NAMESPACE get subscription | grep websphere-automation

    When the operator subscription exists, the command output lists the operator subscription information.

    ibm-websphere-automation   ibm-websphere-automation   ibm-operator-catalog   v1.11.0
  • Verify the installation status of the operator.
    oc -n $WSA_OPERATOR_NAMESPACE get csv | grep websphere-automation

    The command output has Succeeded for a successful installation.

    ibm-websphere-automation.v1.11.0   IBM WebSphere Automation   1.11.0   Succeeded

Validating the WebSphere Automation instance

To validate the WebSphere Automation instance deployment, run oc commands that list the status of custom resources. Be sure to set the WSA_INSTANCE_NAMESPACE environment variable. For more information about status conditions, see Custom resource status conditions.

  • Check the status of the WebSphereAutomation custom resource.
    oc -n $WSA_INSTANCE_NAMESPACE describe websphereautomation

    Verify that all status conditions are True.

    status:
        conditions:
        - message: All prerequisites and installed components are ready
          status: "True"
          type: Ready
        - status: "True"
          type: OperandRequestReady
        - status: "True"
          type: PlatformUIReady
        - message: Network policies are ready
          status: "True"
          type: NetworkPoliciesReady
        - message: Kafka cluster is ready
          status: "True"
          type: KafkaReady
        - message: Kafka resources are ready
          status: "True"
          type: KafkaResourcesReady
        - message: Data store is ready
          status: "True"
          type: DataStoreReady
        - status: "True"
          type: ActivityRecordManagerReady
        - status: "True"
          type: WebSphereAutomationAPIsReady
        - status: "True"
          type: ZenExtensionsReady
        - message: All prerequisites and WebSphere Secure components are ready
          status: "True"
          type: WebSphereSecureReady
        - message: All prerequisites and WebSphere Health components are ready
          status: "True"
          type: WebSphereHealthReady
        - status: "True"
          type: RunbookManagerReady
        - message: All updates to WebSphereAutomation instance have been processed
          status: "True"
          type: Reconciled
  • Check the status of the WebSphereSecure custom resource.
    oc -n $WSA_INSTANCE_NAMESPACE describe webspheresecure

    Verify that all status conditions are True.

    status:
      conditions:
      - message: All prerequisites and WebSphere Secure components are ready
        status: "True"
        type: Ready
      - message: File store is ready
        status: "True"
        type: FileStoreReady
      - message: Kafka cluster is ready
        status: "True"
        type: KafkaReady
      - message: Data store is ready
        status: "True"
        type: DataStoreReady
      - message: Kafka resources are ready
        status: "True"
        type: KafkaResourcesReady
      - message: Dependencies are ready
        status: "True"
        type: DependenciesReady
      - status: "True"
        type: CVEMonitorReady
      - status: "True"
        type: ServerRegistrationProcessorReady
      - status: "True"
        type: VulnerabilityNotifierReady
      - status: "True"
        type: VulnerabilityManagerReady
      - status: "True"
        type: WebSphereSecureAPIsReady
      - status: "True"
        type: MeteringAPIsReadyd
  • If the health components are deployed, check the status of the WebSphereHealth custom resource.
    oc -n $WSA_INSTANCE_NAMESPACE describe webspherehealth

    Verify that all status conditions are True.

    status:
      conditions:
      - message: All prerequisites and WebSphere Health components are ready
        status: "True"
        type: Ready
      - message: File store is ready
        status: "True"
        type: FileStoreReady
      - message: Kafka cluster is ready
        status: "True"
        type: KafkaReady
      - message: Dependencies are ready
        status: "True"
        type: DependenciesReady
      - message: Data store is ready
        status: "True"
        type: DataStoreReady
      - message: Kafka resources are ready
        status: "True"
        type: KafkaResourcesReady
      - status: "True"
        type: InvestigationManagerReady
      - status: "True"
        type: AnalysisManagerReady
      - status: "True"
        type: WebSphereHealthAPIsReady
      - status: "True"
        type: WebhooksAPIsReady
      - status: "True"
        type: ZenExtensionsReady
      - message: All updates to WebSphereHealth instance have been processed
        status: "True"
        type: Reconciled
  • Check the status of the Cartridge, CartridgeRequirement, and AutomationBase custom resources.

Custom resource status conditions

The following table provides information about the status conditions from validation of WebSphere Automation instance deployment.

Table 1. Status conditions
Type Description
Ready

The overall status of the WebSphereAutomation, WebSphereHealth, or WebSphereSecure instance, reporting whether all prerequisite components and dependencies are ready.

If the status is False, check other components for errors.

WebSphereSecureReady

The overall status of the WebSphereSecure instance, reporting whether all prerequisite components are ready.

If the status is False, check the WebSphereSecure instance for errors.

WebSphereHealthReady

The overall status of the WebSphereHealth instance, reporting whether all prerequisite components are ready.

If the status is False, check the WebSphereHealth instance for errors.

KafkaReady

The status of the Kafka instance for event streaming.

If the status is False, check the status of the Kafka instance and IBM Events Stream operator logs.

KafkaResourcesReady

The status of whether the KafkaTopics and Kafka configuration are ready.

If the status is False, check the IBM Events Stream operator logs, KafkaTopic instances.

DataStoreReady

The status of the Mongo Database service for data storage.

If the status is False, check the Mongo StatefulSet pods and logs.

ActivityRecordManagerReady

The status of Activity Record Manager deployment for handing and organizing information records.

If the status is False, check the Activity Record Manager deployment pods and logs.

WebSphereAutomationAPIsReady

The status of the WebSphereAutomation Core APIs deployment and service.

If the status is False, check the APIs deployment pods and logs.

RunbookManagerReady

The status of Runbook Manager deployment for defining and managing Runbooks.

If the status is False, check the Runbook Manager deployment pods and logs.

FileStoreReady

The status of file storage for WebSphereSecure or WebSphereHealth.

If the status is False, check the Persistent Volume Claim for WebSphereSecure and WebSphereHealth instances.

DependenciesReady

The overall status of dependencies (Kafka, DataStore, Activity Record Manager, Runbook Manager, APIs, secrets, and configMaps).

If the status is False, check the status of dependencies.

CVEMonitorReady

The status of CronJob for Common Vulnerabilities and Exposures (CVEs) monitoring.

If the status is False, check the status of CronJob and Job instances.

ServerRegistrationProcessorReady

The status of Server Registration Processor deployment.

If the status is False, check the Server Registration Processor deployment pods and logs.

VulnerabilityNotifierReady

The status of Vulnerability Notifier deployment.

If the status is False, check the Vulnerability Notifier deployment pods and logs.

VulnerabilityManagerReady

The status of Vulnerability Manager deployment.

If the status is False, check the Vulnerability Manager deployment pods and logs.

WebSphereSecureAPIsReady

The status of WebSphereSecure APIs deployment and service.

If the status is False, check the WebSphereSecure APIs deployment pods and logs.

MeteringAPIsReady

The status of Metering API tokens and deployments for usage metrics.

If the status is False, check the Metering APIs deployment pods and logs.

WebSphereSecureUIReady

The status of WebSphereSecure UI deployments, translation package, roles and permissions setup, and extensions.

If the status is False, check the UI deployment pods and logs.

FixManagerReady

The status of Fix Manager deployment for accessing fixes and updates.

If the status is False, check the Fix Manager deployment pods and logs.

InstallationManagerReady

The status of Installation Manager deployment for installing fixes and updates.

If the status is False, check the Installation Manager deployment pods and logs.

AnalysisManagerReady

The status of Analysis Manager deployment for analyzing server health information.

If the status is False, check the Analysis Manager deployment pods and logs.

InvestigationManagerReady

The status of Investigation Manager deployment for investigating server health issues.

If the status is False, check the Investigation Manager deployment pods and logs.

WebSphereHealthAPIsReady

The status of WebSphereHealth APIs deployment and service.

If the status is False, check the deployment pods and logs.

WebhooksAPIsReady

The status of Webhooks APIs deployment and service.

If the status is False, check the Webhooks APIs deployment pods and logs.

Reconciled

The overall status of the reconciliation process. Errors from configuration validation of the WebSphere Automation custom resources or from operational errors that are encountered by the WebSphere Automation operator are reported in this status.

If the status is False, check the reconcile message and WebSphere Automation operator logs.