-
Notifications
You must be signed in to change notification settings - Fork 43
Add description of vshard.enable/disable #3019
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
Add description of vshard.enable/disable #3019
Conversation
* Add description of the automatic and manual router API's enabling/disabling Resolves #3012
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.
Thanks for the patch! Most of my suggestions are language-related.
I haven't looked at the changes on the staging website yet because the deployment is currently broken. If it's okay with you, I'll take another look at the PR after the deployment is fixed.
.. NOTE:: | ||
|
||
``vshard.router.enable()`` cannot be used for enabling the router | ||
API which was automatically disabled due to running configuration | ||
process. |
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.
.. NOTE:: | |
``vshard.router.enable()`` cannot be used for enabling the router | |
API which was automatically disabled due to running configuration | |
process. | |
.. note:: | |
``vshard.router.enable()`` cannot be used for enabling a router | |
API that was automatically disabled due to a running configuration | |
process. |
- We use
.. note::
now: https://www.tarantool.io/en/doc/latest/contributing/docs/markup/admonitions/ - A running configuration process is
router.cfg()
, right? Let's mention this.
Manually restrict access to the router API. Disabling makes all | ||
its methods, excluding :ref:`vshard.router.cfg() <router_api-cfg>`, | ||
:ref:`vshard.router.new() <router_api-new>`, | ||
:ref:`vshard.router.enable() <router_api-enable>` and | ||
:ref:`vshard.router.disable() <router_api-disable>`, to throw a Lua | ||
error in case of invoking them. The error object has a name attribute | ||
equal to ``ROUTER_IS_DISABLED``. |
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.
Manually restrict access to the router API. Disabling makes all | |
its methods, excluding :ref:`vshard.router.cfg() <router_api-cfg>`, | |
:ref:`vshard.router.new() <router_api-new>`, | |
:ref:`vshard.router.enable() <router_api-enable>` and | |
:ref:`vshard.router.disable() <router_api-disable>`, to throw a Lua | |
error in case of invoking them. The error object has a name attribute | |
equal to ``ROUTER_IS_DISABLED``. | |
Manually restrict access to the router API. When the API is disabled, | |
all its methods throw a Lua error, | |
except :ref:`vshard.router.cfg() <router_api-cfg>`, | |
:ref:`vshard.router.new() <router_api-new>`, | |
:ref:`vshard.router.enable() <router_api-enable>` and | |
:ref:`vshard.router.disable() <router_api-disable>`. The error object's name attribute is | |
``ROUTER_IS_DISABLED``. |
Russian is a wordy language, and English is not. Please try to use fewer words and simpler constructions whenever possible.
equal to ``ROUTER_IS_DISABLED``. | ||
|
||
The router is enabled by default. However, it is automatically and | ||
forcefully disabled until configuration is finished as accessing the |
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.
forcefully disabled until configuration is finished as accessing the | |
forcefully disabled until the configuration is finished, as accessing the |
Closed as a duplicate of #3025 |
enabling/disabling
Resolves #3012