Skip to content

Add compat.box_info_cluster_meaning #4584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 9, 2024
Merged

Add compat.box_info_cluster_meaning #4584

merged 3 commits into from
Oct 9, 2024

Conversation

p7nov
Copy link
Contributor

@p7nov p7nov commented Oct 8, 2024

Resolves #3465

Follow-up on #4427

Deployment: https://docs.d.tarantool.io/en/doc/gh-3465-compat-option/reference/reference_lua/compat/box_info_cluster_meaning/

@p7nov p7nov requested a review from Totktonada October 8, 2024 05:53
Comment on lines 25 to 34
tarantool> box.info.cluster
---
- <cluster information>
...

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be convenient to have an example of a real output (preferably with persistent names set).

We say 'entire cluster information' and 'replicaset information' above, but it is very abstract. As a user I can expect a list of instances, their metrics, configuration and so on.

In fact, we have box.info.replicaset.{uuid,name} and box.info.cluster.name. That's all the fields.

Comment on lines 44 to 58
tarantool> compat.box_info_cluster_meaning = 'old'
---
...

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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto.

Comment on lines 8 to 11
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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add something that makes it clear that the new behavior is 3.0.0's default?

After reading this paragraph I was in a doubt: whether it is 3.0.0's behavior that can be enabled using the compat option or it is a default in this version.

@p7nov p7nov requested a review from lenkis October 8, 2024 12:23
@p7nov p7nov merged commit dca6d47 into latest Oct 9, 2024
1 check passed
@p7nov p7nov deleted the gh-3465-compat-option branch October 9, 2024 03:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

box.info.cluster is renamed to box.info.replicaset
3 participants