-
Notifications
You must be signed in to change notification settings - Fork 183
DOC-12351 Add or Remove Services and Rebalance #3846
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
base: release/8.0
Are you sure you want to change the base?
Conversation
6e59e19
to
6766596
Compare
modules/learn/pages/services-and-indexes/services/analytics-service.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/analytics-service.adoc
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/services.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/services.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/services.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/services.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/modify-services-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/modify-services-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/modify-services-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/modify-services-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/modify-services-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/services.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/services.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/services.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/services.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/modify-services-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/modify-services-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/modify-services-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/rest-api/pages/rest-set-up-services-existing-nodes.adoc
Outdated
Show resolved
Hide resolved
modules/rest-api/pages/rest-set-up-services-existing-nodes.adoc
Outdated
Show resolved
Hide resolved
modules/rest-api/pages/rest-set-up-services-existing-nodes.adoc
Outdated
Show resolved
Hide resolved
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.
@rao-shwe
Just a few additional changes.
modules/manage/pages/manage-nodes/manage-data-service-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/manage-data-service-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/services.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/manage-data-service-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/manage-data-service-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/manage-data-service-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/manage-data-service-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/manage-nodes/modify-services-and-rebalance.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/services-and-indexes/services/services.adoc
Outdated
Show resolved
Hide resolved
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.
@rao-shwe
I suggested a name change for the new page you added -- the "Manage Data Service and Rebalance" is too broad (will be confusing) for the narrow topic. Anyways, the rest look good, so I'll approve. Thanks for all the links/references changes and updates, as well as the core feature documentation -- I think that people will appreciate the effort when they can find the info they need easily.
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.
Let me know if you want to discuss any of these changes. Please make sure you're running Vale either while you're writing, or before opening a PR.
|
||
For information about the deployment of services on a new node using: | ||
|
||
* The REST API, see xref:rest-api:rest-set-up-services.adoc[Assigning Services to a New Single Node], xref:rest-api:rest-cluster-addnodes.adoc[Adding Nodes to Clusters], and xref:rest-api:rest-cluster-joinnode.adoc[Joining Nodes into Clusters]. | ||
|
||
* 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]. |
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.
* 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]. | |
* The Couchbase Server Web Console during node-addition and node-joining, see xref:manage:manage-nodes/add-node-and-rebalance#arbiter-node-addition[Add a Node and Rebalance] and xref:manage:manage-nodes/join-cluster-and-rebalance#arbiter-node-join[Join a Cluster and Rebalance]. |
|
||
* 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]. | ||
|
||
* The CLI during node-addition, see xref:cli:cbcli/couchbase-cli-server-add[server-add]. | ||
|
||
For information about adding or removing non-Data Services on an existing node in a cluster, using: | ||
|
||
* 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]. |
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.
This is very hard to follow, since UI and CLI are both links. Are users supposed to use the last link, or click on UI and CLI individually? Can you take a different approach, here?
For more information about: | ||
|
||
* Initializing a cluster, see xref:manage:manage-nodes/create-cluster.adoc[Create a Cluster]. | ||
|
||
* Joining or adding a new node to a cluster, see xref:manage:manage-nodes/join-cluster-and-rebalance.adoc[Join a Cluster and Rebalance] and see xref:manage:manage-nodes/add-node-and-rebalance.adoc[Add a Node and Rebalance]. | ||
|
||
* Adding or removing services on an existing node of a cluster, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. | ||
|
||
* How to run analytic queries, see the xref:analytics:introduction.adoc[Introduction] to Couchbase Analytics. |
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.
For more information about: | |
* Initializing a cluster, see xref:manage:manage-nodes/create-cluster.adoc[Create a Cluster]. | |
* Joining or adding a new node to a cluster, see xref:manage:manage-nodes/join-cluster-and-rebalance.adoc[Join a Cluster and Rebalance] and see xref:manage:manage-nodes/add-node-and-rebalance.adoc[Add a Node and Rebalance]. | |
* Adding or removing services on an existing node of a cluster, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. | |
* How to run analytic queries, see the xref:analytics:introduction.adoc[Introduction] to Couchbase Analytics. | |
For more information about: | |
* How to initialize a cluster, see xref:manage:manage-nodes/create-cluster.adoc[Create a Cluster]. | |
* How to join or add a new node to a cluster to support the Analytics Service, see xref:manage:manage-nodes/join-cluster-and-rebalance.adoc[Join a Cluster and Rebalance] and see xref:manage:manage-nodes/add-node-and-rebalance.adoc[Add a Node and Rebalance]. | |
* How to add or remove services on an existing node of a cluster, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. | |
* How to run analytic queries, see the xref:analytics:introduction.adoc[Introduction] to Couchbase Analytics. |
|
||
== See Also | ||
|
||
* For information about adding or removing an Analytics Service on an existing node of a cluster, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. |
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.
* For information about adding or removing an Analytics Service on an existing node of a cluster, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. | |
* For more information about adding or removing the Analytics Service on an existing node of a cluster, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. |
@@ -250,3 +247,4 @@ You may want to experiment with different thread settings to find a balance betw | |||
* See xref:rest-api:backup-rest-api.adoc[Backup Service API] for information about using the Backup Service from the REST API. | |||
* To learn about the port numbers the Backup Service uses, see xref:install:install-ports.adoc[Couchbase Server Ports]. | |||
* For a list of Backup Service audit events, see xref:audit-event-reference:audit-event-reference.adoc[Audit Event Reference]. | |||
* For information about adding or removing a Backup Service on an existing node of a cluster, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. |
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.
* For information about adding or removing a Backup Service on an existing node of a cluster, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. | |
* For more information about adding or removing the Backup Service on an existing node of a cluster, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. |
For illustration, consider 5 nodes in the cluster with the following services: | ||
|
||
* 172.23.108.69 – Data, Index, Query | ||
* 172.23.108.70 – Data, Search, Query | ||
* 172.23.108.71 – Query | ||
* 172.23.108.72 – Backup | ||
* 172.23.108.73 – Analytics | ||
|
||
Reconfigure the services on the existing nodes so that the following is the required output of services on each of the 5 nodes: | ||
|
||
* 172.23.108.69 – Data, Query | ||
* 172.23.108.70 – Data, Index | ||
* 172.23.108.71 – Index, Query | ||
* 172.23.108.72 – Search, Query | ||
* 172.23.108.73 – Analytics |
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.
For illustration, consider 5 nodes in the cluster with the following services: | |
* 172.23.108.69 – Data, Index, Query | |
* 172.23.108.70 – Data, Search, Query | |
* 172.23.108.71 – Query | |
* 172.23.108.72 – Backup | |
* 172.23.108.73 – Analytics | |
Reconfigure the services on the existing nodes so that the following is the required output of services on each of the 5 nodes: | |
* 172.23.108.69 – Data, Query | |
* 172.23.108.70 – Data, Index | |
* 172.23.108.71 – Index, Query | |
* 172.23.108.72 – Search, Query | |
* 172.23.108.73 – Analytics | |
For example, a cluster with 5 nodes could have the following service configuration: | |
* 172.23.108.69 – Data, Index, Query | |
* 172.23.108.70 – Data, Search, Query | |
* 172.23.108.71 – Query | |
* 172.23.108.72 – Backup | |
* 172.23.108.73 – Analytics | |
You could reconfigure the services on the existing nodes to match the following: | |
* 172.23.108.69 – Data, Query | |
* 172.23.108.70 – Data, Index | |
* 172.23.108.71 – Index, Query | |
* 172.23.108.72 – Search, Query | |
* 172.23.108.73 – Analytics |
Because the Backup service is not in the topology list, it will be removed from the cluster. | ||
After the topology change and rebalance, two nodes (172.23.108.71 and 172.23.108.72) that previously had no services using the index disk storage path will now have services using it. | ||
|
||
Run the following command to reconfigure the services on the existing nodes and get the required output. |
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.
Run the following command to reconfigure the services on the existing nodes and get the required output. | |
To reconfigure the 5 nodes to the new topology, run the following command: |
* For information about allocating memory per service, see xref:rest-api:rest-configure-memory.adoc[Configuring Memory]. | ||
|
||
* To fetch the details of current memory allocation for each service, see xref:rest-api:rest-get-memory-information.adoc[Getting Memory Information]. | ||
|
||
* For information about assigning services to existing nodes from the UI and CLI, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. | ||
|
||
* For information about assigning services to a new node, see xref:rest-api:rest-set-up-services.adoc[Assigning Services to a New Single Node]. | ||
|
||
* For information about rebalancing, see xref:rest-api:rest-cluster-rebalance.adoc[Rebalancing the Cluster]. |
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.
* For information about allocating memory per service, see xref:rest-api:rest-configure-memory.adoc[Configuring Memory]. | |
* To fetch the details of current memory allocation for each service, see xref:rest-api:rest-get-memory-information.adoc[Getting Memory Information]. | |
* For information about assigning services to existing nodes from the UI and CLI, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. | |
* For information about assigning services to a new node, see xref:rest-api:rest-set-up-services.adoc[Assigning Services to a New Single Node]. | |
* For information about rebalancing, see xref:rest-api:rest-cluster-rebalance.adoc[Rebalancing the Cluster]. | |
* For more information about allocating memory per service, see xref:rest-api:rest-configure-memory.adoc[Configuring Memory]. | |
* To fetch the details of current memory allocation for each service, see xref:rest-api:rest-get-memory-information.adoc[Getting Memory Information]. | |
* For more information about assigning services to existing nodes from the UI and CLI, see xref:manage:manage-nodes/modify-services-and-rebalance.adoc[Modify Services and Rebalance]. | |
* For more information about assigning services to a new node, see xref:rest-api:rest-set-up-services.adoc[Assigning Services to a New Single Node]. | |
* For more information about rebalancing, see xref:rest-api:rest-cluster-rebalance.adoc[Rebalancing the Cluster]. |
@@ -68,9 +68,11 @@ curl -X POST http://10.144.220.101:8091/node/controller/setupServices \ | |||
|
|||
== See Also | |||
|
|||
The sequence of tasks divided into _initialization_ and _provisioning_ is explained in xref:rest-api:rest-cluster-init-and-provisioning.adoc[Cluster Initialization and Provisioning]. | |||
* The sequence of tasks divided into _initialization_ and _provisioning_ is explained in xref:rest-api:rest-cluster-init-and-provisioning.adoc[Cluster Initialization and Provisioning]. |
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.
* The sequence of tasks divided into _initialization_ and _provisioning_ is explained in xref:rest-api:rest-cluster-init-and-provisioning.adoc[Cluster Initialization and Provisioning]. | |
* For more information about cluster initialization and provisioning with the REST API, see xref:rest-api:rest-cluster-init-and-provisioning.adoc[Cluster Initialization and Provisioning]. |
* For further information on initialization and provisioning -- using the UI, the CLI, and the REST API -- see xref:manage:manage-nodes/node-management-overview.adoc[Manage Nodes and Clusters]. | ||
|
||
* For information about assigning non-Data Services to an existing node using the REST API, see xref:rest-api:rest-set-up-services-existing-nodes.adoc[Assigning Services to an Existing Node]. |
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.
* For further information on initialization and provisioning -- using the UI, the CLI, and the REST API -- see xref:manage:manage-nodes/node-management-overview.adoc[Manage Nodes and Clusters]. | |
* For information about assigning non-Data Services to an existing node using the REST API, see xref:rest-api:rest-set-up-services-existing-nodes.adoc[Assigning Services to an Existing Node]. | |
* For more information on initialization and provisioning -- using the UI, the CLI, and the REST API -- see xref:manage:manage-nodes/node-management-overview.adoc[Manage Nodes and Clusters]. | |
* For more information about assigning non-Data Services to an existing node using the REST API, see xref:rest-api:rest-set-up-services-existing-nodes.adoc[Assigning Services to an Existing Node]. |
DOC-12351
Login credentials to access the docs preview site.
Main content changes:
Updated the following pages to mention add/remove services:
-- Nodes.
-- Data Service.
-- Query Service.
-- Index Service.
-- Search Service.
-- Analytics Service.
-- Eventing Service.
-- Backup Service.
-- Initializing a Cluster.
-- Initializing a Node.
-- Establishing Credentials.
-- Naming a Node.
-- Configuring Memory.
-- Naming a Cluster.
-- Assigning Services to a New Node.
-- Adding Nodes to Clusters.
-- Rebalancing the Cluster.