-
Notifications
You must be signed in to change notification settings - Fork 43
Adds isolated instance mode description #5136
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
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| groups: | ||
| g: | ||
| replicasets: | ||
| r: | ||
| instances: | ||
| i-001: {} | ||
| i-002: {} | ||
| i-003: {} | ||
| i-004: | ||
| isolated: true | ||
Totktonada marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2836,6 +2836,39 @@ Attributes must be ``key: value`` pairs with string keys and values. | |
|
|
||
| See also: :ref:`configuration_labels` | ||
|
|
||
| .. _configuration_reference_isolated_mode: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Forgot to say it on the previous review iteration: AFAIR, options/sections on each level are sorted alphabetically. Here |
||
|
|
||
| isolated mode | ||
| ------ | ||
|
|
||
| Since version :doc:`3.3.0 </release/3.3.0>`, a new ``isolated`` option is added to instance configuration. | ||
|
|
||
| The option takes boolean values, by default it is set to ``false``. | ||
| ``isolated:true`` moves the instance it has been applied at to the **isolated** mode. | ||
|
||
|
|
||
| The isolated mode allows the user to temporarily isolate an instance and perform maintenance activities on it. | ||
|
|
||
| The isolated mode moves the instance to the read-only state, in which: | ||
|
|
||
| * iproto stops listening for new connections | ||
| * iproto drops all the current connections | ||
| * The instance is disconnected from all the replication upstreams | ||
| * Other replicaset members exclude the isolated instance from the replication upstreams | ||
Totktonada marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Once the mode is enabled, any request trying to change persistent data will fail with the ``ER_READONLY`` error. | ||
Totktonada marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| .. NOTE:: | ||
|
|
||
| Isolated instance can't be bootstrapped (a local snapshot is required to start). | ||
|
|
||
| **Example** | ||
|
|
||
| The example below shows how to isolate an instance: | ||
|
|
||
| .. literalinclude:: /code_snippets/snippets/config/instances.enabled/isolated_mode/config.yaml | ||
| :language: yaml | ||
| :dedent: | ||
|
|
||
| .. _configuration_reference_log: | ||
|
|
||
| log | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.