Redpanda CRD Reference

external object (keys:string, values:ExternalListener)

Defines settings for the external listener.

port integer

Specifies the container port number for the internal listener.

tls ListenerTLS

Configures TLS settings for the internal listener.

sasl SASL

Configures SASL authentication in the Helm values.

maxUnavailable integer

Defines the maximum number of Pods that can be unavailable during a voluntary disruption.

cores Quantity

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 --smp, resources.requests.cpu, and resources.limits.cpu. For production, use 4 or greater.

overprovisioned boolean

Specifies whether Redpanda assumes it has all of the provisioned CPU. This should be true unless the container has CPU affinity. Equivalent to: --idle-poll-time-us 0, --thread-affinity 0, and --poll-aio 0. If the value of full cores in resources.cpu.cores is less than 1, this setting is set to true.

issuerRef IssuerRef

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.

secretRef SecretRef

Specify the name of an existing Secret resource that contains your TLS certificate.

duration Duration

Specifies the validity duration of certificates generated with issuerRef.

caEnabled boolean

Specifies whether to include the ca.crt file in the trust stores of all listeners. Set to true only for certificates that are not authenticated using public certificate authorities (CAs).

chartName string

Specifies the name of the chart to deploy.

chartVersion string

Defines the version of the Redpanda Helm chart to deploy.

helmRepositoryName string

Defines the chart repository to use. Defaults to redpanda if not defined.

timeout Duration

Specifies the time to wait for any individual Kubernetes operation (like Jobs for hooks) during Helm actions. Defaults to 15m0s.

upgrade HelmUpgrade

Defines how to handle upgrades, including failures.

rpk RawExtension

Specifies cluster configuration properties. See https://docs.redpanda.com/current/reference/cluster-properties/.

cluster RawExtension

Specifies cluster configuration properties. See https://docs.redpanda.com/current/reference/cluster-properties/.

node RawExtension

Specifies broker configuration properties. See https://docs.redpanda.com/current/reference/node-properties/.

tunable RawExtension

Specifies tunable configuration properties. See https://docs.redpanda.com/current/reference/tunable-properties/.

schema_registry_client RawExtension

Specifies tunable configuration properties. See https://docs.redpanda.com/current/reference/tunable-properties/.

pandaproxy_client RawExtension

Specifies tunable configuration properties. See https://docs.redpanda.com/current/reference/tunable-properties/.

enabled boolean

Specifies whether the sidecar is enabled.

extraVolumeMounts string

Specifies additional volumes to mount to the sidecar.

resources ResourceRequirements

Specifies resource requests for the sidecar container.

SecurityContext SecurityContext

Specifies the container’s security context, including privileges and access levels of the container and its processes.

extraVolumeMounts string

resources ResourceRequirements

enabled boolean

Specifies whether to create a ServiceMonitor that can be used by Prometheus Operator or VictoriaMetrics Operator to scrape the metrics.

labels object (keys:string, values:string)

Adds custom labels to the ServiceMonitor resource.

scrapeInterval string

Specifies how often to scrape metrics.

annotations object (keys:string, values:string)

Adds custom Annotations to the ServiceMonitor resource.

namespaceSelector object (keys:string, values:string)

Adds custom namespaceSelector to monitoring resources

enabled boolean

Specifies whether to create the resource.

create boolean

Indicates whether the corresponding Kubernetes object (ConfigMap, Secret, or Deployment) should be created.

max Quantity

Specifies the maximum resources that can be allocated to a container.

min Quantity

Specifies the minimum resources required for a container.

license string

Specifies the Enterprise license key.

licenseSecretRef EnterpriseLicenseSecretRef

Defines a reference to a Secret resource that contains the Enterprise license key.

key string

Specifies the key that is contains the Enterprise license in the Secret.

name string

Specifies the name of the Secret resource to use.

addresses string array

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 statefulset.replicas. The values can be IP addresses or DNS names. If external.domain is set, the domain is appended to these values.

annotations object (keys:string, values:string)

Adds custom annotations to the external Service.

domain string

Specifies the domain to advertise to external clients. If specified, then it will be appended to the external.addresses values as each broker’s advertised address.

enabled boolean

Specifies whether the external access is enabled.

service ExternalService

Configures the external Service resource.

sourceRanges string array

Source range for external access. Only applicable when external.type is LoadBalancer.

type string

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.

externalDns ExternalDNS

Defines externalDNS configurations.

prefixTemplate string

Specifies a naming prefix template for external Services.

enabled boolean

Specifies whether externalDNS annotations are added to LoadBalancer Services. If you enable externalDns, each LoadBalancer Service defined in external.type will be annotated with an external-dns hostname that matches external.addresses[i].external.domain.

enabled boolean

authenticationMethod string

Specifies the authentication method for the external listener. For example, 'mtls_identity' or sasl.

port integer

Specifies the container port number for the external listener.

tls ListenerTLS

Configures TLS settings for the external listener.

advertisedPorts integer array

Specifies the network port that the external Service listens on.

enabled boolean

Specifies whether to create the external Service. If set to false, the external Service type is not created. You can still set your cluster with external access but not create the supporting Service. Set this to false to manage your own Service.

enabled boolean

expectedFS string

extraVolumeMounts string

Adds extra volume mounts.

resources ResourceRequirements

Specifies the resource requirements.

authenticationMethod string

Specifies the authentication method for the external listener. For example, 'mtls_identity' or sasl.

enabled boolean

Specifies whether the HTTP Proxy is enabled.

external object (keys:string, values:ExternalListener)

Defines settings for the external listener.

kafkaEndpoint string

Configures the listener to use for HTTP connections. For example default for the internal listener.

port integer

Specifies the container port number for the internal listener.

tls ListenerTLS

Configures TLS settings for the internal listener.

prefixTemplate string

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.

remediation UpgradeRemediation

Specifies the actions to take on upgrade failures. See https://pkg.go.dev/github.com/fluxcd/helm-controller/api/v2beta1#UpgradeRemediation.

force boolean

Enables forceful updates during an upgrade.

preserveValues boolean

Specifies whether to preserve user-configured values during an upgrade.

cleanupOnFail boolean

Specifies whether to perform cleanup in case of failed upgrades.

repository string

tag string

configurator Configurator

extraInitContainers string

setDataDirOwnership SetDataDirOwnership

Defines the settings related to ownership of the Redpanda data directory in environments where root access is restricted.

setTieredStorageCacheDirOwnership SetTieredStorageCacheDirOwnership

Defines the settings related to ownership of the Tiered Storage cache in environments where root access is restricted.

fsValidator FsValidator

Defines the setting for init container that not allow to start Redpanda until filesystem matches

tuning Tuning

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.

name string

Specifies the name of the resource.

kind string

Specifies the kind of resource. One of Issuer or ClusterIssuer.

authenticationMethod string

Specifies the authentication method for the external listener. For example, 'mtls_identity' or sasl.

external object (keys:string, values:ExternalListener)

Defines settings for the external listener.

port integer

Specifies the container port number for the internal listener.

tls ListenerTLS

Configures TLS settings for the internal listener.

prefixTemplate string

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.

secret_key string

Specifies the key that is contains the Enterprise license in the Secret.

secret_name string

Specifies the name of the Secret.

cert string

References a specific certificate for the listener.

enabled boolean

Specifies whether TLS is enabled for the listener.

secretRef string

References a Secret rsource containing TLS credentials for the listener.

requireClientAuth boolean

Indicates whether client authentication (mTLS) is required.

admin Admin

Configures settings for the Admin API listeners.

http HTTP

Configures settings for the HTTP Proxy listeners.

kafka Kafka

Configures settings for the Kafka API listeners.

rpc RPC

Configures settings for the RPC API listener.

schemaRegistry SchemaRegistry

Configures settings for the Schema Registry listeners.

failureThreshold integer

Sets the number of consecutive failures required to consider a Pod as not live.

initialDelaySeconds integer

Specifies the time in seconds to wait before the first probe is initiated.

periodSeconds integer

Determines the frequency in seconds of performing the probe.

logLevel string

Sets the verbosity level of logs.

usageStats UsageStats

Specifies whether to send usage statistics to Redpanda Data.

container Container

Defines resource limits for containers.

enable_memory_locking boolean

Enables memory locking. For production, set to true.

redpanda RedpandaMemory

Allows you to optionally specify the memory size for both the Redpanda process and the underlying reserved memory used by Seastar.

enabled boolean

clusterRef NamespaceNameRef

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 NamespaceNameRef

ConsoleRef by default will not be able to reach different namespaces, but it can be overwritten by adding ClusterRole and ClusterRoleBinding to operator ServiceAccount.

enabled boolean

Specifies whether to create a ServiceMonitor that can be used by Prometheus Operator or VictoriaMetrics Operator to scrape the metrics.

labels object (keys:string, values:string)

Adds custom labels to the ServiceMonitor resource.

scrapeInterval string

Specifies how often to scrape metrics.

tlsConfig RawExtension

Specifies tls configuration properties.

annotations object (keys:string, values:string)

Adds annotations to the PersistentVolumeClaims to provide additional information or metadata that can be used by other tools or libraries.

enabled boolean

Specifies whether to enable the Helm chart to create PersistentVolumeClaims for Pods.

labels object (keys:string, values:string)

Applies labels to the PersistentVolumeClaims to facilitate identification and selection based on custom criteria.

size string

Specifies the storage capacity required.

storageClass string

Specifies the StorageClass for the PersistentVolumeClaims to determine how PersistentVolumes are provisioned and managed.

resources ResourceRequirements

Sets resource requirements (CPU, memory) for the job to ensure proper allocation and limit resource usage.

annotations object (keys:string, values:string)

Adds annotations to the job to provide additional information or metadata that can be used by other tools or libraries.

enabled boolean

Specifies whether the job is deployed.

labels object (keys:string, values:string)

Applies labels to the job to facilitate identification and selection based on custom criteria.

annotations object (keys:string, values:string)

Adds annotations to the job to provide additional information or metadata that can be used by other tools or libraries.

enabled boolean

Specifies whether the job is deployed.

labels object (keys:string, values:string)

Applies labels to the job to facilitate identification and selection based on custom criteria.

extraEnv EnvVar array

Adds environment variables to the job container to configure its runtime behavior.

extraEnvFrom EnvFromSource array

Specifies environment variables from external sources, such as ConfigMap resources, or Secret resources, to dynamically configure the job.

resources ResourceRequirements

Sets resource requirements (CPU, memory) for the job to ensure proper allocation and limit resource usage.

annotations object (keys:string, values:string)

Adds custom annotations to the RBAC resources.

enabled boolean

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 --set rbac.createRPKBundleCRs=true flag to give it the required ClusterRoles.

port integer

Specifies the container port number for the internal listener.

tls ListenerTLS

Configures TLS settings for the internal listener.

enabled boolean

Specifies whether the Controllers are enabled.

resources ResourceRequirements

SecurityContext SecurityContext

image RedpandaImage

healthProbeAddress string

metricsAddress string

run string array

createRBAC boolean

enabled boolean

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 rbac.enabled set to true.

nodeAnnotation string

Specifies the key in Node labels or annotations to use to denote failure zones.

failureThreshold integer

Defines the threshold for how many times the probe can fail before the Pod is marked Unready.

initialDelaySeconds integer

Sets the initial delay before the readiness probe is initiated, in seconds.

periodSeconds integer

Configures the period, in seconds, between each readiness check.

apiVersion string

cluster.redpanda.com/v1alpha1

kind string

Redpanda

kind string

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 string

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

metadata ObjectMeta

Refer to the Kubernetes API documentation for fields of metadata.

spec RedpandaSpec

Defines the desired state of the Redpanda cluster.

status RedpandaStatus

Represents the current status of the Redpanda cluster.

nameOverride string

Customizes the labels app.kubernetes.io/component=<nameOverride>-statefulset and app.kubernetes.io/name=<nameOverride> on the StatefulSet Pods. The default is redpanda.

fullNameOverride string

Customizes the name of the StatefulSet and Services. The default is redpanda.

clusterDomain string

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 cluster.local domain.

commonLabels object (keys:string, values:string)

Assigns custom labels to all resources generated by the Redpanda Helm chart. Specify labels as key/value pairs.

nodeSelector object (keys:string, values:string)

Specifies on which nodes a Pod should be scheduled. These key/value pairs ensure that Pods are scheduled onto nodes with the specified labels.

tolerations Toleration array

Specifies tolerations to allow Pods to be scheduled onto nodes where they otherwise wouldn’t.

image RedpandaImage

Defines the container image settings to use for the Redpanda cluster.

imagePullSecrets LocalObjectReference array

Specifies credentials for a private image repository. For details, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/.

license_key string

Deprecated: Use Enterprise instead.

license_secret_ref LicenseSecretRef

Deprecated: Use EnterpriseLicenseSecretRef instead.

enterprise Enterprise

Defines an Enterprise license.

rackAwareness RackAwareness

Defines rack awareness settings.

console RedpandaConsole

Defines Redpanda Console settings.

connectors RedpandaConnectors

Defines Redpanda Connector settings.

auth Auth

Defines authentication settings for listeners.

tls TLS

Defines TLS settings for listeners.

external External

Defines external access settings.

logging Logging

Defines the log level settings.

resources Resources

Defines container resource settings.

service Service

Defines settings for the headless ClusterIP Service.

storage Storage

Defines storage settings for the Redpanda data directory and the Tiered Storage cache.

post_install_job PostInstallJob

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.

post_upgrade_job PostUpgradeJob

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.

statefulset Statefulset

Defines settings for the StatefulSet that manages Redpanda brokers.

tuning Tuning

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.

listeners Listeners

Defines settings for listeners, including HTTP Proxy, Schema Registry, the Admin API and the Kafka API.

config Config

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 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.

rbac RBAC

Defines Role Based Access Control (RBAC) settings.

serviceAccount ServiceAccount

Defines Service account settings.

monitoring Monitoring

Defines settings for monitoring Redpanda.

force boolean

Adds the --force flag in helm upgrade commands. Used for allowing a change of TLS configuration for the RPC listener. Setting force to true will result in a short period of downtime.

enabled boolean

test ConnectorsCreateObj

Specifies whether to create Helm tests.

monitoring ConnectorMonitoring

Specifies monitoring resources

connectors RawExtension

Connectors specified manual configurations

deployment RawExtension

Connectors specified manual configurations

nameOverride string

Specifies a custom name for the Redpanda Console resources, overriding the default naming convention.

fullnameOverride string

Specifies a full custom name, which overrides the entire naming convention including release name and chart name.

commonLabels object (keys:string, values:string)

Assigns custom labels to all resources generated by the Connector Helm chart. Specify labels as key/value pairs.

tolerations Toleration array

Applies tolerations to allow Pods to be scheduled on nodes with matching taints, enabling control over where Pods can run.

image RedpandaImage

Defines the container image settings to use for the Redpanda cluster.

imagePullSecrets LocalObjectReference array

Specifies credentials for a private image repository. For details, see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/.

auth RawExtension

Specifies superuser credentials

container RawExtension

Specifies container information

storage RawExtension

Specifies storage information

logging RawExtension

Specifies logging details

enabled boolean

Specifies whether the Redpanda Console subchart should be deployed.

replicaCount integer

Sets the number of replicas for the Redpanda Console Deployment resource.

nameOverride string

Specifies a custom name for the Redpanda Console resources, overriding the default naming convention.

fullnameOverride string

Specifies a full custom name, which overrides the entire naming convention including release name and chart name.

priorityClassName string

Specifies the priority class name for the Pods that run Redpanda Console.

image RawExtension

Defines the container image for the Redpanda Console, including the repository, name, and tag.

imagePullSecrets RawExtension array

Defines Secrets used to pull the container images from a private registry.

serviceAccount RawExtension

Configures the ServiceAccount used by the Pods that run Redpanda Console.

annotations RawExtension

podAnnotations RawExtension

Adds custom annotations to the Pods that run Redpanda Console.

podLabels RawExtension

Adds custom labels to the Pods that run Redpanda Console.

podSecurityContext RawExtension

securityContext RawExtension

Sets the security context for the Pods that run Redpanda Console.

service RawExtension

Configures the Kubernetes Service for Redpanda Console.

ingress RawExtension

Configures the Kubernetes Ingress resource for Redpanda Console.

resources RawExtension

Configures resource requests and limits for the Pods that run Redpanda Console.

autoscaling RawExtension

Configures Horizontal Pod Autoscaling (HPA) for Redpanda Console.

nodeSelector RawExtension

Specifies Node labels for Pod assignment.

tolerations RawExtension array

Specifies tolerations for scheduling Pods onto Nodes with taints.

affinity RawExtension

Defines affinity rules for Pod assignment.

topologySpreadConstraints RawExtension

Specifies topology spread constraints for Pod placement.

extraEnv RawExtension array

Adds extra environment variables to the Pods that run Redpanda Console.

extraEnvFrom RawExtension array

Allows you to add extra environment variables from external resources to the Pods that run Redpanda Console.

extraVolumes RawExtension array

Adds extra volumes to the Pods that run Redpanda Console.

extraVolumeMounts RawExtension array

Mounts additional volumes inside the containers that run Redpanda Console.

extraContainers RawExtension array

Adds extra containers to the Pods that run Redpanda Console.

initContainers RawExtension

Specifies init containers for the Pods that run Redpanda Console.

secretMounts RawExtension array

Mounts additional Secret resources inside the containers that run Redpanda Console.

configMap ConsoleCreateObj

Specifies whether a ConfigMap should be created for Redpanda Console.

secret ConsoleCreateObj

Specifies whether a Secret should be created for Redpanda Console.

deployment ConsoleCreateObj

Specifies whether a Deployment should be created for Redpanda Console.

console RawExtension

Configures custom settings for Redpanda Console.

repository string

Specifies the image repository to pull from.

tag string

Specifies the image tag.

pullPolicy string

Specifies the strategy used for pulling images from the repository. For available values, see https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy.

apiVersion string

cluster.redpanda.com/v1alpha1

kind string

RedpandaList

kind string

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 string

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

metadata ListMeta

Refer to the Kubernetes API documentation for fields of metadata.

items Redpanda array

Specifies a list of Redpanda resources.

memory Quantity

Memory for the Redpanda process. This must be lower than the container’s memory (resources.memory.container.min if provided, otherwise resources.memory.container.max). Equivalent to --memory. For production, use 8Gi or greater.

reserveMemory Quantity

Memory reserved for the Seastar subsystem. Any value above 1Gi will provide diminishing performance benefits. Equivalent to --reserve-memory. For production, use 1Gi.

chartRef ChartRef

Defines chart details, including the version and repository.

clusterSpec RedpandaClusterSpec

Defines the Helm values to use to deploy the cluster.

migration Migration

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/

observedGeneration integer

Specifies the last observed generation.

lastHandledReconcileAt string

LastHandledReconcileAt holds the value of the most recent reconcile request value, so a change of the annotation value can be detected.

conditions Condition array

Conditions holds the conditions for the Redpanda.

lastAppliedRevision string

LastAppliedRevision is the revision of the last successfully applied source.

lastAttemptedRevision string

LastAttemptedRevision is the revision of the last reconciliation attempt.

helmRelease string

helmReleaseReady boolean

helmRepository string

helmRepositoryReady boolean

upgradeFailures integer

failures integer

Failures is the reconciliation failure count against the latest desired state. It is reset after a successful reconciliation.

installFailures integer

cpu CPU

Specifies the number of CPU cores.

memory Memory

Specifies the amount of memory.

enabled boolean

Enables SASL authentication. If you enable SASL authentication, you must provide a Secret name in secretRef.

mechanism string

Specifies the default authentication mechanism to use for superusers. Options are SCRAM-SHA-256 and SCRAM-SHA-512.

secretRef string

If users is empty, secretRef specifies the name of the Secret that contains your superuser credentials in the format <username>:<password>:<optional-authentication-mechanism>. Otherwise, secretRef specifies the name of the Secret that the chart creates to store the credentials in users.

users UsersItems array

Specifies a list of superuser credentials.

authenticationMethod string

Specifies the authentication method for the external listener. For example, 'mtls_identity' or sasl.

enabled boolean

Specifies whether the Schema Registry is enabled.

external object (keys:string, values:ExternalListener)

Defines settings for the external listener.

kafkaEndpoint string

Configures the listener to use for HTTP connections. For example default for the internal listener.

port integer

Specifies the container port number for the internal listener.

tls ListenerTLS

Configures TLS settings for the internal listener.

name string

Specifies the name of the Secret resource.

name string

internal ServiceInternal

annotations object (keys:string, values:string)

Adds custom annotations to the ServiceAccount resources.

create boolean

Specifies whether a ServiceAccount should be created.

name string

Specifies the name of the ServiceAccount.

annotations object (keys:string, values:string)

enabled boolean

Specifies whether to enable root access. Enable only in environments where root access is not allowed, such as minikube.

extraVolumeMounts string

Adds extra volume mounts.

resources ResourceRequirements

Specifies the resource requirements.

extraVolumeMounts string

resources ResourceRequirements

enabled boolean

resources ResourceRequirements

SecurityContext SecurityContext

configWatcher ConfigWatcher

Configures the config-watcher sidecar. The config-watcher sidecar polls the Secret resource in auth.sasl.secretRef for changes and triggers a rolling upgrade to add the new superusers to the Redpanda cluster.

rpkStatus SideCarObj

controllers RPControllers

failureThreshold integer

Determines the failure threshold to mark the application in the Pod as not started.

initialDelaySeconds integer

Specifies the delay in seconds before the startup probe begins.

periodSeconds integer

Sets the period in seconds for conducting subsequent probes.

additionalRedpandaCmdFlags string array

Includes additional command flags for Redpanda at startup to customize its runtime behavior.

annotations object (keys:string, values:string)

Adds annotations to the StatefulSet to provide additional information or metadata.

budget Budget

Defines the management of disruptions affecting the Pods in the StatefulSet.

extraVolumeMounts string

Specifies extra volume mounts for the Pods.

extraVolumes string

Defines additional volumes for the Pods.

initContainerImage InitContainerImage

Defines the init container image used to perform initial setup tasks before the main containers start.

initContainers InitContainers

Configures the init container used to perform initial setup tasks before the main containers start.

livenessProbe LivenessProbe

Defines liveness probes to monitor the health of the Pods and restart them if necessary.

nodeSelector object (keys:string, values:string)

Applies node selectors to schedule Pods on specific nodes based on labels.

podAffinity PodAffinity

Defines Pod affinity rules to influence the scheduling and placement of Pods relative to other Pods.

podAntiAffinity PodAntiAffinity

Defines Pod anti-affinity rules to prevent Pods from being scheduled together on the same node.

priorityClassName string

Defines the priority class name to assign priority levels to the Pods, influencing their scheduling order.

readinessProbe ReadinessProbe

Defines readiness probes to determine when a Pod is ready to handle traffic.

replicas integer

Specifies the number of replicas to determine the desired number of Pods (Redpanda brokers) in the StatefulSet.

securityContext SecurityContext

Sets a security context for the Pods to define privilege and access control settings.

sideCars SideCars

Defines the additional sidecar containers that run alongside the main Redpanda container in the Pod.

skipChown boolean

Specifies whether to skip the changing of file ownership (chown) during Pod initialization.

startupProbe StartupProbe

Configures the startup probe to determine when the Redpanda application within the Pod has started successfully.

tolerations Toleration array

Applies tolerations to allow Pods to be scheduled on nodes with matching taints, enabling control over where Pods can run.

topologySpreadConstraints TopologySpreadConstraints

Defines topology spread constraints to control how Pods are spread across different topology domains.

updateStrategy UpdateStrategy

Defines the update strategy for the StatefulSet to manage how updates are rolled out to the Pods.

terminationGracePeriodSeconds integer

Specifies the termination grace period in seconds to control the time delay before forcefully terminating a Pod.

hostPath string

Specifies the absolute path on the worker node to store the Redpanda data directory. If unspecified, then an emptyDir volume is used. If specified but persistentVolume.enabled is true, storage.hostPath has no effect.

persistentVolume PersistentVolume

Configures a PersistentVolumeClaim (PVC) template to create for each Pod. This PVC is used to store the Redpanda data directory.

tiered Tiered

Configures storage for the Tiered Storage cache.

certs object (keys:string, values:Certificate)

Lists all available certificates in the cluster. You can reference a specific certificate’s name in each listener’s listeners.<listener name>.tls.cert setting.

enabled boolean

Enables TLS globally for all listeners. Each listener must include a certificate name in its <listener>.tls object. To allow you to enable TLS for individual listeners, certificates are always loaded, even if TLS is disabled.

mountType string

mountType can be one of: - none: Does not mount a volume. Tiered storage will use the same volume as the one defined for the Redpanda data directory. - hostPath: Uses the path specified in hostPath on the worker node that the Pod is running on. - emptyDir: Mounts an empty directory every time the Pod starts. - persistentVolume: Creates and mounts a PersistentVolumeClaim using the template defined in persistentVolume.

hostPath string

Specifies the absolute path on the worker node to store the Tiered Storage cache.

persistentVolume TieredStoragePersistentVolume

Configures a PersistentVolumeClaim (PVC) template to create for each Pod. This PVC is used to store the Tiered Storage cache.

config TieredConfig

Configures Tiered Storage, which requires an Enterprise license configured in enterprise.licenseKey or enterprised.licenseSecretRef.

cloud_storage_enabled string

Enables Tiered Storage if a license key is provided. See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_enabled.

cloud_storage_api_endpoint string

See https://docs.redpanda.com/docs/reference/cluster-properties/#cloud_storage_api_endpoint.

cloud_storage_api_endpoint_port integer

See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_api_endpoint_port.

cloud_storage_bucket string

See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_bucket.

cloud_storage_cache_check_interval integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_cache_check_interval.

cloud_storage_cache_directory string

See https://docs.redpanda.com/current/reference/node-properties/#cloud_storage_cache_directory.

cloud_storage_cache_size string

See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_cache_size.

cloud_storage_credentials_source string

See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_credentials_source.

cloud_storage_disable_tls boolean

See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_disable_tls.

cloud_storage_enable_remote_read boolean

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_read.

cloud_storage_enable_remote_write boolean

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_enable_remote_write.

cloud_storage_initial_backoff_ms integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_initial_backoff_ms.

cloud_storage_manifest_upload_timeout_ms integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_manifest_upload_timeout_ms.

cloud_storage_max_connection_idle_time_ms integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_max_connection_idle_time_ms.

cloud_storage_max_connections integer

See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_max_connections.

cloud_storage_reconciliation_interval_ms integer

Deprecated: See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_reconciliation_interval_ms.

cloud_storage_region string

See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_region.

cloud_storage_segment_max_upload_interval_sec integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_max_upload_interval_sec.

cloud_storage_segment_upload_timeout_ms integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_segment_upload_timeout_ms.

cloud_storage_trust_file string

See https://docs.redpanda.com/current/reference/cluster-properties/#cloud_storage_trust_file.

cloud_storage_upload_ctrl_d_coeff integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_d_coeff.

cloud_storage_upload_ctrl_max_shares integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_max_shares.

cloud_storage_upload_ctrl_min_shares integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_min_shares.

cloud_storage_upload_ctrl_p_coeff integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_p_coeff.

cloud_storage_upload_ctrl_update_interval_ms integer

See https://docs.redpanda.com/current/reference/tunable-properties/#cloud_storage_upload_ctrl_update_interval_ms.

annotations object (keys:string, values:string)

Adds annotations to the PersistentVolumeClaims to provide additional information or metadata that can be used by other tools or libraries.

labels object (keys:string, values:string)

Applies labels to the PersistentVolumeClaims to facilitate identification and selection based on custom criteria.

storageClass string

Specifies the StorageClass for the PersistentVolumeClaims to determine how PersistentVolumes are provisioned and managed.

maxSkew integer

Defines the maximum skew between the number of Pods in any two topology domains.

topologyKey string

Specifies the topology key to use for spreading Pods.

whenUnsatisfiable string

Sets the policy for how to handle unsatisfiable constraints, such as DoNotSchedule or ScheduleAnyway.

extraVolumeMounts string

Configures additional volume mounts for the Pod.

resources ResourceRequirements

Sets resource requirements such as CPU and memory limits.

ballast_file_path string

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.

ballast_file_size string

Defines the size of the ballast file.

tune_aio_events boolean

Specifies whether to increase the number of allowed asynchronous IO events.

tune_ballast_file boolean

Specifies whether to create the ballast file.

tune_clocksource boolean

Specifies whether to synchronize NTP.

well_known_io string

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.

type string

Defines the strategy type for updating the StatefulSet, such as RollingUpdate or OnDelete.

enabled boolean

Specifies whether usage reporting is enabled.

organization string

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.

clusterId string

Specifies the ID of your Redpanda cluster.

mechanism string

Specifies the authentication mechanism to use for superusers. Overrides the default in SASL. Options are SCRAM-SHA-256 and SCRAM-SHA-512.

name string

Specifies the name of the superuser.

password string

Specifies the superuser password.