From b9918115d96750f0debfce14aa33387cc83adeac Mon Sep 17 00:00:00 2001 From: Adam Janikowski <12255597+ajanikow@users.noreply.github.com> Date: Thu, 19 Oct 2023 11:41:10 +0200 Subject: [PATCH] [Documentation] Improve Member Memory docs (#1449) --- docs/api/ArangoDeployment.V1.md | 732 ++++++++++-------- internal/docs_test.go | 10 + pkg/apis/deployment/v1/server_group_spec.go | 12 +- .../deployment/v2alpha1/server_group_spec.go | 12 +- 4 files changed, 444 insertions(+), 322 deletions(-) diff --git a/docs/api/ArangoDeployment.V1.md b/docs/api/ArangoDeployment.V1.md index 44ff0a177..8bdab61c7 100644 --- a/docs/api/ArangoDeployment.V1.md +++ b/docs/api/ArangoDeployment.V1.md @@ -9,31 +9,31 @@ Affinity specified additional affinity settings in ArangoDB Pod definitions Links: * [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L142) ### .spec.agents.allowMemberRecreation: bool AllowMemberRecreation allows to recreate member. Value is used only for Coordinator and DBServer with default to True, for all other groups set to false. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L179) ### .spec.agents.annotations: map[string]string Annotations specified the annotations added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L98) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) ### .spec.agents.annotationsIgnoreList: []string AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) ### .spec.agents.annotationsMode: string AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L102) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L110) ### .spec.agents.antiAffinity: core.PodAntiAffinity @@ -42,7 +42,7 @@ AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definiti Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) ### .spec.agents.args: []string @@ -92,19 +92,19 @@ Links: ExporterPort define Port used by exporter -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L184) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L192) ### .spec.agents.extendedRotationCheck: bool ExtendedRotationCheck extend checks for rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L157) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) ### .spec.agents.externalPortEnabled: bool ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) ### .spec.agents.indexMethod: string @@ -114,7 +114,7 @@ Possible Values: * random (default) - Pick random ID for member. Enforced on the Community Operator. * ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L185) ### .spec.agents.initContainers.containers: []core.Container @@ -135,31 +135,31 @@ Mode keep container replace mode InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) ### .spec.agents.internalPortProtocol: string InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L167) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L175) ### .spec.agents.labels: map[string]string Labels specified the labels added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) ### .spec.agents.labelsIgnoreList: []string LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) ### .spec.agents.labelsMode: string LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L116) ### .spec.agents.maxCount: int @@ -180,13 +180,13 @@ NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definiti Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L146) ### .spec.agents.nodeSelector: map[string]string NodeSelector speficies a set of selectors for nodes -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) ### .spec.agents.numactl.args: []string @@ -214,15 +214,31 @@ Default Value: /usr/bin/numactl ### .spec.agents.overrideDetectedNumberOfCores: bool -OverrideDetectedNumberOfCores determines if number of cores should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L92) +OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources. +If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) ### .spec.agents.overrideDetectedTotalMemory: bool -OverrideDetectedTotalMemory determines if memory should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L90) +OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources. +If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L94) ### .spec.agents.podModes.network: string @@ -236,104 +252,104 @@ OverrideDetectedTotalMemory determines if memory should be overrided based on va Port define Port used by member -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L182) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L190) ### .spec.agents.priorityClassName: string PriorityClassName specifies a priority class name -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L118) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) ### .spec.agents.probes.livenessProbeDisabled: bool LivenessProbeDisabled if true livenessProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L193) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L201) ### .spec.agents.probes.livenessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.agents.probes.livenessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.agents.probes.livenessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.agents.probes.livenessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.agents.probes.livenessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.agents.probes.ReadinessProbeDisabled: bool OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L200) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L208) ### .spec.agents.probes.readinessProbeDisabled: bool ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L202) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L210) ### .spec.agents.probes.readinessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.agents.probes.readinessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.agents.probes.readinessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.agents.probes.readinessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.agents.probes.readinessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.agents.probes.startupProbeDisabled: bool StartupProbeDisabled if true startupProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L207) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L215) ### .spec.agents.probes.startupProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.agents.probes.startupProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.agents.probes.startupProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.agents.probes.startupProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.agents.probes.startupProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.agents.pvcResizeMode: string VolumeResizeMode specified resize mode for pvc -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L124) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L132) ### .spec.agents.resources: core.ResourceRequirements @@ -436,26 +452,26 @@ sysctls: ServiceAccountName specifies the name of the service account used for Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L120) ### .spec.agents.shutdownDelay: int ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L163) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) ### .spec.agents.shutdownMethod: string ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) ### .spec.agents.sidecarCoreNames: []string SidecarCoreNames is a list of sidecar containers which must run in the pod. Some names (e.g.: "server", "worker") are reserved, and they don't have any impact. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L141) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L149) ### .spec.agents.sidecars: []core.Container @@ -464,7 +480,7 @@ Sidecars specifies a list of additional containers to be started Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L145) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) ### .spec.agents.storageClassName: string @@ -476,7 +492,7 @@ StorageClassName specifies the classname for storage of the servers. TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L181) ### .spec.agents.tolerations: []core.Toleration @@ -485,13 +501,13 @@ Tolerations specifies the tolerations added to Pods in this group. Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L96) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) ### .spec.agents.volumeAllowShrink: bool Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) ### .spec.agents.volumeClaimTemplate: core.PersistentVolumeClaim @@ -500,7 +516,7 @@ VolumeClaimTemplate specifies a template for volume claims Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) ### .spec.agents.volumeMounts: []ServerGroupSpecVolumeMount @@ -509,7 +525,7 @@ VolumeMounts define list of volume mounts mounted into server container Links: * [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) ### .spec.agents.volumes\[int\].configMap: core.ConfigMapVolumeSource @@ -660,31 +676,31 @@ Affinity specified additional affinity settings in ArangoDB Pod definitions Links: * [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L142) ### .spec.coordinators.allowMemberRecreation: bool AllowMemberRecreation allows to recreate member. Value is used only for Coordinator and DBServer with default to True, for all other groups set to false. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L179) ### .spec.coordinators.annotations: map[string]string Annotations specified the annotations added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L98) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) ### .spec.coordinators.annotationsIgnoreList: []string AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) ### .spec.coordinators.annotationsMode: string AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L102) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L110) ### .spec.coordinators.antiAffinity: core.PodAntiAffinity @@ -693,7 +709,7 @@ AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definiti Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) ### .spec.coordinators.args: []string @@ -743,19 +759,19 @@ Links: ExporterPort define Port used by exporter -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L184) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L192) ### .spec.coordinators.extendedRotationCheck: bool ExtendedRotationCheck extend checks for rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L157) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) ### .spec.coordinators.externalPortEnabled: bool ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) ### .spec.coordinators.indexMethod: string @@ -765,7 +781,7 @@ Possible Values: * random (default) - Pick random ID for member. Enforced on the Community Operator. * ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L185) ### .spec.coordinators.initContainers.containers: []core.Container @@ -786,31 +802,31 @@ Mode keep container replace mode InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) ### .spec.coordinators.internalPortProtocol: string InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L167) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L175) ### .spec.coordinators.labels: map[string]string Labels specified the labels added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) ### .spec.coordinators.labelsIgnoreList: []string LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) ### .spec.coordinators.labelsMode: string LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L116) ### .spec.coordinators.maxCount: int @@ -831,13 +847,13 @@ NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definiti Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L146) ### .spec.coordinators.nodeSelector: map[string]string NodeSelector speficies a set of selectors for nodes -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) ### .spec.coordinators.numactl.args: []string @@ -865,15 +881,31 @@ Default Value: /usr/bin/numactl ### .spec.coordinators.overrideDetectedNumberOfCores: bool -OverrideDetectedNumberOfCores determines if number of cores should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L92) +OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources. +If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) ### .spec.coordinators.overrideDetectedTotalMemory: bool -OverrideDetectedTotalMemory determines if memory should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L90) +OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources. +If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L94) ### .spec.coordinators.podModes.network: string @@ -887,104 +919,104 @@ OverrideDetectedTotalMemory determines if memory should be overrided based on va Port define Port used by member -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L182) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L190) ### .spec.coordinators.priorityClassName: string PriorityClassName specifies a priority class name -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L118) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) ### .spec.coordinators.probes.livenessProbeDisabled: bool LivenessProbeDisabled if true livenessProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L193) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L201) ### .spec.coordinators.probes.livenessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.coordinators.probes.livenessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.coordinators.probes.livenessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.coordinators.probes.livenessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.coordinators.probes.livenessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.coordinators.probes.ReadinessProbeDisabled: bool OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L200) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L208) ### .spec.coordinators.probes.readinessProbeDisabled: bool ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L202) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L210) ### .spec.coordinators.probes.readinessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.coordinators.probes.readinessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.coordinators.probes.readinessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.coordinators.probes.readinessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.coordinators.probes.readinessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.coordinators.probes.startupProbeDisabled: bool StartupProbeDisabled if true startupProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L207) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L215) ### .spec.coordinators.probes.startupProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.coordinators.probes.startupProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.coordinators.probes.startupProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.coordinators.probes.startupProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.coordinators.probes.startupProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.coordinators.pvcResizeMode: string VolumeResizeMode specified resize mode for pvc -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L124) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L132) ### .spec.coordinators.resources: core.ResourceRequirements @@ -1087,26 +1119,26 @@ sysctls: ServiceAccountName specifies the name of the service account used for Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L120) ### .spec.coordinators.shutdownDelay: int ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L163) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) ### .spec.coordinators.shutdownMethod: string ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) ### .spec.coordinators.sidecarCoreNames: []string SidecarCoreNames is a list of sidecar containers which must run in the pod. Some names (e.g.: "server", "worker") are reserved, and they don't have any impact. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L141) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L149) ### .spec.coordinators.sidecars: []core.Container @@ -1115,7 +1147,7 @@ Sidecars specifies a list of additional containers to be started Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L145) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) ### .spec.coordinators.storageClassName: string @@ -1127,7 +1159,7 @@ StorageClassName specifies the classname for storage of the servers. TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L181) ### .spec.coordinators.tolerations: []core.Toleration @@ -1136,13 +1168,13 @@ Tolerations specifies the tolerations added to Pods in this group. Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L96) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) ### .spec.coordinators.volumeAllowShrink: bool Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) ### .spec.coordinators.volumeClaimTemplate: core.PersistentVolumeClaim @@ -1151,7 +1183,7 @@ VolumeClaimTemplate specifies a template for volume claims Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) ### .spec.coordinators.volumeMounts: []ServerGroupSpecVolumeMount @@ -1160,7 +1192,7 @@ VolumeMounts define list of volume mounts mounted into server container Links: * [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) ### .spec.coordinators.volumes\[int\].configMap: core.ConfigMapVolumeSource @@ -1226,31 +1258,31 @@ Affinity specified additional affinity settings in ArangoDB Pod definitions Links: * [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L142) ### .spec.dbservers.allowMemberRecreation: bool AllowMemberRecreation allows to recreate member. Value is used only for Coordinator and DBServer with default to True, for all other groups set to false. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L179) ### .spec.dbservers.annotations: map[string]string Annotations specified the annotations added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L98) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) ### .spec.dbservers.annotationsIgnoreList: []string AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) ### .spec.dbservers.annotationsMode: string AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L102) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L110) ### .spec.dbservers.antiAffinity: core.PodAntiAffinity @@ -1259,7 +1291,7 @@ AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definiti Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) ### .spec.dbservers.args: []string @@ -1309,19 +1341,19 @@ Links: ExporterPort define Port used by exporter -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L184) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L192) ### .spec.dbservers.extendedRotationCheck: bool ExtendedRotationCheck extend checks for rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L157) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) ### .spec.dbservers.externalPortEnabled: bool ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) ### .spec.dbservers.indexMethod: string @@ -1331,7 +1363,7 @@ Possible Values: * random (default) - Pick random ID for member. Enforced on the Community Operator. * ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L185) ### .spec.dbservers.initContainers.containers: []core.Container @@ -1352,31 +1384,31 @@ Mode keep container replace mode InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) ### .spec.dbservers.internalPortProtocol: string InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L167) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L175) ### .spec.dbservers.labels: map[string]string Labels specified the labels added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) ### .spec.dbservers.labelsIgnoreList: []string LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) ### .spec.dbservers.labelsMode: string LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L116) ### .spec.dbservers.maxCount: int @@ -1397,13 +1429,13 @@ NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definiti Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L146) ### .spec.dbservers.nodeSelector: map[string]string NodeSelector speficies a set of selectors for nodes -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) ### .spec.dbservers.numactl.args: []string @@ -1431,15 +1463,31 @@ Default Value: /usr/bin/numactl ### .spec.dbservers.overrideDetectedNumberOfCores: bool -OverrideDetectedNumberOfCores determines if number of cores should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L92) +OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources. +If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) ### .spec.dbservers.overrideDetectedTotalMemory: bool -OverrideDetectedTotalMemory determines if memory should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L90) +OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources. +If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L94) ### .spec.dbservers.podModes.network: string @@ -1453,104 +1501,104 @@ OverrideDetectedTotalMemory determines if memory should be overrided based on va Port define Port used by member -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L182) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L190) ### .spec.dbservers.priorityClassName: string PriorityClassName specifies a priority class name -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L118) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) ### .spec.dbservers.probes.livenessProbeDisabled: bool LivenessProbeDisabled if true livenessProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L193) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L201) ### .spec.dbservers.probes.livenessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.dbservers.probes.livenessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.dbservers.probes.livenessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.dbservers.probes.livenessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.dbservers.probes.livenessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.dbservers.probes.ReadinessProbeDisabled: bool OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L200) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L208) ### .spec.dbservers.probes.readinessProbeDisabled: bool ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L202) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L210) ### .spec.dbservers.probes.readinessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.dbservers.probes.readinessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.dbservers.probes.readinessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.dbservers.probes.readinessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.dbservers.probes.readinessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.dbservers.probes.startupProbeDisabled: bool StartupProbeDisabled if true startupProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L207) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L215) ### .spec.dbservers.probes.startupProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.dbservers.probes.startupProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.dbservers.probes.startupProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.dbservers.probes.startupProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.dbservers.probes.startupProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.dbservers.pvcResizeMode: string VolumeResizeMode specified resize mode for pvc -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L124) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L132) ### .spec.dbservers.resources: core.ResourceRequirements @@ -1653,26 +1701,26 @@ sysctls: ServiceAccountName specifies the name of the service account used for Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L120) ### .spec.dbservers.shutdownDelay: int ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L163) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) ### .spec.dbservers.shutdownMethod: string ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) ### .spec.dbservers.sidecarCoreNames: []string SidecarCoreNames is a list of sidecar containers which must run in the pod. Some names (e.g.: "server", "worker") are reserved, and they don't have any impact. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L141) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L149) ### .spec.dbservers.sidecars: []core.Container @@ -1681,7 +1729,7 @@ Sidecars specifies a list of additional containers to be started Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L145) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) ### .spec.dbservers.storageClassName: string @@ -1693,7 +1741,7 @@ StorageClassName specifies the classname for storage of the servers. TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L181) ### .spec.dbservers.tolerations: []core.Toleration @@ -1702,13 +1750,13 @@ Tolerations specifies the tolerations added to Pods in this group. Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L96) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) ### .spec.dbservers.volumeAllowShrink: bool Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) ### .spec.dbservers.volumeClaimTemplate: core.PersistentVolumeClaim @@ -1717,7 +1765,7 @@ VolumeClaimTemplate specifies a template for volume claims Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) ### .spec.dbservers.volumeMounts: []ServerGroupSpecVolumeMount @@ -1726,7 +1774,7 @@ VolumeMounts define list of volume mounts mounted into server container Links: * [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) ### .spec.dbservers.volumes\[int\].configMap: core.ConfigMapVolumeSource @@ -2230,31 +2278,31 @@ Affinity specified additional affinity settings in ArangoDB Pod definitions Links: * [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L142) ### .spec.single.allowMemberRecreation: bool AllowMemberRecreation allows to recreate member. Value is used only for Coordinator and DBServer with default to True, for all other groups set to false. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L179) ### .spec.single.annotations: map[string]string Annotations specified the annotations added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L98) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) ### .spec.single.annotationsIgnoreList: []string AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) ### .spec.single.annotationsMode: string AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L102) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L110) ### .spec.single.antiAffinity: core.PodAntiAffinity @@ -2263,7 +2311,7 @@ AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definiti Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) ### .spec.single.args: []string @@ -2313,19 +2361,19 @@ Links: ExporterPort define Port used by exporter -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L184) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L192) ### .spec.single.extendedRotationCheck: bool ExtendedRotationCheck extend checks for rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L157) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) ### .spec.single.externalPortEnabled: bool ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) ### .spec.single.indexMethod: string @@ -2335,7 +2383,7 @@ Possible Values: * random (default) - Pick random ID for member. Enforced on the Community Operator. * ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L185) ### .spec.single.initContainers.containers: []core.Container @@ -2356,31 +2404,31 @@ Mode keep container replace mode InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) ### .spec.single.internalPortProtocol: string InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L167) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L175) ### .spec.single.labels: map[string]string Labels specified the labels added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) ### .spec.single.labelsIgnoreList: []string LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) ### .spec.single.labelsMode: string LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L116) ### .spec.single.maxCount: int @@ -2401,13 +2449,13 @@ NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definiti Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L146) ### .spec.single.nodeSelector: map[string]string NodeSelector speficies a set of selectors for nodes -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) ### .spec.single.numactl.args: []string @@ -2435,15 +2483,31 @@ Default Value: /usr/bin/numactl ### .spec.single.overrideDetectedNumberOfCores: bool -OverrideDetectedNumberOfCores determines if number of cores should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L92) +OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources. +If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) ### .spec.single.overrideDetectedTotalMemory: bool -OverrideDetectedTotalMemory determines if memory should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L90) +OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources. +If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L94) ### .spec.single.podModes.network: string @@ -2457,104 +2521,104 @@ OverrideDetectedTotalMemory determines if memory should be overrided based on va Port define Port used by member -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L182) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L190) ### .spec.single.priorityClassName: string PriorityClassName specifies a priority class name -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L118) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) ### .spec.single.probes.livenessProbeDisabled: bool LivenessProbeDisabled if true livenessProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L193) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L201) ### .spec.single.probes.livenessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.single.probes.livenessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.single.probes.livenessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.single.probes.livenessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.single.probes.livenessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.single.probes.ReadinessProbeDisabled: bool OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L200) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L208) ### .spec.single.probes.readinessProbeDisabled: bool ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L202) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L210) ### .spec.single.probes.readinessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.single.probes.readinessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.single.probes.readinessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.single.probes.readinessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.single.probes.readinessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.single.probes.startupProbeDisabled: bool StartupProbeDisabled if true startupProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L207) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L215) ### .spec.single.probes.startupProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.single.probes.startupProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.single.probes.startupProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.single.probes.startupProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.single.probes.startupProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.single.pvcResizeMode: string VolumeResizeMode specified resize mode for pvc -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L124) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L132) ### .spec.single.resources: core.ResourceRequirements @@ -2657,26 +2721,26 @@ sysctls: ServiceAccountName specifies the name of the service account used for Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L120) ### .spec.single.shutdownDelay: int ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L163) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) ### .spec.single.shutdownMethod: string ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) ### .spec.single.sidecarCoreNames: []string SidecarCoreNames is a list of sidecar containers which must run in the pod. Some names (e.g.: "server", "worker") are reserved, and they don't have any impact. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L141) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L149) ### .spec.single.sidecars: []core.Container @@ -2685,7 +2749,7 @@ Sidecars specifies a list of additional containers to be started Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L145) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) ### .spec.single.storageClassName: string @@ -2697,7 +2761,7 @@ StorageClassName specifies the classname for storage of the servers. TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L181) ### .spec.single.tolerations: []core.Toleration @@ -2706,13 +2770,13 @@ Tolerations specifies the tolerations added to Pods in this group. Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L96) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) ### .spec.single.volumeAllowShrink: bool Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) ### .spec.single.volumeClaimTemplate: core.PersistentVolumeClaim @@ -2721,7 +2785,7 @@ VolumeClaimTemplate specifies a template for volume claims Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) ### .spec.single.volumeMounts: []ServerGroupSpecVolumeMount @@ -2730,7 +2794,7 @@ VolumeMounts define list of volume mounts mounted into server container Links: * [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) ### .spec.single.volumes\[int\].configMap: core.ConfigMapVolumeSource @@ -2898,31 +2962,31 @@ Affinity specified additional affinity settings in ArangoDB Pod definitions Links: * [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L142) ### .spec.syncmasters.allowMemberRecreation: bool AllowMemberRecreation allows to recreate member. Value is used only for Coordinator and DBServer with default to True, for all other groups set to false. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L179) ### .spec.syncmasters.annotations: map[string]string Annotations specified the annotations added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L98) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) ### .spec.syncmasters.annotationsIgnoreList: []string AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) ### .spec.syncmasters.annotationsMode: string AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L102) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L110) ### .spec.syncmasters.antiAffinity: core.PodAntiAffinity @@ -2931,7 +2995,7 @@ AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definiti Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) ### .spec.syncmasters.args: []string @@ -2981,19 +3045,19 @@ Links: ExporterPort define Port used by exporter -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L184) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L192) ### .spec.syncmasters.extendedRotationCheck: bool ExtendedRotationCheck extend checks for rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L157) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) ### .spec.syncmasters.externalPortEnabled: bool ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) ### .spec.syncmasters.indexMethod: string @@ -3003,7 +3067,7 @@ Possible Values: * random (default) - Pick random ID for member. Enforced on the Community Operator. * ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L185) ### .spec.syncmasters.initContainers.containers: []core.Container @@ -3024,31 +3088,31 @@ Mode keep container replace mode InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) ### .spec.syncmasters.internalPortProtocol: string InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L167) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L175) ### .spec.syncmasters.labels: map[string]string Labels specified the labels added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) ### .spec.syncmasters.labelsIgnoreList: []string LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) ### .spec.syncmasters.labelsMode: string LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L116) ### .spec.syncmasters.maxCount: int @@ -3069,13 +3133,13 @@ NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definiti Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L146) ### .spec.syncmasters.nodeSelector: map[string]string NodeSelector speficies a set of selectors for nodes -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) ### .spec.syncmasters.numactl.args: []string @@ -3103,15 +3167,31 @@ Default Value: /usr/bin/numactl ### .spec.syncmasters.overrideDetectedNumberOfCores: bool -OverrideDetectedNumberOfCores determines if number of cores should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L92) +OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources. +If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) ### .spec.syncmasters.overrideDetectedTotalMemory: bool -OverrideDetectedTotalMemory determines if memory should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L90) +OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources. +If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L94) ### .spec.syncmasters.podModes.network: string @@ -3125,104 +3205,104 @@ OverrideDetectedTotalMemory determines if memory should be overrided based on va Port define Port used by member -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L182) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L190) ### .spec.syncmasters.priorityClassName: string PriorityClassName specifies a priority class name -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L118) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) ### .spec.syncmasters.probes.livenessProbeDisabled: bool LivenessProbeDisabled if true livenessProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L193) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L201) ### .spec.syncmasters.probes.livenessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.syncmasters.probes.livenessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.syncmasters.probes.livenessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.syncmasters.probes.livenessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.syncmasters.probes.livenessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.syncmasters.probes.ReadinessProbeDisabled: bool OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L200) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L208) ### .spec.syncmasters.probes.readinessProbeDisabled: bool ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L202) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L210) ### .spec.syncmasters.probes.readinessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.syncmasters.probes.readinessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.syncmasters.probes.readinessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.syncmasters.probes.readinessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.syncmasters.probes.readinessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.syncmasters.probes.startupProbeDisabled: bool StartupProbeDisabled if true startupProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L207) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L215) ### .spec.syncmasters.probes.startupProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.syncmasters.probes.startupProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.syncmasters.probes.startupProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.syncmasters.probes.startupProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.syncmasters.probes.startupProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.syncmasters.pvcResizeMode: string VolumeResizeMode specified resize mode for pvc -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L124) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L132) ### .spec.syncmasters.resources: core.ResourceRequirements @@ -3325,26 +3405,26 @@ sysctls: ServiceAccountName specifies the name of the service account used for Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L120) ### .spec.syncmasters.shutdownDelay: int ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L163) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) ### .spec.syncmasters.shutdownMethod: string ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) ### .spec.syncmasters.sidecarCoreNames: []string SidecarCoreNames is a list of sidecar containers which must run in the pod. Some names (e.g.: "server", "worker") are reserved, and they don't have any impact. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L141) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L149) ### .spec.syncmasters.sidecars: []core.Container @@ -3353,7 +3433,7 @@ Sidecars specifies a list of additional containers to be started Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L145) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) ### .spec.syncmasters.storageClassName: string @@ -3365,7 +3445,7 @@ StorageClassName specifies the classname for storage of the servers. TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L181) ### .spec.syncmasters.tolerations: []core.Toleration @@ -3374,13 +3454,13 @@ Tolerations specifies the tolerations added to Pods in this group. Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L96) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) ### .spec.syncmasters.volumeAllowShrink: bool Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) ### .spec.syncmasters.volumeClaimTemplate: core.PersistentVolumeClaim @@ -3389,7 +3469,7 @@ VolumeClaimTemplate specifies a template for volume claims Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) ### .spec.syncmasters.volumeMounts: []ServerGroupSpecVolumeMount @@ -3398,7 +3478,7 @@ VolumeMounts define list of volume mounts mounted into server container Links: * [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) ### .spec.syncmasters.volumes\[int\].configMap: core.ConfigMapVolumeSource @@ -3458,31 +3538,31 @@ Affinity specified additional affinity settings in ArangoDB Pod definitions Links: * [Documentation of core.PodAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L142) ### .spec.syncworkers.allowMemberRecreation: bool AllowMemberRecreation allows to recreate member. Value is used only for Coordinator and DBServer with default to True, for all other groups set to false. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L179) ### .spec.syncworkers.annotations: map[string]string Annotations specified the annotations added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L98) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) ### .spec.syncworkers.annotationsIgnoreList: []string AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) ### .spec.syncworkers.annotationsMode: string AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L102) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L110) ### .spec.syncworkers.antiAffinity: core.PodAntiAffinity @@ -3491,7 +3571,7 @@ AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definiti Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) ### .spec.syncworkers.args: []string @@ -3541,19 +3621,19 @@ Links: ExporterPort define Port used by exporter -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L184) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L192) ### .spec.syncworkers.extendedRotationCheck: bool ExtendedRotationCheck extend checks for rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L157) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) ### .spec.syncworkers.externalPortEnabled: bool ExternalPortEnabled if external port should be enabled. If is set to false, ports needs to be exposed via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) ### .spec.syncworkers.indexMethod: string @@ -3563,7 +3643,7 @@ Possible Values: * random (default) - Pick random ID for member. Enforced on the Community Operator. * ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L177) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L185) ### .spec.syncworkers.initContainers.containers: []core.Container @@ -3584,31 +3664,31 @@ Mode keep container replace mode InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L165) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) ### .spec.syncworkers.internalPortProtocol: string InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L167) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L175) ### .spec.syncworkers.labels: map[string]string Labels specified the labels added to Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) ### .spec.syncworkers.labelsIgnoreList: []string LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L106) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) ### .spec.syncworkers.labelsMode: string LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L108) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L116) ### .spec.syncworkers.maxCount: int @@ -3629,13 +3709,13 @@ NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definiti Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L138) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L146) ### .spec.syncworkers.nodeSelector: map[string]string NodeSelector speficies a set of selectors for nodes -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L114) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) ### .spec.syncworkers.numactl.args: []string @@ -3663,15 +3743,31 @@ Default Value: /usr/bin/numactl ### .spec.syncworkers.overrideDetectedNumberOfCores: bool -OverrideDetectedNumberOfCores determines if number of cores should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L92) +OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources. +If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L100) ### .spec.syncworkers.overrideDetectedTotalMemory: bool -OverrideDetectedTotalMemory determines if memory should be overrided based on values in resources. +**Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L90) +OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources. +If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits. + +Links: +* [Docs of the ArangoDB Envs](https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/) + +Default Value: true + +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L94) ### .spec.syncworkers.podModes.network: string @@ -3685,104 +3781,104 @@ OverrideDetectedTotalMemory determines if memory should be overrided based on va Port define Port used by member -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L182) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L190) ### .spec.syncworkers.priorityClassName: string PriorityClassName specifies a priority class name -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L118) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) ### .spec.syncworkers.probes.livenessProbeDisabled: bool LivenessProbeDisabled if true livenessProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L193) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L201) ### .spec.syncworkers.probes.livenessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.syncworkers.probes.livenessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.syncworkers.probes.livenessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.syncworkers.probes.livenessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.syncworkers.probes.livenessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.syncworkers.probes.ReadinessProbeDisabled: bool OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L200) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L208) ### .spec.syncworkers.probes.readinessProbeDisabled: bool ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L202) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L210) ### .spec.syncworkers.probes.readinessProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.syncworkers.probes.readinessProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.syncworkers.probes.readinessProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.syncworkers.probes.readinessProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.syncworkers.probes.readinessProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.syncworkers.probes.startupProbeDisabled: bool StartupProbeDisabled if true startupProbes are disabled -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L207) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L215) ### .spec.syncworkers.probes.startupProbeSpec.failureThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L227) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L235) ### .spec.syncworkers.probes.startupProbeSpec.initialDelaySeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L223) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L231) ### .spec.syncworkers.probes.startupProbeSpec.periodSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L224) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L232) ### .spec.syncworkers.probes.startupProbeSpec.successThreshold: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L226) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L234) ### .spec.syncworkers.probes.startupProbeSpec.timeoutSeconds: int32 -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L225) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L233) ### .spec.syncworkers.pvcResizeMode: string VolumeResizeMode specified resize mode for pvc -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L124) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L132) ### .spec.syncworkers.resources: core.ResourceRequirements @@ -3885,26 +3981,26 @@ sysctls: ServiceAccountName specifies the name of the service account used for Pods in this group. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L112) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L120) ### .spec.syncworkers.shutdownDelay: int ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L163) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L171) ### .spec.syncworkers.shutdownMethod: string ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L169) ### .spec.syncworkers.sidecarCoreNames: []string SidecarCoreNames is a list of sidecar containers which must run in the pod. Some names (e.g.: "server", "worker") are reserved, and they don't have any impact. -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L141) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L149) ### .spec.syncworkers.sidecars: []core.Container @@ -3913,7 +4009,7 @@ Sidecars specifies a list of additional containers to be started Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L145) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) ### .spec.syncworkers.storageClassName: string @@ -3925,7 +4021,7 @@ StorageClassName specifies the classname for storage of the servers. TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L173) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L181) ### .spec.syncworkers.tolerations: []core.Toleration @@ -3934,13 +4030,13 @@ Tolerations specifies the tolerations added to Pods in this group. Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L96) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L104) ### .spec.syncworkers.volumeAllowShrink: bool Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L126) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L134) ### .spec.syncworkers.volumeClaimTemplate: core.PersistentVolumeClaim @@ -3949,7 +4045,7 @@ VolumeClaimTemplate specifies a template for volume claims Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L122) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L130) ### .spec.syncworkers.volumeMounts: []ServerGroupSpecVolumeMount @@ -3958,7 +4054,7 @@ VolumeMounts define list of volume mounts mounted into server container Links: * [Documentation of ServerGroupSpecVolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#volumemount-v1-core) -[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L153) +[Code Reference](/pkg/apis/deployment/v1/server_group_spec.go#L161) ### .spec.syncworkers.volumes\[int\].configMap: core.ConfigMapVolumeSource diff --git a/internal/docs_test.go b/internal/docs_test.go index a6cf35534..8bc7d0341 100644 --- a/internal/docs_test.go +++ b/internal/docs_test.go @@ -51,6 +51,10 @@ func (d DocDefinitions) Render(t *testing.T) []byte { write(t, out, "### %s: %s\n\n", el.Path, el.Type) + if d := el.Important; d != nil { + write(t, out, "**Important**: %s\n\n", *d) + } + if len(el.Docs) > 0 { for _, doc := range el.Docs { write(t, out, "%s\n", doc) @@ -129,6 +133,8 @@ type DocDefinition struct { Links []string + Important *string + Enum []string Immutable *string @@ -215,6 +221,10 @@ func generateDocs(t *testing.T, objects map[string]map[string]interface{}, paths def.Immutable = util.NewType[string](immutable[0]) } + if important, ok := extract(field, "important"); ok { + def.Important = util.NewType[string](important[0]) + } + if docs, ok := extractNotTags(field); !ok { println(def.Path, " is missing documentation!") } else { diff --git a/pkg/apis/deployment/v1/server_group_spec.go b/pkg/apis/deployment/v1/server_group_spec.go index f875d8a37..cbacd43af 100644 --- a/pkg/apis/deployment/v1/server_group_spec.go +++ b/pkg/apis/deployment/v1/server_group_spec.go @@ -86,9 +86,17 @@ type ServerGroupSpec struct { // +doc/type: core.ResourceRequirements // +doc/link: Documentation of core.ResourceRequirements|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core Resources core.ResourceRequirements `json:"resources,omitempty"` - // OverrideDetectedTotalMemory determines if memory should be overrided based on values in resources. + // OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources. + // If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits. + // +doc/important: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable + // +doc/default: true + // +doc/link: Docs of the ArangoDB Envs|https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/ OverrideDetectedTotalMemory *bool `json:"overrideDetectedTotalMemory,omitempty"` - // OverrideDetectedNumberOfCores determines if number of cores should be overrided based on values in resources. + // OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources. + // If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits. + // +doc/important: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable + // +doc/default: true + // +doc/link: Docs of the ArangoDB Envs|https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/ OverrideDetectedNumberOfCores *bool `json:"overrideDetectedNumberOfCores,omitempty"` // Tolerations specifies the tolerations added to Pods in this group. // +doc/type: []core.Toleration diff --git a/pkg/apis/deployment/v2alpha1/server_group_spec.go b/pkg/apis/deployment/v2alpha1/server_group_spec.go index ebf2311b6..aac37d880 100644 --- a/pkg/apis/deployment/v2alpha1/server_group_spec.go +++ b/pkg/apis/deployment/v2alpha1/server_group_spec.go @@ -86,9 +86,17 @@ type ServerGroupSpec struct { // +doc/type: core.ResourceRequirements // +doc/link: Documentation of core.ResourceRequirements|https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core Resources core.ResourceRequirements `json:"resources,omitempty"` - // OverrideDetectedTotalMemory determines if memory should be overrided based on values in resources. + // OverrideDetectedTotalMemory determines if memory should be overridden based on values in resources. + // If is set to true and Container Memory Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` to the value from the Container Memory Limits. + // +doc/important: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable + // +doc/default: true + // +doc/link: Docs of the ArangoDB Envs|https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/ OverrideDetectedTotalMemory *bool `json:"overrideDetectedTotalMemory,omitempty"` - // OverrideDetectedNumberOfCores determines if number of cores should be overrided based on values in resources. + // OverrideDetectedNumberOfCores determines if number of cores should be overridden based on values in resources. + // If is set to true and Container CPU Limits are set, it sets Container Environment Variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` to the value from the Container CPU Limits. + // +doc/important: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable + // +doc/default: true + // +doc/link: Docs of the ArangoDB Envs|https://docs.arangodb.com/devel/components/arangodb-server/environment-variables/ OverrideDetectedNumberOfCores *bool `json:"overrideDetectedNumberOfCores,omitempty"` // Tolerations specifies the tolerations added to Pods in this group. // +doc/type: []core.Toleration