Skip to content
Open
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 @@
= First steps
:description: First steps with Apache ZooKeeper, covering a first cluster and ZNode deployed by the Stackable operator and connecting through the discovery ConfigMap.

Now that the operator is installed it is time to deploy a ZooKeeper cluster and connect to it.

Expand Down
1 change: 1 addition & 0 deletions docs/modules/zookeeper/pages/getting_started/index.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Getting started
:description: Getting started with Apache ZooKeeper on Kubernetes, covering the Stackable operator, a first ZooKeeper cluster and ZNode and connecting to them.

This guide gets you started with Apache ZooKeeper using the Stackable Operator.
It guides you through the installation of the Operator and its dependencies, setting up your first ZooKeeper cluster and connecting to it as well as setting up your first xref:znodes.adoc[ZNode].
Expand Down
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 ZooKeeper 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/zookeeper/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 ZooKeeper on the Stackable Hub, covering every field, default and API version.

Find all CRD reference for the Stackable Operator for Apache ZooKeeper at: {crd-ref}{crd-ref-release}&operator=zookeeper-operator.
1 change: 1 addition & 0 deletions docs/modules/zookeeper/pages/reference/discovery.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Discovery Profiles
:description: Reference for the discovery profiles the Stackable operator for Apache ZooKeeper publishes as ConfigMaps for clusters and ZNodes, with their contents.
:page-aliases: discovery.adoc

The Stackable Operator for Apache ZooKeeper creates a number of discovery profiles, which are client configuration bundles
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 ZooKeeper 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/zookeeper/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 ZooKeeper, covering CRDs, discovery properties, command-line parameters, environment variables and zoo.cfg.

Consult the reference documentation section to find exhaustive information on:

Expand Down

This file was deleted.

1 change: 1 addition & 0 deletions docs/modules/zookeeper/pages/usage_guide/index.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
= Usage guide
:description: In-depth guides to the Stackable operator for Apache ZooKeeper, covering ZNodes, authentication, encryption, resources, logging, monitoring and overrides.

This section provides more in depth information about specific aspects of using the Stackable Operator for Apache ZooKeeper.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@

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

The managed ZooKeeper 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.
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Graceful shutdown
:description: Graceful shutdown of Apache ZooKeeper servers, covering the configurable shutdown timeout and how the server process stops.

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Operations
:description: Operating Apache ZooKeeper with the Stackable operator, covering graceful shutdown, Pod disruptions, Pod placement 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,4 +1,5 @@
= Allowed Pod disruptions
:description: The PodDisruptionBudget the Stackable operator writes for Apache ZooKeeper servers, and how to disable it.

You can configure the permitted Pod disruptions for Zookeeper 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 ZooKeeper on Kubernetes, covering the default affinity that spreads the servers of an ensemble across nodes.

You can configure the Pod placement of the ZooKeeper pods as described in xref:concepts:operations/pod_placement.adoc[].

Expand Down
1 change: 1 addition & 0 deletions docs/modules/zookeeper/pages/usage_guide/overrides.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

= Configuration and environment overrides
:description: Overrides for Apache ZooKeeper, covering zoo.cfg and security.properties settings, 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 @@ -27,7 +27,7 @@ See the xref:data_directory.adoc[data directory docs] for how that data grows an

== Resource requests

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

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

Expand Down
Loading