Skip to content

Commit 3da45e9

Browse files
pkosiecpkosiec
authored
Update links in Helm chart values file (#1448)
1 parent 304528f commit 3da45e9

File tree

2 files changed

+25
-26
lines changed

2 files changed

+25
-26
lines changed

‎helm/botkube/README.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A virtual SRE, powered by AI.
2727
| [podSecurityPolicy](./values.yaml#L24) | object | `{"enabled":false}` | Configures Pod Security Policy to allow Botkube to run in restricted clusters. [Ref doc](https://kubernetes.io/docs/concepts/policy/pod-security-policy/). |
2828
| [securityContext](./values.yaml#L30) | object | Runs as a Non-Privileged user. | Configures security context to manage user Privileges in Pod. [Ref doc](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod). |
2929
| [containerSecurityContext](./values.yaml#L36) | object | `{"allowPrivilegeEscalation":false,"privileged":false,"readOnlyRootFilesystem":true}` | Configures container security context. [Ref doc](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container). |
30-
| [rbac](./values.yaml#L43) | object | `{"create":true,"groups":{"botkube-plugins-default":{"create":true,"rules":[{"apiGroups":["*"],"resources":["*"],"verbs":["get","watch","list"]}]}},"rules":[],"serviceAccountMountPath":"/var/run/7e7fd2f5-b15d-4803-bc52-f54fba357e76/secrets/kubernetes.io/serviceaccount","staticGroupName":""}` | Role Based Access for Botkube Pod and plugins. [Ref doc](https://kubernetes.io/docs/admin/authorization/rbac/). |
30+
| [rbac](./values.yaml#L43) | object | `{"create":true,"groups":{"botkube-plugins-default":{"create":true,"rules":[{"apiGroups":["*"],"resources":["*"],"verbs":["get","watch","list"]}]}},"rules":[],"serviceAccountMountPath":"/var/run/7e7fd2f5-b15d-4803-bc52-f54fba357e76/secrets/kubernetes.io/serviceaccount","staticGroupName":""}` | Role Based Access for Botkube Pod and plugins. [Ref doc](https://kubernetes.io/docs/reference/access-authn-authz/rbac/ ). |
3131
| [rbac.serviceAccountMountPath](./values.yaml#L47) | string | `"/var/run/7e7fd2f5-b15d-4803-bc52-f54fba357e76/secrets/kubernetes.io/serviceaccount"` | It is used to specify a custom path for mounting a service account to the Botkube deployment. This is important because we run plugins within the same Pod, and we want to avoid potential bugs when plugins rely on the default in-cluster K8s client configuration. Instead, they should always use kubeconfig specified directly for a given plugin. |
3232
| [rbac.create](./values.yaml#L50) | bool | `true` | Configure RBAC resources for Botkube and (deprecated) `staticGroupName` subject with `rules`. For creating RBAC resources related to plugin permissions, use the `groups` property. |
3333
| [rbac.rules](./values.yaml#L52) | list | `[]` | Deprecated. Use `rbac.groups` instead. |
@@ -193,35 +193,35 @@ A virtual SRE, powered by AI.
193193
| [priorityClassName](./values.yaml#L773) | string | `""` | Priority class name for the Botkube Pod. |
194194
| [nameOverride](./values.yaml#L776) | string | `""` | Fully override "botkube.name" template. |
195195
| [fullnameOverride](./values.yaml#L778) | string | `""` | Fully override "botkube.fullname" template. |
196-
| [resources](./values.yaml#L784) | object | `{}` | The Botkube Pod resource request and limits. We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. [Ref docs](https://kubernetes.io/docs/user-guide/compute-resources/) |
196+
| [resources](./values.yaml#L784) | object | `{}` | The Botkube Pod resource request and limits. We usually recommend not to specify default resources and to leave this as a conscious choice for the user. This also increases chances charts run on environments with little resources, such as Minikube. [Ref docs](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) |
197197
| [extraEnv](./values.yaml#L796) | list | `[{"name":"LOG_LEVEL_SOURCE_BOTKUBE_KUBERNETES","value":"debug"}]` | Extra environment variables to pass to the Botkube container. [Ref docs](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#environment-variables). |
198198
| [extraVolumes](./values.yaml#L810) | list | `[]` | Extra volumes to pass to the Botkube container. Mount it later with extraVolumeMounts. [Ref docs](https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/volume/#Volume). |
199199
| [extraVolumeMounts](./values.yaml#L825) | list | `[]` | Extra volume mounts to pass to the Botkube container. [Ref docs](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#volumes-1). |
200-
| [nodeSelector](./values.yaml#L843) | object | `{}` | Node labels for Botkube Pod assignment. [Ref doc](https://kubernetes.io/docs/user-guide/node-selection/). |
200+
| [nodeSelector](./values.yaml#L843) | object | `{}` | Node labels for Botkube Pod assignment. [Ref doc](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/). |
201201
| [tolerations](./values.yaml#L847) | list | `[]` | Tolerations for Botkube Pod assignment. [Ref doc](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/). |
202202
| [affinity](./values.yaml#L851) | object | `{}` | Affinity for Botkube Pod assignment. [Ref doc](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity). |
203203
| [serviceAccount.create](./values.yaml#L855) | bool | `true` | If true, a ServiceAccount is automatically created. |
204204
| [serviceAccount.name](./values.yaml#L858) | string | `""` | The name of the service account to use. If not set, a name is generated using the fullname template. |
205205
| [serviceAccount.annotations](./values.yaml#L860) | object | `{}` | Extra annotations for the ServiceAccount. |
206206
| [extraObjects](./values.yaml#L863) | list | `[]` | Extra Kubernetes resources to create. Helm templating is allowed as it is evaluated before creating the resources. |
207-
| [analytics.disable](./values.yaml#L891) | bool | `false` | If true, sending anonymous analytics is disabled. To learn what date we collect, see [Privacy Policy](https://docs.botkube.io/privacy#privacy-policy). |
208-
| [configWatcher](./values.yaml#L895) | object | `{"enabled":true,"inCluster":{"informerResyncPeriod":"10m"}}` | Parameters for the Config Watcher component which reloads Botkube on ConfigMap changes. It restarts Botkube when configuration data change is detected. It watches ConfigMaps and/or Secrets with the `botkube.io/config-watch: "true"` label from the namespace where Botkube is installed. |
209-
| [configWatcher.enabled](./values.yaml#L897) | bool | `true` | If true, restarts the Botkube Pod on config changes. |
210-
| [configWatcher.inCluster](./values.yaml#L899) | object | `{"informerResyncPeriod":"10m"}` | In-cluster Config Watcher configuration. It is used when remote configuration is not provided. |
211-
| [configWatcher.inCluster.informerResyncPeriod](./values.yaml#L901) | string | `"10m"` | Resync period for the Config Watcher informers. |
212-
| [plugins](./values.yaml#L904) | object | `{"cacheDir":"/tmp","healthCheckInterval":"10s","incomingWebhook":{"enabled":true,"port":2115,"targetPort":2115},"repositories":{"botkube":{"url":"https://storage.googleapis.com/botkube-plugins-latest/plugins-index.yaml"}},"restartPolicy":{"threshold":10,"type":"DeactivatePlugin"}}` | Configuration for Botkube executors and sources plugins. |
213-
| [plugins.cacheDir](./values.yaml#L906) | string | `"/tmp"` | Directory, where downloaded plugins are cached. |
214-
| [plugins.repositories](./values.yaml#L908) | object | `{"botkube":{"url":"https://storage.googleapis.com/botkube-plugins-latest/plugins-index.yaml"}}` | List of plugins repositories. Each repository defines the URL and optional `headers` |
215-
| [plugins.repositories.botkube](./values.yaml#L910) | object | `{"url":"https://storage.googleapis.com/botkube-plugins-latest/plugins-index.yaml"}` | This repository serves officially supported Botkube plugins. |
216-
| [plugins.incomingWebhook](./values.yaml#L915) | object | `{"enabled":true,"port":2115,"targetPort":2115}` | Configure Incoming webhook for source plugins. |
217-
| [plugins.restartPolicy](./values.yaml#L920) | object | `{"threshold":10,"type":"DeactivatePlugin"}` | Botkube Restart Policy on plugin failure. |
218-
| [plugins.restartPolicy.type](./values.yaml#L922) | string | `"DeactivatePlugin"` | Restart policy type. Allowed values: "RestartAgent", "DeactivatePlugin". |
219-
| [plugins.restartPolicy.threshold](./values.yaml#L924) | int | `10` | Number of restarts before policy takes into effect. |
220-
| [config](./values.yaml#L928) | object | `{"provider":{"apiKey":"","endpoint":"https://api.botkube.io/graphql","identifier":""}}` | Configuration for synchronizing Botkube configuration. |
221-
| [config.provider](./values.yaml#L930) | object | `{"apiKey":"","endpoint":"https://api.botkube.io/graphql","identifier":""}` | Base provider definition. |
222-
| [config.provider.identifier](./values.yaml#L933) | string | `""` | Unique identifier for remote Botkube settings. If set to an empty string, Botkube won't fetch remote configuration. |
223-
| [config.provider.endpoint](./values.yaml#L935) | string | `"https://api.botkube.io/graphql"` | Endpoint to fetch Botkube settings from. |
224-
| [config.provider.apiKey](./values.yaml#L937) | string | `""` | Key passed as a `X-API-Key` header to the provider's endpoint. |
207+
| [analytics.disable](./values.yaml#L890) | bool | `false` | If true, sending anonymous analytics is disabled. To learn what date we collect, see the [Privacy Policy](https://botkube.io/privacy-policy). |
208+
| [configWatcher](./values.yaml#L894) | object | `{"enabled":true,"inCluster":{"informerResyncPeriod":"10m"}}` | Parameters for the Config Watcher component which reloads Botkube on ConfigMap changes. It restarts Botkube when configuration data change is detected. It watches ConfigMaps and/or Secrets with the `botkube.io/config-watch: "true"` label from the namespace where Botkube is installed. |
209+
| [configWatcher.enabled](./values.yaml#L896) | bool | `true` | If true, restarts the Botkube Pod on config changes. |
210+
| [configWatcher.inCluster](./values.yaml#L898) | object | `{"informerResyncPeriod":"10m"}` | In-cluster Config Watcher configuration. It is used when remote configuration is not provided. |
211+
| [configWatcher.inCluster.informerResyncPeriod](./values.yaml#L900) | string | `"10m"` | Resync period for the Config Watcher informers. |
212+
| [plugins](./values.yaml#L903) | object | `{"cacheDir":"/tmp","healthCheckInterval":"10s","incomingWebhook":{"enabled":true,"port":2115,"targetPort":2115},"repositories":{"botkube":{"url":"https://storage.googleapis.com/botkube-plugins-latest/plugins-index.yaml"}},"restartPolicy":{"threshold":10,"type":"DeactivatePlugin"}}` | Configuration for Botkube executors and sources plugins. |
213+
| [plugins.cacheDir](./values.yaml#L905) | string | `"/tmp"` | Directory, where downloaded plugins are cached. |
214+
| [plugins.repositories](./values.yaml#L907) | object | `{"botkube":{"url":"https://storage.googleapis.com/botkube-plugins-latest/plugins-index.yaml"}}` | List of plugins repositories. Each repository defines the URL and optional `headers` |
215+
| [plugins.repositories.botkube](./values.yaml#L909) | object | `{"url":"https://storage.googleapis.com/botkube-plugins-latest/plugins-index.yaml"}` | This repository serves officially supported Botkube plugins. |
216+
| [plugins.incomingWebhook](./values.yaml#L914) | object | `{"enabled":true,"port":2115,"targetPort":2115}` | Configure Incoming webhook for source plugins. |
217+
| [plugins.restartPolicy](./values.yaml#L919) | object | `{"threshold":10,"type":"DeactivatePlugin"}` | Botkube Restart Policy on plugin failure. |
218+
| [plugins.restartPolicy.type](./values.yaml#L921) | string | `"DeactivatePlugin"` | Restart policy type. Allowed values: "RestartAgent", "DeactivatePlugin". |
219+
| [plugins.restartPolicy.threshold](./values.yaml#L923) | int | `10` | Number of restarts before policy takes into effect. |
220+
| [config](./values.yaml#L927) | object | `{"provider":{"apiKey":"","endpoint":"https://api.botkube.io/graphql","identifier":""}}` | Configuration for synchronizing Botkube configuration. |
221+
| [config.provider](./values.yaml#L929) | object | `{"apiKey":"","endpoint":"https://api.botkube.io/graphql","identifier":""}` | Base provider definition. |
222+
| [config.provider.identifier](./values.yaml#L932) | string | `""` | Unique identifier for remote Botkube settings. If set to an empty string, Botkube won't fetch remote configuration. |
223+
| [config.provider.endpoint](./values.yaml#L934) | string | `"https://api.botkube.io/graphql"` | Endpoint to fetch Botkube settings from. |
224+
| [config.provider.apiKey](./values.yaml#L936) | string | `""` | Key passed as a `X-API-Key` header to the provider's endpoint. |
225225

226226
### AWS IRSA on EKS support
227227

‎helm/botkube/values.yaml

+4-5
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ containerSecurityContext:
3939
readOnlyRootFilesystem: true
4040

4141
# -- Role Based Access for Botkube Pod and plugins.
42-
# [Ref doc](https://kubernetes.io/docs/admin/authorization/rbac/).
42+
# [Ref doc](https://kubernetes.io/docs/reference/access-authn-authz/rbac/ ).
4343
rbac:
4444
# -- It is used to specify a custom path for mounting a service account to the Botkube deployment.
4545
# This is important because we run plugins within the same Pod, and we want to avoid potential bugs when plugins rely on
@@ -780,7 +780,7 @@ fullnameOverride: ""
780780
# -- The Botkube Pod resource request and limits. We usually recommend not to specify default resources and to leave this as a conscious
781781
# choice for the user. This also increases chances charts run on environments with little
782782
# resources, such as Minikube.
783-
# [Ref docs](https://kubernetes.io/docs/user-guide/compute-resources/)
783+
# [Ref docs](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)
784784
resources: {}
785785
## If you do want to specify resources, uncomment the following lines,
786786
## adjust them as necessary, and remove the curly braces after 'resources:'.
@@ -839,7 +839,7 @@ extraVolumeMounts: []
839839
# readOnly: true
840840

841841
# -- Node labels for Botkube Pod assignment.
842-
# [Ref doc](https://kubernetes.io/docs/user-guide/node-selection/).
842+
# [Ref doc](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/).
843843
nodeSelector: {}
844844

845845
# -- Tolerations for Botkube Pod assignment.
@@ -886,8 +886,7 @@ extraObjects: []
886886

887887
## Parameters for anonymous analytics collection.
888888
analytics:
889-
# -- If true, sending anonymous analytics is disabled. To learn what date we collect,
890-
# see [Privacy Policy](https://docs.botkube.io/privacy#privacy-policy).
889+
# -- If true, sending anonymous analytics is disabled. To learn what date we collect, see the [Privacy Policy](https://botkube.io/privacy-policy).
891890
disable: false
892891

893892
# -- Parameters for the Config Watcher component which reloads Botkube on ConfigMap changes.

0 commit comments

Comments
 (0)