Resource status
Overview
Resource status displays in a list of resources to indicate what the current status of the resource is.
The examples shown below were created for communicating status in a list of managed Kafka instances.
Types of status for managed Kafka
The following statuses are influenced by the fact that these resources were created in a managed service. For example, we wouldn't have a status like “Failed” where the user needs to troubleshoot why the resource is in a failed state, because the SRE team would ensure that instances are always able to provision.
Creating
The creating status displays with a spinner component in front of the text label with an additional message indicating that creation the resource should transition to the ready status after a short period.
The user can click the status text “Creating” to see a popover that provides more information about next steps the user can take as well as a progress stepper showing the current step in the full creation process.
 |  |  |
When the user chooses to create a Kafka instance, there are several statuses returned by the API:
- Accepted - presented as “Creation pending” in the progress stepper
- Provisioning
- Preparing
Rather than display all of these individual statuses that occur before a resource is ready for use, a single umbrella “Creating” status displays with a spinner, which provides a popover that displays each of these individual statuses.
Often when a creation process is represented, users will state that they expect to see some indication of progress. But having an exact measurement of how much time is remaining or how much of the process is complete is often not feasible. One of the benefits of this method is that it uses the separate individual statuses provided by the API to provide this sense of progress happening. It also eliminates the “black box” effect by allowing the UI to provide a more minimal presentation on the surface, while allowing the user to drill down to see the more specific details that the API is providing.
Warning state
For this resource, successful creation was expected to happen within 15 minutes of initiating creation. Therefore, the UI component transitioned to a warning state after the 15 minute threshold, to communicate that creation is taking longer than expected.
Error
If the resource still had not successfully provisioned within 30 minutes, the warning message transitioned to and error message, and additional information was provided in the popover about contacting support.
Ready
Degraded
In a managed service, the SRE team monitors the service to prevent failures from happening. However there are still situations that can occur where the resource performance is temporarily degraded while the SRE team works to address issues causing this. During this time, the Ready status changes to a “Degraded” status.
Deleting
When the user chooses to delete a resource, there are a few minutes where the resource is listed until it's fully deprovisioned and deleted. During this time, the resource is still included in the API response that provides a list of resources.
Similar to the Creating status, there are 2 statuses that the API sends after a user chooses to delete the resource:
- Deprovisioning
- Deleting
However unlike the Creating status, there is no popover with progress stepper. For both of these statuses provided by the API, the same “Deleting” status displays in the UI.
When the status Deleting displays in a table row, there are other changes to contents in the table row to reenforce this change in status and essentially disable further interaction with the item in the UI. These changes include:
- Disabling the row click behavior to open the details drawer
- Applying the PF color variable to all contents in the table row: --pf-global--Color--200
- Removing the kebab action menu
Suspended
Given that for a managed service, the account used for the service could become inactive, there's a need to transition any resources associated with that account to a Suspended status. This provides a grace period where the resource remains available and can become active again if the account is resumed.
Resuming
When an account becomes active after being inactive, any resources that were suspended will become ready again. The transition status between Suspended and Ready displays as “Resuming” with a spinner similar to the “Creating” status.
