Redpanda Operator CRD Reference

external object (keys:string, values:ExternalListener)

port integer

tls ListenerTLS

sasl SASL

maxUnavailable integer

cores Quantity

overprovisioned boolean

issuerRef IssuerRef

secretRef SecretRef

duration Duration

caEnabled boolean

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

upgrade HelmUpgrade

Upgrade contains the details for handling upgrades including failures

cluster RawExtension

node RawExtension

tunable RawExtension

enabled boolean

extraVolumeMounts string

resources ResourceRequirements

SecurityContext SecurityContext

extraVolumeMounts string

resources ResourceRequirements

create boolean

max Quantity

min Quantity

addresses string array

domain string

enabled boolean

type string

externalDNS ExternalDNS

enabled boolean

port integer

tls ListenerTLS

advertisedPorts integer array

authenticationMethod string

enabled boolean

external object (keys:string, values:ExternalListener)

kafkaEndpoint string

port integer

tls ListenerTLS

remediation UpgradeRemediation

force boolean

preserveValues boolean

cleanupOnFail boolean

repository string

tag string

configurator Configurator

extraInitContainers string

setDataDirOwnership SetDataDirOwnership

setTieredStorageCacheDirOwnership SetTieredStorageCacheDirOwnership

tuning Tuning

name string

kind string

authenticationMethod string

external object (keys:string, values:ExternalListener)

port integer

tls ListenerTLS

secret_key string

secret_name string

cert string

enabled boolean

requireClientAuth boolean

admin Admin

http HTTP

kafka Kafka

rpc RPC

schemaRegistry SchemaRegistry

failureThreshold integer

initialDelaySeconds integer

periodSeconds integer

logLevel string

usageStats UsageStats

container Container

enable_memory_locking boolean

redpanda RedpandaMemory

enabled boolean

commonLabels object (keys:string, values:string)

scrapeInterval string

annotations object (keys:string, values:string)

enabled boolean

labels object (keys:string, values:string)

size string

storageClass string

resources ResourceRequirements

annotations object (keys:string, values:string)

enabled boolean

labels object (keys:string, values:string)

annotations object (keys:string, values:string)

enabled boolean

labels object (keys:string, values:string)

extraEnv EnvVar array

extraEnvFrom EnvFromSource array

resources ResourceRequirements

annotations object (keys:string, values:string)

enabled boolean

port integer

tls ListenerTLS

enabled boolean

nodeAnnotation string

failureThreshold integer

initialDelaySeconds integer

periodSeconds integer

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 Kubernetes API documentation for fields of metadata.

spec RedpandaSpec

status RedpandaStatus

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

enabled boolean

configMap ConsoleCreateObj

secret ConsoleCreateObj

deployment ConsoleCreateObj

config RawExtension

repository string

tag string

pullPolicy string

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 Kubernetes API documentation for fields of metadata.

items Redpanda array

memory Quantity

reserveMemory Quantity

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

observedGeneration integer

ObservedGeneration is 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

memory Memory

enabled boolean

mechanism string

secretRef string

users UsersItems array

authenticationMethod string

enabled boolean

external object (keys:string, values:ExternalListener)

kafkaEndpoint string

port integer

tls ListenerTLS

name string

annotations object (keys:string, values:string)

create boolean

name string

enabled boolean

extraVolumeMounts string

resources ResourceRequirements

extraVolumeMounts string

resources ResourceRequirements

enabled boolean

resources ResourceRequirements

SecurityContext SecurityContext

configWatcher ConfigWatcher

rpkStatus SideCarObj

failureThreshold integer

initialDelaySeconds integer

periodSeconds integer

additionalRedpandaCmdFlags string array

annotations object (keys:string, values:string)

budget Budget

extraVolumeMounts string

extraVolumes string

initContainerImage InitContainerImage

initContainers InitContainers

livenessProbe LivenessProbe

nodeSelector object (keys:string, values:string)

podAffinity PodAffinity

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

hostPath string

persistentVolume PersistentVolume

tieredConfig TieredConfig

tieredStorageHostPath string

tieredStoragePersistentVolume TieredStoragePersistentVolume

certs object (keys:string, values:Certificate)

enabled boolean

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

annotations object (keys:string, values:string)

enabled boolean

labels object (keys:string, values:string)

storageClass string

maxSkew integer

topologyKey string

whenUnsatisfiable string

extraVolumeMounts string

resources ResourceRequirements

ballast_file_path string

ballast_file_size string

tune_aio_events boolean

tune_ballast_file boolean

tune_clocksource boolean

well_known_io string

type string

enabled boolean

organization string

clusterId string

mechanism string

name string

password string