demo 23.2 23.1 22.3 22.2 22.1

Redpanda Operator CRD Reference

Packages

cluster.redpanda.com/v1alpha1

Package v1alpha1 contains API Schema definitions for the redpanda v1alpha1 API group

Resource Types

Admin

Admin is a top level field of the values file

Appears in:

Field Description

external External

port integer

tls TLS

Auth

Auth is a top level field of the values file

Appears in:

Field Description

sasl SASL

Budget

Budget is a top level field of the values file

Appears in:

Field Description

maxUnavailable integer

CPU

Appears in:

Field Description

cores string

overprovisioned boolean

Certs

Certs is a top level field of the values file

Appears in:

ChartRef

Appears in:

Field Description

chartName string

ChartName is the chart to use

chartVersion string

ChartVersion defines the helm chart version to use

helmRepositoryName string

HelmRepositoryName defines the repository to use, defaults to redpanda if not defined

timeout Duration

Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) during the performance of a Helm action. Defaults to '15m0s'.

Config

Config is a top level field of the values file

Appears in:

Field Description

cluster integer array

node integer array

tunable integer array

ConfigWatcher

Appears in:

Field Description

enabled boolean

resources Resources

Configurator

Appears in:

Field Description

resources Resources

Container

Appears in:

Field Description

max string

min string

External

External is a top level field of the values file

Appears in:

Field Description

addresses integer array

domain string

enabled boolean

type string

externalDNS ExternalDNS

ExternalDNS

Appears in:

Field Description

enabled boolean

HTTP

HTTP is a top level field of the values file

Appears in:

Field Description

authenticationMethod string

enabled boolean

external External

kafkaEndpoint string

port integer

tls TLS

InitContainerImage

Appears in:

Field Description

repository string

tag string

InitContainers

Appears in:

Field Description

configurator Configurator

setDataDirOwnership SetDataDirOwnership

setTieredStorageCacheDirOwnership SetTieredStorageCacheDirOwnership

tuning Tuning

Kafka

Kafka is a top level field of the values file

Appears in:

Field Description

authenticationMethod string

external External

port integer

tls TLS

LicenseSecretRef

LicenseSecretRef is a top level field of the values file

Appears in:

Field Description

secret_key string

secret_name string

Listeners

Listeners is a top level field of the values file

Appears in:

Field Description

admin Admin

http HTTP

kafka Kafka

rpc RPC

schemaRegistry SchemaRegistry

LivenessProbe

LivenessProbe is a top level field of the values file

Appears in:

Field Description

failureThreshold integer

initialDelaySeconds integer

periodSeconds integer

Logging

Logging is a top level field of the values file

Appears in:

Field Description

logLevel string

usageStats UsageStats

Memory

Appears in:

Field Description

container Container

enable_memory_locking boolean

Monitoring

Appears in:

Field Description

enabled boolean

commonLabels object (keys:string, values:string)

scrapeInterval string

PersistentVolume

PersistentVolume is a top level field of the values file

Appears in:

Field Description

annotations object (keys:string, values:string)

enabled boolean

labels object (keys:string, values:string)

size string

storageClass string

PodAntiAffinity

PodAntiAffinity is a top level field of the values file

Appears in:

Field Description

topologyKey string

type string

weight integer

custom integer array

PostInstallJob

PostInstallJob is a top level field of the values file

Appears in:

Field Description

resources Resources

annotations object (keys:string, values:string)

enabled boolean

labels object (keys:string, values:string)

PostUpgradeJob

PostUpgradeJob is a top level field of the values file

Appears in:

Field Description

annotations object (keys:string, values:string)

enabled boolean

labels object (keys:string, values:string)

extraEnv integer array

extraEnvFrom integer array

resources Resources

RBAC

Appears in:

Field Description

annotations object (keys:string, values:string)

enabled boolean

RPC

RPC is a top level field of the values file

Appears in:

Field Description

port integer

tls TLS

RackAwareness

RackAwareness is a top level field of the values file

Appears in:

Field Description

enabled boolean

nodeAnnotation string

ReadinessProbe

ReadinessProbe is a top level field of the values file

Appears in:

Field Description

failureThreshold integer

initialDelaySeconds integer

periodSeconds integer

Redpanda

Redpanda is the Schema for the redpanda API

apiVersion: cluster.redpanda.com/v1alpha1
kind: Redpanda
metadata:
spec:

Appears in:

Field Description

apiVersion string

cluster.redpanda.com/v1alpha1

kind string

Redpanda

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec RedpandaSpec

RedpandaClusterSpec

RedpandaClusterSpec defines the desired state of Redpanda ClusterThese fields are used to configure the Redpanda Helm chart. For descriptions and default values, see Redpanda Helm Chart Specification.

Appears in:

Field Description

nameOverride string

NameOverride is the override to give your redpanda release

fullNameOverride string

FullnameOverride is the override to give your redpanda release

clusterDomain string

ClusterDomain is the override to give your redpanda release

commonLabels object (keys:string, values:string)

CommonLabels is the override to give your redpanda release

nodeSelector object (keys:string, values:string)

NodeSelector is the override to give your redpanda release

tolerations Toleration array

Tolerations is the override to give your redpanda release

image RedpandaImage

Image defines the container image to use for the redpanda cluster

imagePullSecrets LocalObjectReference array

license_key string

license_secret_ref LicenseSecretRef

rackAwareness RackAwareness

console RedpandaConsole

auth Auth

tls TLS

external External

logging Logging

resources Resources

storage Storage

post_install_job PostInstallJob

post_upgrade_job PostUpgradeJob

statefulset Statefulset

tuning Tuning

listeners Listeners

config Config

rbac RBAC

serviceAccount ServiceAccount

monitoring Monitoring

RedpandaConsole

Appears in:

RedpandaImage

RedpandaImage is a top level field of the values file

Appears in:

Field Description

repository string

tag string

pullPolicy string

RedpandaList

RedpandaList contains a list of Redpanda

apiVersion: cluster.redpanda.com/v1alpha1
kind: RedpandaList
metadata:
items:
Field Description

apiVersion string

cluster.redpanda.com/v1alpha1

kind string

RedpandaList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Redpanda array

RedpandaSpec

RedpandaSpec defines the desired state of Redpanda

Appears in:

Field Description

chartRef ChartRef

ChartRef defines chart details including repository

helmRepositoryName string

HelmRepositoryName defines the repository to use, defaults to redpanda if not defined

clusterSpec RedpandaClusterSpec

ClusterSpec defines the values to use in the cluster

Resources

Appears in:

Field Description

cpu CPU

memory Memory

SASL

SASL is a top level field of the values file

Appears in:

Field Description

enabled boolean

mechanism string

secretRef string

users UsersItems array

SchemaRegistry

SchemaRegistry is a top level field of the values file

Appears in:

Field Description

authenticationMethod string

enabled boolean

external External

kafkaEndpoint string

port integer

tls TLS

SecurityContext

SecurityContext is a top level field of the values file

Appears in:

Field Description

fsGroup integer

fsGroupChangePolicy string

runAsUser integer

ServiceAccount

Appears in:

Field Description

annotations object (keys:string, values:string)

create boolean

name string

SetDataDirOwnership

Appears in:

Field Description

enabled boolean

resources Resources

SetTieredStorageCacheDirOwnership

Appears in:

Field Description

resources Resources

SideCars

SideCars is a field that stores sidecars in the statefulset

Appears in:

Field Description

configWatcher ConfigWatcher

StartupProbe

StartupProbe is a top level field of the values file

Appears in:

Field Description

failureThreshold integer

initialDelaySeconds integer

periodSeconds integer

Statefulset

Statefulset is a top level field of the values file

Appears in:

Field Description

additionalRedpandaCmdFlags string array

annotations object (keys:string, values:string)

budget Budget

initContainerImage InitContainerImage

initContainer InitContainers

livenessProbe LivenessProbe

nodeSelector object (keys:string, values:string)

podAffinity integer array

podAntiAffinity PodAntiAffinity

priorityClassName string

readinessProbe ReadinessProbe

replicas integer

securityContext SecurityContext

sideCars SideCars

skipChown boolean

startupProbe StartupProbe

tolerations Toleration array

topologySpreadConstraints TopologySpreadConstraints

updateStrategy UpdateStrategy

terminationGracePeriodSeconds integer

Storage

Storage is a top level field of the values file

Appears in:

Field Description

hostPath string

persistentVolume PersistentVolume

tieredConfig TieredConfig

tieredStorageHostPath string

tieredStoragePersistentVolume TieredStoragePersistentVolume

TLS

TLS is a top level field of the values file

Appears in:

Field Description

certs Certs

enabled boolean

requireClientAuth boolean

TieredConfig

TieredConfig is a top level field of the values file

Appears in:

Field Description

cloud_storage_api_endpoint string

cloud_storage_api_endpoint_port integer

cloud_storage_bucket string

cloud_storage_cache_check_interval integer

cloud_storage_cache_directory string

cloud_storage_cache_size integer

cloud_storage_credentials_source string

cloud_storage_disable_tls boolean

cloud_storage_enable_remote_read boolean

cloud_storage_enable_remote_write boolean

cloud_storage_initial_backoff_ms integer

cloud_storage_manifest_upload_timeout_ms integer

cloud_storage_max_connection_idle_time_ms integer

cloud_storage_max_connections integer

cloud_storage_reconciliation_interval_ms integer

cloud_storage_region string

cloud_storage_segment_max_upload_interval_sec integer

cloud_storage_segment_upload_timeout_ms integer

cloud_storage_trust_file string

cloud_storage_upload_ctrl_d_coeff integer

cloud_storage_upload_ctrl_max_shares integer

cloud_storage_upload_ctrl_min_shares integer

cloud_storage_upload_ctrl_p_coeff integer

cloud_storage_upload_ctrl_update_interval_ms integer

TieredStoragePersistentVolume

TieredStoragePersistentVolume is a top level field of the values file

Appears in:

Field Description

annotations object (keys:string, values:string)

enabled boolean

labels object (keys:string, values:string)

storageClass string

TopologySpreadConstraints

TopologySpreadConstraints is a top level field of the values file

Appears in:

Field Description

maxSkew integer

topologyKey string

whenUnsatisfiable string

Tuning

Tuning is a top level field of the values file

Appears in:

Field Description

resources Resources

ballast_file_path string

ballast_file_size string

tune_aio_events boolean

tune_ballast_file boolean

tune_clocksource boolean

well_known_io string

UpdateStrategy

UpdateStrategy is a top level field of the values file

Appears in:

Field Description

type string

UsageStats

Appears in:

Field Description

enabled boolean

organization string

clusterId string

UsersItems

UsersItems is a top level field of the values file

Appears in:

Field Description

mechanism string

name string

password string