Doc 686 Update descriptions of configs in the RP Connect values file #1594
Conversation
JakeSCahill
requested review from
RafalKorepta,
chrisseto and
andrewstucki
as code owners
| @@ -8,77 +8,13 @@ description: Find the default values and descriptions of settings in the Redpand | |||
| {{ define "chart.description" -}} | |||
| Redpanda Connect is a high performance and resilient stream processor, able to connect various sources and sinks in a range of brokering patterns and perform hydration, enrichments, transformations and filters on payloads. | |||
|
|
|||
| This Helm Chart deploys a single Redpanda Connect instance in either streams mode or standalone. | |||
There was a problem hiding this comment.
This is all being moved to docs to avoid long-form guides in the reference.
|
|
||
| When deploying Redpanda Connect in streams mode, you may want to configure global tracing, logging and http configuration which is shared across all of your pipelines. | ||
| For instructions on how to install and use the chart, including how to override and customize the chart's values, refer to the [deployment documentation](https://docs.redpanda.com/redpanda-connect/get-started/helm-chart/). |
There was a problem hiding this comment.
This page will go live when the docs PR is merged: redpanda-data/rp-connect-docs#89
| terminationGracePeriodSeconds: 60 | ||
| # Rollout the deployment on ConfigMap changes | ||
| # -- Rollout the deployment on ConfigMap changes. |
There was a problem hiding this comment.
I tried testing this but not sure how it works. Could someone confirm what it's supposed to do?
There was a problem hiding this comment.
If user would update (helm upgrade) connect configuration which would only change ConfigMap the Deployment and along with it Pods would not picked up (missing iNotify events probably in Redpanda Connect). That's why config map sha256 sum annotation set in Deployment would help automate config change rollout.
template:
metadata:
annotations:
{{- if .Values.deployment.rolloutConfigMap }}
checksum/config: {{ include (print $.Template.BasePath "/configmap.yaml") . | sha256sum }}
{{- end}}
helm-charts/charts/connect/templates/deployment.yaml
Lines 20 to 25 in 0eab2ff
There was a problem hiding this comment.
But as I see https://github.com/redpanda-data/helm-charts/pull/1594/files#diff-2d6335db92d8ff0df28b4fea97de9c234115fdca59c11fb7a09f7c86275d0539R320 watch option should be mentioned here :) just to cross reference such 'watch' capability.
|
Adding @ooesili as a reviewer. |
RafalKorepta
force-pushed
the
DOC-686
branch
from
2b5c5f4 to
7843bbd
Compare
RafalKorepta
force-pushed
the
DOC-686
branch
from
7843bbd to
bae0c53
Compare
No description provided.