From 2420846895000b400d22e91822201ec0071e257a Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Wed, 6 Nov 2024 15:51:27 +0000 Subject: [PATCH] Update docs for Connect chart values file --- CHANGELOG.md | 5 + charts/connect/Chart.yaml | 2 +- charts/connect/README.md | 474 +++++++++++++++++++++----------- charts/connect/README.md.gotmpl | 74 +---- charts/connect/values.yaml | 121 ++++++-- 5 files changed, 418 insertions(+), 258 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 866c354929..3c2069bfcb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -508,6 +508,11 @@ #### Removed ## Connect Chart + +### [3.0.3](https://github.com/redpanda-data/helm-charts/releases/tag/connect-3.0.3) +#### Changed +* Added complete descriptions for all options in the `values.yaml`. + ### [3.0.2](https://github.com/redpanda-data/helm-charts/releases/tag/connect-3.0.2) #### Changed * Bump Connect app version to 4.42.0 diff --git a/charts/connect/Chart.yaml b/charts/connect/Chart.yaml index bd7ab46985..20464f68c9 100644 --- a/charts/connect/Chart.yaml +++ b/charts/connect/Chart.yaml @@ -24,7 +24,7 @@ type: application # The chart version and the app version are not the same and will not track # together. The chart version is a semver representation of changes to this # chart. -version: 3.0.2 +version: 3.0.3 # The app version is the default version of Redpanda to install. # ** NOTE for maintainers: please ensure the artifacthub image annotation is updated before merging diff --git a/charts/connect/README.md b/charts/connect/README.md index afc3b70db4..efc94df82c 100644 --- a/charts/connect/README.md +++ b/charts/connect/README.md @@ -3,81 +3,17 @@ description: Find the default values and descriptions of settings in the Redpanda Connect Helm chart. --- -![Version: 3.0.2](https://img.shields.io/badge/Version-3.0.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.42.0](https://img.shields.io/badge/AppVersion-4.42.0-informational?style=flat-square) +![Version: 3.0.3](https://img.shields.io/badge/Version-3.0.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 4.42.0](https://img.shields.io/badge/AppVersion-4.42.0-informational?style=flat-square) 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. - -This page describes the official Redpanda Connect Helm Chart. In particular, this page describes the contents of the chart’s [`values.yaml` file](https://github.com/redpanda-data/helm-charts/blob/main/charts/connect/values.yaml). Each of the settings is listed and described on this page, along with any default values. - -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/docs/deploy/deployment-option/self-hosted/kubernetes/kubernetes-deploy/). - -### Migration from Benthos - -If you are coming here from [the old Benthos based chart](https://github.com/redpanda-data/redpanda-connect-helm-chart), please see the [migration guide in this repo](https://github.com/redpanda-data/helm-charts/blob/main/charts/connect/MIGRATION_FROM_BENTHOS.md). - -### Streams mode - -When running Redpanda Connect in [streams mode](https://docs.redpanda.com/redpanda-connect/guides/streams_mode/about/), all individual stream configuration files should be combined and placed in a single Kubernetes `ConfigMap`, like so: - -```yaml -apiVersion: v1 -kind: ConfigMap -metadata: - name: connect-streams -data: - hello.yaml: | - input: - generate: - mapping: root = "woof" - interval: 5s - count: 0 - output: - stdout: - codec: lines - aaaaa.yaml: | - input: - generate: - mapping: root = "meow" - interval: 2s - count: 0 - output: - stdout: - codec: lines -``` - -Then you can simply reference your `ConfigMap` and enable streams mode in your `values.yaml` file. -```yaml -# values.yaml -streams: - enabled: true - streamsConfigMap: "connect-streams" -``` - -Currently the streams mode `ConfigMap` should be applied **separately from and before installation of** the helm chart; support for deploying additional `ConfigMap`'s within the chart may be implemented later. - -### Global Configuration +This Helm chart deploys a Redpanda Connect instance in either streams mode or standalone. -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. +This page describes the contents of the chart's [`values.yaml` file](https://github.com/redpanda-data/helm-charts/blob/main/charts/connect/values.yaml). Each of the settings is listed and described on this page, along with any default values. -This can be done by specifying configuration under the `metrics`, `logger` and `tracing` configuration sections in your `values.yaml` file. These all use their respective upstream Redpanda Connect configuration syntax. +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/). -```yaml -metrics: - prometheus: {} - -tracing: - openTelemetry: - http: [] - grpc: [] - tags: {} - -logger: - level: INFO - static_fields: - '@service': redpanda-connect -``` +NOTE: To migrate to this chart from the [Benthos Helm chart](https://github.com/redpanda-data/redpanda-connect-helm-chart), see the [migration guide in this GitHub repository](https://github.com/redpanda-data/helm-charts/blob/main/charts/connect/MIGRATION_FROM_BENTHOS.md). ---------------------------------------------- Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) @@ -88,183 +24,293 @@ Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/n ## Settings -### [affinity](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=affinity) +### [affinity](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=affinity) + +Affinity rules for scheduling Pods. **Default:** `{}` -### [args](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=args) +### [args](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=args) -Override Redpanda Connect's default arguments passed with command. +Override the default arguments for the entrypoint command. **Default:** `[]` -### [autoscaling.enabled](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=autoscaling.enabled) +### [autoscaling](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=autoscaling) -**Default:** `false` +Configuration for Horizontal Pod Autoscaling for the Redpanda Connect Deployment. -### [autoscaling.maxReplicas](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=autoscaling.maxReplicas) +**Default:** -**Default:** `12` +``` +{"enabled":false,"maxReplicas":12,"metrics":[{"resource":{"name":"cpu","target":{"averageUtilization":80,"type":"Utilization"}},"type":"Resource"}],"minReplicas":1} +``` -### [autoscaling.metrics[0].resource.name](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=autoscaling.metrics[0].resource.name) +### [autoscaling.enabled](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=autoscaling.enabled) -**Default:** `"cpu"` +Enable Horizontal Pod Autoscaling. -### [autoscaling.metrics[0].resource.target.averageUtilization](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=autoscaling.metrics[0].resource.target.averageUtilization) +**Default:** `false` -**Default:** `80` +### [autoscaling.maxReplicas](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=autoscaling.maxReplicas) -### [autoscaling.metrics[0].resource.target.type](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=autoscaling.metrics[0].resource.target.type) +Maximum number of replicas if autoscaling is enabled. -**Default:** `"Utilization"` +**Default:** `12` -### [autoscaling.metrics[0].type](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=autoscaling.metrics[0].type) +### [autoscaling.metrics](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=autoscaling.metrics) -**Default:** `"Resource"` +List of metrics to use for scaling, such as CPU utilization. -### [autoscaling.minReplicas](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=autoscaling.minReplicas) +**Default:** + +``` +[{"resource":{"name":"cpu","target":{"averageUtilization":80,"type":"Utilization"}},"type":"Resource"}] +``` + +### [autoscaling.minReplicas](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=autoscaling.minReplicas) + +Minimum number of replicas if autoscaling is enabled. **Default:** `1` -### [command](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=command) +### [command](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=command) -Command replaces the entrypoint command of the docker +Override the default entrypoint command of the container. **Default:** `[]` -### [commonLabels](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=commonLabels) +### [commonLabels](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=commonLabels) -Add additional labels to all created resources. +Additional labels to apply to all resources created by this chart. **Default:** `{}` -### [config](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=config) +### [config](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=config) + +Configuration for `/redpanda-connect.yaml` file. **Default:** `{}` -### [deployment.annotations](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.annotations) +### [deployment.annotations](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.annotations) + +Set Annotations on the Redpanda Connect Deployment. **Default:** `{}` -### [deployment.livenessProbe.failureThreshold](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.livenessProbe.failureThreshold) +### [deployment.livenessProbe](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.livenessProbe) + +Configuration for the liveness probe that checks if the container is running. + +**Default:** + +``` +{"failureThreshold":3,"httpGet":{"path":"/ping","port":"http"},"periodSeconds":5,"successThreshold":1,"timeoutSeconds":2} +``` + +### [deployment.livenessProbe.failureThreshold](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.livenessProbe.failureThreshold) + +Number of consecutive failures before Pod is restarted. **Default:** `3` -### [deployment.livenessProbe.httpGet.path](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.livenessProbe.httpGet.path) +### [deployment.livenessProbe.httpGet](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.livenessProbe.httpGet) -**Default:** `"/ping"` +HTTP GET request configuration for the liveness probe. -### [deployment.livenessProbe.httpGet.port](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.livenessProbe.httpGet.port) +**Default:** -**Default:** `"http"` +``` +{"path":"/ping","port":"http"} +``` -### [deployment.livenessProbe.periodSeconds](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.livenessProbe.periodSeconds) +### [deployment.livenessProbe.periodSeconds](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.livenessProbe.periodSeconds) + +Frequency (in seconds) of liveness checks. **Default:** `5` -### [deployment.livenessProbe.successThreshold](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.livenessProbe.successThreshold) +### [deployment.livenessProbe.successThreshold](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.livenessProbe.successThreshold) + +Number of consecutive successes required to mark as healthy. **Default:** `1` -### [deployment.livenessProbe.timeoutSeconds](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.livenessProbe.timeoutSeconds) +### [deployment.livenessProbe.timeoutSeconds](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.livenessProbe.timeoutSeconds) + +Timeout (in seconds) for each liveness check. **Default:** `2` -### [deployment.podAnnotations](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.podAnnotations) +### [deployment.podAnnotations](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.podAnnotations) + +Annotations to add to Redpanda Connect Pods. **Default:** `{}` -### [deployment.podLabels](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.podLabels) +### [deployment.podLabels](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.podLabels) + +Labels to add to Redpanda Connect Pods. **Default:** `{}` -### [deployment.readinessProbe.failureThreshold](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.readinessProbe.failureThreshold) +### [deployment.readinessProbe](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.readinessProbe) + +Configuration for the readiness probe that checks if the container is ready to accept traffic. + +**Default:** + +``` +{"failureThreshold":1,"httpGet":{"path":"/ready","port":"http"},"periodSeconds":5,"successThreshold":1,"timeoutSeconds":2} +``` + +### [deployment.readinessProbe.failureThreshold](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.readinessProbe.failureThreshold) + +Number of consecutive failures before marking Pod as unhealthy. **Default:** `1` -### [deployment.readinessProbe.httpGet.path](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.readinessProbe.httpGet.path) +### [deployment.readinessProbe.httpGet](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.readinessProbe.httpGet) -**Default:** `"/ready"` +HTTP GET request configuration for the readiness probe. -### [deployment.readinessProbe.httpGet.port](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.readinessProbe.httpGet.port) +**Default:** -**Default:** `"http"` +``` +{"path":"/ready","port":"http"} +``` + +### [deployment.readinessProbe.periodSeconds](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.readinessProbe.periodSeconds) -### [deployment.readinessProbe.periodSeconds](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.readinessProbe.periodSeconds) +Frequency (in seconds) of readiness checks. **Default:** `5` -### [deployment.readinessProbe.successThreshold](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.readinessProbe.successThreshold) +### [deployment.readinessProbe.successThreshold](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.readinessProbe.successThreshold) + +Number of consecutive successes before marking Pod as healthy. **Default:** `1` -### [deployment.readinessProbe.timeoutSeconds](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.readinessProbe.timeoutSeconds) +### [deployment.readinessProbe.timeoutSeconds](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.readinessProbe.timeoutSeconds) + +Timeout (in seconds) for each readiness check. **Default:** `2` -### [deployment.replicaCount](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.replicaCount) +### [deployment.replicaCount](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.replicaCount) + +Number of Replicas for the Redpanda Connect Deployment. **Default:** `1` -### [deployment.restartPolicy](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.restartPolicy) +### [deployment.restartPolicy](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.restartPolicy) + +Restart policy for containers in the Pod. **Default:** `"Always"` -### [deployment.rolloutConfigMap](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.rolloutConfigMap) +### [deployment.rolloutConfigMap](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.rolloutConfigMap) + +Rollout the deployment on ConfigMap changes. **Default:** `true` -### [deployment.terminationGracePeriodSeconds](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=deployment.terminationGracePeriodSeconds) +### [deployment.terminationGracePeriodSeconds](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=deployment.terminationGracePeriodSeconds) + +Time in seconds for Pod termination grace period. **Default:** `60` -### [env](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=env) +### [env](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=env) + +Environment variables to pass to the Redpanda Connect container. **Default:** `[]` -### [envFrom](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=envFrom) +### [envFrom](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=envFrom) -Define environment variables from Secrets or ConfigMaps. https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#define-an-environment-variable-for-a-container +Names of Secrets or ConfigMaps that contain environment variables to pass to the Redpanda Connect container. **Default:** `[]` -### [extraVolumeMounts](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=extraVolumeMounts) +### [extraVolumeMounts](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=extraVolumeMounts) + +Additional volume mounts for the container. **Default:** `[]` -### [extraVolumes](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=extraVolumes) +### [extraVolumes](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=extraVolumes) + +Additional volumes to add to the Pod. **Default:** `[]` -### [fullnameOverride](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=fullnameOverride) +### [fullnameOverride](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=fullnameOverride) + +Override for the full name template. **Default:** `""` -### [http.address](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=http.address) +### [http](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=http) + +Configuration for the HTTP server used to expose Redpanda Connect endpoints. + +**Default:** + +``` +{"address":"0.0.0.0:4195","cors":{"enabled":false},"debug_endpoints":false,"enabled":true,"root_path":"/redpanda-connect"} +``` + +### [http.address](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=http.address) + +Bind Address for the HTTP server. **Default:** `"0.0.0.0:4195"` -### [http.cors.enabled](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=http.cors.enabled) +### [http.cors.enabled](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=http.cors.enabled) + +Enable CORS support for HTTP server. **Default:** `false` -### [http.debug_endpoints](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=http.debug_endpoints) +### [http.debug_endpoints](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=http.debug_endpoints) + +Enable debug endpoints for the HTTP server. **Default:** `false` -### [http.enabled](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=http.enabled) +### [http.enabled](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=http.enabled) + +Enable HTTP server. **Default:** `true` -### [http.root_path](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=http.root_path) +### [http.root_path](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=http.root_path) + +Root path for HTTP API endpoints. **Default:** `"/redpanda-connect"` -### [image.pullPolicy](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=image.pullPolicy) +### [image](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=image) + +Configuration for the Redpanda Connect container image. + +**Default:** + +``` +{"pullPolicy":"IfNotPresent","repository":"docker.redpanda.com/redpandadata/connect","tag":""} +``` + +### [image.pullPolicy](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=image.pullPolicy) + +Image pull policy, such as `IfNotPresent` or `Always`. **Default:** `"IfNotPresent"` -### [image.repository](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=image.repository) +### [image.repository](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=image.repository) + +Docker repository for the Redpanda Connect image. **Default:** @@ -272,143 +318,247 @@ Define environment variables from Secrets or ConfigMaps. https://kubernetes.io/d "docker.redpanda.com/redpandadata/connect" ``` -### [image.tag](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=image.tag) +### [image.tag](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=image.tag) + +Override for the default image tag (uses chart `appVersion` if empty). **Default:** `""` -### [imagePullSecrets](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=imagePullSecrets) +### [imagePullSecrets](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=imagePullSecrets) + +List of Secrets for private Docker registry authentication. **Default:** `[]` -### [ingress.annotations](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=ingress.annotations) +### [ingress.annotations](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=ingress.annotations) + +Annotations for the Ingress resource. **Default:** `{}` -### [ingress.className](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=ingress.className) +### [ingress.className](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=ingress.className) + +Ingress Class name for the Ingress resource. **Default:** `""` -### [ingress.enabled](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=ingress.enabled) +### [ingress.enabled](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=ingress.enabled) + +Enable Ingress resource creation. **Default:** `false` -### [ingress.hosts](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=ingress.hosts) +### [ingress.hosts](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=ingress.hosts) + +List of host definitions for the Ingress resource. **Default:** `[]` -### [ingress.tls](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=ingress.tls) +### [ingress.tls](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=ingress.tls) + +TLS configuration for Ingress resource. **Default:** `[]` -### [initContainers](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=initContainers) +### [initContainers](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=initContainers) -Init Containers to be added to the Redpanda Connect Pods. +Additional init containers to add to the Deployment. **Default:** `[]` -### [nameOverride](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=nameOverride) +### [nameOverride](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=nameOverride) **Default:** `""` -### [nodeSelector](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=nodeSelector) +### [nodeSelector](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=nodeSelector) + +Node selector for scheduling Pods. **Default:** `{}` -### [podDisruptionBudget.enabled](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=podDisruptionBudget.enabled) +### [podDisruptionBudget](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=podDisruptionBudget) + +Configuration for the PodDisruptionBudget, which controls voluntary evictions of Redpanda Connect Pods. + +**Default:** `{"enabled":false}` + +### [podDisruptionBudget.enabled](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=podDisruptionBudget.enabled) -Enable a [PodDisruptionBudget](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) for Redpanda Connect. +Enable a PodDisruptionBudget for the Deployment. **Default:** `false` -### [podSecurityContext](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=podSecurityContext) +### [podSecurityContext](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=podSecurityContext) + +Security context to be applied at the Pod level. **Default:** `{}` -### [resources](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=resources) +### [resources](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=resources) + +Resource limits and requests for the container. **Default:** `{}` -### [securityContext](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=securityContext) +### [securityContext](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=securityContext) + +Security context to be applied to containers in the Pod. **Default:** `{}` -### [service.extraPorts](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=service.extraPorts) +### [service](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=service) + +Configuration for the Kubernetes Service that exposes Redpanda Connect. + +**Default:** + +``` +{"extraPorts":null,"name":"http","port":80,"protocol":"TCP","targetPort":"http","type":"ClusterIP"} +``` + +### [service.extraPorts](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=service.extraPorts) + +Additional ports to expose through the Service. **Default:** `nil` -### [service.name](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=service.name) +### [service.name](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=service.name) + +Name of the Kubernetes Service. **Default:** `"http"` -### [service.port](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=service.port) +### [service.port](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=service.port) + +Service port for accessing the application. **Default:** `80` -### [service.protocol](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=service.protocol) +### [service.protocol](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=service.protocol) + +Protocol to use for the Service, for example TCP or UDP. **Default:** `"TCP"` -### [service.targetPort](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=service.targetPort) +### [service.targetPort](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=service.targetPort) + +Target port on the container. **Default:** `"http"` -### [service.type](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=service.type) +### [service.type](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=service.type) + +Type of Kubernetes Service, for example ClusterIP, NodePort, or LoadBalancer. **Default:** `"ClusterIP"` -### [serviceAccount.annotations](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=serviceAccount.annotations) +### [serviceAccount](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=serviceAccount) + +Configuration for the Kubernetes ServiceAccount associated with the Redpanda Connect Pods. + +**Default:** + +``` +{"annotations":{},"create":true,"name":""} +``` + +### [serviceAccount.annotations](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=serviceAccount.annotations) + +Annotations to add to the ServiceAccount. **Default:** `{}` -### [serviceAccount.create](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=serviceAccount.create) +### [serviceAccount.create](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=serviceAccount.create) + +Specify whether a ServiceAccount should be created. **Default:** `true` -### [serviceAccount.name](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=serviceAccount.name) +### [serviceAccount.name](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=serviceAccount.name) + +Name of the ServiceAccount to use. If not set and `create` is `true`, a name is autogenerated. **Default:** `""` -### [serviceMonitor.enabled](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=serviceMonitor.enabled) +### [serviceMonitor](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=serviceMonitor) + +Configuration for the ServiceMonitor used by Prometheus to scrape Redpanda Connect metrics. + +**Default:** + +``` +{"enabled":false,"interval":"10s","scheme":"http"} +``` + +### [serviceMonitor.enabled](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=serviceMonitor.enabled) + +Enable the creation of a ServiceMonitor for Prometheus monitoring. **Default:** `false` -### [serviceMonitor.interval](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=serviceMonitor.interval) +### [serviceMonitor.interval](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=serviceMonitor.interval) + +Scrape interval for Prometheus monitoring. **Default:** `"10s"` -### [serviceMonitor.scheme](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=serviceMonitor.scheme) +### [serviceMonitor.scheme](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=serviceMonitor.scheme) + +HTTP Scheme to use for scraping. **Default:** `"http"` -### [streams.api.enable](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=streams.api.enable) +### [streams](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=streams) + +Configuration settings for the streams mode feature in Redpanda Connect. + +**Default:** + +``` +{"api":{"enable":true},"enabled":false,"streamsConfigMap":""} +``` + +### [streams.api.enable](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=streams.api.enable) + +Enable the streams API. **Default:** `true` -### [streams.enabled](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=streams.enabled) +### [streams.enabled](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=streams.enabled) + +Enable streams mode. **Default:** `false` -### [streams.streamsConfigMap](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=streams.streamsConfigMap) +### [streams.streamsConfigMap](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=streams.streamsConfigMap) + +Name of the ConfigMap that contains stream configuration files. **Default:** `""` -### [telemetry](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=telemetry) +### [telemetry](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=telemetry) **Default:** `true` -### [tolerations](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=tolerations) +### [tolerations](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=tolerations) + +Tolerations for scheduling Pods onto nodes with matching taints. **Default:** `[]` -### [topologySpreadConstraints](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=topologySpreadConstraints) +### [topologySpreadConstraints](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=topologySpreadConstraints) **Default:** `[]` -### [updateStrategy](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=updateStrategy) +### [updateStrategy](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=updateStrategy) + +Update strategy for the Deployment, for example `RollingUpdate`. **Default:** `{}` -### [watch](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path=watch) +### [watch](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path=watch) + +Experimental feature: Watch config files for changes and automatically apply them without needing to rollout the Deployment. Make sure that `deployment.rolloutConfigMap` is `false`. **Default:** `false` diff --git a/charts/connect/README.md.gotmpl b/charts/connect/README.md.gotmpl index 2c2ddc4dbb..8e17906aa4 100644 --- a/charts/connect/README.md.gotmpl +++ b/charts/connect/README.md.gotmpl @@ -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. - -This page describes the official Redpanda Connect Helm Chart. In particular, this page describes the contents of the chart’s [`values.yaml` file](https://github.com/redpanda-data/helm-charts/blob/main/charts/connect/values.yaml). Each of the settings is listed and described on this page, along with any default values. - -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/docs/deploy/deployment-option/self-hosted/kubernetes/kubernetes-deploy/). - -### Migration from Benthos - -If you are coming here from [the old Benthos based chart](https://github.com/redpanda-data/redpanda-connect-helm-chart), please see the [migration guide in this repo](https://github.com/redpanda-data/helm-charts/blob/main/charts/connect/MIGRATION_FROM_BENTHOS.md). - -### Streams mode - -When running Redpanda Connect in [streams mode](https://docs.redpanda.com/redpanda-connect/guides/streams_mode/about/), all individual stream configuration files should be combined and placed in a single Kubernetes `ConfigMap`, like so: - -```yaml -apiVersion: v1 -kind: ConfigMap -metadata: - name: connect-streams -data: - hello.yaml: | - input: - generate: - mapping: root = "woof" - interval: 5s - count: 0 - output: - stdout: - codec: lines - aaaaa.yaml: | - input: - generate: - mapping: root = "meow" - interval: 2s - count: 0 - output: - stdout: - codec: lines -``` - -Then you can simply reference your `ConfigMap` and enable streams mode in your `values.yaml` file. -```yaml -# values.yaml -streams: - enabled: true - streamsConfigMap: "connect-streams" -``` - -Currently the streams mode `ConfigMap` should be applied **separately from and before installation of** the helm chart; support for deploying additional `ConfigMap`'s within the chart may be implemented later. +This Helm chart deploys a Redpanda Connect instance in either streams mode or standalone. -### Global Configuration +This page describes the contents of the chart's [`values.yaml` file](https://github.com/redpanda-data/helm-charts/blob/main/charts/connect/values.yaml). Each of the settings is listed and described on this page, along with any default values. -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/). -This can be done by specifying configuration under the `metrics`, `logger` and `tracing` configuration sections in your `values.yaml` file. These all use their respective upstream Redpanda Connect configuration syntax. - -```yaml -metrics: - prometheus: {} - -tracing: - openTelemetry: - http: [] - grpc: [] - tags: {} - -logger: - level: INFO - static_fields: - '@service': redpanda-connect -``` +NOTE: To migrate to this chart from the [Benthos Helm chart](https://github.com/redpanda-data/redpanda-connect-helm-chart), see the [migration guide in this GitHub repository](https://github.com/redpanda-data/helm-charts/blob/main/charts/connect/MIGRATION_FROM_BENTHOS.md). {{ end -}} {{ define "chart.valuesTable" }} @@ -87,7 +23,7 @@ logger: {{- range .Values }} -### [{{ .Key }}](https://artifacthub.io/packages/helm/redpanda-data/redpanda?modal=values&path={{ .Key }}) +### [{{ .Key }}](https://artifacthub.io/packages/helm/redpanda-data/connect?modal=values&path={{ .Key }}) {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} diff --git a/charts/connect/values.yaml b/charts/connect/values.yaml index 8693749bdc..44930247d6 100644 --- a/charts/connect/values.yaml +++ b/charts/connect/values.yaml @@ -2,22 +2,34 @@ # This is a YAML-formatted file. # Declare variables to be passed into your templates. +# Configuration settings for the Redpanda Connect Deployment. deployment: + + # -- Number of Replicas for the Redpanda Connect Deployment. replicaCount: 1 + # -- Annotations to add to Redpanda Connect Pods. podAnnotations: {} + # -- Labels to add to Redpanda Connect Pods. podLabels: {} - # annotations -- Set annotations on the Redpanda Connect Deployment + # -- Set Annotations on the Redpanda Connect Deployment. annotations: {} - # Default 60. ref: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/ + # -- Time in seconds for Pod termination grace period. terminationGracePeriodSeconds: 60 - # Rollout the deployment on ConfigMap changes + # -- Rollout the deployment on ConfigMap changes. rolloutConfigMap: true + # -- Configuration for the readiness probe that checks if the container is ready to accept traffic. readinessProbe: + + # -- Number of consecutive failures before marking Pod as unhealthy. failureThreshold: 1 + # -- Frequency (in seconds) of readiness checks. periodSeconds: 5 + # -- Number of consecutive successes before marking Pod as healthy. successThreshold: 1 + # -- Timeout (in seconds) for each readiness check. timeoutSeconds: 2 + # -- HTTP GET request configuration for the readiness probe. httpGet: path: /ready port: http @@ -25,11 +37,19 @@ deployment: # httpHeaders: # - name: My-Header # value: Bar + + # -- Configuration for the liveness probe that checks if the container is running. livenessProbe: + + # -- Number of consecutive failures before Pod is restarted. failureThreshold: 3 + # -- Frequency (in seconds) of liveness checks. periodSeconds: 5 + # -- Number of consecutive successes required to mark as healthy. successThreshold: 1 + # -- Timeout (in seconds) for each liveness check. timeoutSeconds: 2 + # -- HTTP GET request configuration for the liveness probe. httpGet: path: /ping port: http @@ -38,74 +58,99 @@ deployment: # - name: My-Header # value: Bar - # podRestartPolicy - Container restart policy. ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy + # -- Restart policy for containers in the Pod. restartPolicy: Always -# commonLabels -- Add additional labels to all created resources. +# -- Additional labels to apply to all resources created by this chart. commonLabels: {} +# -- Configuration for the Redpanda Connect container image. image: + + # -- Docker repository for the Redpanda Connect image. repository: "docker.redpanda.com/redpandadata/connect" + # -- Image pull policy, such as `IfNotPresent` or `Always`. pullPolicy: IfNotPresent - # Overrides the image tag whose default is the chart appVersion. + # -- Override for the default image tag (uses chart `appVersion` if empty). tag: "" +# -- List of Secrets for private Docker registry authentication. imagePullSecrets: [] + +# - Override for the default chart name. nameOverride: "" + +# -- Override for the full name template. fullnameOverride: "" +# -- Configuration for the Kubernetes ServiceAccount associated with the Redpanda Connect Pods. serviceAccount: - # Specifies whether a service account should be created + # -- Specify whether a ServiceAccount should be created. create: true - # Annotations to add to the service account + # -- Annotations to add to the ServiceAccount. annotations: {} - # The name of the service account to use. - # If not set and create is true, a name is generated using the fullname template + # -- Name of the ServiceAccount to use. If not set and `create` is `true`, a name is autogenerated. name: "" +# -- Security context to be applied at the Pod level. podSecurityContext: {} # fsGroup: 2000 +# -- Security context to be applied to containers in the Pod. securityContext: {} # capabilities: - # drop:d + # drop: # - ALL # readOnlyRootFilesystem: true # runAsNonRoot: true # runAsUser: 1000 +# -- Configuration for the Kubernetes Service that exposes Redpanda Connect. service: + # -- Name of the Kubernetes Service. name: http + # -- Type of Kubernetes Service, for example ClusterIP, NodePort, or LoadBalancer. type: ClusterIP + # -- Service port for accessing the application. port: 80 + # -- Target port on the container. targetPort: http + # -- Protocol to use for the Service, for example TCP or UDP. protocol: TCP + # -- Additional ports to expose through the Service. extraPorts: # - name: extraPort # port: 9999 # targetPort: 9999 # protocol: UDP +# -- Configuration for Kubernetes Ingress to expose Redpanda Connect externally. ingress: + # -- Enable Ingress resource creation. enabled: false + # -- Ingress Class name for the Ingress resource. className: "" + # -- Annotations for the Ingress resource. annotations: {} # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: "true" + # -- List of host definitions for the Ingress resource. hosts: [] # - host: chart-example.local # paths: # - path: / # pathType: ImplementationSpecific + # -- TLS configuration for Ingress resource. tls: [] # - secretName: chart-example-tls # hosts: # - chart-example.local +# -- Environment variables to pass to the Redpanda Connect container. env: [] # - name: KAFKA_USER # valueFrom: @@ -113,17 +158,17 @@ env: [] # name: s-name # key: KAFKA_USER -# envFrom -- Define environment variables from Secrets or ConfigMaps. https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#define-an-environment-variable-for-a-container +# -- Names of Secrets or ConfigMaps that contain environment variables to pass to the Redpanda Connect container. envFrom: [] # - secretRef: # name: redpanda +# -- Resource limits and requests for the container. resources: {} - # 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. If you do want to specify resources, uncomment the following + # By default, the chart does not specify default resources to increase the chances that it runs on environments with few + # resources, such as Minikube. If you want to specify resources, uncomment the following # lines, adjust them as necessary, and remove the curly braces after 'resources:'. # limits: # cpu: 100m @@ -132,10 +177,15 @@ resources: # cpu: 100m # memory: 128Mi +# -- Configuration for Horizontal Pod Autoscaling for the Redpanda Connect Deployment. autoscaling: + # -- Enable Horizontal Pod Autoscaling. enabled: false + # -- Minimum number of replicas if autoscaling is enabled. minReplicas: 1 + # -- Maximum number of replicas if autoscaling is enabled. maxReplicas: 12 + # -- List of metrics to use for scaling, such as CPU utilization. metrics: - type: Resource resource: @@ -157,29 +207,34 @@ autoscaling: # value: 1 # periodSeconds: 60 +# -- Node selector for scheduling Pods. nodeSelector: {} +# -- Tolerations for scheduling Pods onto nodes with matching taints. tolerations: [] +# -- Affinity rules for scheduling Pods. affinity: {} +# -- Configuration for the PodDisruptionBudget, which controls voluntary evictions of Redpanda Connect Pods. podDisruptionBudget: - # podDisruptionBudget.enabled -- Enable a [PodDisruptionBudget](https://kubernetes.io/docs/tasks/run-application/configure-pdb/) for Redpanda Connect. + # -- Enable a PodDisruptionBudget for the Deployment. enabled: false - # podDisruptionBudget.minAvailable -- The number of Pods that must still be available after an eviction. + # -- Minimum number of available Pods for voluntary disruptions such as maintenance, scaling down, or node draining. # minAvailable: 1 - # podDisruptionBudget.maxUnavailable -- (int) The number of Pods that can be unavailable after an eviction. + # -- Maximum number of unavailable Pods for voluntary disruptions. # maxUnavailable: 1 -# initContainers -- Init Containers to be added to the Redpanda Connect Pods. +# -- Additional init containers to add to the Deployment. initContainers: [] -# DeploymentStrategy: https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/deployment-v1/ +# -- Update strategy for the Deployment, for example `RollingUpdate`. updateStrategy: {} # type: RollingUpdate # rollingUpdate: # maxUnavailable: 1 +# -- Additional volumes to add to the Pod. extraVolumes: [] # - name: config-map @@ -189,6 +244,7 @@ extraVolumes: # secret: # secretName: s-name +# -- Additional volume mounts for the container. extraVolumeMounts: [] # - name: config-map @@ -198,27 +254,40 @@ extraVolumeMounts: # mountPath: /mnt/secret # readOnly: true +# -- Configuration settings for the streams mode feature in Redpanda Connect. streams: + # -- Enable streams mode. enabled: false + # -- Name of the ConfigMap that contains stream configuration files. streamsConfigMap: "" api: + # -- Enable the streams API. enable: true - # /redpanda-connect.yaml HTTP configuration +# -- Configuration for the HTTP server used to expose Redpanda Connect endpoints. http: - # Disabling HTTP server will prevent service and ingress objects from being created. + # -- Enable HTTP server. enabled: true + # -- Bind Address for the HTTP server. address: "0.0.0.0:4195" + # -- Root path for HTTP API endpoints. root_path: "/redpanda-connect" + # -- Enable debug endpoints for the HTTP server. debug_endpoints: false cors: + # -- Enable CORS support for HTTP server. enabled: false + # -- List of allowed Origins for CORS. # Uncomment and provide list when .Values.http.cors.enabled is true # allowedOrigins: [] +# -- Configuration for the ServiceMonitor used by Prometheus to scrape Redpanda Connect metrics. serviceMonitor: + # -- Enable the creation of a ServiceMonitor for Prometheus monitoring. enabled: false + # -- Scrape interval for Prometheus monitoring. interval: "10s" + # -- HTTP Scheme to use for scraping. scheme: http # basicAuth: # username: foo @@ -242,13 +311,13 @@ serviceMonitor: # static_fields: # '@service': redpanda-connect -# command -- Command replaces the entrypoint command of the docker +# -- Override the default entrypoint command of the container. command: [] -# args -- Override Redpanda Connect's default arguments passed with command. +# -- Override the default arguments for the entrypoint command. args: [] -# EXPERIMENTAL: watch config files for changes and automatically apply them +# -- Experimental feature: Watch config files for changes and automatically apply them without needing to rollout the Deployment. Make sure that `deployment.rolloutConfigMap` is `false`. watch: false # Allow submitting anonymous telemetry data @@ -257,5 +326,5 @@ telemetry: true # Spread incoming Pod in relation to the existing Pods across your cluster. https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/#topologyspreadconstraints-field topologySpreadConstraints: [] -# /redpanda-connect.yaml configuration +# -- Configuration for `/redpanda-connect.yaml` file. config: {}