Skip to content

Commit 105e9a6

Browse files
author
lamai93
committed
Updated documentation for volumeClaimTemplates.
1 parent f9cf8c7 commit 105e9a6

File tree

1 file changed

+27
-20
lines changed

1 file changed

+27
-20
lines changed

docs/Manual/Deployment/Kubernetes/DeploymentResource.md

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -377,25 +377,22 @@ Specifies a maximum for the count of servers. If set, a specification is invalid
377377
This setting specifies additional commandline arguments passed to all servers of this group.
378378
The default value is an empty array.
379379

380-
### `spec.<group>.resources.requests.cpu: cpuUnit`
380+
### `spec.<group>.resources: ResourceRequirements`
381381

382-
This setting specifies the amount of CPU requested by server of this group.
382+
This setting specifies the resources required by pods of this group. This includes requests and limits.
383383

384384
See https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ for details.
385385

386-
### `spec.<group>.resources.requests.memory: memoryUnit`
386+
### `spec.<group>.volumeClaimTemplate.Spec: PersistentVolumeClaimSpec`
387387

388-
This setting specifies the amount of memory requested by server of this group.
388+
Specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group.
389+
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`.
389390

390-
See https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ for details.
391-
392-
### `spec.<group>.resources.requests.storage: storageUnit`
393-
394-
This setting specifies the amount of storage required for each server of this group.
395-
The default value is `8Gi`.
391+
The default value describes a volume with `8Gi` storage, `ReadWriteOnce` access mode and volume mode set to `PersistentVolumeFilesystem`.
396392

397-
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`
398-
because servers in these groups do not need persistent storage.
393+
If this field is not set and `spec.<group>.resources.requests.storage` is set, then a default volume claim
394+
with size as specified by `spec.<group>.resources.requests.storage` will be created. In that case `storage`
395+
and `iops` is not forwarded to the pods resource requirements.
399396

400397
### `spec.<group>.serviceAccountName: string`
401398

@@ -405,14 +402,6 @@ for each server of this group.
405402
Using an alternative `ServiceAccount` is typically used to separate access rights.
406403
The ArangoDB deployments do not require any special rights.
407404

408-
### `spec.<group>.storageClassName: string`
409-
410-
This setting specifies the `storageClass` for the `PersistentVolume`s created
411-
for each server of this group.
412-
413-
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`
414-
because servers in these groups do not need persistent storage.
415-
416405
### `spec.<group>.priorityClassName: string`
417406

418407
Priority class name for pods of this group. Will be forwarded to the pod spec. [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/)
@@ -443,3 +432,21 @@ For more information on tolerations, consult the [Kubernetes documentation](http
443432
This setting specifies a set of labels to be used as `nodeSelector` for Pods of this node.
444433

445434
For more information on node selectors, consult the [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/).
435+
436+
## Deprecated Fields
437+
438+
### `spec.<group>.resources.requests.storage: storageUnit`
439+
440+
This setting specifies the amount of storage required for each server of this group.
441+
The default value is `8Gi`.
442+
443+
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`
444+
because servers in these groups do not need persistent storage.
445+
446+
### `spec.<group>.storageClassName: string`
447+
448+
This setting specifies the `storageClass` for the `PersistentVolume`s created
449+
for each server of this group.
450+
451+
This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`
452+
because servers in these groups do not need persistent storage.

0 commit comments

Comments
 (0)