You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/modules/zookeeper/pages/znodes.adoc
+21-5
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,19 @@ as it sees fit. This can be thought of like a namespace for that client, and pre
8
8
9
9
The Stackable Operator for Apache ZooKeeper manages ZNodes using the _ZookeeperZnode_ resource.
10
10
11
+
IMPORTANT: The Operator connects directly to ZooKeeper to manage the ZNodes inside of the ZooKeeper ensemble. This means that network access to the ZooKeeper pods is necessary. If your Kubernetes cluster restricts network acess, you need to configure a NetworkPolicy to allow the operator to connect to ZooKeeper.
12
+
13
+
== Configuring ZNodes
14
+
15
+
ZNodes are configured with the ZookeeperZnode CustomResource.
16
+
If a ZookeeperZnode resource is created, the operator will create the respective tree in ZooKeeper.
17
+
Also, if the resource in Kubernetes is deleted, so is the data in ZooKeeper.
18
+
19
+
CAUTION: The operator automatically deletes the ZNode from the ZooKeeper cluster if the Kubernetes `ZookeeperZnode` object is deleted. Recreating the
20
+
`ZookeeperZnode` object will not restore access to the data.
<2> Reference to the `ZookeeperCluster` object where the ZNode should be created.
17
30
<3> The namespace of the `ZookeeperCluster`. Can be omitted and will default to the namespace of the ZNode object.
18
31
19
-
NOTE: It is the responsibility of the user to ensure that ZNodes are not shared between products. For example, a Kafka and a Hadoop cluster should not share the same ZNode.
20
-
21
32
When a ZNode is created, the operator creates the required tree in ZooKeeper and a xref:concepts:service_discovery.adoc[discovery ConfigMap] with a xref:discovery.adoc[] for this ZNode. This discovery ConfigMap is used by other operators to configure clients with access to the ZNode.
22
33
23
34
The operator _does not_ manage the contents of the ZNode.
24
35
25
-
CAUTION: The operator automatically deletes the ZNode from the ZooKeeper cluster if the Kubernetes `ZookeeperZnode` object is deleted. Recreating the
26
-
`ZookeeperZnode` object will not restore access to the data.
36
+
37
+
== Creating a ZNode per dependant
38
+
39
+
To ensure that a product that uses ZooKeeper is running smoothly, you should make sure that each Stacklet or product instance is operating with its own ZNode.
40
+
For example, a Kafka and a Hadoop cluster should not share the same ZNode. Also no two Kafka instances should share the same ZNode.
41
+
42
+
Have a look at the xref:usage_guide/isolating_clients_with_znodes.adoc[] guide for hands-on instructions on how to set up multiple ZNodes for different Stacklets.
27
43
28
44
== Split responsibilities for ZooKeeper and ZNodes
29
45
@@ -35,4 +51,4 @@ ZNodes however are product specific and need to be managed by product teams that
35
51
36
52
== What's next
37
53
38
-
Have a look at the usage guide for ZNodes: xref:usage_guide/isolating_clients_with_znodes.adoc[]
54
+
Have a look at the usage guide for ZNodes: xref:usage_guide/isolating_clients_with_znodes.adoc[] or the CRD reference for the {crd-docs}/zookeeper.stackable.tech/zookeeperznode/v1alpha1/[ZookeeperZnode {external-link-icon}^] CustomResource.
0 commit comments