Skip to content

Commit b939de9

Browse files
authored
[Doc] OverrideDetectedTotalMemory (ArangoDB Env ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY) documentation (#1258)
1 parent 8bc4d49 commit b939de9

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/design/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
- [Metrics](./metrics.md)
66
- [Kubernetes Pod name versus cluster ID](./pod_name_versus_cluster_id.md)
77
- [Resource & labels](./resource_and_labels.md)
8+
- [Resource Management](./resource_management.md)
89
- [Scaling](./scaling.md)
910
- [Status](./status.md)
1011
- [Upgrading](./upgrading.md)

docs/design/resource_management.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Resource Management
2+
3+
## overrideDetectedTotalMemory
4+
5+
The `spec.<group>.overrideDetectedTotalMemory` flag is an option that allows users to override the total memory available to the ArangoDB member
6+
by automatically injecting `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` ENV variable into the container with the value of `spec.<group>.resources.limits.memory`.
7+
8+
Sample:
9+
10+
```yaml
11+
apiVersion: database.arangodb.com/v1
12+
kind: ArangoDeployment
13+
metadata:
14+
name: cluster
15+
spec:
16+
mode: Cluster
17+
dbservers:
18+
overrideDetectedTotalMemory: true
19+
resources:
20+
limits:
21+
memory: 1Gi
22+
```

0 commit comments

Comments
 (0)