Skip to content

Commit

Permalink
Update defaults for slack addon (#12)
Browse files Browse the repository at this point in the history
* Update defaults for slack addon

* helm-docs
  • Loading branch information
sfunkhouser authored Sep 14, 2023
1 parent dc18783 commit d06d87d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions charts/governor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,14 +67,14 @@ helm install governor-api equinixmetal/governor-api
| api.tracing.secrets | object | `{"enabled":false,"honeycombKey":null}` | tracing secrets, set to `true` if you want to set the value directly in the chart (not recommended) |
| audit | object | `{"auditImage":{"pullPolicy":"IfNotPresent","repository":"ghcr.io/metal-toolbox/audittail","tag":"v0.7.0"},"enabled":true,"initContainer":{"resources":{"limits":{"cpu":"100m","memory":"20Mi"},"requests":{"cpu":"100m","memory":"20Mi"}}},"resources":{"limits":{"cpu":"500m","memory":"1Gi"},"requests":{"cpu":"100m","memory":"128Mi"}},"securityContext":{"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":1000}}` | audit sidecar settings |
| k8s-otel-collector | object | `{"include_otel_attributes":false}` | settings for the otel collector sub-chart ref https://github.com/equinixmetal-helm/k8s-otel-collector |
| slackAddon | object | `{"api":{"audience":"https://api.governor.example.com","clientId":"gov-slack-addon-governor","url":"https://api.governor.example.com"},"autoscaling":{"enabled":false},"debug":false,"dryrun":false,"enabled":true,"hydra":{"url":"https://hydra.example.com/oauth2/token"},"image":{"pullPolicy":"IfNotPresent","repository":"ghcr.io/metal-toolbox/governor-slack-addon","tag":"46-c41b0158"},"nats":{"credsPath":"/nats","subjectPrefix":"equinixmetal.governor.events","url":"tls://nats.governor.hollow-a.sv15.metalkube.net:4222,tls://nats.governor.hollow-a.dc10.metalkube.net:4222,tls://nats.governor.hollow-a.ch3.metalkube.net:4222"},"nodeSelector":null,"pretty":false,"reconciler":{"interval":"1h","locking":true},"replicas":1,"resources":{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"250m","memory":"500Mi"}},"securityContext":{"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":1000},"service":{"port":80},"tolerations":null}` | slack-addon settings |
| slackAddon | object | `{"api":{"audience":"https://api.governor.example.com","clientId":"gov-slack-addon-governor","url":"https://api.governor.example.com"},"autoscaling":{"enabled":false},"debug":false,"dryrun":false,"enabled":true,"hydra":{"url":"https://hydra.example.com/oauth2/token"},"image":{"pullPolicy":"IfNotPresent","repository":"ghcr.io/metal-toolbox/governor-slack-addon","tag":"46-c41b0158"},"nats":{"credsPath":"/nats","subjectPrefix":"governor.events","url":"tls://nats.governor.example.com:4222,"},"nodeSelector":null,"pretty":false,"reconciler":{"interval":"1h","locking":true},"replicas":1,"resources":{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"250m","memory":"500Mi"}},"securityContext":{"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":1000},"service":{"port":80},"tolerations":null}` | slack-addon settings |
| slackAddon.api | object | `{"audience":"https://api.governor.example.com","clientId":"gov-slack-addon-governor","url":"https://api.governor.example.com"}` | governor-api settings to retrieve required information by the slack addon |
| slackAddon.debug | bool | `false` | set to true to turn on debug logging |
| slackAddon.dryrun | bool | `false` | dryrun on the reconcile loop |
| slackAddon.enabled | bool | `true` | set to false to disable this addon completely |
| slackAddon.hydra | object | `{"url":"https://hydra.example.com/oauth2/token"}` | hydra settings for communication with the governor-api |
| slackAddon.image | object | `{"pullPolicy":"IfNotPresent","repository":"ghcr.io/metal-toolbox/governor-slack-addon","tag":"46-c41b0158"}` | image settings for the slack addon |
| slackAddon.nats | object | `{"credsPath":"/nats","subjectPrefix":"equinixmetal.governor.events","url":"tls://nats.governor.hollow-a.sv15.metalkube.net:4222,tls://nats.governor.hollow-a.dc10.metalkube.net:4222,tls://nats.governor.hollow-a.ch3.metalkube.net:4222"}` | nats setup for the slack addon |
| slackAddon.nats | object | `{"credsPath":"/nats","subjectPrefix":"governor.events","url":"tls://nats.governor.example.com:4222,"}` | nats setup for the slack addon |
| slackAddon.pretty | bool | `false` | set to true for human readable logging |
| slackAddon.resources | dict | `{"limits":{"cpu":"500m","memory":"500Mi"},"requests":{"cpu":"250m","memory":"500Mi"}}` | resource limits & requests ref: https://kubernetes.io/docs/user-guide/compute-resources/ |
| slackAddon.securityContext | object | `{"capabilities":{"drop":["ALL"]},"readOnlyRootFilesystem":true,"runAsNonRoot":true,"runAsUser":1000}` | Security context to be added to the deployment |
Expand Down
4 changes: 2 additions & 2 deletions charts/governor/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ slackAddon:

# -- nats setup for the slack addon
nats:
url: tls://nats.governor.hollow-a.sv15.metalkube.net:4222,tls://nats.governor.hollow-a.dc10.metalkube.net:4222,tls://nats.governor.hollow-a.ch3.metalkube.net:4222
url: tls://nats.governor.example.com:4222,
credsPath: /nats
subjectPrefix: equinixmetal.governor.events
subjectPrefix: governor.events

# reconciler will run at the defined interval to ensure no events were missed
reconciler:
Expand Down

0 comments on commit d06d87d

Please sign in to comment.