File tree Expand file tree Collapse file tree 2 files changed +44
-0
lines changed
code_snippets/snippets/config/instances.enabled/isolated_mode Expand file tree Collapse file tree 2 files changed +44
-0
lines changed Original file line number Diff line number Diff line change 1+ groups :
2+ g :
3+ replicasets :
4+ r :
5+ instances :
6+ i-001 : {}
7+ i-002 : {}
8+ i-003 : {}
9+ i-004 :
10+ isolated : true
Original file line number Diff line number Diff line change @@ -2836,6 +2836,40 @@ Attributes must be ``key: value`` pairs with string keys and values.
28362836
28372837 See also: :ref: `configuration_labels `
28382838
2839+ .. _configuration_reference_isolated_mode :
2840+
2841+ isolated mode
2842+ ------
2843+
2844+ Since version :doc: `3.3.0 </release/3.3.0 >`, a new ``isolated `` option is added to instance configuration.
2845+
2846+ The option takes boolean values, by default it is set to ``false ``.
2847+
2848+ When set to ``true ``, it moves the instance it has been applied at to the **isolated ** mode.
2849+
2850+ The isolated mode allows the user to temporarily isolate an instance and perform maintenance activities on it.
2851+
2852+ The isolated mode moves the instance to the read-only state, in which:
2853+
2854+ * iproto stops listening for new connections
2855+ * iproto drops all the current connections
2856+ * The instance is disconnected from all the replication upstreams
2857+ * Other replicaset members exclude the isolated instance from the replication upstreams
2858+
2859+ Once the mode is enabled, After any requests that try to change persistent data will fail with the ``ER_READONLY `` error.
2860+
2861+ .. NOTE ::
2862+
2863+ isolated instance can't be bootstrapped (a local snapshot is required to start).
2864+
2865+ **Example **
2866+
2867+ The example below shows how to isolate an instance:
2868+
2869+ .. literalinclude :: /code_snippets/snippets/config/instances.enabled/isolated_mode/config.yaml
2870+ :language: yaml
2871+ :dedent:
2872+
28392873.. _configuration_reference_log :
28402874
28412875log
You can’t perform that action at this time.
0 commit comments