Portworx MultiCluster Operator Details View
After you install the Portworx MultiCluster Operator, the Installed Operators page in the OpenShift console lists the Portworx Multi-Cluster Operator. Select the operator to open its details page, where you can view installation information and inspect or manage the disaster recovery custom resources that the operator provides.
The operator details page contains several tabs. The Details, YAML, Subscription, Events, and All instances tabs are standard Operator Lifecycle Manager (OLM) tabs that provide information about the operator. The Cluster, Disaster Recovery Action, Protection Group, and Disaster Recovery Pair tabs correspond to the custom resources managed by the operator and allow you to create, view, and manage instances of each resource.
note
Use the operator details page for advanced inspection and direct management of custom resources. For guided disaster recovery workflows, use the Portworx dashboards in the multicluster management view (All Clusters in OpenShift 4.18 and 4.19, or Fleet Management in OpenShift 4.20 and later). For more information, see Portworx ACM Dynamic Console Plugin Dashboards.
Access the operator details page
To access the operator details page, complete the following steps:
- Sign in to the OpenShift web console.
- From the left navigation pane, select Operators > Installed Operators.
The system displays the Installed Operators page that lists the installed operators. - From the Project dropdown, select the portworx project in which you installed the operator.
- Click the Portworx Multi-Cluster Operator item.
The system opens the operator details page with multiple tabs.
Operator details page attributes
The following table lists the tabs on the operator details page and the attributes that each tab displays.
| Attributes | Description |
|---|---|
| Details Tab | |
| Provided APIs | Displays the custom resource types that the operator provides: Cluster, Disaster Recovery Action, Protection Group, and Disaster Recovery Pair. Click Create instance under an API to create a custom resource of that type. |
| Provider | Displays the provider of the operator. |
| Created at | Displays the date and time when the operator was installed. |
| Console plugin | Displays whether the Portworx console plugin is enabled. The plugin adds the Portworx option and the disaster recovery dashboards to the OpenShift console. |
| Links | Displays the documentation and support links for the operator. |
| Maintainers | Displays the maintainer name and contact email for the operator. |
| Description | Displays an overview of the operator, including its features, prerequisites, and getting started steps. |
| ClusterServiceVersion details | Displays metadata about the installed operator version, including its name, namespace, labels, annotations, managed namespaces, creation time, and owner. It also displays the installation Status and status reason, the operator deployments, the operator service accounts, and the operator group. |
| Conditions | Displays a table of the operator lifecycle conditions, including the Phase, the time it was last Updated, the Reason, and a descriptive Message. |
| YAML Tab | |
| YAML editor | Displays the full ClusterServiceVersion manifest of the installed operator in an editor. You can view and edit the operator configuration, and then save, reload, cancel, or download the manifest. |
| Subscription Tab | |
| Update channel | Displays the channel from which the operator receives updates. |
| Update approval | Displays whether updates are applied automatically or require manual approval. |
| Upgrade status | Displays whether the operator is up to date, along with the number of installed and installing versions. |
| Name | Displays the name of the operator subscription. |
| Namespace | Displays the namespace where the subscription is created. |
| Labels | Displays the labels applied to the subscription. |
| Created at | Displays the date and time when the subscription was created. |
| Owner | Displays the owner of the subscription, if any. |
| Installed version | Displays the currently installed ClusterServiceVersion (CSV). |
| Starting version | Displays the version from which the operator started, if any. |
| CatalogSource | Displays the catalog source that provides the operator, along with its health status. |
| InstallPlan | Displays the install plan associated with the subscription. |
| Conditions | Displays a table of subscription conditions, including the Type, Status, last Updated time, Reason, and Message. |
| Events Tab | |
| Streaming events | Displays a real-time stream of events related to the operator and the resources it manages. |
| All instances Tab | |
| Name | Displays the name of the custom resource instance. Click the name to view the resource details. |
| Kind | Displays the kind of the custom resource instance, such as Cluster, DisasterRecoveryAction, ProtectionGroup, or DisasterRecoveryPair. |
| Status | Displays the status of the custom resource instance for a disaster recovery action. |
| Labels | Displays the labels applied to the custom resource instance. |
| Last updated | Displays the date and time when the custom resource instance was last updated. |
| Create new | Click Create new and select a resource type such as Cluster, Disaster Recovery Action, Protection Group, or Disaster Recovery Pair to create a new instance of that type. |
| Cluster Tab | |
| Name | Displays the name of the Cluster custom resource. Click the name to view the resource details. |
| Kind | Displays the resource kind, which is Cluster. |
| Status | Displays the status of the custom resource. |
| Labels | Displays the labels applied to the custom resource. |
| Last updated | Displays the date and time when the custom resource was last updated. |
| Create Cluster | Click Create Cluster to create a new Cluster custom resource. |
| Disaster Recovery Action Tab | |
| Name | Displays the name of the DisasterRecoveryAction custom resource. Click the name to view the resource details. |
| Kind | Displays the resource kind, which is DisasterRecoveryAction. |
| Status | Displays the status of the action, such as Successful or Failed. |
| Labels | Displays the labels applied to the custom resource. |
| Last updated | Displays the date and time when the custom resource was last updated. |
| Create DisasterRecoveryAction | Click Create DisasterRecoveryAction to create a new DisasterRecoveryAction custom resource. |
| Protection Group Tab | |
| Name | Displays the name of the ProtectionGroup custom resource. Click the name to view the resource details. |
| Kind | Displays the resource kind, which is ProtectionGroup. |
| Status | Displays the status of the custom resource. |
| Labels | Displays the labels applied to the custom resource. |
| Last updated | Displays the date and time when the custom resource was last updated. |
| Create ProtectionGroup | Click Create ProtectionGroup to create a new ProtectionGroup custom resource. |
| Disaster Recovery Pair Tab | |
| Name | Displays the name of the DisasterRecoveryPair custom resource. Click the name to view the resource details. |
| Kind | Displays the resource kind, which is DisasterRecoveryPair. |
| Status | Displays the status of the custom resource. |
| Labels | Displays the labels applied to the custom resource. |
| Last updated | Displays the date and time when the custom resource was last updated. |
| Create DisasterRecoveryPair | Click Create DisasterRecoveryPair to create a new DisasterRecoveryPair custom resource. |