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. Valid values are nodeWatcher or decommission. For more
information about the Nodewatcher controller, see
Install
the Nodewatcher controller. For more information about the Decommission
controller, see
Use
the Decommission controller.
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: nil
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}
configurator
Configuration for the Redpanda configurator, a component for managing Redpanda configuration.
Default:
{"pullPolicy":"IfNotPresent","repository":"docker.redpanda.com/redpandadata/configurator"}
configurator.pullPolicy
Sets the pullPolicy
for the Redpanda configurator image.
Default: "IfNotPresent"
configurator.repository
Sets the repository in which the Redpanda configurator image is available.
Default:
"docker.redpanda.com/redpandadata/configurator"
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: []
kubeRbacProxy
Configuration for the kube-rbac-proxy
, a component that provides an
HTTP proxy to perform authorization checks.
Default:
{"image":{"pullPolicy":"IfNotPresent","repository":"gcr.io/kubebuilder/kube-rbac-proxy","tag":"v0.14.0"}}
kubeRbacProxy.image
Sets settings for pulling the kube-rbac-proxy
image.
Default:
{"pullPolicy":"IfNotPresent","repository":"gcr.io/kubebuilder/kube-rbac-proxy","tag":"v0.14.0"}
kubeRbacProxy.image.pullPolicy
Sets the pullPolicy
for kube-rbac-proxy
image
Default: "IfNotPresent"
kubeRbacProxy.image.repository
Sets the repository in which the kube-rbac-proxy
image is available.
Default:
"gcr.io/kubebuilder/kube-rbac-proxy"
logLevel
Log level Valid values (from least to most verbose) are: fatal
,
panic
, error
, info
and debug
.
Default: "info"
monitoring
Configuration for monitoring.
Default:
{"deployPrometheusKubeStack":false,"enabled":false}
monitoring.enabled
Creates a ServiceMonitor that can be used by Prometheus-Operator or VictoriaMetrics-Operator to scrape the metrics.
Default: false
nodeSelector
Node selection constraints for scheduling Pods on specific nodes. For details, see the Kubernetes documentation.
Default: {}
podAnnotations
Default: {}
podLabels
Default: {}
rbac
Role-based Access Control (RBAC) configuration for the Redpanda Operator.
Default:
{"create":true,"createAdditionalControllerCRs":false,"createRPKBundleCRs":false}
rbac.createAdditionalControllerCRs
Creates additional RBAC cluster roles that are needed to run additional
controllers using additionalCmdFlags
.
Default: false
rbac.createRPKBundleCRs
Create RBAC cluster roles needed for the Redpanda Helm chart’s `rbac.enabled' feature.
Default: false
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: {}
scope
Sets the scope of the Redpanda Operator. Valid values are Cluster
or
Namespace
. The Cluster scope is deprecated because it deploys the
deprecated version of the Redpanda Operator. Use the default Namespace
scope. In the Namespace scope, the Redpanda Operator manages Redpanda
resources that are deployed in the same namespace as itself.
Default: "Namespace"
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
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"