API Reference

Resource Types:

• LHCanaryAggregator

• LHCanaryMetronome

• LHCluster

• LHDashboard

• LHKafka

• LHKafkaUser

• LHOperator

• LHPrincipal

• LHTenant

LHCanaryAggregator

^{[↩ Parent]}

Name	Type	Description	Required
apiVersion	string	littlehorse.io/v1	true
kind	string	LHCanaryAggregator	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object		false
status	object		false

LHCanaryAggregator.spec

^{↩ Parent}

Name	Type	Description	Required
image	string	The Docker Image to use	true
imagePullPolicy	enum	Image Pull Policy for the Canary Image Enum: Always, IfNotPresent, Never	true
kafka	object	Configures access to the Kafka cluster	true
storage	object	Configures storage for the LHCanary Statefulset	true
defaultLabels	map[string]string	Labels to put on all created resources	false
podMonitor	object	Configures PodMonitor resources for the Aggregator	false
replicas	integer	Number of replicas for the LH Canary Statefulset Minimum: 1	false

LHCanaryAggregator.spec.kafka

^{↩ Parent}

Configures access to the Kafka cluster

Name	Type	Description	Required
lhKafkaRef	object	Points to an LHKafka Cluster	false
partitions	integer	Number of partitions to use for the Canary's internal Kafka topics Minimum: 1	false
replicationFactor	integer	Replication factor for the Canary Kafka Topics Minimum: 0	false

LHCanaryAggregator.spec.kafka.lhKafkaRef

^{↩ Parent}

Points to an LHKafka Cluster

Name	Type	Description	Required
clusterWideQuotas	object	Quotas for the Canary. Includes Metronomes as well as the Aggregator since both share the same credentials.	true
clusterName	string	The name of the LHKaka resource that the Aggregator connects to	false

LHCanaryAggregator.spec.kafka.lhKafkaRef.clusterWideQuotas

^{↩ Parent}

Quotas for the Canary. Includes Metronomes as well as the Aggregator since both share the same credentials.

Name	Type	Description	Required
consumerThroughputPerSecond	int or string	The throughput in bytes per second that may be consumed by this Kafka principal	true
producerThroughputPerSecond	int or string	The throughput in bytes per second that may be produced by this Kafka principal	true

LHCanaryAggregator.spec.storage

^{↩ Parent}

Configures storage for the LHCanary Statefulset

Name	Type	Description	Required
storageClassName	string	The name of the storageclass with which to provision storage for the server	true
volumeSize	int or string	The size of the persistent volume.	true

LHCanaryAggregator.spec.podMonitor

^{↩ Parent}

Configures PodMonitor resources for the Aggregator

Name	Type	Description	Required
podMonitorLabels	map[string]string	Labels to add to the generated PodMonitor resources	false

LHCanaryAggregator.status

^{↩ Parent}

Name	Type	Description	Required
observedGeneration	integer		false
problems	string		false

LHCanaryMetronome

^{[↩ Parent]}

Name	Type	Description	Required
apiVersion	string	littlehorse.io/v1	true
kind	string	LHCanaryMetronome	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object		false
status	object		false

LHCanaryMetronome.spec

^{↩ Parent}

Name	Type	Description	Required
aggregatorRef	object	Specifies the LHCanaryAggregator for this Metronome	true
lhCluster	object	Specifies the LittleHorse Cluster to monitor	true
replicas	integer	Number of metronome replicas to deploy	true
storage	object	Storage Configuration for the Metronome	true
additionalConfigs	map[string]string	Configurations to pass to the LHCanaryMetronome.	false
defaultLabels	map[string]string	Labels to put on all created resources	false
image	string	The docker image for the LH Canary Default: ghcr.io/littlehorse-enterprises/littlehorse/lh-canary:master	false
imagePullPolicy	enum	ImagePullPolicy for the LH Canary Enum: Always, IfNotPresent, Never	false

LHCanaryMetronome.spec.aggregatorRef

^{↩ Parent}

Specifies the LHCanaryAggregator for this Metronome

Name	Type	Description	Required
name	string	Name of the LHCanaryAggregator that should aggregate beats from this Metronome.	false

LHCanaryMetronome.spec.lhCluster

^{↩ Parent}

Specifies the LittleHorse Cluster to monitor

Name	Type	Description	Required
externalClusterRef	object	Specifies a LittleHorse Cluster not managed by the same Operator as this Metronome	false

LHCanaryMetronome.spec.lhCluster.externalClusterRef

^{↩ Parent}

Specifies a LittleHorse Cluster not managed by the same Operator as this Metronome

Name	Type	Description	Required
apiHost	string	The API Host of the LH Cluster to monitor	true
apiPort	integer	The API Port of the LH Cluster to monitor	true
listenerName	string	The Listener Name to connect to	false
tenantId	string	The Tenant to use Default: default	false

LHCanaryMetronome.spec.storage

^{↩ Parent}

Storage Configuration for the Metronome

Name	Type	Description	Required
storageClassName	string	The name of the storageclass with which to provision storage for the server	true
volumeSize	int or string	The size of the persistent volume.	true

LHCanaryMetronome.status

^{↩ Parent}

Name	Type	Description	Required
observedGeneration	integer		false
problems	string		false

LHCluster

^{[↩ Parent]}

Name	Type	Description	Required
apiVersion	string	littlehorse.io/v1	true
kind	string	LHCluster	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object		false
status	object		false

LHCluster.spec

^{↩ Parent}

Name	Type	Description	Required
kafka	object		true
server	object		true
dashboard	object	Specifies to create Dashboard resources for the cluster	false
defaultLabels	map[string]string		false
internalCommsIssuer	object	Specifies cert-manager issuer to be used for internal communication certificates	false
podMonitor	object		false

LHCluster.spec.kafka

^{↩ Parent}

Name	Type	Description	Required
clusterPartitions	integer		true
externalClusterRef	object		false
lhKafkaRef	object		false
replicationFactor	integer		false
strimziClusterRef	object		false

LHCluster.spec.kafka.externalClusterRef

^{↩ Parent}

Name	Type	Description	Required
bootstrapServers	string		true
securityProtocol	string		true
createTopics	boolean		false
kafkaKeyStore	object		false
kafkaTrustStore	object		false
saslJaasConfig	object		false
saslMechanism	string		false

LHCluster.spec.kafka.externalClusterRef.kafkaKeyStore

^{↩ Parent}

Name	Type	Description	Required
name	string		true

LHCluster.spec.kafka.externalClusterRef.kafkaTrustStore

^{↩ Parent}

Name	Type	Description	Required
name	string		true

LHCluster.spec.kafka.externalClusterRef.saslJaasConfig

^{↩ Parent}

Name	Type	Description	Required
name	string		true

LHCluster.spec.kafka.lhKafkaRef

^{↩ Parent}

Name	Type	Description	Required
clusterName	string		true
clusterWideQuotas	object		true

LHCluster.spec.kafka.lhKafkaRef.clusterWideQuotas

^{↩ Parent}

Name	Type	Description	Required
consumerThroughputPerSecond	int or string	The throughput in bytes per second that may be consumed by this Kafka principal	true
producerThroughputPerSecond	int or string	The throughput in bytes per second that may be produced by this Kafka principal	true

LHCluster.spec.kafka.strimziClusterRef

^{↩ Parent}

Name	Type	Description	Required
clusterName	string		true
createTopics	boolean		true
listener	object		true
quotas	object		false

LHCluster.spec.kafka.strimziClusterRef.listener

^{↩ Parent}

Name	Type	Description	Required
port	integer		true
authentication	string		false
tls	boolean		false

LHCluster.spec.kafka.strimziClusterRef.quotas

^{↩ Parent}

Name	Type	Description	Required
consumerByteRate	integer		false
controllerMutationRate	number		false
producerByteRate	integer		false
requestPercentage	integer		false

LHCluster.spec.server

^{↩ Parent}

Name	Type	Description	Required
replicas	integer	Desired number of LH Server pods Minimum: 1	true
storage	object	Specification for persistent storage used by the server	true
authentication	object	Determines how the LH Servers will determine Principal identity	false
compute	object	Specifies the compute resources allocated to the Server pods	false
coreStreamsCommitIntervalMs	integer	Sets commit.interval.ms for the Core topology.	false
experimentalConfigOverride	map[string]string	EXPERIMENTAL: specific configurations to override on the LH Server. Only applies to configs that are constant across all server instances.	false
hotStandbyReplicas	integer	The number of Kafka Streams standby replicas	false
image	string	Image to use for the LH Server	false
imagePullPolicy	enum	Image Pull Policy for LH Server Pods Enum: Always, IfNotPresent, Never	false
internalPort	object	Configures authentication on the internal port used for interactive queries	false
lingerMs	integer	Desired value for linger.ms on the Command Producer.	false
listeners	[]object	Listeners to expose on the LH Server for use by clients of the LHCluster	false
logLevel	enum	Log Level for the LH Server Enum: DEBUG, INFO, TRACE, WARN	false
nodeSelector	map[string]string	Node Selector for LH Server pods.	false
operatorListener	object	Configures a listener on the Servers for the Operator to perform admin operations	false
podAnnotations	map[string]string	Labels to put on LH Server Pods	false
podLabels	map[string]string	Annotations to put on LH Server Pods	false
priorityClassName	string	Priority Class for LH Server pods.	false
rackAwareness	object	Specifies rack awareness for the LH Servers	false
serviceAnnotations	map[string]string	Annotations to put on LH Server Services	false
serviceLabels	map[string]string	Labels to put on LH Server Services	false
streamsMetricsLevel	enum	Level of Kafka Streams metrics to collect. Setting to DEBUG or TRACE impacts performance. Enum: DEBUG, INFO, TRACE, WARN	false
tolerations	[]object	Tolerations for LH Server pods.	false
version	string	Version of the LH Server to deploy	false

LHCluster.spec.server.storage

^{↩ Parent}

Specification for persistent storage used by the server

Name	Type	Description	Required
storageClassName	string	The name of the storageclass with which to provision storage for the server	true
volumeSize	int or string	The size of the persistent volume.	true

LHCluster.spec.server.authentication

^{↩ Parent}

Determines how the LH Servers will determine Principal identity

Name	Type	Description	Required
mtls	object		false
oauth	object		false

LHCluster.spec.server.authentication.mtls

^{↩ Parent}

Name	Type	Description	Required
clientCaCert	object		true

LHCluster.spec.server.authentication.mtls.clientCaCert

^{↩ Parent}

Name	Type	Description	Required
secretRef	object		true

LHCluster.spec.server.authentication.mtls.clientCaCert.secretRef

^{↩ Parent}

Name	Type	Description	Required
name	string		true

LHCluster.spec.server.authentication.oauth

^{↩ Parent}

Name	Type	Description	Required
credentials	object		true
introspectionEndpointUrl	string		true

LHCluster.spec.server.authentication.oauth.credentials

^{↩ Parent}

Name	Type	Description	Required
secretRef	object		true

LHCluster.spec.server.authentication.oauth.credentials.secretRef

^{↩ Parent}

Name	Type	Description	Required
name	string		true

LHCluster.spec.server.compute

^{↩ Parent}

Specifies the compute resources allocated to the Server pods

Name	Type	Description	Required
cpu	int or string	The amount of CPU to assign to the server pod. Sets request and limit. Influences rocksdb and kafka streams configs.	false
memory	int or string	The amount of memory to assign to the server pod. Sets request and limit. Influences RocksDB Configs.	false

LHCluster.spec.server.internalPort

^{↩ Parent}

Configures authentication on the internal port used for interactive queries

Name	Type	Description	Required
mtls	object		true

LHCluster.spec.server.internalPort.mtls

^{↩ Parent}

Name	Type	Description	Required
secretRef	object		true

LHCluster.spec.server.internalPort.mtls.secretRef

^{↩ Parent}

Name	Type	Description	Required
name	string		true

LHCluster.spec.server.listeners[index]

^{↩ Parent}

Name	Type	Description	Required
name	string		true
port	integer		true
advertisedListeners	object		false
authentication	object		false
infrastructure	object		false
tls	object		false

LHCluster.spec.server.listeners[index].advertisedListeners

^{↩ Parent}

Name	Type	Description	Required
bootstrap	object		false
serverHostSuffix	string		false
servers	[]object		false

LHCluster.spec.server.listeners[index].advertisedListeners.bootstrap

^{↩ Parent}

Name	Type	Description	Required
host	string		true

LHCluster.spec.server.listeners[index].advertisedListeners.servers[index]

^{↩ Parent}

Name	Type	Description	Required
host	string		true
port	integer		true

LHCluster.spec.server.listeners[index].authentication

^{↩ Parent}

Name	Type	Description	Required
type	enum	Enum: MTLS, NONE, OAUTH	true

LHCluster.spec.server.listeners[index].infrastructure

^{↩ Parent}

Name	Type	Description	Required
ingress	object	Specifies to create Ingress resources for the listener.	false
tlsRoute	object	Specifies to create TLSRoute according to the Gateway API. Requires a listener with the 'Passthrough' TLS mode enabled.	false

LHCluster.spec.server.listeners[index].infrastructure.ingress

^{↩ Parent}

Specifies to create Ingress resources for the listener.

Name	Type	Description	Required
ingressClassName	string		true
ingressAnnotations	map[string]string		false

LHCluster.spec.server.listeners[index].infrastructure.tlsRoute

^{↩ Parent}

Specifies to create TLSRoute according to the Gateway API. Requires a listener with the 'Passthrough' TLS mode enabled.

Name	Type	Description	Required
advertisedPort	integer	The advertised port. May differ from Gateway port depending on load balancer configuration.	true
gatewayRef	object	Specifies the Gateway to create routes for.	true
tlsRouteAnnotations	map[string]string	Optional additional annotations to apply to the generated TLSRoutes.	false
tlsRouteLabels	map[string]string	Optional additional labels to apply to the generated TLSRoutes.	false

LHCluster.spec.server.listeners[index].infrastructure.tlsRoute.gatewayRef

^{↩ Parent}

Specifies the Gateway to create routes for.

Name	Type	Description	Required
name	string	The name of the Gateway.	true
sectionName	string	The sectionName, usually a port name, of the referenced Gateway to attach to.	true
namespace	string	The namespace of the Gateway to attach to. Defaults to current namespace.	false

LHCluster.spec.server.listeners[index].tls

^{↩ Parent}

Name	Type	Description	Required
issuerRef	object		false
secretRef	object		false

LHCluster.spec.server.listeners[index].tls.issuerRef

^{↩ Parent}

Name	Type	Description	Required
name	string	Name of the CertManager Issuer or ClusterIssuer	true
kind	string	Kind of the CertManager Issuer or ClusterIssuer	false

LHCluster.spec.server.listeners[index].tls.secretRef

^{↩ Parent}

Name	Type	Description	Required
name	string		true

LHCluster.spec.server.operatorListener

^{↩ Parent}

Configures a listener on the Servers for the Operator to perform admin operations

Name	Type	Description	Required
name	string	Specifies the name of the listener for the operator. Defaults to operator-only	false
port	integer	Specifies the port of the listener for the operator. Defaults to 3031	false

LHCluster.spec.server.rackAwareness

^{↩ Parent}

Specifies rack awareness for the LH Servers

Name	Type	Description	Required
zoneIds	[]string	List of all possible Racks. Required to avoid giving the Operator a ClusterRole.	true
zoneKey	string	The name of the label on K8s nodes which contains the Rack information	true

LHCluster.spec.server.tolerations[index]

^{↩ Parent}

Name	Type	Description	Required
effect	string		false
key	string		false
operator	string		false
tolerationSeconds	integer		false
value	string		false

LHCluster.spec.dashboard

^{↩ Parent}

Specifies to create Dashboard resources for the cluster

Name	Type	Description	Required
image	string	Dashboard image for the pod. If not provided it defaults to ghcr.io/littlehorse-enterprises/littlehorse/lh-dashboard with either latest or the server version if spec.server.version is set	false
imagePullPolicy	string	Image pull policy for the dashboard container	false
replicas	integer	Number of dashboard pod replicas. Defaults to 1 Minimum: 1	false
tls	object	Image pull policy for the dashboard container	false

LHCluster.spec.dashboard.tls

^{↩ Parent}

Image pull policy for the dashboard container

Name	Type	Description	Required
secretRef	object	Secret with a tls.crt for the cert and a tls.key entry for the key. If tls.cert and tls.key are not present on the secret the deployment will fail	true

LHCluster.spec.dashboard.tls.secretRef

^{↩ Parent}

Secret with a tls.crt for the cert and a tls.key entry for the key. If tls.cert and tls.key are not present on the secret the deployment will fail

Name	Type	Description	Required
name	string		true

LHCluster.spec.internalCommsIssuer

^{↩ Parent}

Specifies cert-manager issuer to be used for internal communication certificates

Name	Type	Description	Required
name	string	Name of the CertManager Issuer or ClusterIssuer	true
kind	string	Kind of the CertManager Issuer or ClusterIssuer	false

LHCluster.spec.podMonitor

^{↩ Parent}

Name	Type	Description	Required
metricRelabelings	[]object	Relabelings for the metrics exposed by the server	false
podMonitorLabels	map[string]string	Labels to add to the generated PodMonitor resources	false

LHCluster.spec.podMonitor.metricRelabelings[index]

^{↩ Parent}

Name	Type	Description	Required
action	string		false
modulus	integer		false
regex	string		false
replacement	string		false
separator	string		false
sourceLabels	[]string		false
targetLabel	string		false

LHCluster.status

^{↩ Parent}

Name	Type	Description	Required
adminPrincipal	string		false
clusterHealth	object		false
kafkaType	enum	Enum: EXTERNAL, LHKAFKA, STRIMZI	false
lastBounceTime	integer		false
lastBouncedPod	integer		false
observedGeneration	integer		false
partitions	integer		false
problems	string		false
volumeSizeInternal	int or string		false

LHCluster.status.clusterHealth

^{↩ Parent}

Name	Type	Description	Required
offlineTasks	integer	Number of Active Core Streams Tasks that are under restoration.	false
streamTasks	[]object	Health of each Core Topology Stream Task, ordered by partition number	false
underReplicatedCoreTasks	integer	Total number of Core Streams Tasks that don't have enough caught-up Standbys	false
warmingUpCoreTasks	integer	Number of Core Streams Tasks that are being moved to different instances	false

LHCluster.status.clusterHealth.streamTasks[index]

^{↩ Parent}

Name	Type	Description	Required
activeTask	object		false
standbys	[]object		false

LHCluster.status.clusterHealth.streamTasks[index].activeTask

^{↩ Parent}

Name	Type	Description	Required
instanceId	integer		false
restorationLag	integer		false

LHCluster.status.clusterHealth.streamTasks[index].standbys[index]

^{↩ Parent}

Name	Type	Description	Required
instanceId	integer		false
lag	integer		false

LHDashboard

^{[↩ Parent]}

Name	Type	Description	Required
apiVersion	string	littlehorse.io/v1	true
kind	string	LHDashboard	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object		false
status	object		false

LHDashboard.spec

^{↩ Parent}

Name	Type	Description	Required
api	object		true
image	string		true
replicas	integer	Minimum: 1	true
authentication	object		false
defaultLabels	map[string]string		false
imagePullPolicy	string		false
infrastructure	object		false
resources	object		false
tls	object		false

LHDashboard.spec.api

^{↩ Parent}

Name	Type	Description	Required
host	string		true
port	integer		true
caCert	object		false
protocol	enum	Enum: PLAINTEXT, TLS	false

LHDashboard.spec.api.caCert

^{↩ Parent}

Name	Type	Description	Required
secretRef	object		true

LHDashboard.spec.api.caCert.secretRef

^{↩ Parent}

Name	Type	Description	Required
name	string		true

LHDashboard.spec.authentication

^{↩ Parent}

Name	Type	Description	Required
oauth	object		true

LHDashboard.spec.authentication.oauth

^{↩ Parent}

Name	Type	Description	Required
callbackUrl	string		true
clientId	object		true
clientSecret	object		true
serverUrl	string		true

LHDashboard.spec.authentication.oauth.clientId

^{↩ Parent}

Name	Type	Description	Required
valueFrom	object		true

LHDashboard.spec.authentication.oauth.clientId.valueFrom

^{↩ Parent}

Name	Type	Description	Required
configMapKeyRef	object		false
fieldRef	object		false
resourceFieldRef	object		false
secretKeyRef	object		false

LHDashboard.spec.authentication.oauth.clientId.valueFrom.configMapKeyRef

^{↩ Parent}

Name	Type	Description	Required
key	string		false
name	string		false
optional	boolean		false

LHDashboard.spec.authentication.oauth.clientId.valueFrom.fieldRef

^{↩ Parent}

Name	Type	Description	Required
apiVersion	string		false
fieldPath	string		false

LHDashboard.spec.authentication.oauth.clientId.valueFrom.resourceFieldRef

^{↩ Parent}

Name	Type	Description	Required
containerName	string		false
divisor	int or string		false
resource	string		false

LHDashboard.spec.authentication.oauth.clientId.valueFrom.secretKeyRef

^{↩ Parent}

Name	Type	Description	Required
key	string		false
name	string		false
optional	boolean		false

LHDashboard.spec.authentication.oauth.clientSecret

^{↩ Parent}

Name	Type	Description	Required
valueFrom	object		true

LHDashboard.spec.authentication.oauth.clientSecret.valueFrom

^{↩ Parent}

Name	Type	Description	Required
configMapKeyRef	object		false
fieldRef	object		false
resourceFieldRef	object		false
secretKeyRef	object		false

LHDashboard.spec.authentication.oauth.clientSecret.valueFrom.configMapKeyRef

^{↩ Parent}

Name	Type	Description	Required
key	string		false
name	string		false
optional	boolean		false

LHDashboard.spec.authentication.oauth.clientSecret.valueFrom.fieldRef

^{↩ Parent}

Name	Type	Description	Required
apiVersion	string		false
fieldPath	string		false

LHDashboard.spec.authentication.oauth.clientSecret.valueFrom.resourceFieldRef

^{↩ Parent}

Name	Type	Description	Required
containerName	string		false
divisor	int or string		false
resource	string		false

LHDashboard.spec.authentication.oauth.clientSecret.valueFrom.secretKeyRef

^{↩ Parent}

Name	Type	Description	Required
key	string		false
name	string		false
optional	boolean		false

LHDashboard.spec.infrastructure

^{↩ Parent}

Name	Type	Description	Required
ingress	object	Specifies to create Ingress resources for the dashboard	false
tlsRoute	object	Specifies to create TLSRoute according to the Gateway API. Requires a listener with the 'Passthrough' TLS mode enabled.	false

LHDashboard.spec.infrastructure.ingress

^{↩ Parent}

Specifies to create Ingress resources for the dashboard

Name	Type	Description	Required
hostname	string	The host to be used in the Ingress resource rule	true
ingressClassName	string	The name of the Ingress class to be used in the ingressClassName property of the Ingress resource	true
annotations	map[string]string	Annotations to put in the Ingress resource	false

LHDashboard.spec.infrastructure.tlsRoute

^{↩ Parent}

Specifies to create TLSRoute according to the Gateway API. Requires a listener with the 'Passthrough' TLS mode enabled.

Name	Type	Description	Required
gatewayRef	object	Specifies the Gateway to create routes for.	true
hostname	string	The host to be added to the TLSRoute hostnames	true
annotations	map[string]string	Optional additional annotations to apply to the generated TLSRoute.	false
labels	map[string]string	Optional additional labels to apply to the generated TLSRoute.	false

LHDashboard.spec.infrastructure.tlsRoute.gatewayRef

^{↩ Parent}

Specifies the Gateway to create routes for.

Name	Type	Description	Required
name	string	The name of the Gateway.	true
sectionName	string	The sectionName, usually a port name, of the referenced Gateway to attach to.	true
namespace	string	The namespace of the Gateway to attach to. Defaults to current namespace.	false

LHDashboard.spec.resources

^{↩ Parent}

Name	Type	Description	Required
claims	[]object		false
limits	map[string]int or string		false
requests	map[string]int or string		false

LHDashboard.spec.resources.claims[index]

^{↩ Parent}

Name	Type	Description	Required
name	string		false

LHDashboard.spec.tls

^{↩ Parent}

Name	Type	Description	Required
secretRef	object	Secret with a tls.crt for the cert and a tls.key entry for the key. If tls.cert and tls.key are not present on the secret the deployment will fail	true

LHDashboard.spec.tls.secretRef

^{↩ Parent}

Secret with a tls.crt for the cert and a tls.key entry for the key. If tls.cert and tls.key are not present on the secret the deployment will fail

Name	Type	Description	Required
name	string		true

LHDashboard.status

^{↩ Parent}

Name	Type	Description	Required
observedGeneration	integer		false
problems	string		false

LHKafka

^{[↩ Parent]}

Name	Type	Description	Required
apiVersion	string	littlehorse.io/v1	true
kind	string	LHKafka	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object		false
status	object		false

LHKafka.spec

^{↩ Parent}

Name	Type	Description	Required
controllers	object	Specifies the controllers for the Kafka cluster. If brokers is not set, then these pods are both brokers and controllers.	true
kafkaVersion	string	The desired kafka version	true
brokers	object	Specifies the brokers for the Kafka cluster. If not set, then the controllers are both brokers and controllers.	false
externalAccess	object	Configures external access to the Kafka cluster from outside Kubernetes	false
podMonitor	object	Configures PodMonitor's to be deployed for this LHKafka	false
rackNodeLabel	string	The k8s node label to be used for rack awareness	false

LHKafka.spec.controllers

^{↩ Parent}

Specifies the controllers for the Kafka cluster. If brokers is not set, then these pods are both brokers and controllers.

Name	Type	Description	Required
replicas	integer	Minimum: 1	true
storage	object		true
compute	object		false
nodeSelectorTerms	[]object		false
tolerations	[]object		false

LHKafka.spec.controllers.storage

^{↩ Parent}

Name	Type	Description	Required
storageClassName	string	The name of the storageclass with which to provision storage for the server	true
volumeSize	int or string	The size of the persistent volume.	true

LHKafka.spec.controllers.compute

^{↩ Parent}

Name	Type	Description	Required
cpu	int or string	The amount of CPU to assign to the server pod. Sets request and limit. Influences rocksdb and kafka streams configs.	false
memory	int or string	The amount of memory to assign to the server pod. Sets request and limit. Influences RocksDB Configs.	false

LHKafka.spec.controllers.nodeSelectorTerms[index]

^{↩ Parent}

Name	Type	Description	Required
matchExpressions	[]object		false
matchFields	[]object		false

LHKafka.spec.controllers.nodeSelectorTerms[index].matchExpressions[index]

^{↩ Parent}

Name	Type	Description	Required
key	string		false
operator	string		false
values	[]string		false

LHKafka.spec.controllers.nodeSelectorTerms[index].matchFields[index]

^{↩ Parent}

Name	Type	Description	Required
key	string		false
operator	string		false
values	[]string		false

LHKafka.spec.controllers.tolerations[index]

^{↩ Parent}

Name	Type	Description	Required
effect	string		false
key	string		false
operator	string		false
tolerationSeconds	integer		false
value	string		false

LHKafka.spec.brokers

^{↩ Parent}

Specifies the brokers for the Kafka cluster. If not set, then the controllers are both brokers and controllers.

Name	Type	Description	Required
replicas	integer	Minimum: 1	true
storage	object		true
compute	object		false
nodeSelectorTerms	[]object		false
tolerations	[]object		false

LHKafka.spec.brokers.storage

^{↩ Parent}

Name	Type	Description	Required
storageClassName	string	The name of the storageclass with which to provision storage for the server	true
volumeSize	int or string	The size of the persistent volume.	true

LHKafka.spec.brokers.compute

^{↩ Parent}

Name	Type	Description	Required
cpu	int or string	The amount of CPU to assign to the server pod. Sets request and limit. Influences rocksdb and kafka streams configs.	false
memory	int or string	The amount of memory to assign to the server pod. Sets request and limit. Influences RocksDB Configs.	false

LHKafka.spec.brokers.nodeSelectorTerms[index]

^{↩ Parent}

Name	Type	Description	Required
matchExpressions	[]object		false
matchFields	[]object		false

LHKafka.spec.brokers.nodeSelectorTerms[index].matchExpressions[index]

^{↩ Parent}

Name	Type	Description	Required
key	string		false
operator	string		false
values	[]string		false

LHKafka.spec.brokers.nodeSelectorTerms[index].matchFields[index]

^{↩ Parent}

Name	Type	Description	Required
key	string		false
operator	string		false
values	[]string		false

LHKafka.spec.brokers.tolerations[index]

^{↩ Parent}

Name	Type	Description	Required
effect	string		false
key	string		false
operator	string		false
tolerationSeconds	integer		false
value	string		false

LHKafka.spec.externalAccess

^{↩ Parent}

Configures external access to the Kafka cluster from outside Kubernetes

Name	Type	Description	Required
advertisedListeners	object	Specifies the advertised listeners that clients will connect to	true
tls	object	Configures TLS for the external access	true
infrastructure	object	Configures K8s resources to be deployed to access the LHKafka	false

LHKafka.spec.externalAccess.advertisedListeners

^{↩ Parent}

Specifies the advertised listeners that clients will connect to

Name	Type	Description	Required
wildcardDomainSuffix	string	Subdomain that all brokers will be exposed on. Must start with a '.' character.	true
advertisedPort	integer	Port that clients will use to connect to the Kafka cluster. Default: 9092	false

LHKafka.spec.externalAccess.tls

^{↩ Parent}

Configures TLS for the external access

Name	Type	Description	Required
secretRef	object	Reference to a Secret containing a TLS certificate to be used by the Kafka brokers	false

LHKafka.spec.externalAccess.tls.secretRef

^{↩ Parent}

Reference to a Secret containing a TLS certificate to be used by the Kafka brokers

Name	Type	Description	Required
name	string		true

LHKafka.spec.externalAccess.infrastructure

^{↩ Parent}

Configures K8s resources to be deployed to access the LHKafka

Name	Type	Description	Required
tlsRoutes	object	Specifies TLSRoute's to create to access LHKafka using Gateway API	true

LHKafka.spec.externalAccess.infrastructure.tlsRoutes

^{↩ Parent}

Specifies TLSRoute's to create to access LHKafka using Gateway API

Name	Type	Description	Required
gatewayRef	object	Specifies the Gateway to create routes for.	true
annotations	map[string]string	Optional additional annotations to apply to the generated TLSRoutes.	false
labels	map[string]string	Optional additional labels to apply to the generated TLSRoutes.	false

LHKafka.spec.externalAccess.infrastructure.tlsRoutes.gatewayRef

^{↩ Parent}

Specifies the Gateway to create routes for.

Name	Type	Description	Required
name	string	The name of the Gateway.	true
sectionName	string	The sectionName, usually a port name, of the referenced Gateway to attach to.	true
namespace	string	The namespace of the Gateway to attach to. Defaults to current namespace.	false

LHKafka.spec.podMonitor

^{↩ Parent}

Configures PodMonitor's to be deployed for this LHKafka

Name	Type	Description	Required
podMonitorLabels	map[string]string		false

LHKafka.status

^{↩ Parent}

Name	Type	Description	Required
currentActiveBrokers	[]integer		false
internalTopicReplicationFactor	integer		false
numControllers	integer		false
observedGeneration	integer		false
ongoingRebalance	object		false
problems	string		false
rackNodeLabel	string		false

LHKafka.status.ongoingRebalance

^{↩ Parent}

Name	Type	Description	Required
dedicatedBrokersAfter	[]integer		false
dedicatedBrokersBefore	[]integer		false
lastRebalanceAttempt	integer		false
shouldHoldBrokerNodePool	boolean		false
shouldHoldMixedPool	boolean		false

LHKafkaUser

^{[↩ Parent]}

Name	Type	Description	Required
apiVersion	string	littlehorse.io/v1	true
kind	string	LHKafkaUser	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object		false
status	object		false

LHKafkaUser.spec

^{↩ Parent}

Name	Type	Description	Required
quotas	object	The quotas for this user.	true
acls	object	Configures the ACL's of the Kafka User.	false
aclsPrefix	string	DEPRECATED: use acls.simple.prefix instead The prefix for the ACL's that will be created for this user. Mutually exclusive with strimziAcls. If this is provided, then the LH Operator will create opinionated ACL's that allow the user to read/write to topics, txns, and consumer groups that start with this prefix, but not create or delete topics nor take cluster actions	false
externalAccess	object	Configures authentication for the Kafka User to access Kafka from outside the K8s cluster	false
lhKafkaClusterName	string	DEPRECATED: use lhKafkaRef instead. The name of the LHKafka cluster this user will be created in. Must be in the same namespace.	false
lhKafkaRef	object	Reference to the LHKafka in which this LHKafkaUser will be created.	false

LHKafkaUser.spec.quotas

^{↩ Parent}

The quotas for this user.

Name	Type	Description	Required
consumerThroughputPerSecond	int or string	The throughput in bytes per second that may be consumed by this Kafka principal	true
producerThroughputPerSecond	int or string	The throughput in bytes per second that may be produced by this Kafka principal	true

LHKafkaUser.spec.acls

^{↩ Parent}

Configures the ACL's of the Kafka User.

Name	Type	Description	Required
simple	object	Simple ACL's designed to namespace-scope a user, allowing actions to publish/consume from topics and groups within a prefix scope.	true

LHKafkaUser.spec.acls.simple

^{↩ Parent}

Simple ACL's designed to namespace-scope a user, allowing actions to publish/consume from topics and groups within a prefix scope.

Name	Type	Description	Required
prefix	string	The prefix for the ACL's that will be created for this user. Mutually exclusive with strimziAcls. If this is provided, then the LH Operator will create opinionated ACL's that allow the user to read/write to topics, txns, and consumer groups that start with this prefix, but not create or delete topics nor take cluster actions	true
allowTopicManagement	boolean	Whether the user should be able to create and delete topics	false

LHKafkaUser.spec.externalAccess

^{↩ Parent}

Configures authentication for the Kafka User to access Kafka from outside the K8s cluster

Name	Type	Description	Required
scramSha512	object	Configures the SCRAM-SHA-512 authentication for the user	true

LHKafkaUser.spec.externalAccess.scramSha512

^{↩ Parent}

Configures the SCRAM-SHA-512 authentication for the user

Name	Type	Description	Required
passwordSecretRef	object	Reference to the secret containing the password for the user. If null, one will be generated with a random password, and a name matching the name of the LHKafkaUser but with the prefix 'lhku-'.	false

LHKafkaUser.spec.externalAccess.scramSha512.passwordSecretRef

^{↩ Parent}

Reference to the secret containing the password for the user. If null, one will be generated with a random password, and a name matching the name of the LHKafkaUser but with the prefix 'lhku-'.

Name	Type	Description	Required
additionalProperties	map[string]object		false
secretKeyRef	object		false

LHKafkaUser.spec.externalAccess.scramSha512.passwordSecretRef.secretKeyRef

^{↩ Parent}

Name	Type	Description	Required
key	string		false
name	string		false
optional	boolean		false

LHKafkaUser.spec.lhKafkaRef

^{↩ Parent}

Reference to the LHKafka in which this LHKafkaUser will be created.

Name	Type	Description	Required
name	string	Name of the LHKafka cluster this user will be created in. Must be in the same namespace.	true

LHKafkaUser.status

^{↩ Parent}

Name	Type	Description	Required
lhKafkaClusterName	string		false
problems	string		false
ready	boolean		false

LHOperator

^{[↩ Parent]}

Name	Type	Description	Required
apiVersion	string	littlehorse.io/v1	true
kind	string	LHOperator	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object		false
status	object		false

LHOperator.status

^{↩ Parent}

Name	Type	Description	Required
observedGeneration	integer		false
reconciledBy	[]string		false

LHPrincipal

^{[↩ Parent]}

Name	Type	Description	Required
apiVersion	string	littlehorse.io/v1	true
kind	string	LHPrincipal	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object		false
status	object		false

LHPrincipal.spec

^{↩ Parent}

Name	Type	Description	Required
lhCluster	object	Specifies the LittleHorse Cluster	true
globalACLs	[]object	Global ACL's to add to the Principal to be created in the LH Server. These permissions apply to all Tenants inside the LH Server.	false
perTenantACLs	[]object	Allows assigning permissions to the Principal to access specific Tenants inside the LH Server.	false
principalName	string	The name of the Principal to be created in the LH Server. If null, uses the LHPrincipal name.	false

LHPrincipal.spec.lhCluster

^{↩ Parent}

Specifies the LittleHorse Cluster

Name	Type	Description	Required
lhClusterRef	object	Specifies a LittleHorse Cluster managed by the same Operator	true

LHPrincipal.spec.lhCluster.lhClusterRef

^{↩ Parent}

Specifies a LittleHorse Cluster managed by the same Operator

Name	Type	Description	Required
name	string	Specifies a the name of the LittleHorse Cluster	true

LHPrincipal.spec.globalACLs[index]

^{↩ Parent}

Name	Type	Description	Required
actions	[]string		false
resource	string		false

LHPrincipal.spec.perTenantACLs[index]

^{↩ Parent}

Name	Type	Description	Required
acls	[]object		false
tenant	string		false

LHPrincipal.spec.perTenantACLs[index].acls[index]

^{↩ Parent}

Name	Type	Description	Required
actions	[]string		false
resource	string		false

LHPrincipal.status

^{↩ Parent}

Name	Type	Description	Required
isCreated	boolean	Whether the Principal has been created in the LH Server	false
lhCluster	string	The LHCluster that the Principal belongs to	false
observedGeneration	integer		false
principalId	string	The ID of the created Principal in the LHCluster.	false
problems	string		false

LHTenant

^{[↩ Parent]}

Name	Type	Description	Required
apiVersion	string	littlehorse.io/v1	true
kind	string	LHTenant	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the metadata field.	true
spec	object		false
status	object		false

LHTenant.spec

^{↩ Parent}

Name	Type	Description	Required
lhCluster	object	Specifies the LittleHorse Cluster	true
tenantName	string	Name of the Tenant in LittleHorse. If not provided, inferred from LHTenant name.	false

LHTenant.spec.lhCluster

^{↩ Parent}

Specifies the LittleHorse Cluster

Name	Type	Description	Required
lhClusterRef	object	Specifies a LittleHorse Cluster managed by the same Operator	true

LHTenant.spec.lhCluster.lhClusterRef

^{↩ Parent}

Specifies a LittleHorse Cluster managed by the same Operator

Name	Type	Description	Required
name	string	Specifies a the name of the LittleHorse Cluster	true

LHTenant.status

^{↩ Parent}

Name	Type	Description	Required
isCreated	boolean	Whether the Tenant has been successfully created in the LH Cluster	false
lhCluster	string	The LHCluster that the Tenant belongs to	false
observedGeneration	integer		false
problems	string		false
tenantId	string	The ID of the created Tenant in the LHCluster.	false