Add automatic RBAC creation for k8sevents receiver #3421
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: enhancement | ||
|
|
||
| # The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action) | ||
| component: collector | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Create RBAC rules for the k8s_events receiver automatically. | ||
|
|
||
| # One or more tracking issues related to the change | ||
| issues: [3420] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package receivers | ||
|
|
||
| import ( | ||
| "github.com/go-logr/logr" | ||
| rbacv1 "k8s.io/api/rbac/v1" | ||
| ) | ||
|
|
||
| type k8seventsConfig struct{} | ||
|
|
||
| func generatek8seventsRbacRules(_ logr.Logger, _ k8seventsConfig) ([]rbacv1.PolicyRule, error) { | ||
| // The k8s Events Receiver needs get permissions on the following resources always. | ||
| return []rbacv1.PolicyRule{ | ||
| { | ||
| APIGroups: []string{""}, | ||
| Resources: []string{ | ||
| "events", | ||
| "namespaces", | ||
| "namespaces/status", | ||
| "nodes", | ||
| "nodes/spec", | ||
| "pods", | ||
| "pods/status", | ||
| "replicationcontrollers", | ||
| "replicationcontrollers/status", | ||
| "resourcequotas", | ||
| "services", | ||
| }, | ||
| Verbs: []string{"get", "list", "watch"}, | ||
| }, | ||
| { | ||
| APIGroups: []string{"apps"}, | ||
| Resources: []string{ | ||
| "daemonsets", | ||
| "deployments", | ||
| "replicasets", | ||
| "statefulsets", | ||
| }, | ||
| Verbs: []string{"get", "list", "watch"}, | ||
| }, | ||
| { | ||
| APIGroups: []string{"extensions"}, | ||
| Resources: []string{ | ||
| "daemonsets", | ||
| "deployments", | ||
| "replicasets", | ||
| }, | ||
| Verbs: []string{"get", "list", "watch"}, | ||
| }, | ||
| { | ||
| APIGroups: []string{"batch"}, | ||
| Resources: []string{ | ||
| "jobs", | ||
| "cronjobs", | ||
| }, | ||
| Verbs: []string{"get", "list", "watch"}, | ||
| }, | ||
| { | ||
| APIGroups: []string{"autoscaling"}, | ||
| Resources: []string{ | ||
| "horizontalpodautoscalers", | ||
| }, | ||
| Verbs: []string{"get", "list", "watch"}, | ||
| }, | ||
| }, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| - op: add | ||
| path: /rules/- | ||
| value: | ||
| apiGroups: | ||
| - batch | ||
| resources: | ||
| - cronjobs | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| - op: add | ||
| path: /rules/- | ||
| value: | ||
| apiGroups: | ||
| - extensions | ||
| resources: | ||
| - daemonsets | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,11 @@ | ||
| - op: add | ||
| path: /rules/- | ||
| value: | ||
| apiGroups: | ||
| - "" | ||
| resources: | ||
| - events | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| - op: add | ||
| path: /rules/- | ||
| value: | ||
| apiGroups: | ||
| - extensions | ||
| resources: | ||
| - deployments | ||
| - replicasets | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| - op: add | ||
| path: /rules/- | ||
| value: | ||
| apiGroups: | ||
| - "" | ||
| resources: | ||
| - namespaces/status | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,6 +5,7 @@ | |
| apiGroups: | ||
| - "" | ||
| resources: | ||
| - nodes/stats | ||
| - nodes/proxy | ||
| verbs: | ||
| - get | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| - op: add | ||
| path: /rules/- | ||
| value: | ||
| apiGroups: | ||
| - "" | ||
| resources: | ||
| - nodes/spec | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,23 +10,3 @@ | |
| - get | ||
| - list | ||
| - watch | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --- | ||
| - op: add | ||
| path: /rules/- | ||
| value: | ||
| apiGroups: | ||
| - "" | ||
| resources: | ||
| - pods/status | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| - op: add | ||
| path: /rules/- | ||
| value: | ||
| apiGroups: | ||
| - "" | ||
| resources: | ||
| - replicationcontrollers | ||
| - replicationcontrollers/status | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| - op: add | ||
| path: /rules/- | ||
| value: | ||
| apiGroups: | ||
| - "" | ||
| resources: | ||
| - resourcequotas | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| apiVersion: v1 | ||
| kind: Namespace | ||
| metadata: | ||
| name: chainsaw-k8s-events |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: ClusterRole | ||
| metadata: | ||
| name: simplest-chainsaw-k8s-events-cluster-role | ||
| rules: | ||
| - apiGroups: | ||
| - "" | ||
| resources: | ||
| - events | ||
| - namespaces | ||
| - namespaces/status | ||
| - nodes | ||
| - nodes/spec | ||
| - pods | ||
| - pods/status | ||
| - replicationcontrollers | ||
| - replicationcontrollers/status | ||
| - resourcequotas | ||
| - services | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch | ||
| - apiGroups: | ||
| - apps | ||
| resources: | ||
| - daemonsets | ||
| - deployments | ||
| - replicasets | ||
| - statefulsets | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch | ||
| - apiGroups: | ||
| - extensions | ||
| resources: | ||
| - daemonsets | ||
| - deployments | ||
| - replicasets | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch | ||
| - apiGroups: | ||
| - batch | ||
| resources: | ||
| - jobs | ||
| - cronjobs | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch | ||
| - apiGroups: | ||
| - autoscaling | ||
| resources: | ||
| - horizontalpodautoscalers | ||
| verbs: | ||
| - get | ||
| - list | ||
| - watch | ||
| --- | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: ClusterRoleBinding | ||
| metadata: | ||
| labels: | ||
| app.kubernetes.io/component: opentelemetry-collector | ||
| app.kubernetes.io/instance: chainsaw-k8s-events.simplest | ||
| app.kubernetes.io/managed-by: opentelemetry-operator | ||
| app.kubernetes.io/name: simplest-chainsaw-k8s-events-collector | ||
| app.kubernetes.io/part-of: opentelemetry | ||
| name: simplest-chainsaw-k8s-events-collector | ||
| roleRef: | ||
| apiGroup: rbac.authorization.k8s.io | ||
| kind: ClusterRole | ||
| name: simplest-chainsaw-k8s-events-cluster-role | ||
| subjects: | ||
| - kind: ServiceAccount | ||
| name: simplest-collector | ||
| namespace: chainsaw-k8s-events |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| apiVersion: opentelemetry.io/v1alpha1 | ||
| kind: OpenTelemetryCollector | ||
| metadata: | ||
| name: simplest | ||
| namespace: chainsaw-k8s-events | ||
| spec: | ||
| config: | | ||
| receivers: | ||
| k8s_events: | ||
| processors: | ||
| exporters: | ||
| debug: | ||
| service: | ||
| pipelines: | ||
| traces: | ||
|
There was a problem hiding this comment. This shouldn't work and should fail with I wonder if this is the reason why no CR/CRB is created if I deploy exactly this manifest, but with There was a problem hiding this comment. Nevermind, my operator SA was missing permissions... but this typo is legit. There was a problem hiding this comment. Worth fixing, but for the purpose of this test it doesn't matter. We don't even care if the collector starts, just that the generated ClusterRole is correct. |
||
| receivers: [k8s_events] | ||
| processors: [] | ||
| exporters: [debug] | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we know why this component requires all of these permissions? It looks like it only sets a watch on Events themselves.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just followed the component documentation: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/k8seventsreceiver/README.md#rbac
I agree they are a lot. Maybe I can work on the future in the contrib repo to see if we really need that, fix the documentation and fix the permissions where. WDYT?