`box.info.cluster` is renamed to `box.info.replicaset`

[TarantoolBot]

Product: Tarantool
Since: 3.0
Root documents:

• https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_info/info/
• https://www.tarantool.io/en/doc/latest/reference/reference_lua/compat/

SME: @ Gerold103

Details

Done since 3.0.0. The old behaviour can be reverted back via the
compat option box_info_cluster_meaning.

box.info.cluster key is still here, but now means a totally
different thing - the entire cluster with all its replicasets.

Compat documentation

box.info.cluster default meaning is the whole cluster with all
its replicasets. To get info about only the current replicaset
box.info.replicaset should be used.

In old versions (< 3.0.0) box.info.cluster meant the current
replicaset and box.info.replicaset didn't exist.

Old and new behaviour

New behaviour:

tarantool> box.info.cluster
---
- <some cluster keys>
...

tarantool> box.info.replicaset
---
- uuid: <replicaset uuid>
- <... other attributes of the replicaset>
...

Old behaviour:

tarantool> box.info.cluster
---
- uuid: <replicaset uuid>
- <... other attributes of the replicaset>
...

tarantool> box.info.replicaset (= nil on < 3.0.0)
---
- uuid: <replicaset uuid>
- <... other attributes of the replicaset>
...

Known compatibility issues

VShard versions < 0.1.24 do not support the new behaviour.

Detecting issues in you codebase

Look for all usages of box.info.cluster, info.cluster, and
even just .cluster, ['cluster'], ["cluster"]. For the new
behaviour to work all of them have to use 'replicaset' key.
Requested by @Gerold103 in tarantool/tarantool@ef86e00.

Definition of done

• box.info.cluster is replaced with box.info.replicaset across the docs
• new compat option box_info_cluster_meaning is documented

[p7nov]

Add a "see also" link to this page to the compat.box_info_cluster_meaning description in the configuration reference.