Skip to content

Commit 3f63f60

Browse files
doc: Adapt resource page
1 parent bddc7b0 commit 3f63f60

2 files changed

Lines changed: 39 additions & 15 deletions

File tree

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
= Usage guide
22
:page-aliases: usage.doc
3-
:description: Superset usage guide: configure resources, connect to Apache Druid, set up authentication, logging, and monitoring.
3+
:description: OpenSearch usage guide: configure resources and override configurations.
44

5-
The usage guide covers various aspects of configuring Superset and interconnection with other tools.
5+
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] Superset uses or learn how to xref:usage-guide/connecting-druid.adoc[connect to Apache Druid] operated by the xref:druid:index.adoc[].
8-
9-
Configure xref:usage-guide/security.adoc#authentication[authentication] with LDAP and xref:usage-guide/security.adoc#authorization[authorization]. Observe your Superset instance with xref:usage-guide/logging.adoc[log aggregation] and xref:usage-guide/monitoring.adoc[monitoring].
7+
Learn about defining the amount of xref:usage-guide/storage-resource-configuration.adoc[resources] OpenSearch uses.
Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,40 @@
11
= Storage and resource configuration
2-
:description: Superset resource configuration: default CPU and memory requests for HA setup with guidance for adapting production resource needs.
2+
:description: Configure storage and resource allocation for OpenSearch nodes using Stackable Operator, including PersistentVolumeClaims, CPU, memory, and storage defaults.
3+
4+
== Storage for data volumes
5+
6+
You can mount volumes where data is stored by specifying https://kubernetes.io/docs/concepts/storage/persistent-volumes[PersistentVolumeClaims] for each individual role group:
7+
8+
[source,yaml]
9+
----
10+
nodes:
11+
roleGroups:
12+
default:
13+
config:
14+
resources:
15+
storage:
16+
logDirs:
17+
capacity: 50Gi
18+
----
19+
20+
In the above example, all OpenSearch nodes in the default role group store data (the location of the property `path.data`) on a `50Gi` volume.
21+
22+
If nothing is configured in the custom resource for a certain role group, then by default each Pod has a `8Gi` large local volume mount for the data location.
23+
24+
On role groups with only the `cluster_manager` role, you probably want to decrease this value, but increase it on role groups with the `data` role.
325

426
== Resource Requests
527

6-
include::concepts:stackable_resource_requests.adoc[]
28+
include::home:concepts:stackable_resource_requests.adoc[]
29+
30+
A minimal HA setup consisting of 3 nodes has the following https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]:
731

8-
A minimal HA setup consisting of 2 Superset instances has the following
9-
https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/[resource requirements]:
32+
* `300m` CPU request
33+
* `1200m` CPU limit
34+
* `4800Mi` memory request and limit
1035

11-
* `1300m` CPU request
12-
* `3800m` CPU limit
13-
* `2384Mi` memory request and limit
36+
Of course, additional services require additional resources.
37+
For Stackable components, see the corresponding documentation on further resource requirements.
1438

1539
Corresponding to the values above, the operator uses the following resource defaults:
1640

@@ -22,10 +46,12 @@ nodes:
2246
config:
2347
resources:
2448
cpu:
25-
min: '300m'
26-
max: "1200m"
49+
min: "1"
50+
max: "4"
2751
memory:
28-
limit: '1000Mi'
52+
limit: 2Gi
53+
storage:
54+
data: 8Gi
2955
----
3056

3157
WARNING: The default values are _most likely_ not sufficient to run a production cluster. Please adapt according to your requirements.

0 commit comments

Comments
 (0)