Skip to content

Commit feddcee

Browse files
authored
Add warning for modifying services (#3966)
1 parent b5f5b43 commit feddcee

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

modules/manage/pages/manage-nodes/modify-services-and-rebalance.adoc

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,18 @@ NOTE: You cannot add or remove the Data Service (kv) using this method.
2222
Adding or removing of the Data Service on an existing node is supported only through adding or removing nodes.
2323
For more information about adding or removing the Data Service on an existing node, see xref:manage:manage-nodes/manage-data-service-and-rebalance.adoc[Adding or Removing the Data Service on Existing Nodes].
2424

25+
[WARNING]
26+
====
27+
When you modify (add or remove) services on existing nodes in a cluster, rebalance is triggered immediately to apply the changes.
28+
Removing a service instance reduces the cluster's capacity for that service.
29+
For certain services, such as the Index Service, removing the service may result in loss of replicas or entire indexes if no replicas exist,
30+
which can cause queries to fail.
31+
32+
Removing all instances of a service deletes all data and metadata associated with that service, which means effectively removing the service from the cluster.
33+
For example, removing the last Index Service node deletes all indexes.
34+
For the Backup Service, physical backup repositories outside the cluster remain, but the Backup Service metadata about those repositories is deleted.
35+
====
36+
2537
== Prerequisites
2638

2739
Before modifying non-data services on nodes, make sure you have the following:
@@ -153,4 +165,4 @@ From the previous example, if `node3` was not running the index service, the fol
153165
ERROR: Node ns_1@node3 does not provide the index service
154166
----
155167

156-
For more information about the `couchbase-cli rebalance` command, see xref:cli:cbcli/couchbase-cli-rebalance.adoc[rebalance].
168+
For more information about the `couchbase-cli rebalance` command, see xref:cli:cbcli/couchbase-cli-rebalance.adoc[rebalance].

modules/rest-api/pages/rest-set-up-services-existing-nodes.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ Then trigger a rebalance operation.
2626
* For information about using the `POST /controller/rebalance` REST API to rebalance after node additions and removals, after a graceful failover and recovery, and after a hard failover, see xref:rest-api:rest-cluster-rebalance.adoc[Rebalancing the Cluster].
2727
====
2828

29+
[WARNING]
30+
====
31+
When you modify (add or remove) services on existing nodes in a cluster, rebalance is triggered immediately to apply the changes.
32+
Removing a service instance reduces the cluster's capacity for that service.
33+
For certain services, such as the Index Service, removing the service may result in loss of replicas or entire indexes if no replicas exist,
34+
which can cause queries to fail.
35+
36+
Removing all instances of a service deletes all data and metadata associated with that service, which means effectively removing the service from the cluster.
37+
For example, removing the last Index Service node deletes all indexes.
38+
For the Backup Service, physical backup repositories outside the cluster remain, but the Backup Service metadata about those repositories is deleted.
39+
====
40+
2941
=== curl Syntax
3042

3143
You must specify all known nodes in the cluster and the necessary cluster services topology.

0 commit comments

Comments
 (0)