-
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
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletions
10
doc/code_snippets/snippets/config/instances.enabled/isolated_mode/config.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2836,6 +2836,38 @@ Attributes must be ``key: value`` pairs with string keys and values. | |
|
||
See also: :ref:`configuration_labels` | ||
|
||
.. _configuration_reference_isolated_mode: | ||
|
||
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. | ||
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. Nit: |
||
|
||
The isolated mode allows the user to temporarily isolate an instance and perform maintenance activities on it. | ||
|
||
In the isolated mode: | ||
|
||
* The instance is moved to the read-only state | ||
* 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 | ||
|
||
.. 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 | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Forgot to say it on the previous review iteration: AFAIR, options/sections on each level are sorted alphabetically. Here
isolated
goes afterlabels
.