Skip to content

[DOC-14256]: Feedback on Identifying the Orchestrator Node | Couchbase Docs #4113

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.

Sign up for GitHub

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

Open
RayOffiah wants to merge 1 commit into
base: release/7.6
Choose a base branch
from
+7 −7
Open

[DOC-14256]: Feedback on Identifying the Orchestrator Node | Couchbase Docs #4113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions modules/rest-api/pages/rest-identify-orchestrator.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ GET /pools/default/terseClusterInfo

== Description

The _orchestrator_ handles operations with cluster-wide impact; such as failover, rebalance, and adding and deleting buckets.
The _orchestrator_ handles operations with cluster-wide impact, such as failover, rebalance, and adding and deleting buckets.
Every Couchbase-Server node contains an instance of the orchestrator.
However, at any given time, on a multi-node cluster, only one instance of the orchestrator, on one particular node, is active; and thereby responsible for performing _all_ the cluster-wide operations.
If a hitherto active instance becomes unavailable, another instance, on another node, takes over.
Expand All @@ -31,7 +31,7 @@ curl -v -X GET -u <username>:<password>
----

The `ip-address-or-domain-name` should specify a node within the cluster whose orchestrator-location is to be determined: information returned by the call is that which is _known to the specified node_.
The `username` and `password` must be those of a user with the Full Admin, Cluster Admin, Read Only Admin, Local User Security Admin, or External User Security role.
The `username` and `password` must be those of a user with the Full Admin, Cluster Admin, Read-Only Admin, Local User Security Admin, or External User Security role.

== Responses

Expand All @@ -45,15 +45,15 @@ A reference to the node on which the orchestrator is believed, by the specified
This value is `"undefined"` if, for any reason, the specified node is unaware of the orchestrator-location.
In particular, if the orchestrator node is rebalanced out, the value of this attribute will be `"undefined"` during the time-period that starts immediately after the node is rebalanced out, and lasts until a new orchestrator is elected: this period is _10 seconds_ in duration.
+
Note that the location of the orchestrator may change at any time, including at a point subsequent to execution of the call but prior to the return of a value; meaning that the returned value is already incorrect.
Note that the location of the orchestrator may change at any time, including at a point after execution of the call but before the return of a value, meaning that the returned value is already incorrect.
Copy link
Copy Markdown

@Rebecca-Martinez007 Rebecca-Martinez007 May 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the style guide, I've been changing a lot of the "Note that"s to an actual NOTE admonition. Is that something that would work on this page @RayOffiah? I can see that this is REST API page, so it may not work in this context. Just wanted to send a little note about that!

Copy link
Copy Markdown
Contributor Author

@RayOffiah RayOffiah May 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, good point. I'll change it. 👍🏾

Note also that in cases where the cluster has undergone an unexpected network partition, different specified nodes may return different values.

* `isBalanced`.
The value is `true` if the specified node believes that data is distributed evenly, topology-aware services are in balance, and no rebalance is required.
Otherwise, the value is `false`.

* `clusterCompatVersion`.
The minimum Couchbase-Server _compatibilty version_ for the cluster.
The minimum Couchbase-Server _compatibility version_ for the cluster.
For example, if a cluster of ten nodes has eight running Couchbase Server Version 6.6, and two running 6.0, the returned `clusterCompatVersion` value is `"6.0"`.

Failure to authenticate returns `401 Unauthorized`.
Expand All @@ -62,7 +62,7 @@ An incorrectly specified URI returns `404 Object Not Found`.
== Example

The following example returns the orchestrator-location for a cluster that includes a node whose IP address is `10.143.210.102`.
Note that the output is piped to the https://stedolan.github.io/jq[jq^] command, to facilitate readability:
Note that the output is piped to the https://stedolan.github.io/jq[jq^] command to facilitate readability:

----
curl -v -X GET -u Administrator:password \
Expand All @@ -76,12 +76,12 @@ If the call is successful, `200 OK` is returned, with the following output:
"clusterUUID": "21d1c9a5d1f40f5bb8ac73f6df9db8a7",
"orchestrator": "ns_1@10.143.210.101",
"isBalanced": true,
"clusterCompatVersion": "6.6"
"clusterCompatVersion": "7.6"
}
----

The output thus provides the UUID of the cluster, and the orchestrator-location (which is the node whose IP address is `10.143.210.101`).
It also verifies that the cluster currently does not require rebalance, and that its minimum compatibility version is 6.6.
It also verifies that the cluster currently does not require rebalance and that its minimum compatibility version is 6.6.

== See Also

Expand Down