Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-23588

Doc ClusterPermission validation feature

XMLWordPrintable

    • Product / Portfolio Work
    • 4
    • True
    • Show
      Depends on https://issues.redhat.com/browse/ACM-22992
    • False
    • None

      Note: Doc team updates the current version of the documentation and the
      two previous versions (n-2), but we address *only high-priority, or
      customer-reported issues* for -2 releases in support.
      Describe the changes in the doc and link to your dev story:

      1. - [X] Mandatory: Add the required version to the Fix version/s field.

      2. - [X] Mandatory: Choose the type of documentation change or review.

      • [X] We need to update to an existing topic
      • [ ] We need to add a new document to an existing section
      • [ ] We need a whole new section; this is a function not
        documented before and doesn't belong in any current section
      • [ ] We need an Operator Advisory review and approval
      • [ ] We need a z-Stream (Errata) Advisory and Release note for
        MCE and/or ACM

      3. - [X] Mandatory: Find the link to where the documentation update
      should go and add it to the recommended changes. You can either use the
      published doc or the staged repo for this step:

      Note: As the feature and doc is understood, this recommendation may
      change. If this is new documentation, link to the section where you think
      it should be placed.

      Customer Portal published version

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.12

      Doc staged repo within the ACM Workspace:
      https://github.com/stolostron/rhacm-docs

       

      https://docs.redhat.com/en/documentation/red_hat_advanced_cluster_management_for_kubernetes/2.14/html/secure_clusters/securing-cluster-intro#rhacm-rbac-implement

      This task is blocked until we have the new "Cluster life cycle" section created in the link above.

      Make it clear that ACM is a requirement.

      Title: Creating a cluster permission with validation

      Content:
      To create a ClusterPermission resource that will validate the Role or ClusterRole resources referenced by the subjects use the `spec.validate` field and set the value to true.

      For an example, see the following YAML with the specified `validate` field: 

       

      apiVersion: rbac.open-cluster-management.io/v1alpha1
      kind: ClusterPermission
      metadata:
        name: clusterpermission-validate-sample
      spec:
        validate: true
        roleBindings:
          - name: default-existing
            namespace: default
            roleRef:
              apiGroup: rbac.authorization.k8s.io
              kind: ClusterRole
              name: edit
            subject:
              namespace: openshift-gitops
              kind: ServiceAccount
              name: sa-sample-existing
        clusterRoleBinding:
            name: crb-cluster1-argo-app-con-3-existing
            roleRef:
              apiGroup: rbac.authorization.k8s.io
              kind: ClusterRole
              name: view
            subject:
              apiGroup: rbac.authorization.k8s.io
              kind: Group
              name: group1

       

       

       

      4. - [X] Mandatory for GA content:

      • [ ] Add steps, the diff, known issue, and/or other important
        conceptual information in the following space:
      • [ ] *Add Required access level *(example, *Cluster
        Administrator*) for the user to complete the task:
      • [ ] Add verification at the end of the task, how does the user
        verify success (a command to run or a result to see?)

      5. - [ ] Mandatory for bugs: What is the diff? Clearly define what the
      problem is, what the change is, and link to the current documentation. Only
      use this for a documentation bug.

              mdockery@redhat.com Mikela Jackson
              fxiang@redhat.com Feng Xiang
              David Huynh David Huynh
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: