Uploaded image for project: 'OpenShift Bugs'
  1. OpenShift Bugs
  2. OCPBUGS-8833

[downstream-helm operator] Add doc on behavior related to helm operator scaffolding

XMLWordPrintable

    • Quality / Stability / Reliability
    • None
    • None
    • 1
    • Important
    • None
    • Unspecified
    • None
    • None
    • OSDOCS Sprint 233, OSDOCS Sprint 234, OSDOCS Sprint 235
    • 3
    • None
    • If docs needed, set a value
    • None
    • None
    • None
    • None
    • None

      Section Number and Name:
      Operator-SDK documentation. Related to Helm-operators

      Describe the issue:
      The following behavior in helm operator project needs to be mentioned in documentation:
      While scaffolding a new project, the helm operator scaffolder tries to use the cluster config for the best information. The permissions scaffolded in roles/rbac.yaml is based on whether the cluster config can be found or not.

      While scaffolding a helm based project, `operator-sdk create api` needs to have a KUBECONFIG present. If not, users will have to add the required permissions for serviceaccount (in rbac/roles.yaml) manually.

      For example:
      ```

      • apiGroups:
      • demo.my.domain
        resources:
      • nginxes
      • nginxes/status
      • nginxes/finalizers
        verbs:
      • create
      • delete
      • get
      • list
      • patch
      • update
      • watch
      • verbs:
      • "*"
        apiGroups:
      • ""
        resources:
      • "serviceaccounts"
      • "services"
      • verbs:
      • "*"
        apiGroups:
      • "apps"
        resources:
      • "deployments"

      ```

      Additional information:
      The OCP documentation should point out the behavior of helm operator scaffolder to reduce confusions related to scaffolding of roles.yaml in the project.

      cc: Alex Dellapenta (alexd@redhat.com)

              rhn-support-adellape Alex Dellapenta (Inactive)
              vnarsing@redhat.com Varsha Prasad Narsing
              Alex Dellapenta (Inactive)
              None
              None
              Latha Sreenivasa Murthy Latha Sreenivasa Murthy
              Red Hat Employee
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: