-
Feature
-
Resolution: Unresolved
-
Critical
-
None
-
None
-
None
Goal Summary
This feature will enhance the `oc get SecuredCluster` and `oc get SecuredCluster -o wide` commands by adding key status fields directly to the output. This will allow administrators to quickly and efficiently assess the health and status of their RHACS SecuredCluster deployments, reducing the need for multiple commands and speeding up troubleshooting.
$ oc get securedcluster -A NAMESPACE NAME AGE stackrox stackrox-secured-cluster-services 6d22h
Goals and Expected User Outcomes
The primary user, a DevOps Engineer or Site Reliability Engineer (SRE), will now be able to view critical information about the SecuredCluster instance directly from the oc get securedcluster command. This expands the existing functionality by enriching the output of this core oc command, bringing it in line with other OpenShift resources.
- Version: The user can see the deployed version of the SecuredCluster component.
- Progressing: The user can determine if an update or change is currently in progress.
- Available: The user can quickly confirm if the SecuredCluster instance is operational and available, derived from the status of its underlying workloads.
- Message: The user receives a clear, concise summary message regarding the state of the deployment (e.g., "StackRox secured services are successfully installed.").
Acceptance Criteria
- The oc get securedcluster command must display the VERSION, PROGRESSING, AVAILABLE, and MESSAGE fields in its output.
- The oc get securedcluster -o wide command must also include these new fields.
- The VERSION field must accurately reflect the version of the deployed SecuredCluster component.
- The PROGRESSING field must accurately show True when changes are being rolled out and False otherwise.
- The AVAILABLE field must accurately show True when the SecuredCluster instance is available and False otherwise.
- The MESSAGE field must provide a relevant, human-readable summary of the SecuredCluster's status.
- The implementation must not negatively impact the performance of the oc get command.
- The new fields must be properly aligned and formatted within the oc get table output.
- The changes must be maintainable and scalable for future additions to the SecuredCluster CR status.