From 47222006632eb251be096d00ce78238adc05d13c Mon Sep 17 00:00:00 2001
From: Pavel Semyonov
Date: Tue, 8 Oct 2024 19:23:13 +0700
Subject: [PATCH] Update box_info_cluster_meaning.rst
---
.../compat/box_info_cluster_meaning.rst | 21 ++++++++++---------
1 file changed, 11 insertions(+), 10 deletions(-)
diff --git a/doc/reference/reference_lua/compat/box_info_cluster_meaning.rst b/doc/reference/reference_lua/compat/box_info_cluster_meaning.rst
index 337492e33..03a67596e 100644
--- a/doc/reference/reference_lua/compat/box_info_cluster_meaning.rst
+++ b/doc/reference/reference_lua/compat/box_info_cluster_meaning.rst
@@ -7,8 +7,9 @@ Option: ``box_info_cluster_meaning``
Starting from version 3.0, the :ref:`box_info_cluster` table stores the information
about the entire cluster. In earlier versions, it stored only the current replica set
-information. The ``box_info_cluster_meaning`` compat option allows to define the
-the scope of ``box.info.cluster``: the entire cluster or a single replica set.
+information. The ``box_info_cluster_meaning`` compat option in Tarantool 3.0 or later
+allows to rollback to the old meaning of ``box.info.cluster`` - display information
+about a single replica set.
Old and new behavior
--------------------
@@ -24,13 +25,13 @@ cluster with all its replica sets.
tarantool> box.info.cluster
---
- -
+ - name: my_cluster
...
tarantool> box.info.replicaset
---
- - uuid:
- - <... other attributes of the replicaset>
+ - uuid: 0a3ff0c7-9075-441c-b0f5-b93a24be07cb
+ name: router-001
...
.. note::
@@ -47,14 +48,14 @@ Old behavior: ``box.info.cluster`` displays information about the current replic
tarantool> box.info.cluster
---
- - uuid:
- - <... other attributes of the replicaset>
+ - uuid: 0a3ff0c7-9075-441c-b0f5-b93a24be07cb
+ name: router-001
...
tarantool> box.info.replicaset
---
- - uuid:
- - <... other attributes of the replicaset>
+ - uuid: 0a3ff0c7-9075-441c-b0f5-b93a24be07cb
+ name: router-001
...
Known compatibility issues
@@ -69,4 +70,4 @@ Detecting issues in your codebase
Look for all usages of ``box.info.cluster``, ``info.cluster``, and
``.cluster``, ``['cluster']``, ``["cluster"]`` in the application code
written before the change. To make it work the same way on Tarantool 3.0 or later,
-replace the ``cluster`` key with ``replicaset``.
\ No newline at end of file
+replace the ``cluster`` key with ``replicaset``.