Skip to content

Commit ca016a1

Browse files
doc: Add the node roles page
1 parent 5334059 commit ca016a1

3 files changed

Lines changed: 70 additions & 1 deletion

File tree

docs/modules/opensearch/pages/usage-guide/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44

55
The usage guide covers various aspects of configuring OpenSearch and interconnection with other tools.
66

7-
Learn about defining the amount of xref:usage-guide/storage-resource-configuration.adoc[resources] OpenSearch uses.
7+
Learn about xref:usage-guide/node-roles.adoc[] or defining the amount of xref:usage-guide/storage-resource-configuration.adoc[resources] OpenSearch uses.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
= Assigning roles to nodes
2+
:description: Configure OpenSearch node roles
3+
4+
An OpenSearch node can fulfill different roles, e.g. it can manage the operation of a cluster or store and search data.
5+
6+
All nodes are defined under the role `nodes`.
7+
The role config already defaults to a set of node roles:
8+
9+
[source,yaml]
10+
----
11+
nodes:
12+
config:
13+
nodeRoles:
14+
- cluster_manager
15+
- data
16+
- ingest
17+
- remote_cluster_client
18+
----
19+
20+
If you deploy a cluster with the following specification, then 3 replicas with the roles `cluster_manager`, `data`, `ingest` and `remote_cluster_client` are deployed:
21+
22+
[source,yaml]
23+
----
24+
nodes:
25+
roleGroups:
26+
default:
27+
replicas: 3
28+
----
29+
30+
In a production cluster, you probably want to assign different roles to the nodes.
31+
This can be achieved by creating multiple role groups and configuring their node roles.
32+
The node roles configured at the role group level override the ones from the role level.
33+
34+
For instance, if you want to deploy https://docs.opensearch.org/docs/latest/tuning-your-cluster/[the sample cluster from the OpenSearch documentation] that has one dedicated cluster manager node, one dedicated coordinating node and two data nodes, you could configure the role groups as follows:
35+
36+
[source,yaml]
37+
----
38+
nodes:
39+
roleGroups:
40+
cluster-manager:
41+
config:
42+
nodeRoles:
43+
- cluster_manager
44+
replicas: 1
45+
coordinating:
46+
config:
47+
nodeRoles:
48+
- coordinating_only
49+
replicas: 1
50+
data:
51+
config:
52+
nodeRoles:
53+
- data
54+
- ingest
55+
replicas: 2
56+
----
57+
58+
The following roles are currently supported by the operator:
59+
60+
* `cluster_manager`
61+
* `coordinating_only`
62+
* `data`
63+
* `ingest`
64+
* `remote_cluster_client`
65+
* `search`
66+
* `warm`
67+
68+
We refer to https://docs.opensearch.org/docs/latest/install-and-configure/configuring-opensearch/configuration-system/[the OpenSearch documentation] for an exlanation of the roles.

docs/modules/opensearch/partials/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
** xref:opensearch:getting_started/installation.adoc[]
33
** xref:opensearch:getting_started/first_steps.adoc[]
44
* xref:opensearch:usage-guide/index.adoc[]
5+
** xref:opensearch:usage-guide/node-roles.adoc[]
56
** xref:opensearch:usage-guide/storage-resource-configuration.adoc[]
67
** xref:opensearch:usage-guide/configuration-environment-overrides.adoc[]
78
** xref:opensearch:usage-guide/operations/index.adoc[]

0 commit comments

Comments
 (0)