Redpanda CRD Reference
Custom resource definitions for the Redpanda resource. Use the Redpanda resource to create and manage Redpanda clusters with the Redpanda Operator.
cluster.redpanda.com/v1alpha1
Package v1alpha1 defines the v1alpha1 schema for the Redpanda API. It is part of an evolving API architecture, representing an initial stage that may be subject to change based on user feedback and further development.
Admin
Admin configures settings for the Admin API listeners.
Field | Description |
---|---|
|
Defines settings for the external listener. |
|
Specifies the container port number for the internal listener. |
|
Configures TLS settings for the internal listener. |
Auth
Auth configures authentication in the Helm values. See https://docs.redpanda.com/current/manage/kubernetes/security/authentication/sasl-kubernetes/.
Field | Description |
---|---|
|
Configures SASL authentication in the Helm values. |
Budget
Budget configures the management of disruptions affecting the Pods in the StatefulSet.
Field | Description |
---|---|
|
Defines the maximum number of Pods that can be unavailable during a voluntary disruption. |
CPU
CPU configures CPU resources for containers. See https://docs.redpanda.com/current/manage/kubernetes/manage-resources/.
Field | Description |
---|---|
|
Specifies the number of CPU cores available to the application. Redpanda makes use of a thread per core model. For details, see https://docs.redpanda.com/current/get-started/architecture/#thread-per-core-model. For this reason, Redpanda should only be given full cores. Note: You can increase cores, but decreasing cores is not currently supported. See the GitHub issue:https://github.com/redpanda-data/redpanda/issues/350. This setting is equivalent to |
|
Specifies whether Redpanda assumes it has all of the provisioned CPU. This should be |
Certificate
Certificate configures TLS certificates.
Field | Description |
---|---|
|
Specify the name of an existing Issuer or ClusterIssuer resource to use to generate certificates. Requires cert-manager. See https://cert-manager.io/v1.1-docs. |
|
Specify the name of an existing Secret resource that contains your TLS certificate. |
|
Specifies the validity duration of certificates generated with |
|
Specifies whether to include the |
ChartRef
Field | Description |
---|---|
|
Specifies the name of the chart to deploy. |
|
Defines the version of the Redpanda Helm chart to deploy. |
|
Defines the chart repository to use. Defaults to |
|
Specifies the time to wait for any individual Kubernetes operation (like Jobs for hooks) during Helm actions. Defaults to |
|
Defines how to handle upgrades, including failures. |
Config
Config configures Redpanda config properties supported by Redpanda that may not work correctly in a Kubernetes cluster. Changing these values from the defaults comes with some risk. Use these properties to customize various Redpanda configurations that are not available in the RedpandaClusterSpec
. These values have no impact on the configuration or behavior of the Kubernetes objects deployed by Helm, and therefore should not be modified for the purpose of configuring those objects. Instead, these settings get passed directly to the Redpanda binary at startup.
Field | Description |
---|---|
|
Specifies cluster configuration properties. See https://docs.redpanda.com/current/reference/cluster-properties/. |
|
Specifies cluster configuration properties. See https://docs.redpanda.com/current/reference/cluster-properties/. |
|
Specifies broker configuration properties. See https://docs.redpanda.com/current/reference/node-properties/. |
|
Specifies tunable configuration properties. See https://docs.redpanda.com/current/reference/tunable-properties/. |
|
Specifies tunable configuration properties. See https://docs.redpanda.com/current/reference/tunable-properties/. |
|
Specifies tunable configuration properties. See https://docs.redpanda.com/current/reference/tunable-properties/. |
ConfigWatcher
ConfigWatcher configures a sidecar that watches for changes to the Secret in auth.sasl.secretRef
and applies the changes to the Redpanda cluster.
Field | Description |
---|---|
|
Specifies whether the sidecar is enabled. |
|
Specifies additional volumes to mount to the sidecar. |
|
Specifies resource requests for the sidecar container. |
|
Specifies the container’s security context, including privileges and access levels of the container and its processes. |
ConnectorMonitoring
ConnectorMonitoring configures monitoring resources for Connectors. See https://docs.redpanda.com/current/manage/kubernetes/monitoring/monitor-redpanda/.
Field | Description |
---|---|
|
Specifies whether to create a ServiceMonitor that can be used by Prometheus Operator or VictoriaMetrics Operator to scrape the metrics. |
|
Adds custom labels to the ServiceMonitor resource. |
|
Specifies how often to scrape metrics. |
|
Adds custom Annotations to the ServiceMonitor resource. |
|
Adds custom namespaceSelector to monitoring resources |
ConnectorsCreateObj
ConnectorsCreateObj configures Kubernetes resources for Redpanda Connectors.
Field | Description |
---|---|
|
Specifies whether to create the resource. |
ConsoleCreateObj
ConsoleCreateObj represents configuration options for creating Kubernetes objects such as ConfigMaps, Secrets, and Deployments.
Field | Description |
---|---|
|
Indicates whether the corresponding Kubernetes object (ConfigMap, Secret, or Deployment) should be created. |
Container
Container defines resource limits for containers.
Field | Description |
---|---|
|
Specifies the maximum resources that can be allocated to a container. |
|
Specifies the minimum resources required for a container. |
Enterprise
Enterprise configures an Enterprise license key to enable Redpanda Enterprise features. Requires the post-install job to be enabled (default). See https://docs.redpanda.com/current/get-started/licenses/.
Field | Description |
---|---|
|
Specifies the Enterprise license key. |
|
Defines a reference to a Secret resource that contains the Enterprise license key. |
EnterpriseLicenseSecretRef
EnterpriseLicenseSecretRef configures a reference to a Secret resource that contains the Enterprise license key.
Field | Description |
---|---|
|
Specifies the key that is contains the Enterprise license in the Secret. |
|
Specifies the name of the Secret resource to use. |
External
External defines external connectivity settings in the Helm values.
Field | Description |
---|---|
|
Specifies addresses for the external listeners to advertise.Provide one entry for each broker in order of StatefulSet replicas. The number of brokers is defined in |
|
Adds custom annotations to the external Service. |
|
Specifies the domain to advertise to external clients. If specified, then it will be appended to the |
|
Specifies whether the external access is enabled. |
|
Configures the external Service resource. |
|
Source range for external access. Only applicable when |
|
Specifies the external Service type. Only NodePort and LoadBalancer are supported. If undefined, then advertised listeners will be configured in Redpanda, but the Helm chart will not create a Service. NodePort is recommended in cases where latency is a priority. |
|
Defines externalDNS configurations. |
|
Specifies a naming prefix template for external Services. |
ExternalDNS
ExternalDNS configures externalDNS.
Field | Description |
---|---|
|
Specifies whether externalDNS annotations are added to LoadBalancer Services. If you enable externalDns, each LoadBalancer Service defined in |
ExternalListener
ExternalListener configures settings for the external listeners.
Field | Description |
---|---|
|
|
|
Specifies the authentication method for the external listener. For example, 'mtls_identity' or |
|
Specifies the container port number for the external listener. |
|
Configures TLS settings for the external listener. |
|
Specifies the network port that the external Service listens on. |
ExternalService
ExternalService allows you to enable or disable the creation of an external Service type.
Field | Description |
---|---|
|
Specifies whether to create the external Service. If set to |
FsValidator
Field | Description |
---|---|
|
|
|
|
|
Adds extra volume mounts. |
|
Specifies the resource requirements. |
HTTP
HTTP configures settings for the HTTP Proxy listeners.
Field | Description |
---|---|
|
Specifies the authentication method for the external listener. For example, 'mtls_identity' or |
|
Specifies whether the HTTP Proxy is enabled. |
|
Defines settings for the external listener. |
|
Configures the listener to use for HTTP connections. For example |
|
Specifies the container port number for the internal listener. |
|
Configures TLS settings for the internal listener. |
|
Specifies the template used for generating the advertised addresses of Services. This field accepts a string template that dynamically constructs Service addresses based on various parameters such as Service name and port number. |
HelmUpgrade
HelmUpgrade configures the behavior and strategy for Helm chart upgrades.
Field | Description |
---|---|
|
Specifies the actions to take on upgrade failures. See https://pkg.go.dev/github.com/fluxcd/helm-controller/api/v2beta1#UpgradeRemediation. |
|
Enables forceful updates during an upgrade. |
|
Specifies whether to preserve user-configured values during an upgrade. |
|
Specifies whether to perform cleanup in case of failed upgrades. |
InitContainerImage
InitContainerImage configures the init container image used to perform initial setup tasks before the main containers start.
Field | Description |
---|---|
|
|
|
InitContainers
InitContainers configures the init container used to perform initial setup tasks before the main containers start.
Field | Description |
---|---|
|
|
|
|
|
Defines the settings related to ownership of the Redpanda data directory in environments where root access is restricted. |
|
Defines the settings related to ownership of the Tiered Storage cache in environments where root access is restricted. |
|
Defines the setting for init container that not allow to start Redpanda until filesystem matches |
|
Defines settings for the autotuner tool in Redpanda. The autotuner identifies the hardware configuration in the container and optimizes the Linux kernel to give you the best performance. |
IssuerRef
IssuerRef configures the Issuer or ClusterIssuer resource to use to generate certificates. Requires cert-manager. See https://cert-manager.io/v1.1-docs.
Field | Description |
---|---|
|
Specifies the name of the resource. |
|
Specifies the kind of resource. One of |
Kafka
Kafka configures settings for the Kafka API listeners.
Field | Description |
---|---|
|
Specifies the authentication method for the external listener. For example, 'mtls_identity' or |
|
Defines settings for the external listener. |
|
Specifies the container port number for the internal listener. |
|
Configures TLS settings for the internal listener. |
|
Specifies the template used for generating the advertised addresses of Services. This field accepts a string template that dynamically constructs Service addresses based on various parameters such as Service name and port number. |
LicenseSecretRef
LicenseSecretRef is deprecated. Use EnterpriseLicenseSecretRef
instead.
Field | Description |
---|---|
|
Specifies the key that is contains the Enterprise license in the Secret. |
|
Specifies the name of the Secret. |
ListenerTLS
ListenerTLS configures TLS configuration for each listener in the Helm values.
Field | Description |
---|---|
|
References a specific certificate for the listener. |
|
Specifies whether TLS is enabled for the listener. |
|
References a Secret rsource containing TLS credentials for the listener. |
|
Indicates whether client authentication (mTLS) is required. |
Listeners
Listeners configures settings for listeners, including HTTP Proxy, Schema Registry, the Admin API and the Kafka API. See https://docs.redpanda.com/current/manage/kubernetes/networking/configure-listeners/.
Field | Description |
---|---|
|
Configures settings for the Admin API listeners. |
|
Configures settings for the HTTP Proxy listeners. |
|
Configures settings for the Kafka API listeners. |
|
Configures settings for the RPC API listener. |
|
Configures settings for the Schema Registry listeners. |
LivenessProbe
LivenessProbe configures liveness probes to monitor the health of the Pods and restart them if necessary.
Field | Description |
---|---|
|
Sets the number of consecutive failures required to consider a Pod as not live. |
|
Specifies the time in seconds to wait before the first probe is initiated. |
|
Determines the frequency in seconds of performing the probe. |
Logging
Logging configures logging settings in the Helm values. See https://docs.redpanda.com/current/manage/kubernetes/troubleshooting/troubleshoot/.
Field | Description |
---|---|
|
Sets the verbosity level of logs. |
|
Specifies whether to send usage statistics to Redpanda Data. |
Memory
Memory configures memory resources.
Field | Description |
---|---|
|
Defines resource limits for containers. |
|
Enables memory locking. For production, set to |
|
Allows you to optionally specify the memory size for both the Redpanda process and the underlying reserved memory used by Seastar. |
Migration
Migration can configure old Cluster and Console custom resource that will be disabled. With Migration the ChartRef and ClusterSpec still need to be correctly configured.
Field | Description |
---|---|
|
|
|
ClusterRef by default will not be able to reach different namespaces, but it can be overwritten by adding ClusterRole and ClusterRoleBinding to operator ServiceAccount. |
|
ConsoleRef by default will not be able to reach different namespaces, but it can be overwritten by adding ClusterRole and ClusterRoleBinding to operator ServiceAccount. |
Monitoring
Monitoring configures monitoring resources for Redpanda. See https://docs.redpanda.com/current/manage/kubernetes/monitoring/monitor-redpanda/.
Field | Description |
---|---|
|
Specifies whether to create a ServiceMonitor that can be used by Prometheus Operator or VictoriaMetrics Operator to scrape the metrics. |
|
Adds custom labels to the ServiceMonitor resource. |
|
Specifies how often to scrape metrics. |
|
Specifies tls configuration properties. |
PersistentVolume
PersistentVolume configures configurations for a PersistentVolumeClaim to use to store the Redpanda data directory.
Field | Description |
---|---|
|
Adds annotations to the PersistentVolumeClaims to provide additional information or metadata that can be used by other tools or libraries. |
|
Specifies whether to enable the Helm chart to create PersistentVolumeClaims for Pods. |
|
Applies labels to the PersistentVolumeClaims to facilitate identification and selection based on custom criteria. |
|
Specifies the storage capacity required. |
|
Specifies the StorageClass for the PersistentVolumeClaims to determine how PersistentVolumes are provisioned and managed. |
PostInstallJob
PostInstallJob configures configurations for the post-install job that run after installation of the Helm chart.
Field | Description |
---|---|
|
Sets resource requirements (CPU, memory) for the job to ensure proper allocation and limit resource usage. |
|
Adds annotations to the job to provide additional information or metadata that can be used by other tools or libraries. |
|
Specifies whether the job is deployed. |
|
Applies labels to the job to facilitate identification and selection based on custom criteria. |
PostUpgradeJob
PostUpgradeJob configures configurations for the post-upgrade job that run after each upgrade of the Helm chart.
Field | Description |
---|---|
|
Adds annotations to the job to provide additional information or metadata that can be used by other tools or libraries. |
|
Specifies whether the job is deployed. |
|
Applies labels to the job to facilitate identification and selection based on custom criteria. |
|
Adds environment variables to the job container to configure its runtime behavior. |
|
Specifies environment variables from external sources, such as ConfigMap resources, or Secret resources, to dynamically configure the job. |
|
Sets resource requirements (CPU, memory) for the job to ensure proper allocation and limit resource usage. |
RBAC
RBAC configures role-based access control (RBAC).
Field | Description |
---|---|
|
Adds custom annotations to the RBAC resources. |
|
Whether RBAC is enabled. Enable for features that need extra privileges, such as rack awareness. If you use the Redpanda Operator, you must deploy it with the |
RPC
RPC configures settings for the RPC API listeners.
Field | Description |
---|---|
|
Specifies the container port number for the internal listener. |
|
Configures TLS settings for the internal listener. |
RPControllers
RPControllers configures additional controllers that can be deployed as sidecars in rp helm
Field | Description |
---|---|
|
Specifies whether the Controllers are enabled. |
|
|
|
|
|
|
|
|
|
|
|
|
|
RackAwareness
RackAwareness configures rack awareness in the Helm values. See https://docs.redpanda.com/current/manage/kubernetes/kubernetes-rack-awareness/.
Field | Description |
---|---|
|
Specifies whether rack awareness is enabled. When enabled, Kubernetes failure zones are treated as racks. Redpanda maps each rack to a failure zone and places partition replicas across them. Requires |
|
Specifies the key in Node labels or annotations to use to denote failure zones. |
ReadinessProbe
ReadinessProbe configures readiness probes to determine when a Pod is ready to handle traffic.
Field | Description |
---|---|
|
Defines the threshold for how many times the probe can fail before the Pod is marked Unready. |
|
Sets the initial delay before the readiness probe is initiated, in seconds. |
|
Configures the period, in seconds, between each readiness check. |
Redpanda
Redpanda defines the CRD for Redpanda clusters.
Field | Description |
---|---|
|
|
|
|
|
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
Refer to the Kubernetes API documentation for fields of |
|
Defines the desired state of the Redpanda cluster. |
|
Represents the current status of the Redpanda cluster. |
RedpandaClusterSpec
RedpandaClusterSpec defines the desired state of a Redpanda cluster. These settings are the same as those defined in the Redpanda Helm chart. The values in these settings are passed to the Redpanda Helm chart through Flux. For all default values and links to more documentation, see https://docs.redpanda.com/current/reference/redpanda-helm-spec/.
For descriptions and default values, see Redpanda Helm Chart Specification.
Field | Description |
---|---|
|
Customizes the labels |
|
Customizes the name of the StatefulSet and Services. The default is |
|
Customizes the Kubernetes cluster domain. This domain is used to generate the internal domains of the StatefulSet Pods. For details, see https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id. The default is the |
|
Assigns custom labels to all resources generated by the Redpanda Helm chart. Specify labels as key/value pairs. |
|
Specifies on which nodes a Pod should be scheduled. These key/value pairs ensure that Pods are scheduled onto nodes with the specified labels. |
|
Specifies tolerations to allow Pods to be scheduled onto nodes where they otherwise wouldn’t. |
|
Defines the container image settings to use for the Redpanda cluster. |
|
Specifies credentials for a private image repository. For details, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/. |
|
Deprecated: Use |
|
Deprecated: Use |
|
Defines an Enterprise license. |
|
Defines rack awareness settings. |
|
Defines Redpanda Console settings. |
|
Defines Redpanda Connector settings. |
|
Defines authentication settings for listeners. |
|
Defines TLS settings for listeners. |
|
Defines external access settings. |
|
Defines the log level settings. |
|
Defines container resource settings. |
|
Defines settings for the headless ClusterIP Service. |
|
Defines storage settings for the Redpanda data directory and the Tiered Storage cache. |
|
Defines settings for the post-install hook, which runs after each install or upgrade. For example, this job is responsible for setting the Enterprise license, if specified. |
|
Defines settings for the post-upgrade hook, which runs after each update. For example, this job is responsible for setting cluster configuration properties and restarting services such as Schema Registry, if required. |
|
Defines settings for the StatefulSet that manages Redpanda brokers. |
|
Defines settings for the autotuner tool in Redpanda. The autotuner identifies the hardware configuration in the container and optimizes the Linux kernel to give you the best performance. |
|
Defines settings for listeners, including HTTP Proxy, Schema Registry, the Admin API and the Kafka API. |
|
Defines configuration properties supported by Redpanda that may not work correctly in a Kubernetes cluster. Changing these values from the defaults comes with some risk. Use these properties to customize various Redpanda configurations that are not available in the |
|
Defines Role Based Access Control (RBAC) settings. |
|
Defines Service account settings. |
|
Defines settings for monitoring Redpanda. |
|
Adds the |
RedpandaConnectors
RedpandaConnectors configures Redpanda Connectors. Redpanda Connectors is a package that includes Kafka Connect and built-in connectors, sometimes known as plugins. See https://docs.redpanda.com/current/deploy/deployment-option/self-hosted/kubernetes/k-deploy-connectors/.
Field | Description |
---|---|
|
|
|
Specifies whether to create Helm tests. |
|
Specifies monitoring resources |
|
Connectors specified manual configurations |
|
Connectors specified manual configurations |
|
Specifies a custom name for the Redpanda Console resources, overriding the default naming convention. |
|
Specifies a full custom name, which overrides the entire naming convention including release name and chart name. |
|
Assigns custom labels to all resources generated by the Connector Helm chart. Specify labels as key/value pairs. |
|
Applies tolerations to allow Pods to be scheduled on nodes with matching taints, enabling control over where Pods can run. |
|
Defines the container image settings to use for the Redpanda cluster. |
|
Specifies credentials for a private image repository. For details, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/. |
|
Specifies superuser credentials |
|
Specifies container information |
|
Specifies storage information |
|
Specifies logging details |
RedpandaConsole
RedpandaConsole configures the Redpanda Console subchart of the Redpanda Helm chart. Use these settings to configure the subchart. For more details on each setting, see the Helm values for the Redpanda Console chart: https://artifacthub.io/packages/helm/redpanda-data/console?modal=values
Field | Description |
---|---|
|
Specifies whether the Redpanda Console subchart should be deployed. |
|
Sets the number of replicas for the Redpanda Console Deployment resource. |
|
Specifies a custom name for the Redpanda Console resources, overriding the default naming convention. |
|
Specifies a full custom name, which overrides the entire naming convention including release name and chart name. |
|
Specifies the priority class name for the Pods that run Redpanda Console. |
|
Defines the container image for the Redpanda Console, including the repository, name, and tag. |
|
Defines Secrets used to pull the container images from a private registry. |
|
Configures the ServiceAccount used by the Pods that run Redpanda Console. |
|
|
|
Adds custom annotations to the Pods that run Redpanda Console. |
|
Adds custom labels to the Pods that run Redpanda Console. |
|
|
|
Sets the security context for the Pods that run Redpanda Console. |
|
Configures the Kubernetes Service for Redpanda Console. |
|
Configures the Kubernetes Ingress resource for Redpanda Console. |
|
Configures resource requests and limits for the Pods that run Redpanda Console. |
|
Configures Horizontal Pod Autoscaling (HPA) for Redpanda Console. |
|
Specifies Node labels for Pod assignment. |
|
Specifies tolerations for scheduling Pods onto Nodes with taints. |
|
Defines affinity rules for Pod assignment. |
|
Specifies topology spread constraints for Pod placement. |
|
Adds extra environment variables to the Pods that run Redpanda Console. |
|
Allows you to add extra environment variables from external resources to the Pods that run Redpanda Console. |
|
Adds extra volumes to the Pods that run Redpanda Console. |
|
Mounts additional volumes inside the containers that run Redpanda Console. |
|
Adds extra containers to the Pods that run Redpanda Console. |
|
Specifies init containers for the Pods that run Redpanda Console. |
|
Mounts additional Secret resources inside the containers that run Redpanda Console. |
|
Specifies whether a ConfigMap should be created for Redpanda Console. |
|
Specifies whether a Secret should be created for Redpanda Console. |
|
Specifies whether a Deployment should be created for Redpanda Console. |
|
Configures custom settings for Redpanda Console. |
RedpandaImage
RedpandaImage configures the Redpanda container image settings in the Helm values.
Field | Description |
---|---|
|
Specifies the image repository to pull from. |
|
Specifies the image tag. |
|
Specifies the strategy used for pulling images from the repository. For available values, see https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy. |
RedpandaList
RedpandaList contains a list of Redpanda objects.
Field | Description |
---|---|
|
|
|
|
|
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
Refer to the Kubernetes API documentation for fields of |
|
Specifies a list of Redpanda resources. |
RedpandaMemory
RedpandaMemory allows you to optionally specify the memory size for both the Redpanda process and the underlying reserved memory used by Seastar. This section is omitted by default, and memory sizes are calculated automatically based on container memory. Configuring this section and setting memory
and reserveMemory
values will disable automatic calculation. If you are setting the following values manually, keep in mind the following guidelines. Getting this wrong may lead to performance issues, instability, and loss of data: The amount of memory to allocate to a container is determined by the sum of three values:
1. Redpanda (at least 2Gi per core, ~80% of the container’s total memory) 2. Seastar subsystem (200Mi * 0.2% of the container’s total memory, 200Mi < x < 1Gi) 3. Other container processes (whatever small amount remains)
Field | Description |
---|---|
|
Memory for the Redpanda process. This must be lower than the container’s memory ( |
|
Memory reserved for the Seastar subsystem. Any value above 1Gi will provide diminishing performance benefits. Equivalent to |
RedpandaSpec
RedpandaSpec defines the desired state of the Redpanda cluster.
Field | Description |
---|---|
|
Defines chart details, including the version and repository. |
|
Defines the Helm values to use to deploy the cluster. |
|
Migration flag that adjust Kubernetes core resources with annotation and labels, so flux controller can import resources. Doc: https://docs.redpanda.com/current/upgrade/migrate/kubernetes/operator/ |
RedpandaStatus
RedpandaStatus defines the observed state of Redpanda
Field | Description |
---|---|
|
Specifies the last observed generation. |
|
LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected. |
|
Conditions holds the conditions for the Redpanda. |
|
LastAppliedRevision is the revision of the last successfully applied source. |
|
LastAttemptedRevision is the revision of the last reconciliation attempt. |
|
|
|
|
|
|
|
|
|
|
|
Failures is the reconciliation failure count against the latest desired state. It is reset after a successful reconciliation. |
|
Resources
Resources configures resource allocation. The default values are for a development environment. Production-level values and other considerations are documented, where those values are different from the default.
Field | Description |
---|---|
|
Specifies the number of CPU cores. |
|
Specifies the amount of memory. |
SASL
SASL configures SASL authentication in the Helm values.
Field | Description |
---|---|
|
Enables SASL authentication. If you enable SASL authentication, you must provide a Secret name in |
|
Specifies the default authentication mechanism to use for superusers. Options are |
|
If |
|
Specifies a list of superuser credentials. |
SchemaRegistry
SchemaRegistry configures settings for the Schema Registry listeners.
Field | Description |
---|---|
|
Specifies the authentication method for the external listener. For example, 'mtls_identity' or |
|
Specifies whether the Schema Registry is enabled. |
|
Defines settings for the external listener. |
|
Configures the listener to use for HTTP connections. For example |
|
Specifies the container port number for the internal listener. |
|
Configures TLS settings for the internal listener. |
SecretRef
SecretRef configures the Secret resource that contains existing TLS certificates.
Field | Description |
---|---|
|
Specifies the name of the Secret resource. |
ServiceAccount
ServiceAccount configures Service Accounts.
Field | Description |
---|---|
|
Adds custom annotations to the ServiceAccount resources. |
|
Specifies whether a ServiceAccount should be created. |
|
Specifies the name of the ServiceAccount. |
SetDataDirOwnership
SetDataDirOwnership defines the settings related to ownership of the Redpanda data directory in environments where root access is restricted.
Field | Description |
---|---|
|
Specifies whether to enable root access. Enable only in environments where root access is not allowed, such as minikube. |
|
Adds extra volume mounts. |
|
Specifies the resource requirements. |
SetTieredStorageCacheDirOwnership
SetTieredStorageCacheDirOwnership configures the settings related to ownership of the Tiered Storage cache in environments where root access is restricted.
Field | Description |
---|---|
|
|
|
SideCarObj
SideCarObj represents a generic sidecar object. This is a placeholder for now.
Field | Description |
---|---|
|
|
|
|
|
SideCars
SideCars configures the additional sidecar containers that run alongside the main Redpanda container in the Pod.
Field | Description |
---|---|
|
Configures the |
|
|
|
StartupProbe
StartupProbe configures the startup probe to determine when the Redpanda application within the Pod has started successfully.
Field | Description |
---|---|
|
Determines the failure threshold to mark the application in the Pod as not started. |
|
Specifies the delay in seconds before the startup probe begins. |
|
Sets the period in seconds for conducting subsequent probes. |
Statefulset
Statefulset defines configurations for the StatefulSet in Helm values.
Field | Description |
---|---|
|
Includes additional command flags for Redpanda at startup to customize its runtime behavior. |
|
Adds annotations to the StatefulSet to provide additional information or metadata. |
|
Defines the management of disruptions affecting the Pods in the StatefulSet. |
|
Specifies extra volume mounts for the Pods. |
|
Defines additional volumes for the Pods. |
|
Defines the init container image used to perform initial setup tasks before the main containers start. |
|
Configures the init container used to perform initial setup tasks before the main containers start. |
|
Defines liveness probes to monitor the health of the Pods and restart them if necessary. |
|
Applies node selectors to schedule Pods on specific nodes based on labels. |
|
Defines Pod affinity rules to influence the scheduling and placement of Pods relative to other Pods. |
|
Defines Pod anti-affinity rules to prevent Pods from being scheduled together on the same node. |
|
Defines the priority class name to assign priority levels to the Pods, influencing their scheduling order. |
|
Defines readiness probes to determine when a Pod is ready to handle traffic. |
|
Specifies the number of replicas to determine the desired number of Pods (Redpanda brokers) in the StatefulSet. |
|
Sets a security context for the Pods to define privilege and access control settings. |
|
Defines the additional sidecar containers that run alongside the main Redpanda container in the Pod. |
|
Specifies whether to skip the changing of file ownership (chown) during Pod initialization. |
|
Configures the startup probe to determine when the Redpanda application within the Pod has started successfully. |
|
Applies tolerations to allow Pods to be scheduled on nodes with matching taints, enabling control over where Pods can run. |
|
Defines topology spread constraints to control how Pods are spread across different topology domains. |
|
Defines the update strategy for the StatefulSet to manage how updates are rolled out to the Pods. |
|
Specifies the termination grace period in seconds to control the time delay before forcefully terminating a Pod. |
Storage
Storage configures storage-related settings in the Helm values. See https://docs.redpanda.com/current/manage/kubernetes/storage/.
Field | Description |
---|---|
|
Specifies the absolute path on the worker node to store the Redpanda data directory. If unspecified, then an |
|
Configures a PersistentVolumeClaim (PVC) template to create for each Pod. This PVC is used to store the Redpanda data directory. |
|
Configures storage for the Tiered Storage cache. |
TLS
TLS configures TLS in the Helm values. See https://docs.redpanda.com/current/manage/kubernetes/security/tls/.
Field | Description |
---|---|
|
Lists all available certificates in the cluster. You can reference a specific certificate’s name in each listener’s |
|
Enables TLS globally for all listeners. Each listener must include a certificate name in its |
Tiered
Tiered configures storage for the Tiered Storage cache. See https://docs.redpanda.com/current/manage/kubernetes/tiered-storage-kubernetes/.
Field | Description |
---|---|
|
mountType can be one of:
- |
|
Specifies the absolute path on the worker node to store the Tiered Storage cache. |
|
Configures a PersistentVolumeClaim (PVC) template to create for each Pod. This PVC is used to store the Tiered Storage cache. |
|
Configures Tiered Storage, which requires an Enterprise license configured in |
TieredConfig
TieredConfig configures Tiered Storage, which requires an Enterprise license configured in enterprise.licenseKey
or enterprise.licenseSecretRef
.TieredConfig is a top-level field of the Helm values.
Field | Description |
---|---|
|
Enables Tiered Storage if a license key is provided. See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_enabled. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
TieredStoragePersistentVolume
TieredStoragePersistentVolume configures configurations for a PersistentVolumeClaim to use to store the Tiered Storage cache.
Field | Description |
---|---|
|
Adds annotations to the PersistentVolumeClaims to provide additional information or metadata that can be used by other tools or libraries. |
|
Applies labels to the PersistentVolumeClaims to facilitate identification and selection based on custom criteria. |
|
Specifies the StorageClass for the PersistentVolumeClaims to determine how PersistentVolumes are provisioned and managed. |
TopologySpreadConstraints
TopologySpreadConstraints configures topology spread constraints to control how Pods are spread across different topology domains.
Field | Description |
---|---|
|
Defines the maximum skew between the number of Pods in any two topology domains. |
|
Specifies the topology key to use for spreading Pods. |
|
Sets the policy for how to handle unsatisfiable constraints, such as |
Tuning
Tuning configures settings for the autotuner tool in Redpanda. The autotuner identifies the hardware configuration in the container and optimizes the Linux kernel to give you the best performance.
Field | Description |
---|---|
|
Configures additional volume mounts for the Pod. |
|
Sets resource requirements such as CPU and memory limits. |
|
Specifies the file path for ballast file. A ballast file is an empty file that takes up disk space. If Redpanda runs out of disk space and becomes unavailable, you can delete the ballast file as a last resort. This clears up some space and gives you time to delete topics or records and change your retention properties. |
|
Defines the size of the ballast file. |
|
Specifies whether to increase the number of allowed asynchronous IO events. |
|
Specifies whether to create the ballast file. |
|
Specifies whether to synchronize NTP. |
|
Specifies the vendor, VM type, and storage device type that Redpanda runs on, in the format <vendor>:<vm>:<storage>. This hints to Redpanda which configuration values it should use for the Redpanda IO scheduler. |
UpdateStrategy
UpdateStrategy configures the update strategy for the StatefulSet to manage how updates are rolled out to the Pods.
Field | Description |
---|---|
|
Defines the strategy type for updating the StatefulSet, such as |
UsageStats
UsageStats configures the reporting of usage statistics. Redpanda Data uses these metrics to learn how the software is used, which can guide future improvements.
Field | Description |
---|---|
|
Specifies whether usage reporting is enabled. |
|
Specifies the name of the organization using the software. This can be useful for identifying and segmenting usage data by organization, if usage reporting is enabled. |
|
Specifies the ID of your Redpanda cluster. |
UsersItems
UsersItems configures a list of superusers in the Helm values.
Field | Description |
---|---|
|
Specifies the authentication mechanism to use for superusers. Overrides the default in |
|
Specifies the name of the superuser. |
|
Specifies the superuser password. |