Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ Resource filters select which API types to watch. The controller reads, deletes,

### RBAC

By default, the Helm chart grants `get`, `list`, `watch`, `patch`, `update`, and `delete` on all resources and API groups through a `ClusterRole`. The chart also grants Event writes and namespaced leader-election permissions.
By default, the Helm chart watches standard workloads, ConfigMaps, Services, Ingresses, NetworkPolicies, PersistentVolumeClaims, HorizontalPodAutoscalers, PodDisruptionBudgets, Namespaces, and PersistentVolumes. It grants `get`, `list`, `watch`, `patch`, `update`, and `delete` for those resources, plus `Event` permissions and permissions for enabled leader-election and secure-metrics features.

Set `controllerManager.scope.watchResources` to exact resource names to narrow the generated resource grants. These grants still apply across all namespaces. The `watchNamespaces`, `ignoreNamespaces`, and `ignoreResources` scope values do not reduce the generated RBAC permissions.
A list of filtered namespaces creates a `Role` and `RoleBinding` in each watched namespace. Namespace patterns or leaving the list unset results in a `ClusterRole`. Namespace objects still require cluster permissions.

The chart supports exact resource and group names or Kubernetes `*` wildcards in RBAC rules. It does not expand arbitrary globs. For example, `deployment?.apps` can match a resource in the controller but does not authorize access to `deployments.apps`. Use exact names for chart-generated RBAC, or supply RBAC yourself.
For resource patterns such as `deploy*.apps`, set `rbac.create: false` and supply your own RBAC with explicit resource names.
4 changes: 2 additions & 2 deletions charts/lifecycle-controller/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ apiVersion: v2
name: lifecycle-controller
description: A Kubernetes controller to manage the lifecycle of standard resources through time-based annotations.
type: application
version: 0.6.3
appVersion: "v0.6.3"
version: 0.7.0
appVersion: "v0.7.0"
keywords:
- kubernetes
- controller
Expand Down
106 changes: 106 additions & 0 deletions charts/lifecycle-controller/templates/_rbac.tpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
{{/* Use the same resource list for watch flags and permissions. */}}
{{- define "lifecycle-controller.watchResources" -}}
{{- $scope := .Values.controllerManager.scope -}}
{{- if not (kindIs "slice" $scope.watchResources) -}}
{{- fail "controllerManager.scope.watchResources must be a list" -}}
{{- end -}}
{{- $resources := $scope.watchResources -}}
{{- if not (empty $scope.watchNamespaces) -}}
{{- $resources = without $resources "persistentvolumes" -}}
{{- if and (not (empty $scope.watchResources)) (empty $resources) -}}
{{- fail "namespace filters exclude PersistentVolumes, leaving no resources to watch" -}}
{{- end -}}
{{- end -}}
{{- toJson $resources -}}
{{- end -}}

{{/* Derive permission scope from namespace filters. */}}
{{- define "lifecycle-controller.rbacScope" -}}
{{- $scope := .Values.controllerManager.scope -}}
{{- $exact := not (empty $scope.watchNamespaces) -}}
{{- range $scope.watchNamespaces -}}
{{- if regexMatch "[*?\\[\\]\\\\]" . -}}
{{- $exact = false -}}
{{- end -}}
{{- end -}}
{{- if $exact -}}
{{- $namespaces := include "lifecycle-controller.rbacNamespaces" . -}}
{{- end -}}
{{- ternary "namespaced" "cluster" $exact -}}
{{- end -}}

{{/* Do not silently broaden grants when an ignore pattern cannot be represented. */}}
{{- define "lifecycle-controller.rbacNamespaces" -}}
{{- $scope := .Values.controllerManager.scope -}}
{{- range concat $scope.watchNamespaces $scope.ignoreNamespaces -}}
{{- if or (gt (len .) 63) (not (regexMatch "^[a-z0-9]([-a-z0-9]*[a-z0-9])?$" .)) -}}
{{- fail (printf "generated namespaced RBAC requires exact namespace names, got %q; use rbac.create: false for supplied RBAC" .) -}}
{{- end -}}
{{- end -}}
{{- $allowed := list -}}
{{- range uniq $scope.watchNamespaces -}}
{{- if not (has . $scope.ignoreNamespaces) -}}
{{- $allowed = append $allowed . -}}
{{- end -}}
{{- end -}}
{{- if empty $allowed -}}
{{- fail "namespaced RBAC requires at least one namespace after ignore rules" -}}
{{- end -}}
{{- toJson $allowed -}}
{{- end -}}

{{/* Generate resource rules from exact names or a lone wildcard. */}}
{{- define "lifecycle-controller.resourceRules" -}}
{{- $scope := .Values.controllerManager.scope -}}
{{- $resources := include "lifecycle-controller.watchResources" . | fromJsonArray -}}
{{- $namespaced := eq (include "lifecycle-controller.rbacScope" .) "namespaced" -}}
{{- range $scope.ignoreResources -}}
{{- if regexMatch "[?\\[\\]\\\\]" . -}}
{{- fail "chart-generated RBAC requires exact ignoreResources entries or *; use rbac.create: false for supplied RBAC" -}}
{{- end -}}
{{- if and (contains "*" .) (ne . "*") -}}
{{- fail "chart-generated RBAC requires exact ignoreResources entries or *; use rbac.create: false for supplied RBAC" -}}
{{- end -}}
{{- end -}}
{{- if $resources -}}
{{- range uniq $resources -}}
{{- $entry := . -}}
{{- $parts := splitList "." . -}}
{{- $res := index $parts 0 -}}
{{- if eq $res "" -}}
{{- fail (printf "invalid controllerManager.scope.watchResources entry %q: resource segment cannot be empty" .) -}}
{{- end -}}
{{- $grp := "" -}}
{{- if gt (len $parts) 1 -}}
{{- $rest := rest $parts -}}
{{- if has "" $rest -}}
{{- fail (printf "invalid controllerManager.scope.watchResources entry %q: apiGroup segments cannot be empty" .) -}}
{{- end -}}
{{- $grp = join "." $rest -}}
{{- end -}}
{{- if or (and (ne $entry "*") (contains "*" $entry)) (not (regexMatch "^([a-z0-9-]+|\\*)$" $res)) (and (ne $grp "") (not (regexMatch "^[a-z0-9.-]+$" $grp))) -}}
{{- fail (printf "invalid controllerManager.scope.watchResources entry %q: chart-generated RBAC requires exact names or a lone *" .) -}}
{{- end -}}
{{- if eq $entry "*" -}}{{- $grp = "*" -}}{{- end -}}
{{- if and (not (has $entry $scope.ignoreResources)) (not (has "*" $scope.ignoreResources)) (not (and $namespaced (eq $entry "namespaces"))) }}
- apiGroups: [{{ $grp | quote }}]
resources: [{{ $res | quote }}]
verbs: ["delete", "get", "list", "patch", "update", "watch"]
{{- end -}}
{{- end -}}
{{- else if not (has "*" $scope.ignoreResources) }}
- apiGroups: ["*"]
resources: ["*"]
verbs: ["delete", "get", "list", "patch", "update", "watch"]
{{- end }}
{{- include "lifecycle-controller.eventRules" . | nindent 0 }}
{{- end -}}

{{- define "lifecycle-controller.eventRules" -}}
- apiGroups: [""]
resources: ["events"]
verbs: ["create", "patch"]
- apiGroups: ["events.k8s.io"]
resources: ["events"]
verbs: ["create", "patch"]
{{- end -}}
2 changes: 1 addition & 1 deletion charts/lifecycle-controller/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ spec:
{{- end }}
- --dry-run={{ .Values.controllerManager.dryRun }}
- --zap-log-level={{ .Values.controllerManager.logLevel }}
{{- range .Values.controllerManager.scope.watchResources }}
{{- range (include "lifecycle-controller.watchResources" . | fromJsonArray) }}
- --watch-resource={{ . }}
{{- end }}
{{- range .Values.controllerManager.scope.ignoreResources }}
Expand Down
35 changes: 35 additions & 0 deletions charts/lifecycle-controller/templates/leader-election-rbac.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{{- if and .Values.rbac.create .Values.controllerManager.leaderElection.enabled }}
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-leader-election-role
namespace: {{ .Release.Namespace }}
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
rules:
- apiGroups: ["coordination.k8s.io"]
resources: ["leases"]
verbs: ["get", "create", "update"]
- apiGroups: [""]
resources: ["events"]
verbs: ["create", "patch"]
- apiGroups: ["events.k8s.io"]
resources: ["events"]
verbs: ["create", "patch"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-leader-election-rolebinding
namespace: {{ .Release.Namespace }}
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: {{ include "lifecycle-controller.fullname" . }}-leader-election-role
subjects:
- kind: ServiceAccount
name: {{ include "lifecycle-controller.serviceAccountName" . }}
namespace: {{ .Release.Namespace }}
{{- end }}
30 changes: 30 additions & 0 deletions charts/lifecycle-controller/templates/metrics-rbac.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{{- if and .Values.rbac.create .Values.metrics.enabled .Values.metrics.secure }}
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-metrics-auth-role
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
rules:
- apiGroups: ["authentication.k8s.io"]
resources: ["tokenreviews"]
verbs: ["create"]
- apiGroups: ["authorization.k8s.io"]
resources: ["subjectaccessreviews"]
verbs: ["create"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-metrics-auth-rolebinding
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: {{ include "lifecycle-controller.fullname" . }}-metrics-auth-role
subjects:
- kind: ServiceAccount
name: {{ include "lifecycle-controller.serviceAccountName" . }}
namespace: {{ .Release.Namespace }}
{{- end }}
62 changes: 62 additions & 0 deletions charts/lifecycle-controller/templates/namespace-rbac.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
{{- if .Values.rbac.create -}}
{{- $scope := .Values.controllerManager.scope -}}
{{- $resources := include "lifecycle-controller.watchResources" . | fromJsonArray -}}
{{- if and (eq (include "lifecycle-controller.rbacScope" .) "namespaced") (has "namespaces" $resources) (not (has "namespaces" $scope.ignoreResources)) (not (has "*" $scope.ignoreResources)) }}
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-namespace-role
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
rules:
- apiGroups: [""]
resources: ["namespaces"]
verbs: ["get", "list", "watch"]
- apiGroups: [""]
resources: ["namespaces"]
resourceNames: {{ include "lifecycle-controller.rbacNamespaces" . }}
verbs: ["delete", "patch", "update"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-namespace-rolebinding
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: {{ include "lifecycle-controller.fullname" . }}-namespace-role
subjects:
- kind: ServiceAccount
name: {{ include "lifecycle-controller.serviceAccountName" . }}
namespace: {{ .Release.Namespace }}
{{/* Kubernetes records Events for cluster objects in default. */}}
---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-namespace-events-role
namespace: default
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
rules:
{{- include "lifecycle-controller.eventRules" . | nindent 0 }}
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-namespace-events-rolebinding
namespace: default
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: {{ include "lifecycle-controller.fullname" . }}-namespace-events-role
subjects:
- kind: ServiceAccount
name: {{ include "lifecycle-controller.serviceAccountName" . }}
namespace: {{ .Release.Namespace }}
{{- end -}}
{{- end -}}
101 changes: 24 additions & 77 deletions charts/lifecycle-controller/templates/rbac.yaml
Original file line number Diff line number Diff line change
@@ -1,93 +1,40 @@
{{- if .Values.rbac.create -}}
{{- $root := . -}}
{{- $namespaced := eq (include "lifecycle-controller.rbacScope" .) "namespaced" -}}
{{- $namespaces := list "" -}}
{{- if $namespaced -}}
{{- $namespaces = include "lifecycle-controller.rbacNamespaces" . | fromJsonArray -}}
{{- end -}}
{{- range $namespaces }}
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
kind: {{ ternary "Role" "ClusterRole" $namespaced }}
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-manager-role
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
rules:
{{- if .Values.controllerManager.scope.watchResources }}
{{- range .Values.controllerManager.scope.watchResources }}
{{- $parts := splitList "." . }}
{{- $res := index $parts 0 }}
{{- if eq $res "" }}
{{- fail (printf "invalid controllerManager.scope.watchResources entry %q: resource segment cannot be empty" .) }}
{{- end }}
{{- $grp := "" }}
{{- if gt (len $parts) 1 }}
{{- $rest := rest $parts }}
{{- if has "" $rest }}
{{- fail (printf "invalid controllerManager.scope.watchResources entry %q: apiGroup segments cannot be empty" .) }}
{{- end }}
{{- $grp = join "." $rest }}
{{- end }}
- apiGroups: ["{{ $grp }}"]
resources: ["{{ $res }}"]
verbs: ["delete", "get", "list", "patch", "update", "watch"]
name: {{ include "lifecycle-controller.fullname" $root }}-manager-role
{{- if $namespaced }}
namespace: {{ . | quote }}
{{- end }}
{{- else }}
- apiGroups: ["*"]
resources: ["*"]
verbs: ["delete", "get", "list", "patch", "update", "watch"]
{{- end }}
- apiGroups: [""]
resources: ["events"]
verbs: ["create", "patch"]
- apiGroups: ["events.k8s.io"]
resources: ["events"]
verbs: ["create", "patch"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-manager-rolebinding
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: {{ include "lifecycle-controller.fullname" . }}-manager-role
subjects:
- kind: ServiceAccount
name: {{ include "lifecycle-controller.serviceAccountName" . }}
namespace: {{ .Release.Namespace }}
---
# Permissions for leader election
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-leader-election-role
namespace: {{ .Release.Namespace }}
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
{{- include "lifecycle-controller.labels" $root | nindent 4 }}
rules:
- apiGroups: [""]
resources: ["configmaps"]
verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
- apiGroups: ["coordination.k8s.io"]
resources: ["leases"]
verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
- apiGroups: [""]
resources: ["events"]
verbs: ["create", "patch"]
- apiGroups: ["events.k8s.io"]
resources: ["events"]
verbs: ["create", "patch"]
{{- include "lifecycle-controller.resourceRules" $root | nindent 0 }}
---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
kind: {{ ternary "RoleBinding" "ClusterRoleBinding" $namespaced }}
metadata:
name: {{ include "lifecycle-controller.fullname" . }}-leader-election-rolebinding
namespace: {{ .Release.Namespace }}
name: {{ include "lifecycle-controller.fullname" $root }}-manager-rolebinding
{{- if $namespaced }}
namespace: {{ . | quote }}
{{- end }}
labels:
{{- include "lifecycle-controller.labels" . | nindent 4 }}
{{- include "lifecycle-controller.labels" $root | nindent 4 }}
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: {{ include "lifecycle-controller.fullname" . }}-leader-election-role
kind: {{ ternary "Role" "ClusterRole" $namespaced }}
name: {{ include "lifecycle-controller.fullname" $root }}-manager-role
subjects:
- kind: ServiceAccount
name: {{ include "lifecycle-controller.serviceAccountName" . }}
namespace: {{ .Release.Namespace }}
name: {{ include "lifecycle-controller.serviceAccountName" $root }}
namespace: {{ $root.Release.Namespace }}
{{- end }}
{{- end -}}
Loading
Loading