Uploaded image for project: 'Observability Documentation'
  1. Observability Documentation
  2. OBSDOCS-316

Update monitoring content to distinguish more clearly between Role and ClusterRole

XMLWordPrintable

    • 8
    • False
    • Hide

      None

      Show
      None
    • False
    • OBSDOCS (June 20-July 10) #238, OBSDOCS (July 10-31) #239

      Currently, when referring to role-based permissions for the Monitoring stack, we are inconsistent in how we refer to Roles for the monitoring namespaces (openshift-monitoring and openshift-user-workload-monitoring) vs ClusterRoles. This inconsistency can cause confusion with users.

      For example, in https://docs.openshift.com/container-platform/4.11/monitoring/managing-alerts.html, the following content does not make this distinction:

      • The cluster-monitoring-view role, which allows you to access Alertmanager
      • The monitoring-alertmanager-edit role, which permits you to create and silence alerts in the Administrator perspective in the web console
      • The monitoring-rules-edit role, which permits you to create and silence alerts in the Developer perspective in the web console

      We need to make a pass through all of the monitoring content and, where applicable, update references to any ClusterRole roles to specifically say that they are ClusterRoles and that Roles are roles for namespaces.

      All references to the following roles in the Monitoring docs need to be reviewed to ensure that these references consistently distinguish between what is a ClusterRole and what is a Role:

      • ClusterRole
        • cluster-monitoring-view
        • monitoring-edit
        • monitoring-rules-edit
        • monitoring-rules-view
        • openshift-cluster-monitoring-admin
        • openshift-cluster-monitoring-edit
        • openshift-cluster-monitoring-view
        • alert-routing-edit
      • Role
        • monitoring-alertmanager-edit > openshift-monitoring namespace
        • user-workload-monitoring-config-edit > openshift-user-workload-monitoring namespace

            rhn-support-bburt Brian Burt
            rhn-support-bburt Brian Burt
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: