Skip to content

Commit 6766596

Browse files
committed
draft-1
1 parent 59188ce commit 6766596

25 files changed

+418
-227
lines changed

modules/ROOT/nav.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,8 @@ include::cli:partial$cbcli/nav.adoc[]
325325
**** xref:rest-api:rest-name-node.adoc[Naming a Node]
326326
**** xref:rest-api:rest-configure-memory.adoc[Configuring Memory]
327327
**** xref:rest-api:rest-get-memory-information.adoc[Getting Memory Information]
328-
**** xref:rest-api:rest-set-up-services.adoc[Assigning Services]
328+
**** xref:rest-api:rest-set-up-services.adoc[Assigning Services to a New Node]
329+
**** xref:rest-api:rest-set-up-services-existing-nodes.adoc[Assigning Services to an Existing Node]
329330
**** xref:rest-api:rest-name-cluster.adoc[Naming a Cluster]
330331
331332
*** xref:rest-api:rest-adding-and-removing-nodes.adoc[Node Addition and Removal]

modules/introduction/partials/new-features-80.adoc

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,23 @@ curl --get -u <username:password> \
5959
-d clusterLabels=none|uuidOnly|uuidAndName
6060
----
6161
62+
[#section-new-feature-800-services]
63+
=== Services
64+
65+
https://jira.issues.couchbase.com/browse/MB-60349[MB-60349]::
66+
Now you can add or remove non-Data Services dynamically on existing nodes in a cluster, without adding or removing nodes.
67+
Rebalancing is automatically triggered to evenly distribute service workloads.
68+
These are the services that can be modified:
69+
70+
** `index` (Index Service)
71+
** `n1ql` (Query Service)
72+
** `fts` (Search Service)
73+
** `cbas` (Analytics Service)
74+
** `eventing` (Eventing Service)
75+
** `backup` (Backup Service)
76+
77+
You can modify these services using the Couchbase xref:manage:manage-nodes/modify-services-on-nodes-and-rebalance.adoc#modify-mds-services-from-ui[UI], xref:rest-api:rest-set-up-services-existing-nodes.adoc[REST API], or xref:manage:manage-nodes/modify-services-on-nodes-and-rebalance.adoc#modify-mds-services-using-cli[CLI].
78+
6279
[#section-new-feature-data-service]
6380
=== Data Service
6481

modules/learn/pages/clusters-and-availability/nodes.adoc

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,8 @@ Alternatively, the default itself can be changed, provided that it does not requ
8787
The available node must be at stage 2 or 3: that is, it must have been started, and may have had its data, index, analytics, and eventing paths configured.
8888
However, it cannot have been provisioned in any way: if the routine for joining is executed on a provisioned node, an error is flagged, and the operation fails.
8989
+
90-
Note that services can nevertheless be assigned to the new node during the join operation itself.
91-
The
92-
memory quota for each service defaults to the setting for the existing cluster.
90+
NOTE: Services can be assigned to the new node during the join operation or on-demand.
91+
The memory quota for each service defaults to the setting for the existing cluster.
9392
An error occurs if the new node does not have sufficient memory.
9493
+
9594
If Couchbase Web Console is used to perform the join, the data, index, analytics, and eventing paths can be modified as part of the join operations.
@@ -150,14 +149,25 @@ Fast failover can be achieved by deploying an arbiter node, which is a node that
150149
Such a deployment ensures that the Cluster Manager automatically deploys critical system infrastructure on the arbiter node, rather than on any other, so as to avoid clashes.
151150
This may lead to several seconds of latency reduction, when a busy cluster undergoes failover.
152151

153-
For information about service deployment with:
152+
=== Deploying Services on a Node
154153

155-
* The REST API, see xref:rest-api:rest-set-up-services.adoc[Assigning Services].
154+
You can add services to a new node when adding the node to a cluster.
155+
156+
You can also add or remove non-Data Services on an existing node in a cluster, without adding or removing nodes.
157+
158+
For information about the deployment of services on a new node using:
159+
160+
* The REST API, see xref:rest-api:rest-set-up-services.adoc[Assigning Services to a New Node].
156161

157162
* Couchbase Server Web Console during node-addition and node-joining, see the demonstrated uses of checkboxes, in xref:manage:manage-nodes/add-node-and-rebalance#arbiter-node-addition[Add a Node and Rebalance] and in xref:manage:manage-nodes/join-cluster-and-rebalance#arbiter-node-join[Join a Cluster and Rebalance].
158163

159164
* The CLI during node-addition, see xref:cli:cbcli/couchbase-cli-server-add[server-add].
160165

166+
For information about adding or removing non-Data Services on an existing node in a cluster, using:
167+
168+
* The xref:manage:manage-nodes/modify-services-on-nodes-and-rebalance.adoc#modify-mds-services-from-ui[UI] and xref:manage:manage-nodes/modify-services-on-nodes-and-rebalance.adoc#modify-mds-services-using-cli[CLI], see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance].
169+
* The REST API, see xref:rest-api:rest-set-up-services-existing-nodes.adoc[Assigning Services to an Existing Node].
170+
161171
[#Node Quantity]
162172
== Node Quantity
163173

modules/learn/pages/services-and-indexes/services/analytics-service.adoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,13 @@ This continuous data ingestion allows operational and analytic queries to run co
112112

113113
Due to the large scale and duration of operations it is likely to perform, the Analytics Service should be run _alone_, on its node or nodes in the cluster, _with no other Couchbase Service running on the Analytics nodes_.
114114

115-
For the practical steps required to initialize or join a cluster, and to deploy services, see
116-
xref:manage:manage-nodes/create-cluster.adoc[Create a Cluster].
117-
For information on how to run analytic queries, see the xref:analytics:introduction.adoc[Introduction] to Couchbase Analytics.
115+
For more information about:
116+
117+
* Initializing a cluster, see xref:manage:manage-nodes/create-cluster.adoc[Create a Cluster].
118+
119+
* Adding or removing services on a node, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance].
120+
121+
* How to run analytic queries, see the xref:analytics:introduction.adoc[Introduction] to Couchbase Analytics.
118122

119123
[WARNING]
120124
.Non-Uniform Memory Access (NUMA)
@@ -125,3 +129,7 @@ NUMA architectures divide memory into different zones, each with a specific CPU,
125129
Couchbase Analytics is not configured to align with the NUMA architecture.
126130
Deploying Couchbase Analytics on a server with the NUMA architecture may result in uneven memory distribution, increased latency, and degraded performance. Specifically, queries can become slower, and overall system efficiency can drop as memory access times vary significantly.
127131
====
132+
133+
== See Also
134+
135+
* For information about adding or removing an Analytics Service on a node, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance].

modules/learn/pages/services-and-indexes/services/backup-service.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ the Cluster Manager elects one of them to be the leader.
4444
The leader is responsible for:
4545

4646
* Dispatching backup tasks.
47-
* Adding and removing nodes from the Backup Service.
47+
* Adding and removing the Backup Service on nodes.
4848
* Cleaning orphaned tasks.
4949
* Ensuring that all Backup Service nodes can reach the global storage locations.
5050
@@ -224,3 +224,4 @@ You may want to experiment with different thread settings to find a balance betw
224224
* See xref:rest-api:backup-rest-api.adoc[Backup Service API] for information about using the Backup Service from the REST API.
225225
* To learn about the port numbers the Backup Service uses, see xref:install:install-ports.adoc[Couchbase Server Ports].
226226
* For a list of Backup Service audit events, see xref:audit-event-reference:audit-event-reference.adoc[Audit Event Reference].
227+
* For information about adding or removing a Backup Service on a node, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance].

modules/learn/pages/services-and-indexes/services/data-service.adoc

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@ For further information, see xref:buckets-memory-and-storage/memory.adoc[Memory]
4848
For information on how to activate, see
4949
xref:manage:manage-buckets/flush-bucket.adoc[Flush a Bucket].
5050
** *Expiry Pager*: Scans for items that have expired, and erases them from memory and disk; after which, a _tombstone_ remains for a default period of 3 days.
51-
The expiry pager runs every 10 minutes by default: for information on changing the interval, see `cbepctl` xref:cli:cbepctl/set-flush_param.adoc[set flush_param].
52-
For more information on item-deletion and tombstones, see xref:data/expiration.adoc[Expiration].
51+
The expiry pager runs every 10 minutes by default.
52+
For information about changing the interval, see xref:rest-api:rest-bucket-create.adoc#expirypagersleeptime[expiryPagerSleepTime].
53+
For more information about item-deletion and tombstones, see xref:data/expiration.adoc[Expiration].
5354
** *Batch Reader*: Enhances performance by combining changes made to multiple items into _batches_, which are placed on the disk queue, to be written to disk.
5455
* *Scheduler*: A pool of threads mainly used for handling I/O.
5556
The threads are divided into four kinds, which run independently of and without effect on one another:
@@ -61,3 +62,10 @@ The threads are divided into four kinds, which run independently of and without
6162

6263
+
6364
For more information on the Data Service' threading model, see xref:buckets-memory-and-storage/storage-settings.adoc[Storage Properties].
65+
66+
67+
To add or remove a data service on a node:
68+
69+
. xref:manage:manage-nodes/remove-node-and-rebalance.adoc[Remove a Node and Rebalance].
70+
71+
. Then xref:manage:manage-nodes/add-node-and-rebalance.html[add the node] back to the cluster along with adding or removing the data service.

modules/learn/pages/services-and-indexes/services/eventing-service.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@ Events include changes made to specified items, and the arrival of scheduled poi
1313
The Eventing Service depends on the xref:services-and-indexes/services/data-service.adoc[Data Service], which must therefore be running on at least one cluster node.
1414

1515
For information on using the Eventing Service, see xref:eventing:eventing-overview.adoc[Eventing Service: Fundamentals].
16+
17+
For information about adding or removing an Eventing Service on a node, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance].

modules/learn/pages/services-and-indexes/services/index-service.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,7 @@ _Secondary_ Indexes, often referred to as _Global Secondary Indexes_ or _GSIs_,
6868
Secondary Indexes can be created on specified fields; placed on specific cluster-nodes; and replicated.
6969

7070
For information on using the Indexing Service, see xref:indexes:indexing-overview.adoc[].
71+
72+
== See Also
73+
74+
* For information about adding or removing an Index Service on a node, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance].

modules/learn/pages/services-and-indexes/services/query-service.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,7 @@ Note the degree of parallelism with which operations are frequently performed, r
4343
The Query Service supports queries made in {sqlpp}.
4444
As well as providing a rich variety of query-options, {sqlpp} allows statements to be _prepared_, so that the parsing and compiling of plans is completed prior to execution; and permits _consistency-levels_ to be configured.
4545
For detailed information, see xref:n1ql:n1ql-language-reference/index.adoc[{sqlpp} Language Reference].
46+
47+
== See Also
48+
49+
* For information about adding or removing a Query Service on a node, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance].

modules/learn/pages/services-and-indexes/services/search-service.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,7 @@ In Couchbase Server 6.6 Enterprise Edition and later, the _Flex Index_ feature p
6464
For detailed information, see xref:n1ql:n1ql-language-reference/flex-indexes.adoc[Flex Indexes].
6565

6666
To use the Search Service in {sqlpp}, the Query, Index, and Search Services must all be running on the cluster.
67+
68+
== See Also
69+
70+
* For information about adding or removing a Search Service on a node, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance].

0 commit comments

Comments
 (0)