Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add finalizer rbac permission to the go/sample and doc steps #4162

Merged

Conversation

camilamacedo86
Copy link
Contributor

@camilamacedo86 camilamacedo86 commented Nov 2, 2020

Description of the change:

Motivation for the change:
Closes : #3477

Checklist

If the pull request includes user-facing changes, extra documentation is required:

@camilamacedo86 camilamacedo86 changed the title add finalizer rbac permission to the go/sample add finalizer rbac permission to the go/sample and doc steps Nov 2, 2020
Comment on lines 37 to 41
**Note** If your cluster is a non-vanilla one then such as OpenShift then, add the RBAC finalizer permission on the `controllers/memcached_controller.go` file and run `make manifests` before continue.

```go
// +kubebuilder:rbac:groups=cache.example.com,resources=memcacheds/finalizers,verbs=update
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of notes:

  1. We shouldn't put such specific information in the quickstart. Something like this seems more relevant to an FAQ entry (e.g. "I saw error X in my logs. How do I fix it?")
  2. The need for this permission is based on the OwnerReferencesPermissionEnforcement plugin, which can be enabled in any Kubernetes cluster because it is a feature of the upstream kube-apiserver. Anytime we talk about the need for this permission, we should reference that plugin, not a specific distro of Kubernetes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Too much better address it in the FAQ. Indeed we can give a better explanation. 👍

camilamacedo86 and others added 2 commits November 4, 2020 20:32
Co-authored-by: Joe Lanford <joe.lanford@gmail.com>
Co-authored-by: Joe Lanford <joe.lanford@gmail.com>
Copy link
Member

@joelanford joelanford left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 4, 2020
@camilamacedo86 camilamacedo86 merged commit 9241d07 into operator-framework:master Nov 4, 2020
@camilamacedo86 camilamacedo86 deleted the finalizer-status branch November 4, 2020 21:52
reinvantveer pushed a commit to reinvantveer/operator-sdk that referenced this pull request Feb 5, 2021
…r-framework#4162)

**Description of the change:**
- Add the RBAC finalizer permission to allow users to test the Go sample project on OCP
- See that for v3+ plugins this permission will be added by default 
- See that it was added as a NOTE to the quick start and by default in the tutorial in order to avoid the issue faced in operator-framework#3477

**Motivation for the change:**
Closes : operator-framework#3477

Co-authored-by: Joe Lanford <joe.lanford@gmail.com>
Signed-off-by: reinvantveer <rein.van.t.veer@geodan.nl>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Golang example on OpenShift 4.3 cannot produce deployments (finalizer RBAC error)
3 participants