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

Close gaps in RBAC documentation to improve initial setup and configuration UX

Prepare for Y ReleasePrepare for Z ReleaseRemove QuarterXMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • False
    • Important

      Description of problem:

      The documentation for RBAC doesn't actually explicitly tell you how to enable the feature in the plugin's configuration title, it goes straight to a discussion about permission policies:

      https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html/authorization/ref-rbac-permission-policies_title-authorization#ref-rbac-permission-policies_title-authorization

      The steps to enable the RBAC plugin is also missing from the Guide "Configuring Dynamic Plugins" as is any discussion about how to enable any of the the plugins in the container image by converting the identifiers in the reference material @janus-idp/backstage-plugin-rbac to the actual path required ./dynamic-plugins/dist/janus-idp-backstage-plugin-rbac.

      https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html/configuring_dynamic_plugins/index

      The "Using Dynamic Plugins" title also appears to be missing information on how to use the RBAC plugin to perform access control once the plugin is activated. This information is in the "Authorisation" title, but for other plugins (ArgoCD etc.) this information has been moved into the "Using" title. There is some inconsistency here in approach.

      Long story short, enabling RBAC using the RHDH 1.3 documentation is a non-trivial exercise for the uninitiated. Finding the steps in the documentation is less intuative than it perhaps could be.

      Prerequisites (if any, like setup, operators/versions):

      Steps to Reproduce

      1. see above

      Actual results:

      Expected results:

      Reproducibility (Always/Intermittent/Only Once):

      always

      Build Details:

      Additional info (Such as Logs, Screenshots, etc):

          There are no Sub-Tasks for this issue.

              ffloreth@redhat.com Fabrice Flore-Thébault
              rh-ee-bwilcock Ben Wilcock
              RHIDP - Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: