Skip to content

Docs: New index page #719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Aug 24, 2023
4 changes: 4 additions & 0 deletions docs/modules/zookeeper/images/zookeeper_overview.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The operator will create a ZooKeeper cluster with two replicas. Use kubectl to o
[source,bash]
include::example$getting_started/code/getting_started.sh[tag=watch-zookeeper-rollout]

The Operator deploys readiness probes to make sure the replicas are ready and established a quorum. Only then will the StefulSet actually be marked as `Ready`. You will see
The Operator deploys readiness probes to make sure the replicas are ready and established a quorum. Only then will the StatefulSet actually be marked as `Ready`. You will see

----
partitioned roll out complete: 2 new pods have been updated...
Expand Down
43 changes: 33 additions & 10 deletions docs/modules/zookeeper/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,42 @@
= Stackable Operator for Apache ZooKeeper
:description: The Stackable Operator for Apache ZooKeeper is a Kubernetes operator that can manage Apache ZooKeeper ensembles. Learn about its features, resources, dependencies and demos, and see the list of supported ZooKeeper versions.
:keywords: Stackable Operator, Hadoop, Apache ZooKeeper, Kubernetes, k8s, operator, engineer, big data, metadata, storage, cluster

This is an operator for Kubernetes that can manage https://zookeeper.apache.org/[Apache ZooKeeper] ensembles.
The Stackable Operator for Apache ZooKeeper is a Kubernetes Operator for deploying and managing https://zookeeper.apache.org/[Apache ZooKeeper] ensembles.
Apache ZooKeeper is an open-source distributed coordination service that facilitates synchronization, configuration management and leader election in distributed systems.
ZooKeeper is often used for these tasks in the Apache Hadoop ecosystem. Within the Stackable Platform, the Stackable Operators for xref:hbase:index.adoc[Apache HBase], xref:hdfs:index.adoc[Apache Hadoop HDFS], xref:kafka:index.adoc[Apache Kafka] and xref:nifi:index.adoc[Apache NiFi] depend on the ZooKeeper Operator.

WARNING: This operator is part of Stackable Data Platform
and only works with images from the https://repo.stackable.tech/#browse/browse:docker:v2%2Fstackable%2Fzookeeper[Stackable] repository
== Getting started

Get started with Apache ZooKeeper and the Stackable Operator by following the xref:getting_started/index.adoc[Getting started] guide, it will guide you through the xref:getting_started/installation.adoc[installation] process. Afterwards, consult the xref:usage_guide/index.adoc[Usage guide] to learn more about configuring ZooKeeper for your needs. You can also deploy a <<demos, demo>> to see an example deployment of ZooKeeper together with other data products.

== Operator model

The Operator manages two custom resources: _ZookeeperCluster_ and _ZookeeperZnode_. ZooKeeper only has a single process that it runs, so the cluster resource only has a single corresponding xref:concepts:roles-and-role-groups.adoc[role] called _server_.

image::zookeeper_overview.drawio.svg[A diagram depicting the Kubernetes resources created by the Stackable Operator for Apache ZooKeeper]

For every role group the Operator creates a ConfigMap and StatefulSet which can have multiple replicas (Pods). Every role group is accessible through its own Service, and there is a Service for the whole Cluster.

The Operator creates a xref:concepts:service_discovery.adoc[service discovery ConfigMap] for the ZooKeeper instance, as well as for each ZNode. The discovery ConfigMaps contain information on how to connect to ZooKeeper. The ZNode discovery ConfigMap give access information for the ZNode. xref:zookeeper:znodes.adoc[learn more about ZNodes].

== Dependencies

Apache ZooKeeper and the Stackable Operator have no dependencies besides the xref:commons-operator:index.adoc[] and xref:secret-operator:index.adoc[].

== [[demos]]Demos

Apache ZooKeeper is a dependency of xref:hbase:index.adoc[Apache HBase], xref:hdfs:index.adoc[Apache Hadoop HDFS], xref:kafka:index.adoc[Apache Kafka] and xref:nifi:index.adoc[Apache NiFi], thus any demo that uses one or more of these components will also deploy a ZooKeeper ensemble. Here is the list of the demos that include ZooKeeper:

* xref:stackablectl::demos/data-lakehouse-iceberg-trino-spark.adoc[]
* xref:stackablectl::demos/hbase-hdfs-load-cycling-data.adoc[]
* xref:stackablectl::demos/jupyterhub-pyspark-hdfs-anomaly-detection-taxi-data.adoc[]
* xref:stackablectl::demos/logging.adoc[]
* xref:stackablectl::demos/nifi-kafka-druid-earthquake-data.adoc[]
* xref:stackablectl::demos/nifi-kafka-druid-water-level-data.adoc[]

== Supported Versions

The Stackable Operator for Apache ZooKeeper currently supports the following versions of ZooKeeper:

include::partial$supported-versions.adoc[]

== Getting the Docker image

[source]
----
docker pull docker.stackable.tech/stackable/zookeeper:<version>
----
4 changes: 2 additions & 2 deletions docs/modules/zookeeper/partials/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
* xref:zookeeper:getting_started/index.adoc[]
** xref:zookeeper:getting_started/installation.adoc[]
** xref:zookeeper:getting_started/first_steps.adoc[]
* xref:zookeeper:configuration.adoc[]
* xref:zookeeper:pod_placement.adoc[]
* Concepts
** xref:zookeeper:znodes.adoc[]
** xref:zookeeper:discovery.adoc[]
* xref:zookeeper:usage_guide/index.adoc[]
** xref:zookeeper:usage_guide/pod_placement.adoc[]
** xref:zookeeper:usage_guide/encryption.adoc[]
** xref:zookeeper:usage_guide/authentication.adoc[]
** xref:zookeeper:usage_guide/resource_configuration.adoc[]
Expand All @@ -16,3 +15,4 @@
** xref:zookeeper:usage_guide/isolating_clients_with_znodes.adoc[]
** xref:zookeeper:usage_guide/configuration_environment_overrides.adoc[]
** xref:zookeeper:usage_guide/cluster_operations.adoc[]
* xref:zookeeper:configuration.adoc[]