Add role to README, bump version

SickHub · May 6, 2024 · f5b6e01 · f5b6e01
1 parent 370fb24
commit f5b6e01
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/sickhub/cronjobs/Chart.yaml b/sickhub/cronjobs/Chart.yaml
@@ -2,7 +2,7 @@ apiVersion: v2
 name: cronjobs
 description: A generic helm cronjob chart for kubernetes
 type: application
-version: 0.2.0
+version: 0.3.0
 appVersion: latest
 home: https://github.com/SickHub
 icon: https://raw.githubusercontent.com/SickHub/charts/master/sickhub/cronjobs/icon.png

diff --git a/sickhub/cronjobs/README.md b/sickhub/cronjobs/README.md
@@ -79,6 +79,18 @@ secrets:
       id-rsa.pub: ci/files/id-rsa.pub
 ```
 
+### Kubernetes API Permissions
+By default, a Kubernetes ServiceAccount object is created and used by the Pods that are generated by the Cronjobs/Jobs.
+Optionally, you can attach a Role or ClusterRole to this ServiceAccount in order to grant permissions within Kubernetes, e.g., to restart deployments.
+
+```yaml
+role:
+  create: true
+  rules:
+  - apiGroups: ["", "extensions", "apps"]
+    resources: ["deployments", "replicasets", "pods", "pods/attach", "pods/exec", "pods/log"]
+    verbs: ["list", "get", "watch", "create", "update", "patch", "delete"]
+```
 
 ## Missing features - help appreciated
 * [ ] allow overwriting `nodeSelector, affinity, resources, ...`