Skip to content

Commit

Permalink
DOC-9316: Remove 'Auto failover can abort rebalance' from the UI (#2445)
Browse files Browse the repository at this point in the history
* Remove abort rebalance option

* Add stubs for Bloom Filter and Analytics Replicas

* DOC-9181: Remove autofailover of server groups

* Update option names

* Update screenshots

* Remove abort rebalance from CLI and REST sections

* DOC-9181: Remove autofailover of server groups from CLI and REST sections
  • Loading branch information
simon-dew committed Feb 10, 2022
1 parent 63d13c6 commit 6c87133
Show file tree
Hide file tree
Showing 14 changed files with 29 additions and 36 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/manage/assets/images/manage-settings/cluster-name.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/manage/assets/images/manage-settings/data-settings.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/manage/assets/images/manage-settings/memory-quotas.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/manage/assets/images/manage-settings/save-or-cancel.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 29 additions & 36 deletions modules/manage/pages/manage-settings/general-settings.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
= General
:description: pass:q[_General_ settings allow configuration of _cluster name_, _memory quotas_, _storage modes_, and _node availability_ for the cluster; and of _advanced settings_ for the Index and Query Services.]
:page-aliases: settings:cluster-settings,settings:change-failover-settings,manage:manage-settings/cluster-settings,manage:manage-settings/change-failover-settings,manage:manage-settings/update-notification
:imagesdir: ../../assets/images

[abstract]
{description}
Expand All @@ -15,7 +16,7 @@ Full and Cluster Administrators can configure general settings by means of <<con

The appearance of the *General* screen is as follows:

image::manage-settings/general-settings.png[,720,align=center]
image::manage-settings/general-settings.png["The General Settings screen",720,align=center]

The panels and their UI elements are described below.

Expand All @@ -26,7 +27,7 @@ The *Cluster Name* is the name that was given during initial setup.
This name can be changed at any time.
The interactive field appears as follows:

image::manage-settings/cluster-name.png[,540,align=center]
image::manage-settings/cluster-name.png["The Cluster Name option",457,align=center]

[#memory-quotas]
=== Memory Quotas
Expand All @@ -36,38 +37,38 @@ The combination of assigned values is not permitted to exceed the total memory a

The panel appears as follows:

image::manage-settings/memory-quotas.png[,540,align=center]
image::manage-settings/memory-quotas.png["The Memory Quotas panel",457,align=center]

The displayed, configurable options are:

* *Data Service*.
* *Data*.
The memory allocation for the Data Service, per node.
The minimum allocation must be equal to or greater than the sum of all per bucket memory-allocations on the node.
* *Index Service*.
* *Index*.
The buffer cache size for the Index Service.
The specified amount of memory is pre-allocated as soon as the Index Service starts up.
It is then shared with all indexes created on the node.
The total memory-usage of the indexer process will be the buffer cache size plus the size of various internal data structures and queues.
* *Search Service*.
* *Search*.
The memory allocation for the Search Service, per node.
* *Analytics Service*.
* *Analytics*.
The memory allocation for the Analytics Service, per node.
* *Eventing Service*.
* *Eventing*.
The memory allocation for the Eventing Service, per node.
Note that neither the *Query Service* nor the *Backup Service* requires memory-allocation.
Note that neither the Query Service nor the Backup Service requires memory-allocation.

[#current-version]
=== Current Version

This panel displays the current version of Couchbase Server, and can be used to indicate whether updates are available.
It appears as follows:

image::manage-settings/current-version.png[,540,align=center]
image::manage-settings/current-version.png["The Current Version panel",457,align=center]

The *Share usage information with Couchbase and get software update notifications* checkbox is checked by default: this means that Couchbase Web Console will display adjacent notifications whenever a new version of Couchbase Server is available.
If the checkbox is unchecked, notifications are not provided.
Expand All @@ -92,24 +93,18 @@ For detailed information on policy and constraints, see xref:learn:clusters-and-

The panel appears as follows:

image::manage-settings/node-availability.png[,540,align=center]
image::manage-settings/node-availability.png["The Node Availability panel",548,align=center]

The following checkboxes are provided:

* *Enable auto-failover after _x_ seconds for up to _y_ event*: After the timeout period set here as _x_ seconds has elapsed, an unresponsive or malfunctioning node is failed over, provided that the limit on actionable events set here as _y_ has not yet been reached.
* *Auto-failover after _x_ seconds for up to _y_ node*: After the timeout period set here as _x_ seconds has elapsed, an unresponsive or malfunctioning node is failed over, provided that the limit on actionable events set here as _y_ has not yet been reached.
Data replicas are promoted to active on other nodes, as appropriate.
This feature can only be used when three or more nodes are present in the cluster.
The number of seconds to elapse is configurable: the default is 120; the minimum permitted is 5; the maximum 3600.
This option is selected by default.
* *Enable auto-failover for sustained data disk read/write failures after _z_ seconds*: After the timeout period set here as _z_ seconds has elapsed, a node is failed over if it has experienced sustained data disk read/write failures.
* *Auto-failover for sustained data disk read/write failures after _z_ seconds*: After the timeout period set here as _z_ seconds has elapsed, a node is failed over if it has experienced sustained data disk read/write failures.
The timeout period is configurable: the default length is 120 seconds; the minimum permitted is 5; the maximum 3600.
This checkbox can only be checked if *Enable auto-failover after* _x_ *seconds for up to* _y_ *event* has also been checked.
* *Enable auto-failover of server groups*: Server-group failover is enabled.
This checkbox (which can only be checked if *Enable auto-failover after _x_ seconds for up to _y_ event* has also been checked) should only be checked if three or more server groups have been established, and capacity is available to absorb the combined load of all potentially failed-over groups.
For information on groups, see xref:learn:clusters-and-availability/groups.adoc[Server Group Awareness].
* *Can abort rebalance*. Whether a rebalance, in progress at the time the node become unresponsive, can be aborted; in order to perform the auto-failover.
This option is selected by default.
For further information, see xref:learn:clusters-and-availability/automatic-failover.adoc#auto-failover-during-rebalance[Auto-Failover During Rebalance].
This checkbox can only be checked if *Auto-failover after _x_ seconds for up to _y_ node* has also been checked.
The *Node Availability* panel also contains a *For Ephemeral Buckets* option.
When opened, this provides an *Enable auto-reprovisioning* checkbox, with a configurable number of nodes.
Expand All @@ -130,7 +125,7 @@ _Rebalance_ redistributes data, indexes, event processing, and query processing
For an overview, see xref:learn:clusters-and-availability/rebalance.adoc[Rebalance].
Fully open, the panel appears as follows:

image::manage-settings/rebalance-settings.png[,540,align=center]
image::manage-settings/rebalance-settings.png["The Rebalance Settings panel",548,align=center]

The *Retry rebalance* option allows rebalance to be _retried_, in cases where it has failed.
Check the checkbox, to enable.
Expand Down Expand Up @@ -159,7 +154,7 @@ Consequently, changes to the default thread-allocation should not be made to pro

Left-clicking on the *Advanced Data Settings* tab displays radio buttons for *Reader Thread Settings* and *Writer Thread Settings*:

image::manage-settings/data-settings.png[,540,align=center]
image::manage-settings/data-settings.png["The Data Settings panel",548,align=center]

Each group has the same, three radio buttons, which are as follows:

Expand All @@ -178,7 +173,7 @@ The number of threads allocated is equal to the value selected from the pull-dow
Left-clicking on the *Advanced Query Settings* tab displays interactive fields whereby the Query Service can be configured.
The top section of the panel appears as follows:

image::manage-settings/query-settings-top.png[,540,align=center]
image::manage-settings/query-settings-top.png["The top half of the Query Settings panel",548,align=center]

Specify either *Unrestricted* or *Restricted*, to determine which URLs are permitted to be accessed by the `curl` function.
If *Unrestricted* (the default) is specified, all URLs can be accessed.
Expand All @@ -189,7 +184,7 @@ The maximum size of the target can be specified, in megabytes.

Additional Query settings are provided in the lower section of the panel:

image::manage-settings/query-settings-bottom.png[,540,align=center]
image::manage-settings/query-settings-bottom.png["The bottom half of the Query Settings panel",548,align=center]

* *Pipeline Batch*: The number of items that can be batched for fetches from the Data Service.
Expand Down Expand Up @@ -225,7 +220,7 @@ For additional details on all the Query settings in the lower section of the pan
This panel provides radio buttons whereby the storage mode for indexes can be selected.
The panel appears as follows:

image::manage-settings/index-storage-mode.png[align=center]
image::manage-settings/index-storage-mode.png["The Index Storage Mode panel",548,align=center]

The options are xref:learn:services-and-indexes/indexes/storage-modes.adoc#memory-optimized-index-storage[Memory Optimized Index Storage], and xref:learn:services-and-indexes/indexes/storage-modes.adoc#standard-index-storage[Standard Index Storage].

Expand All @@ -250,6 +245,8 @@ Adjust the logging level.
The options are: `Silent`, `Fatal`, `Error`, `Warn`, `Info`, `Verbose`, `Timing`, `Debug`, and `Trace`.
The default is `Info`.
// TODO: Bloom Filter

[#xdcr-maximum-processes]
=== XDCR Maximum Processes

Expand All @@ -259,13 +256,15 @@ The default number of threads is 4.

The panel appears as follows:

image::manage-settings/xdcr-maximum-processes.png[,540,align=center]
image::manage-settings/xdcr-maximum-processes.png["The XDCR Maximum Processes panel",548,align=center]

// TODO: Analytics Replicas

[#saving-settings]
=== Saving Settings
To save settings, left-click on the *Save* button, at the lower left.

image::manage-settings/save-or-cancel.png[,220,align=center]
image::manage-settings/save-or-cancel.png["The Save and Cancel/Reset buttons",270,align=center]

Alternatively, cancel recently entered values, and thereby reset to previous values; by left-clicking on *Cancel/Reset*.

Expand Down Expand Up @@ -382,13 +381,10 @@ Auto-failover can be configured with the xref:cli:cbcli/couchbase-cli-setting-au
-p password \
--enable-auto-failover 1 \
--auto-failover-timeout 120 \
--enable-failover-of-server-groups 1 \
--max-failovers 2 \
--can-abort-rebalance 1
--max-failovers 2
----

This enables auto-failover, with a timeout of 120 seconds, and an event-maximum of 2.
It also enables failover server groups, and specifies, by means of the `--can-abort-rebalance` flag, that if a node becomes unresponsive during a rebalance, that node can be failed over automatically, and the rebalance thereby aborted.

If successful, the command returns the following output:

Expand Down Expand Up @@ -565,13 +561,10 @@ http://10.143.192.101:8091/settings/autoFailover \
-d timeout=120 \
-d failoverOnDataDiskIssues[enabled]=false \
-d failoverOnDataDiskIssues[timePeriod]=120 \
-d failoverServerGroup=true \
-d maxCount=2 \
-d canAbortRebalance=true
-d maxCount=2
----

This enables auto-failover, with a timeout of 120 seconds, and a maximum failover-count of 2.
It also specifies, by means of `canAbortRebalance`, that if a node becomes unresponsive during a rebalance, that node can be failed over automatically, and the rebalance thereby aborted.
Additionally, failover is enabled in the event of suboptimal disk responsiveness, with a time-period of 120 seconds specified.

For more information on these options, see the descriptions provided above, for the <<node-availability,UI>>.
Expand Down Expand Up @@ -719,7 +712,7 @@ This verifies that rebalance retry has been disabled, the required period betwee

For more information on getting and setting the rebalance retry status, see xref:rest-api:rest-configure-rebalance-retry.adoc[Configure Rebalance Retries], xref:rest-api:rest-get-rebalance-retry.adoc[Get Rebalance-Retry Status], and xref:rest-api:rest-cancel-rebalance-retry.adoc[Cancel Rebalance Retries].

==== Maximum Concurent vBucket Moves via REST
==== Maximum Concurrent vBucket Moves via REST

To inspect the current maximum number of concurrent vBucket moves permitted for every node, use the `GET /settings/rebalance` HTTP method and URI, with the `rebalanceMovesPerNode` parameter, as follows:

Expand Down

0 comments on commit 6c87133

Please sign in to comment.