Redpanda Operator Helm Chart Specification
This page describes the official Redpanda Operator Helm Chart. In
particular, this page describes the contents of the chart’s
values.yaml file. 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.
Autogenerated from chart metadata using helm-docs v1.11.0
Settings
additionalCmdFlags
Passes additional flags to the Redpanda Operator at startup. Additional
flags include: - --additional-controllers: Additional controllers to
deploy. The supported value is decommission, which runs the
NodePool-aware broker decommissioner; legacy-decommission opts into
the deprecated controller. For more information about the Decommission
controller, see
Use the Decommission controller. PVC remediation is handled by the
PVCUnbinder via --unbind-pvcs-after.
Default: []
affinity
Sets affinity constraints for scheduling Pods that run the Redpanda Operator. For details, see the Kubernetes documentation.
Default: {}
commonLabels
Additional labels to add to all Kubernetes objects. For example,
my.k8s.service: redpanda-operator.
Default: {}
config
Configuration for the Kubernetes Controller Manager used by Redpanda Operator. The Controller Manager is a component of the Kubernetes control plane that runs controller processes. These controllers are background threads that handle the orchestration and operational logic of Kubernetes, ensuring the desired state of the cluster matches the observed state.
Default:
{"apiVersion":"controller-runtime.sigs.k8s.io/v1alpha1","health":{"healthProbeBindAddress":":8081"},"kind":"ControllerManagerConfig","leaderElection":{"leaderElect":true,"resourceName":"aa9fc693.vectorized.io"},"metrics":{"bindAddress":"127.0.0.1:8080"},"webhook":{"port":9443}}
config.health.healthProbeBindAddress
Sets the address for the health probe server to listen on.
Default: ":8081"
config.leaderElection
Configuration for leader election, which is a process that ensures only one instance of the controller manager is active at a time. This is critical for high availability and to prevent split-brain scenarios in a distributed system.
Default:
{"leaderElect":true,"resourceName":"aa9fc693.vectorized.io"}
config.leaderElection.resourceName
Sets the name of the resource lock for the leader election process.
Default: "aa9fc693.vectorized.io"
config.metrics.bindAddress
Sets the address for the metrics server to bind to.
Default: "127.0.0.1:8080"
config.webhook
Configuration for webhooks, such as the port they listen on. Webhooks are HTTP callbacks that receive and process data in response to events.
Default: {"port":9443}
connectAnnotations
Additional annotations the operator adds to the resources it creates for
Redpanda Connect pipelines. Passed to the operator as
--connect-annotations. Per-pipeline spec.annotations take
precedence. For example, owner: "platform-team@example.com".
Default: {}
connectController
Enables the Redpanda Connect controller for managing Connect pipeline
CRs. Requires an operator-level enterprise license that includes the
Redpanda Connect product, configured via enterprise.licenseSecretRef;
without one, every Pipeline reconciles to License=False /
LicenseInvalid and gets no workload. Note: Pipeline CRs carry an
operator finalizer — disabling this while Pipeline CRs exist blocks
their deletion until the controller is re-enabled (or the finalizer is
removed by hand). Delete Pipelines before disabling.
Default:
{"enabled":false,"monitoring":{"enabled":false}}
connectController.image
Default Redpanda Connect image applied to every Pipeline CR that does
not pin its own .spec.image. Per-Pipeline .spec.image still wins; if
neither is set, the operator falls back to the PipelineDefaultImage
constant baked into the binary (currently
docker.redpanda.com/redpandadata/connect:4.117.0).
Default: nil
connectController.monitoring
Monitoring configuration for Connect pipeline pods.
Default: {"enabled":false}
connectController.monitoring.enabled
Enables PodMonitor creation for all Connect pipelines. Requires the Prometheus Operator CRDs (monitoring.coreos.com) to be installed.
Default: false
connectController.monitoring.scrapeInterval
Prometheus scrape interval for pipeline PodMonitors.
Default: nil
controllers
Default reconcile intervals for the per-CR controllers, rendered into
the operator’s --<resource>-sync-interval flags. Each interval is a
Go duration string (for example 30s or 5m); leaving it empty ("")
uses the operator’s built-in default. The key is named interval to
match the CRs' spec.interval field, which always takes precedence over
these defaults. Introduced in the v26.2 operator. For example, to slow
Topic reconciliation down to once a minute:
controllers: {topic: {interval: 1m}}.
Default:
{"group":{"interval":""},"role":{"interval":""},"schema":{"interval":""},"shadowLink":{"interval":""},"topic":{"interval":""},"user":{"interval":""}}
controllers.group.interval
Group controller default reconcile interval (Go duration, e.g. 5m).
Empty ("") uses the operator default of 5m. A Group’s
spec.interval overrides this.
Default: ""
controllers.role.interval
Role controller default reconcile interval (Go duration, e.g. 5m).
Empty ("") uses the operator default of 5m. A RedpandaRole’s
spec.interval overrides this.
Default: ""
controllers.schema.interval
Schema controller default reconcile interval (Go duration, e.g. 5m).
Empty ("") uses the operator default of 5m. A Schema’s
spec.interval overrides this.
Default: ""
controllers.shadowLink.interval
ShadowLink controller default reconcile interval (Go duration, e.g.
5m). Empty ("") uses the operator default of 5m. (ShadowLink has
no per-CR reconcile interval.)
Default: ""
controllers.topic.interval
Topic controller default reconcile interval (Go duration, e.g. 30s).
Empty ("") uses the operator default of 30s. A Topic’s
spec.interval overrides this.
Default: ""
controllers.user.interval
User controller default reconcile interval (Go duration, e.g. 5m).
Empty ("") uses the operator default of 5m. A User’s spec.interval
overrides this.
Default: ""
crds.experimental
Specifies whether to install experimental CRDs. If this is true both experimental and stable CRDs will be installed.
Default: false
deployment.podTemplate
A PodTemplateSpec strategically merged on top of podTemplate. For
example, to enable a readonly FS on the operator container:
{spec: {containers: [{name: manager, securityContext: {readOnlyRootFilesystem: true}}]}}
Default: nil
enterprise
Enterprise (optional) For details, see the License documentation.
Default:
{"licenseSecretRef":{"key":""}}
enterprise.licenseSecretRef
Secret name and key where the license key is stored.
Default: {"key":""}
image
Container image settings.
Default:
{"pullPolicy":"IfNotPresent","repository":"docker.redpanda.com/redpandadata/redpanda-operator"}
image.repository
Sets the repository from which to pull the redpanda-operator image.
Default:
"docker.redpanda.com/redpandadata/redpanda-operator"
imagePullSecrets
Pull secrets may be used to provide credentials to image repositories See the Kubernetes documentation.
Default: []
jobs
Overrides scoped to this chart’s hook Jobs.
Default:
{"crd":{"podTemplate":null},"migration":{"podTemplate":null}}
jobs.crd.container
A PodTemplateSpec strategically merged on top of podTemplate. For
example, to drop all capabilities from the CRD installation
Default: nil
jobs.crd.podTemplate
A PodTemplateSpec strategically merged on top of podTemplate. For
example, to drop all capabilities from the CRD installation container:
{spec: {containers: [{name: crd-installation, securityContext: {capabilities: {drop: [ALL]}}}]}}
Default: nil
jobs.migration.podTemplate
A PodTemplateSpec strategically merged on top of podTemplate. For
example, to drop all capabilities from the migration container:
{spec: {containers: [{name: migration, securityContext: {capabilities: {drop: [ALL]}}}]}}
Default: nil
livenessProbe
Sets operator container liveness probe various durations For details, see the Kubernetes documentation.
Default: nil
logLevel
Log level Valid values (from least to most verbose) are: warn, info,
debug, and trace.
Default: "info"
monitoring
Configuration for monitoring.
Default:
{"clusterLabel":{"enabled":false,"name":"","value":""},"enabled":false,"labels":{},"rulesEnabled":false,"scrapeInterval":""}
monitoring.clusterLabel
Adds a scrape-time label identifying which Kubernetes cluster a series
came from. Use it whenever operator metrics from more than one
Kubernetes cluster land in the same Prometheus-compatible backend —
several independent installs remote_writing to a shared Mimir/Thanos, or
one stretch cluster spanning clusters. Without it the series collide,
since job, namespace, service and pod names are identical in each. With
multicluster.enabled, the value is inherited from multicluster.name;
otherwise supply value yourself. Off by default: one cluster reporting
to its own Prometheus has nothing to disambiguate.
Default:
{"enabled":false,"name":"","value":""}
monitoring.clusterLabel.enabled
Adds the label to every series scraped from this operator.
Default: false
monitoring.clusterLabel.value
The label’s value. When multicluster.enabled is true, empty inherits
multicluster.name, so a stretch deployment needs nothing further.
Required otherwise — including when multicluster.name is set but
multicluster.enabled is false, since that name configures nothing else
there. The render fails rather than emitting an empty label.
Default: ""
monitoring.enabled
Creates a ServiceMonitor that can be used by Prometheus-Operator or VictoriaMetrics-Operator to scrape the metrics.
Default: false
monitoring.rulesEnabled
Creates a PrometheusRule with the recommended recording rules and alerts
for the operator’s reconcile health. Independent of monitoring.enabled
so consumers can opt into rules without also wanting the ServiceMonitor
(e.g. if Prometheus is configured to scrape another way).
Default: false
monitoring.scrapeInterval
Sets the scrape interval for the ServiceMonitor endpoint. Leave empty to use the Prometheus global default.
Default: ""
nodeSelector
Node selection constraints for scheduling Pods on specific nodes. For details, see the Kubernetes documentation.
Default: {}
podAnnotations
Default: {}
podLabels
Default: {}
podTemplate
Sets almost all fields of the PodTemplate of every workload this chart
renders: the operator Deployment, the CRD installation Job, and the
migration Job. deployment and jobs layer per-workload overrides on
top of this. For details, see the
Kubernetes
documentation.
Default:
{"metadata":{},"spec":{"containers":[{"name":"manager","resources":{}}],"securityContext":{"runAsUser":65532}}}
podTemplate.metadata.annotations
Additional annotations to apply to the Pods of the StatefulSet.
Default: nil
podTemplate.spec
A subset of Kubernetes' PodSpec type that will be merged into the final PodSpec. See Merge Semantics for details.
Default:
{"containers":[{"name":"manager","resources":{}}],"securityContext":{"runAsUser":65532}}
priorityClassName
PriorityClassName assigned to the Redpanda Operator Pods. Set this to a higher-priority PriorityClass so the operator is less likely to be preempted when the cluster is under resource pressure. Empty by default (uses the cluster’s global default PriorityClass, if any). For details, see the Kubernetes documentation.
Default: ""
rbac
Role-based Access Control (RBAC) configuration for the Redpanda Operator.
Default:
{"create":true,"createAdditionalControllerCRs":true}
rbac.createAdditionalControllerCRs
Create RBAC cluster roles needed for the Redpanda Helm chart’s 'rbac.enabled' feature. WARNING: Disabling this value may prevent the operator from deploying certain configurations of redpanda.
Default: true
readinessProbe
Sets operator container readiness probe various durations For details, see the Kubernetes documentation.
Default: nil
replicaCount
Sets the number of instances of the Redpanda Operator to deploy. Each instance is deployed as a Pod. All instances are managed by a Deployment resource.
Default: 1
resources
Sets resources requests/limits for Redpanda Operator Pods. By default
requests and limits are not set to increase the chances that the charts
run on environments with few resources, such as Minikube. To specify
resources, uncomment the following lines, adjust them as necessary, and
remove the curly braces after resources.
Default: {}
serviceAccount
Service account management.
Default:
{"automountServiceAccountToken":false,"create":true}
serviceAccount.automountServiceAccountToken
Specifies whether a service account should automount API-Credentials. The token is used in sidecars.controllers
Default: false
serviceAccount.name
The name of the service account to use. If not set and
serviceAccount.create is true, a name is generated using the
redpanda-operator.fullname template.
Default: nil
strategy
Sets deployment strategy. For details, see the Kubernetes documentation.
Default: {"type":"RollingUpdate"}
telemetry.enabled
Default: true
tolerations
Taints to be tolerated by Pods. For details, see the Kubernetes documentation.
Default: []
webhook
Specifies whether to create Webhook resources both to intercept and
potentially modify or reject Kubernetes API requests as well as
authenticate requests to the Kubernetes API. Only valid when scope is
set to Cluster.
Default: {"enabled":false}
webhookSecretName
Default: "webhook-server-cert"