Skip to content

Commit e8b681d

Browse files
committed
Updates by comments
1 parent c23214e commit e8b681d

File tree

3 files changed

+19
-10
lines changed

3 files changed

+19
-10
lines changed

doc/reference/reference_lua/box_info/config.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ box.info.config
1515

1616
Since version :doc:`3.3.0 </release/3.3.0>`
1717
Returns the ``hierarchy`` table, showing names of the group, replicaset, and the instance itself.
18+
These names are taken directly from the ``--name`` CLI option (or the ``TT_INSTANCE_NAME`` environment variable)
19+
and the cluster configuration. This means they are always present if the YAML configuration flow is in use,
20+
disregarding the database status (whether upgraded, writable or not).
1821

1922
:rtype: table
2023

@@ -30,7 +33,7 @@ box.info.config
3033
active: *0
3134
alerts: []
3235
hierarchy:
33-
group: group-001
34-
replicaset: replicaset-001
35-
instance: instance-001
36+
group: storages
37+
replicaset: storage-a
38+
instance: storage-a-002
3639
...

doc/reference/reference_lua/box_info/info.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ box.info()
1919

2020
Since version :doc:`3.3.0 </release/3.3.0>`
2121
Returns the ``hierarchy`` table, showing names of the group, replicaset, and the instance itself.
22+
These names are taken directly from the ``--name`` CLI option (or the ``TT_INSTANCE_NAME`` environment variable)
23+
and the cluster configuration. This means they are always present if the YAML configuration flow is in use,
24+
disregarding the database status (whether upgraded, writable or not).
2225

2326
**Example**
2427

@@ -98,7 +101,7 @@ box.info()
98101
active: *0
99102
alerts: []
100103
hierarchy:
101-
group: group-001
102-
replicaset: replicaset-001
103-
instance: instance-001
104+
group: storages
105+
replicaset: storage-a
106+
instance: storage-a-002
104107
...

doc/reference/reference_lua/config.rst

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,10 @@ config API
161161

162162
Since version :doc:`3.3.0 </release/3.3.0>`
163163

164-
- ``hierarchy`` -- table, showing names of the group, replicaset, and the instance itself.
164+
- ``hierarchy`` -- table, showing names of the group, replicaset, and the instance itself.
165+
These names are taken directly from the ``--name`` CLI option (or the ``TT_INSTANCE_NAME`` environment variable)
166+
and the cluster configuration. This means they are always present if the YAML configuration flow is in use,
167+
disregarding the database status (whether upgraded, writable or not).
165168

166169
Below are a few examples demonstrating how the ``info()`` output might look.
167170

@@ -265,9 +268,9 @@ config API
265268
3, crit, 4, warn, 5, info, 6, verbose, 7, debug'
266269
timestamp: 2024-07-03T15:22:06.438275Z
267270
hierarchy:
268-
group: group-001
269-
replicaset: replicaset-001
270-
instance: instance-001
271+
group: group001
272+
replicaset: replicaset001
273+
instance: instance001
271274
...
272275
273276

0 commit comments

Comments
 (0)