/
values.yaml
1230 lines (1154 loc) · 50.1 KB
/
values.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Formatting rules:
#
# | Sign | Description |
# |------|--------------------------------------------------------------------------|
# | # -- | Comment is rendered into README.md. |
# | # | Only if defined after '# --' signifies the continuation of the sentence. |
# | ## | Comment is ignored during README.md rendering. |
#
# Read more at https://github.com/norwoodj/helm-docs
## Botkube image configuration.
image:
# -- Botkube container image registry.
registry: ghcr.io
# -- Botkube container image repository.
repository: kubeshop/botkube
# -- Botkube container image pull policy.
pullPolicy: IfNotPresent
# -- Botkube container image tag. Default tag is `appVersion` from Chart.yaml.
tag: v1.7.0
# -- Configures Pod Security Policy to allow Botkube to run in restricted clusters.
# [Ref doc](https://kubernetes.io/docs/concepts/policy/pod-security-policy/).
podSecurityPolicy:
enabled: false
# -- 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).
# @default -- Runs as a Non-Privileged user.
securityContext:
runAsUser: 101
runAsGroup: 101
# -- Configures container security context.
# [Ref doc](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container).
containerSecurityContext:
privileged: false
allowPrivilegeEscalation: false
readOnlyRootFilesystem: true
# -- Role Based Access for Botkube Pod and plugins.
# [Ref doc](https://kubernetes.io/docs/admin/authorization/rbac/).
rbac:
# -- 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.
serviceAccountMountPath: /var/run/7e7fd2f5-b15d-4803-bc52-f54fba357e76/secrets/kubernetes.io/serviceaccount
# -- Configure RBAC resources for Botkube and (deprecated) `staticGroupName` subject with `rules`.
# For creating RBAC resources related to plugin permissions, use the `groups` property.
create: true
# -- Deprecated. Use `rbac.groups` instead.
rules: []
# -- Deprecated. Use `rbac.groups` instead.
staticGroupName: ""
# -- Use this to create RBAC resources for specified group subjects.
groups:
'botkube-plugins-default':
create: true
rules:
- apiGroups: ["*"]
resources: ["*"]
verbs: ["get", "watch", "list"]
'argocd':
# -- Set it to `true` when using ArgoCD source plugin.
create: false
rules:
- apiGroups: [""]
resources: ["configmaps"]
verbs: ["get", "update"]
- apiGroups: ["argoproj.io"]
resources: ["applications"]
verbs: ["get", "patch"]
'flux-read-patch':
# -- Set it to `true` when using Flux executor plugin to enable `flux diff`.
create: false
rules:
- apiGroups: ["*"]
resources: ["*"]
verbs: ["get", "watch", "list", "patch"]
## Kubeconfig settings used by Botkube.
kubeconfig:
# -- If true, enables overriding the Kubernetes auth.
enabled: false
# -- A base64 encoded kubeconfig that will be stored in a Secret, mounted to the Pod, and specified in the KUBECONFIG environment variable.
base64Config: ""
# -- A Secret containing a kubeconfig to use.
## Secret format:
## data:
## config: {base64_encoded_kubeconfig}
existingSecret: ""
# -- Map of actions. Action contains configuration for automation based on observed events.
# The property name under `actions` object is an alias for a given configuration. You can define multiple actions configuration with different names.
# @default -- See the `values.yaml` file for full object.
#
## Format: actions.{alias}
actions:
'describe-created-resource':
# -- If true, enables the action.
enabled: false
# -- Action display name posted in the channels bound to the same source bindings.
displayName: "Describe created resource"
# -- Command to execute when the action is triggered. You can use Go template (https://pkg.go.dev/text/template) together with all helper functions defined by Slim-Sprig library (https://go-task.github.io/slim-sprig).
# You can use the `{{ .Event }}` variable, which contains the event object that triggered the action.
# See all available Kubernetes event properties on https://github.com/kubeshop/botkube/blob/main/internal/source/kubernetes/event/event.go.
# @default -- See the `values.yaml` file for the command in the Go template form.
command: "kubectl describe {{ .Event.Kind | lower }}{{ if .Event.Namespace }} -n {{ .Event.Namespace }}{{ end }} {{ .Event.Name }}"
# -- Bindings for a given action.
bindings:
# -- Event sources that trigger a given action.
sources:
- k8s-create-events
# -- Executors configuration used to execute a configured command.
executors:
- k8s-default-tools
'show-logs-on-error':
# -- If true, enables the action.
enabled: false
# -- Action display name posted in the channels bound to the same source bindings.
displayName: "Show logs on error"
# -- Command to execute when the action is triggered. You can use Go template (https://pkg.go.dev/text/template) together with all helper functions defined by Slim-Sprig library (https://go-task.github.io/slim-sprig).
# You can use the `{{ .Event }}` variable, which contains the event object that triggered the action.
# See all available Kubernetes event properties on https://github.com/kubeshop/botkube/blob/main/internal/source/kubernetes/event/event.go.
# @default -- See the `values.yaml` file for the command in the Go template form.
command: "kubectl logs {{ .Event.Kind | lower }}/{{ .Event.Name }} -n {{ .Event.Namespace }}"
# -- Bindings for a given action.
bindings:
# -- Event sources that trigger a given action.
sources:
- k8s-err-with-logs-events
# -- Executors configuration used to execute a configured command.
executors:
- k8s-default-tools
# -- Map of sources. Source contains configuration for Kubernetes events and sending recommendations.
# The property name under `sources` object is an alias for a given configuration. You can define multiple sources configuration with different names.
# Key name is used as a binding reference.
# @default -- See the `values.yaml` file for full object.
#
## Format: sources.{alias}
sources:
'k8s-recommendation-events':
displayName: "Kubernetes Recommendations"
# -- Describes Kubernetes source configuration.
# @default -- See the `values.yaml` file for full object.
botkube/kubernetes:
context: &default-plugin-context
# -- RBAC configuration for this plugin.
rbac:
group:
# -- Static impersonation for a given username and groups.
type: Static
# -- Prefix that will be applied to .static.value[*].
prefix: ""
static:
# -- Name of group.rbac.authorization.k8s.io the plugin will be bound to.
values: ["botkube-plugins-default"]
# user:
# type: Static
# -- Prefix that will be applied to .static.value[*].
# prefix: ""
# static:
# -- Name of user.rbac.authorization.k8s.io the plugin will be bound to.
# value: ""
enabled: true
config:
namespaces:
include:
- ".*"
# -- Describes configuration for various recommendation insights.
recommendations:
# -- Recommendations for Pod Kubernetes resource.
pod:
# -- If true, notifies about Pod containers that use `latest` tag for images.
noLatestImageTag: true
# -- If true, notifies about Pod resources created without labels.
labelsSet: true
# -- Recommendations for Ingress Kubernetes resource.
ingress:
# -- If true, notifies about Ingress resources with invalid backend service reference.
backendServiceValid: true
# -- If true, notifies about Ingress resources with invalid TLS secret reference.
tlsSecretValid: true
'k8s-all-events':
displayName: "Kubernetes Info"
# -- Describes Kubernetes source configuration.
# @default -- See the `values.yaml` file for full object.
botkube/kubernetes:
context: *default-plugin-context
enabled: true
config:
# -- Filter settings for various sources.
# @default -- See the `values.yaml` file for full object.
filters:
# -- If true, enables support for `botkube.io/disable` resource annotation.
objectAnnotationChecker: true
# -- If true, filters out Node-related events that are not important.
nodeEventsChecker: true
# -- Describes namespaces for every Kubernetes resources you want to watch or exclude.
# These namespaces are applied to every resource specified in the resources list.
# However, every specified resource can override this by using its own namespaces object.
namespaces: &k8s-events-namespaces
# -- Include contains a list of allowed Namespaces.
# It can also contain regex expressions:
# `- ".*"` - to specify all Namespaces.
include:
- ".*"
# -- Exclude contains a list of Namespaces to be ignored even if allowed by Include.
# It can also contain regex expressions:
# `- "test-.*"` - to specif all Namespaces with `test-` prefix.
# Exclude list is checked before the Include list.
# exclude: []
# -- Describes event constraints for Kubernetes resources.
# These constraints are applied for every resource specified in the `resources` list, unless they are overridden by the resource's own `events` object.
event:
# -- Lists all event types to be watched.
types:
- create
- delete
- error
# -- Optional list of exact values or regex patterns to filter events by event reason.
# Skipped, if both include/exclude lists are empty.
reason:
# -- Include contains a list of allowed values. It can also contain regex expressions.
include: []
# -- Exclude contains a list of values to be ignored even if allowed by Include. It can also contain regex expressions.
# Exclude list is checked before the Include list.
exclude: []
# -- Optional list of exact values or regex patterns to filter event by event message. Skipped, if both include/exclude lists are empty.
# If a given event has multiple messages, it is considered a match if any of the messages match the constraints.
message:
# -- Include contains a list of allowed values. It can also contain regex expressions.
include: []
# -- Exclude contains a list of values to be ignored even if allowed by Include. It can also contain regex expressions.
# Exclude list is checked before the Include list.
exclude: []
# -- Filters Kubernetes resources to watch by annotations. Each resource needs to have all the specified annotations.
# Regex expressions are not supported.
annotations: {}
# -- Filters Kubernetes resources to watch by labels. Each resource needs to have all the specified labels.
# Regex expressions are not supported.
labels: {}
# -- Describes the Kubernetes resources to watch.
# Resources are identified by its type in `{group}/{version}/{kind (plural)}` format. Examples: `apps/v1/deployments`, `v1/pods`.
# Each resource can override the namespaces and event configuration by using dedicated `event` and `namespaces` field.
# Also, each resource can specify its own `annotations`, `labels` and `name` regex.
# @default -- See the `values.yaml` file for full object.
resources:
- type: v1/pods
# namespaces: # Overrides 'source'.kubernetes.namespaces
# include:
# - ".*"
# exclude: []
# annotations: {} # Overrides 'source'.kubernetes.annotations
# labels: {} # Overrides 'source'.kubernetes.labels
# # Optional resource name constraints.
# name:
# # Include contains a list of allowed values. It can also contain regex expressions.
# include: []
# # Exclude contains a list of values to be ignored even if allowed by Include. It can also contain regex expressions.
# # Exclude list is checked before the Include list.
# exclude: []
# event:
# # Overrides 'source'.kubernetes.event.reason
# reason:
# include: []
# exclude: []
# # Overrides 'source'.kubernetes.event.message
# message:
# include: []
# exclude: []
# # Overrides 'source'.kubernetes.event.types
# types:
# - create
- type: v1/services
- type: networking.k8s.io/v1/ingresses
- type: v1/nodes
event:
message:
exclude:
- ".*nf_conntrack_buckets.*" # Ignore node related noisy messages from GKE clusters
- type: v1/namespaces
- type: v1/persistentvolumes
- type: v1/persistentvolumeclaims
- type: v1/configmaps
- type: rbac.authorization.k8s.io/v1/roles
- type: rbac.authorization.k8s.io/v1/rolebindings
- type: rbac.authorization.k8s.io/v1/clusterrolebindings
- type: rbac.authorization.k8s.io/v1/clusterroles
- type: apps/v1/daemonsets
event: # Overrides 'source'.kubernetes.event
types:
- create
- update
- delete
- error
updateSetting:
includeDiff: true
fields:
- spec.template.spec.containers[*].image
- status.numberReady
- type: batch/v1/jobs
event: # Overrides 'source'.kubernetes.event
types:
- create
- update
- delete
- error
updateSetting:
includeDiff: true
fields:
- spec.template.spec.containers[*].image
- status.conditions[*].type
- type: apps/v1/deployments
event: # Overrides 'source'.kubernetes.event
types:
- create
- update
- delete
- error
updateSetting:
includeDiff: true
fields:
- spec.template.spec.containers[*].image
- status.availableReplicas
- type: apps/v1/statefulsets
event: # Overrides 'source'.kubernetes.event
types:
- create
- update
- delete
- error
updateSetting:
includeDiff: true
fields:
- spec.template.spec.containers[*].image
- status.readyReplicas
## Custom resource example
# - type: velero.io/v1/backups
# namespaces:
# include:
# - ".*"
# exclude:
# -
# event:
# types:
# - create
# - update
# - delete
# - error
# updateSetting:
# includeDiff: true
# fields:
# - status.phase
'k8s-err-events':
displayName: "Kubernetes Errors"
# -- Describes Kubernetes source configuration.
# @default -- See the `values.yaml` file for full object.
botkube/kubernetes:
context: *default-plugin-context
enabled: true
config:
# -- Describes namespaces for every Kubernetes resources you want to watch or exclude.
# These namespaces are applied to every resource specified in the resources list.
# However, every specified resource can override this by using its own namespaces object.
namespaces: *k8s-events-namespaces
# -- Describes event constraints for Kubernetes resources.
# These constraints are applied for every resource specified in the `resources` list, unless they are overridden by the resource's own `events` object.
event:
# -- Lists all event types to be watched.
types:
- error
# -- Describes the Kubernetes resources you want to watch.
# @default -- See the `values.yaml` file for full object.
resources:
- type: v1/pods
- type: v1/services
- type: networking.k8s.io/v1/ingresses
- type: v1/nodes
event:
message:
exclude:
- ".*nf_conntrack_buckets.*" # Ignore node related noisy messages from GKE clusters
- type: v1/namespaces
- type: v1/persistentvolumes
- type: v1/persistentvolumeclaims
- type: v1/configmaps
- type: rbac.authorization.k8s.io/v1/roles
- type: rbac.authorization.k8s.io/v1/rolebindings
- type: rbac.authorization.k8s.io/v1/clusterrolebindings
- type: rbac.authorization.k8s.io/v1/clusterroles
- type: apps/v1/deployments
- type: apps/v1/statefulsets
- type: apps/v1/daemonsets
- type: batch/v1/jobs
'k8s-err-with-logs-events':
displayName: "Kubernetes Errors for resources with logs"
# -- Describes Kubernetes source configuration.
# @default -- See the `values.yaml` file for full object.
botkube/kubernetes:
context: *default-plugin-context
enabled: true
config:
# -- Describes namespaces for every Kubernetes resources you want to watch or exclude.
# These namespaces are applied to every resource specified in the resources list.
# However, every specified resource can override this by using its own namespaces object.
namespaces: *k8s-events-namespaces
# -- Describes event constraints for Kubernetes resources.
# These constraints are applied for every resource specified in the `resources` list, unless they are overridden by the resource's own `events` object.
event:
# -- Lists all event types to be watched.
types:
- error
# -- Describes the Kubernetes resources you want to watch.
# @default -- See the `values.yaml` file for full object.
resources:
- type: v1/pods
- type: apps/v1/deployments
- type: apps/v1/statefulsets
- type: apps/v1/daemonsets
- type: batch/v1/jobs
# `apps/v1/replicasets` excluded on purpose - to not show logs twice for a given higher-level resource (e.g. Deployment)
'k8s-create-events':
displayName: "Kubernetes Resource Created Events"
# -- Describes Kubernetes source configuration.
# @default -- See the `values.yaml` file for full object.
botkube/kubernetes:
context: *default-plugin-context
enabled: true
config:
# -- Describes namespaces for every Kubernetes resources you want to watch or exclude.
# These namespaces are applied to every resource specified in the resources list.
# However, every specified resource can override this by using its own namespaces object.
namespaces: *k8s-events-namespaces
# -- Describes event constraints for Kubernetes resources.
# These constraints are applied for every resource specified in the `resources` list, unless they are overridden by the resource's own `events` object.
event:
# -- Lists all event types to be watched.
types:
- create
# -- Describes the Kubernetes resources you want to watch.
# @default -- See the `values.yaml` file for full object.
resources:
- type: v1/pods
- type: v1/services
- type: networking.k8s.io/v1/ingresses
- type: v1/nodes
- type: v1/namespaces
- type: v1/configmaps
- type: apps/v1/deployments
- type: apps/v1/statefulsets
- type: apps/v1/daemonsets
- type: batch/v1/jobs
k8s-err-events-with-ai-support:
displayName: "Kubernetes Errors with AI support"
# -- Describes Kubernetes source configuration.
# @default -- See the `values.yaml` file for full object.
botkube/kubernetes:
context: *default-plugin-context
enabled: false
config:
# -- Define extra buttons to be displayed beside notification message.
extraButtons:
- enabled: true
trigger:
type: ["error"]
button:
displayName: "Get Help"
commandTpl: "doctor --resource={{ .Kind | lower }}/{{ .Name }} --namespace={{ .Namespace }} --error={{ .Reason }} --bk-cmd-header='AI assistance'"
# -- Describes namespaces for every Kubernetes resources you want to watch or exclude.
# These namespaces are applied to every resource specified in the resources list.
# However, every specified resource can override this by using its own namespaces object.
namespaces: *k8s-events-namespaces
# -- Describes event constraints for Kubernetes resources.
# These constraints are applied for every resource specified in the `resources` list, unless they are overridden by the resource's own `events` object.
event:
# -- Lists all event types to be watched.
types:
- error
# -- Describes the Kubernetes resources you want to watch.
# @default -- See the `values.yaml` file for full object.
resources:
- type: v1/pods
- type: v1/services
- type: networking.k8s.io/v1/ingresses
- type: v1/nodes
event:
message:
exclude:
- ".*nf_conntrack_buckets.*" # Ignore node related noisy messages from GKE clusters
- type: v1/namespaces
- type: v1/persistentvolumes
- type: v1/persistentvolumeclaims
- type: v1/configmaps
- type: rbac.authorization.k8s.io/v1/roles
- type: rbac.authorization.k8s.io/v1/rolebindings
- type: rbac.authorization.k8s.io/v1/clusterrolebindings
- type: rbac.authorization.k8s.io/v1/clusterroles
- type: apps/v1/deployments
- type: apps/v1/statefulsets
- type: apps/v1/daemonsets
- type: batch/v1/jobs
'prometheus':
## Prometheus source configuration
## Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
botkube/prometheus:
# -- If true, enables `prometheus` source.
enabled: false
config:
# -- Prometheus endpoint without api version and resource.
url: "http://localhost:9090"
# -- If set as true, Prometheus source plugin will not send alerts that is created before plugin start time.
ignoreOldAlerts: true
# -- Only the alerts that have state provided in this config will be sent as notification. https://pkg.go.dev/github.com/prometheus/prometheus/rules#AlertState
alertStates: ["firing", "pending", "inactive"]
# -- Logging configuration
log:
# -- Log level
level: info
'keptn':
## Keptn source configuration
## Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
botkube/keptn:
# -- If true, enables `keptn` source.
enabled: false
config:
# -- Keptn API Gateway URL.
url: "http://api-gateway-nginx.keptn.svc.cluster.local/api"
# -- Keptn API Token to access events through API Gateway.
token: ""
# -- Optional Keptn project.
project: ""
# -- Optional Keptn Service name under the project.
service: ""
# -- Logging configuration
log:
# -- Log level
level: info
'argocd':
botkube/argocd:
enabled: false
context:
rbac:
group:
type: Static
static:
values: ["argocd"]
# -- Config contains configuration for ArgoCD source plugin.
# This section lists only basic options, and uses default triggers and templates
# which are based on ArgoCD Notification Catalog ones (https://github.com/argoproj/argo-cd/blob/master/notifications_catalog/install.yaml).
# Advanced customization (including triggers and templates) is described in the documentation.
config:
defaultSubscriptions:
# -- Provide application name and namespace to subscribe to all events for a given application.
applications:
- name: "guestbook"
namespace: "argocd"
argoCD:
# -- ArgoCD UI base URL. It is used for generating links in the incoming events.
uiBaseUrl: http://localhost:8080
# -- ArgoCD Notifications ConfigMap reference.
notificationsConfigMap:
name: argocd-notifications-cm
namespace: argocd
# -- Map of executors. Executor contains configuration for running `kubectl` commands.
# The property name under `executors` is an alias for a given configuration. You can define multiple executor configurations with different names.
# Key name is used as a binding reference.
# @default -- See the `values.yaml` file for full object.
#
## Format: executors.{alias}
executors:
k8s-default-tools:
## Helm executor configuration
## Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
botkube/helm:
# -- If true, enables `helm` commands execution.
enabled: false
config:
# Configures the default Namespace for executing Botkube `helm` commands. If not set, uses 'default'.
defaultNamespace: "default"
# -- Allowed values are configmap, secret, memory.
helmDriver: "secret"
# -- Location for storing Helm configuration.
helmConfigDir: "/tmp/helm/"
# -- Location for storing cached files. Must be under the Helm config directory.
helmCacheDir: "/tmp/helm/.cache"
context: *default-plugin-context
## Kubectl executor configuration
## Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
botkube/kubectl:
enabled: false
# -- Custom kubectl configuration.
# @default -- See the `values.yaml` file for full object including optional properties related to interactive builder.
config:
# Configures the default Namespace for executing Botkube `kubectl` commands. If not set, uses 'default'.
defaultNamespace: "default"
# # Configures Kubectl internal logger. Messages are send to stdout.
# # To see the plugin standard output you need to enable it. Learn more at https://docs.botkube.io/plugin/debugging/.
# log:
# level: "info"
# # Configures the interactive kubectl command builder.
# interactiveBuilder:
# allowed:
# # Configures which K8s namespace are displayed in namespace dropdown.
# # If not specified, plugin needs to have access to fetch all Namespaces, otherwise Namespace dropdown won't be visible at all.
# namespaces: [ "default" ]
# # Configures which `kubectl` methods are displayed in commands dropdown.
# verbs: [ "api-resources", "api-versions", "cluster-info", "describe", "explain", "get", "logs", "top" ]
# # Configures which K8s resource are displayed in resources dropdown.
# resources: [ "deployments", "pods", "namespaces", "daemonsets", "statefulsets", "storageclasses", "nodes", "configmaps", "services", "ingresses", "replicasets", "secrets", "cronjobs", "jobs" ]
context: *default-plugin-context
bins-management:
## Exec executor configuration.
## Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
botkube/exec:
enabled: false
context: *default-plugin-context
## -- Custom exec plugin configuration.
config:
## -- An array of templates that define how to convert the command output into an interactive message.
templates:
## -- Link to templates source
## It uses the go-getter library, which supports multiple URL formats (such as HTTP, Git repositories, or S3) and is able to unpack archives.
## For more details, see the documentation at https://github.com/hashicorp/go-getter.
- ref: github.com/kubeshop/botkube//cmd/executor/exec/templates?ref=v1.7.0
ai:
## Doctor executor configuration.
## Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
botkube/doctor:
enabled: false
context: *default-plugin-context
## -- Custom doctor plugin configuration.
config:
# # To see the plugin standard output you need to enable it. Learn more at https://docs.botkube.io/plugin/debugging/.
# log:
# level: "info"
## -- Open API key for accessing the ChatGPT engine. You can get it at https://platform.openai.com/account/api-keys.
apiKey: ""
## -- OpenAI API Base URL. If empty, the default "https://api.openai.com/v1" value is used.
apiBaseUrl: ""
## -- Default engine to use. If empty, "text-davinci-003" engine is used.
defaultEngine: ""
## -- Optional organization ID for requests.
organizationID: ""
## -- User agent to use for requests. If empty, the default value is used ("go-gpt3").
userAgent: ""
flux:
# Flux executor configuration.
## Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
botkube/flux:
enabled: false
context:
rbac:
group:
type: Static
static:
values: ["botkube-plugins-default", "flux-read-patch"]
## -- Flux executor plugin configuration.
config:
# -- Logging configuration
log:
# -- Log level
level: info
github:
auth:
# GitHub access token.
# Instructions for token creation: https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/#creating-a-token.
# Lack of token may limit functionality, e.g., adding comments to pull requests or approving them.
accessToken: ""
# -- Custom aliases for given commands.
# The aliases are replaced with the underlying command before executing it.
# Aliases can replace a single word or multiple ones. For example, you can define a `k` alias for `kubectl`, or `kgp` for `kubectl get pods`.
# @default -- See the `values.yaml` file for full object.
#
## Format: aliases.{alias}
aliases:
kc:
command: kubectl
displayName: "Kubectl alias"
k:
command: kubectl
displayName: "Kubectl alias"
chatgpt:
command: doctor
displayName: "Doctor alias"
x:
command: exec
displayName: "Exec alias"
## Multi-word alias example:
# kgp:
# command: kubectl get pods
# displayName: "Get pods"
# -- Configures existing Secret with communication settings. It MUST be in the `botkube` Namespace.
# To reload Botkube once it changes, add label `botkube.io/config-watch: "true"`.
## Secret format:
## stringData:
## comm_config.yaml: |
## communications:
## # Here specify settings for each app, like Slack, Mattermost etc.
## # NOTE: Use setting format visible below.
existingCommunicationsSecretName: ""
# -- Map of communication groups. Communication group contains settings for multiple communication platforms.
# The property name under `communications` object is an alias for a given configuration group. You can define multiple communication groups with different names.
# @default -- See the `values.yaml` file for full object.
#
## Format: communications.{alias}
communications:
'default-group':
## Settings for Slack with Socket Mode.
socketSlack:
# -- If true, enables Slack bot.
enabled: false
# -- Map of configured channels. The property name under `channels` object is an alias for a given configuration.
#
## Format: channels.{alias}
channels:
'default':
# -- Slack channel name without '#' prefix where you have added Botkube and want to receive notifications in.
name: 'SLACK_CHANNEL'
bindings:
# -- Executors configuration for a given channel.
executors:
- k8s-default-tools
- bins-management
- ai
- flux
# -- Notification sources configuration for a given channel.
sources:
- k8s-err-events
- k8s-recommendation-events
- k8s-err-events-with-ai-support
- argocd
# -- Slack bot token for your own Slack app.
# [Ref doc](https://api.slack.com/authentication/token-types).
botToken: ''
# -- Slack app-level token for your own Slack app.
# [Ref doc](https://api.slack.com/authentication/token-types).
appToken: ''
## Settings for Mattermost.
mattermost:
# -- If true, enables Mattermost bot.
enabled: false
# -- User in Mattermost which belongs the specified Personal Access token.
botName: 'Botkube'
# -- The URL (including http/https schema) where Mattermost is running. e.g https://example.com:9243
url: 'MATTERMOST_SERVER_URL'
# -- Personal Access token generated by Botkube user.
token: 'MATTERMOST_TOKEN'
# -- The Mattermost Team name where Botkube is added.
team: 'MATTERMOST_TEAM'
# -- Map of configured channels. The property name under `channels` object is an alias for a given configuration.
#
## Format: channels.{alias}
channels:
'default':
# -- The Mattermost channel name for receiving Botkube alerts.
# The Botkube user needs to be added to it.
name: 'MATTERMOST_CHANNEL'
notification:
# -- If true, the notifications are not sent to the channel. They can be enabled with `@Botkube` command anytime.
disabled: false
bindings:
# -- Executors configuration for a given channel.
executors:
- k8s-default-tools
- bins-management
- ai
- flux
# -- Notification sources configuration for a given channel.
sources:
- k8s-err-events
- k8s-recommendation-events
- k8s-err-events-with-ai-support
- argocd
## Settings for MS Teams.
teams:
# -- If true, enables MS Teams bot.
enabled: false
# -- The Bot name set while registering Bot to MS Teams.
botName: 'Botkube'
# -- The Botkube application ID generated while registering Bot to MS Teams.
appID: 'APPLICATION_ID'
# -- The Botkube application password generated while registering Bot to MS Teams.
appPassword: 'APPLICATION_PASSWORD'
bindings:
# -- Executor bindings apply to all MS Teams channels where Botkube has access to.
executors:
- k8s-default-tools
- bins-management
- ai
- flux
# -- Source bindings apply to all channels which have notification turned on with `@Botkube enable notifications` command.
sources:
- k8s-err-events
- k8s-recommendation-events
- k8s-err-events-with-ai-support
- argocd
# -- The path in endpoint URL provided while registering Botkube to MS Teams.
messagePath: "/bots/teams"
# -- The Service port for bot endpoint on Botkube container.
port: 3978
## Settings for Discord.
discord:
# -- If true, enables Discord bot.
enabled: false
# -- Botkube Bot Token.
token: 'DISCORD_TOKEN'
# -- Botkube Application Client ID.
botID: 'DISCORD_BOT_ID'
# -- Map of configured channels. The property name under `channels` object is an alias for a given configuration.
#
## Format: channels.{alias}
channels:
'default':
# -- Discord channel ID for receiving Botkube alerts.
# The Botkube user needs to be added to it.
id: 'DISCORD_CHANNEL_ID'
notification:
# -- If true, the notifications are not sent to the channel. They can be enabled with `@Botkube` command anytime.
disabled: false
bindings:
# -- Executors configuration for a given channel.
executors:
- k8s-default-tools
- bins-management
- ai
- flux
# -- Notification sources configuration for a given channel.
sources:
- k8s-err-events
- k8s-recommendation-events
- k8s-err-events-with-ai-support
- argocd
## Settings for Elasticsearch.
elasticsearch:
# -- If true, enables Elasticsearch.
enabled: false
awsSigning:
# -- If true, enables awsSigning using IAM for Elasticsearch hosted on AWS. Make sure AWS environment variables are set.
# [Ref doc](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html).
enabled: false
# -- AWS region where Elasticsearch is deployed.
awsRegion: "us-east-1"
# -- AWS IAM Role arn to assume for credentials, use this only if you don't want to use the EC2 instance role or not running on AWS instance.
roleArn: ""
# -- The server URL, e.g https://example.com:9243
server: 'ELASTICSEARCH_ADDRESS'
# -- Basic Auth username.
username: 'ELASTICSEARCH_USERNAME'
# -- Basic Auth password.
password: 'ELASTICSEARCH_PASSWORD'
# -- If true, skips the verification of TLS certificate of the Elastic nodes.
# It's useful for clusters with self-signed certificates.
skipTLSVerify: false
# -- Specify the log level for Elasticsearch client. Leave empty to disable logging.
## Possible values: "info", "error", "trace".
## - "info": Logs information level messages.
## - "error": Logs information and error level messages.
## - "trace": Logs information, error, and trace level messages.
## To disable logging, simply leave the logLevel empty or remove the line.
logLevel: ""
# -- Map of configured indices. The `indices` property name is an alias for a given configuration.
#
## Format: indices.{alias}
indices:
'default':
# -- Configures Elasticsearch index settings.
name: botkube
type: botkube-event
shards: 1
replicas: 0
bindings:
# -- Notification sources configuration for a given index.
sources:
- k8s-err-events
- k8s-recommendation-events
## Settings for Webhook.
webhook:
# -- If true, enables Webhook.
enabled: false
# -- The Webhook URL, e.g.: https://example.com:80
url: 'WEBHOOK_URL'
bindings:
# -- Notification sources configuration for the webhook.
sources:
- k8s-err-events
- k8s-recommendation-events
# -- Settings for deprecated Slack integration.
# **DEPRECATED:** Legacy Slack integration has been deprecated and removed from the Slack App Directory.
# Use `socketSlack` instead. Read more here: https://docs.botkube.io/installation/slack/
#
# @default -- See the `values.yaml` file for full object.
## This object will be removed as a part of https://github.com/kubeshop/botkube/issues/865.
slack:
enabled: false
channels:
'default':
name: 'SLACK_CHANNEL'
notification:
disabled: false
bindings:
executors:
- k8s-default-tools
sources:
- k8s-err-events
- k8s-recommendation-events
token: ''
## Global Botkube configuration.
settings:
# -- Cluster name to differentiate incoming messages.
clusterName: not-configured
# -- Server configuration which exposes functionality related to the app lifecycle.
lifecycleServer:
enabled: true
port: 2113
healthPort: 2114
# -- If true, notifies about new Botkube releases.
upgradeNotifier: true
## Botkube logging settings.
log:
# -- Sets one of the log levels. Allowed values: `info`, `warn`, `debug`, `error`, `fatal`, `panic`.
level: info
# -- If true, disable ANSI colors in logging. Ignored when `json` formatter is used.
disableColors: false
# -- Configures log format. Allowed values: `text`, `json`.
formatter: json
# -- Botkube's system ConfigMap where internal data is stored.
systemConfigMap:
name: botkube-system
# -- Persistent config contains ConfigMap where persisted configuration is stored.
# The persistent configuration is evaluated from both chart upgrade and Botkube commands used in runtime.
persistentConfig:
startup:
configMap:
name: botkube-startup-config
annotations: {}
fileName: "_startup_state.yaml"
runtime:
configMap:
name: botkube-runtime-config
annotations: {}
fileName: "_runtime_state.yaml"
## For using custom SSL certificates.
ssl:
# -- If true, specify cert path in `config.ssl.cert` property or K8s Secret in `config.ssl.existingSecretName`.
enabled: false
# -- Using existing SSL Secret. It MUST be in `botkube` Namespace.
## Secret format:
## data:
## config: {base64_encoded_kubeconfig}
existingSecretName: ""
# -- SSL Certificate file e.g certs/my-cert.crt.