Skip to content

Commit 4d37963

Browse files
Update zookeeper doc to caution about intermediate nodes.
1 parent dfe7bf2 commit 4d37963

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

components/lock.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@ can be two running containers in parallel.
519519
ZookeeperStore
520520
~~~~~~~~~~~~~~
521521

522-
The way ZookeeperStore works is by maintaining locks in ephemeral nodes within ``PHP_LOCK_NODE`` on the server. That means that by using
522+
The way ZookeeperStore works is by maintaining locks as ephemeral nodes on the server. That means that by using
523523
the :ref:`ZookeeperStore <lock-store-zookeeper>` the locks will be automatically released at the end of the session
524524
in case the client cannot unlock for any reason.
525525

@@ -532,6 +532,11 @@ be lost without notifying the running processes.
532532
the server goes down, the majority will still be up and serving the requests. All the available servers in the
533533
cluster will see the same state.
534534

535+
.. caution::
536+
If you have a path such as ``base_node/node_1/lock_node`` when creating a lock, then only ``lock_node`` will be created as an ephemeral node and other
537+
nodes will be created as a persistent node and will not be cleaned up as a part of delete operations. This is because, it could lead
538+
to unexpected behavior and hence it is recommended that you always create a lock as ``lock_node`` without any subpath.
539+
535540
Overall
536541
~~~~~~~
537542

0 commit comments

Comments
 (0)