Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Command line parameters
:description: Command-line parameters the Stackable operator for Apache Kafka accepts, with their default values and usage examples.

This operator accepts the following command line parameters:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/kafka/pages/reference/crds.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
= CRD Reference
:description: CRD reference for the Stackable operator for Apache Kafka on the Stackable Hub, covering every field, default and API version.

Find all CRD reference for the Stackable Operator for Apache Kafka at: {crd-ref}{crd-ref-release}&operator=kafka-operator.
1 change: 1 addition & 0 deletions docs/modules/kafka/pages/reference/discovery.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
:brokerPort: 9092

= Discovery
:description: Reference for the discovery ConfigMap the Stackable operator for Apache Kafka publishes, with the connection string other tools use to reach the brokers.
:page-aliases: discovery.adoc

The Stackable Operator for Apache Kafka publishes a xref:concepts:service_discovery.adoc[service discovery ConfigMap] which exposes a client configuration bundle that allows access to the Apache Kafka cluster.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Environment variables
:description: Environment variables the Stackable operator for Apache Kafka accepts, with their default values and what each one controls.

This operator accepts the following environment variables:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/kafka/pages/reference/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Reference
:description: Reference for the Stackable operator for Apache Kafka, covering CRD fields, discovery ConfigMap properties, command-line parameters and environment variables.

Consult the reference documentation section to find exhaustive information on:

Expand Down
1 change: 1 addition & 0 deletions docs/modules/kafka/pages/usage-guide/index.adoc
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
= Usage guide
:description: Guides for Apache Kafka on Kubernetes, covering KRaft controllers, service exposition, security, storage, logging, monitoring and overrides.
:page-aliases: usage.adoc
1 change: 1 addition & 0 deletions docs/modules/kafka/pages/usage-guide/listenerclass.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Service exposition with ListenerClasses
:description: Exposing Apache Kafka brokers with ListenerClasses, covering the bootstrap and per-broker Listeners the operator creates for client connections.

The operator deploys a bootstrap xref:listener-operator:listener.adoc[Listener] for each broker rolegroup, as well as a xref:listener-operator:listener.adoc[Listener] for each broker pod.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

= Cluster operation
:description: Cluster operations for Apache Kafka, covering how to pause reconciliation of a cluster or stop it entirely through its custom resource.

The managed Kafka instances can be configured with different cluster operations like pausing reconciliation or stopping the cluster. See xref:concepts:operations/cluster_operations.adoc[cluster operations] for more details.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Graceful shutdown
:description: Graceful shutdown of Apache Kafka brokers, covering the shutdown timeout and how brokers hand over partition leadership before stopping.

You can configure the graceful shutdown as described in xref:concepts:operations/graceful_shutdown.adoc[].

Expand Down
1 change: 1 addition & 0 deletions docs/modules/kafka/pages/usage-guide/operations/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Operations
:description: Operating Apache Kafka with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement, cluster IDs and cluster operations.

This section of the documentation is intended for the operations teams that maintain a Stackable Data Platform installation.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

= Allowed Pod disruptions
:description: PodDisruptionBudgets the Stackable operator writes for Apache Kafka brokers and KRaft controllers, and how to disable them.

You can configure the permitted Pod disruptions for Kafka nodes as described in xref:concepts:operations/pod_disruptions.adoc[].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Pod placement
:description: Pod placement for Apache Kafka brokers, covering the default anti-affinity and placement next to OPA when OPA authorization is used.

You can configure Pod placement for Kafka brokers and controllers as described in xref:concepts:pod_placement.adoc[].

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Cluster ID
:description: The Apache Kafka cluster ID stored in ZooKeeper, covering how mismatches arise when restarting a cluster, replacing a ZNode or upgrading SDP.

Kafka has an internal check to ensure that a broker cannot join a different cluster to the one in which it was previously registered (this is important to avoid various kinds of metadata inconsistencies in the cluster).
The clusterId is stored locally after initial registration and is verified upon cluster startup that it still matches what is in ZooKeeper.
Expand Down
1 change: 1 addition & 0 deletions docs/modules/kafka/pages/usage-guide/overrides.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Configuration & Environment Overrides
:description: Overrides for Apache Kafka, covering configuration properties, security.properties, environment variables, Pod specs and JVM arguments per role group.

The cluster definition also supports overriding configuration properties and environment variables, either per role or per role group, where the more specific override (role group) has precedence over the less specific one (role).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If nothing is configured in the custom resource for a certain role group, then b

== Resource Requests

include::home:concepts:stackable_resource_requests.adoc[]
include::concepts:partial$stackable_resource_requests.adoc[]

A minimal HA setup consisting of 2 Brokers has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]:

Expand Down
Loading