Skip to content

Commit d7c13b7

Browse files
docs: Update the description of the Kubernetes resources
1 parent 0c52663 commit d7c13b7

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

docs/modules/opensearch/pages/index.adoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,18 @@ It helps you tune your cluster to your needs by configuring xref:usage-guide/sto
4141

4242
=== Kubernetes resources
4343

44-
Based on the custom resources you define, the operator creates ConfigMaps, StatefulSets and Services.
44+
Based on the custom resources you define, the operator creates ConfigMaps, StatefulSets, Services and so on.
4545

4646
image::opensearch_overview.drawio.svg[A diagram depicting the Kubernetes resources created by the operator]
4747

4848
The diagram above depicts all the Kubernetes resources created by the operator, and how they relate to each other.
4949

50-
For every xref:concepts:roles-and-role-groups.adoc#role-groups[role group] you define, the operator creates a StatefulSet with the amount of replicas defined in the role group.
51-
For every role group, a Service is created, as well as one for the whole cluster that references the cluster manager nodes.
50+
What should be highlighted, is the xref:reference/discovery.adoc[discovery ConfigMap] which is named the same as the OpenSearchCluster.
51+
It references the Service that should be used to connect to the cluster.
5252

53-
Additionally, a ConfigMap is created for each role group.
54-
These ConfigMaps contain configuration files like `opensearch.yml`.
53+
For every xref:concepts:roles-and-role-groups.adoc#role-groups[role group] you define, the operator deploys OpenSearch as a StatefulSet with the amount of replicas defined in the role group.
54+
The pods of a StatefulSet use the configuration from the role group ConfigMap, i.e. they all use the same OpenSearch node roles, e.g. `cluster-manager` or `data`, and xref:opensearch:usage-guide/storage-resource-configuration.adoc[resource configurations].
55+
If you want dedicated `cluster-manager` and `data` nodes, you just define two role groups with according configurations as described in xref:opensearch:usage-guide/node-roles.adoc[].
5556

5657
== Supported versions
5758

0 commit comments

Comments
 (0)