-
Notifications
You must be signed in to change notification settings - Fork 43
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
Conversation
tarantool> box.info.cluster | ||
--- | ||
- <cluster information> | ||
... | ||
|
||
tarantool> box.info.replicaset | ||
--- | ||
- uuid: <replicaset uuid> | ||
- <... other attributes of the replicaset> | ||
... |
There was a problem hiding this comment.
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.
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> | ||
... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto.
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. |
There was a problem hiding this comment.
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.
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/