Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-1450

Extend operator Status for improving user experience

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Major Major
    • 1.5.0
    • None
    • Operator
    • Extend operator Status for improving user experience
    • S
    • False
    • Hide

      None

      Show
      None
    • False
    • RHIDP-2233 - RHDH Operator: Improve configuration for simplifying user experience (onboarding)
    • 0% To Do, 0% In Progress, 100% Done
    • Hide
      = Improved status conditions for Backstage custom resources

      This update enhances the status conditions in the Backstage Custom Resource(s) managed by the {product-short} Operator, providing clearer insights into application availability.

      A new `DeployInProgress` reason has been introduced under the `Deployed` condition. It appears when the application is still starting up and not fully available. The `Deployed` reason now only reflects when the {product-short} application is fully up and running with the desired number of replicas, improving visibility during deployment.

      For example:

      [source,terminal,subs="+quotes,+attributes"]
      ----
      Status:
        Conditions:
          Last Transition Time: 2025-03-10T17:09:22Z
          Message: Deployment status: Available: Deployment does not have minimum availability. Progressing: ReplicaSet "backstage-bs1-674476fd67" is progressing.
          Reason: DeployInProgress
          Status: False
          Type: Deployed

      ...
      Status:
        Conditions:
          Last Transition Time: 2025-03-10T17:14:43Z
          Message:
          Reason: Deployed
          Status: True
          Type: Deployed
      ----
      Show
      = Improved status conditions for Backstage custom resources This update enhances the status conditions in the Backstage Custom Resource(s) managed by the {product-short} Operator, providing clearer insights into application availability. A new `DeployInProgress` reason has been introduced under the `Deployed` condition. It appears when the application is still starting up and not fully available. The `Deployed` reason now only reflects when the {product-short} application is fully up and running with the desired number of replicas, improving visibility during deployment. For example: [source,terminal,subs="+quotes,+attributes"] ---- Status:   Conditions:     Last Transition Time: 2025-03-10T17:09:22Z     Message: Deployment status: Available: Deployment does not have minimum availability. Progressing: ReplicaSet "backstage-bs1-674476fd67" is progressing.     Reason: DeployInProgress     Status: False     Type: Deployed ... Status:   Conditions:     Last Transition Time: 2025-03-10T17:14:43Z     Message:     Reason: Deployed     Status: True     Type: Deployed ----
    • Enhancement
    • Done

      [2156468159] Upstream Reporter: Gennady Azarenkov
      Upstream issue status: Open
      Upstream description:

      This is the follow-up of improving Operator Status topic. For the time being the only information we can obtain from the Status is where the operator succeeded with creation runtime objects (Deployments, Services, default configurations etc) Ideally, the Status should NOT be overloaded but contain enough information for User and dependent code to make it clear:

      • What's going on with runtime and where to see more detailed information if something going wrong.
      • How to reach Backstage application (best effort of exposing direct URL or some hints how to obtain it)
      • What configuration objects (ConfigMaps, Secrets) take part in Backstage Application config
      • As part of the Level 2 Capability Level, the operator should convey inability to manage an unsupported version of the Operand in the status section of the CR
      • ... (not limited to)

      Upstream URL: https://github.com/janus-idp/operator/issues/240

              gazarenk-1 Gennady Azarenkov
              upstream-sync Upstream Sync
              RHIDP - Install
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: