1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-15 17:51:03 +00:00
kube-arangodb/docs/api/ArangoDeployment.V1.md
2023-10-19 11:41:10 +02:00

142 KiB
Raw Blame History

API Reference for ArangoDeployment V1

Spec

.spec.agents.affinity: core.PodAffinity

Affinity specified additional affinity settings in ArangoDB Pod definitions

Links:

Code Reference

.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

.spec.agents.annotations: map[string]string

Annotations specified the annotations added to Pods in this group.

Code Reference

.spec.agents.annotationsIgnoreList: []string

AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored

Code Reference

.spec.agents.annotationsMode: string

AnnotationsMode Define annotations mode which should be use while overriding annotations

Code Reference

.spec.agents.antiAffinity: core.PodAntiAffinity

AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.agents.args: []string

Args holds additional commandline arguments

Code Reference

.spec.agents.count: int

Count holds the requested number of servers

Code Reference

.spec.agents.entrypoint: string

Entrypoint overrides container executable

Code Reference

.spec.agents.envs[int].name: string

Code Reference

.spec.agents.envs[int].value: string

Code Reference

.spec.agents.ephemeralVolumes.apps.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.agents.ephemeralVolumes.temp.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.agents.exporterPort: uint16

ExporterPort define Port used by exporter

Code Reference

.spec.agents.extendedRotationCheck: bool

ExtendedRotationCheck extend checks for rotation

Code Reference

.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

.spec.agents.indexMethod: string

IndexMethod define group Indexing method

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

.spec.agents.initContainers.containers: []core.Container

Containers contains list of containers

Links:

Code Reference

.spec.agents.initContainers.mode: string

Mode keep container replace mode

Code Reference

.spec.agents.internalPort: int

InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members

Code Reference

.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

.spec.agents.labels: map[string]string

Labels specified the labels added to Pods in this group.

Code Reference

.spec.agents.labelsIgnoreList: []string

LabelsIgnoreList list regexp or plain definitions which labels should be ignored

Code Reference

.spec.agents.labelsMode: string

LabelsMode Define labels mode which should be use while overriding labels

Code Reference

.spec.agents.maxCount: int

MaxCount specifies a upper limit for count

Code Reference

.spec.agents.minCount: int

MinCount specifies a lower limit for count

Code Reference

.spec.agents.nodeAffinity: core.NodeAffinity

NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.agents.nodeSelector: map[string]string

NodeSelector speficies a set of selectors for nodes

Code Reference

.spec.agents.numactl.args: []string

Args define list of the numactl process

Default Value: []

Code Reference

.spec.agents.numactl.enabled: bool

Enabled define if numactl should be enabled

Default Value: false

Code Reference

.spec.agents.numactl.path: string

Path define numactl path within the container

Default Value: /usr/bin/numactl

Code Reference

.spec.agents.overrideDetectedNumberOfCores: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES Container Environment Variable

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:

Default Value: true

Code Reference

.spec.agents.overrideDetectedTotalMemory: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY Container Environment Variable

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:

Default Value: true

Code Reference

.spec.agents.podModes.network: string

Code Reference

.spec.agents.podModes.pid: string

Code Reference

.spec.agents.port: uint16

Port define Port used by member

Code Reference

.spec.agents.priorityClassName: string

PriorityClassName specifies a priority class name

Code Reference

.spec.agents.probes.livenessProbeDisabled: bool

LivenessProbeDisabled if true livenessProbes are disabled

Code Reference

.spec.agents.probes.livenessProbeSpec.failureThreshold: int32

Code Reference

.spec.agents.probes.livenessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.agents.probes.livenessProbeSpec.periodSeconds: int32

Code Reference

.spec.agents.probes.livenessProbeSpec.successThreshold: int32

Code Reference

.spec.agents.probes.livenessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.agents.probes.ReadinessProbeDisabled: bool

OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility.

Code Reference

.spec.agents.probes.readinessProbeDisabled: bool

ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility

Code Reference

.spec.agents.probes.readinessProbeSpec.failureThreshold: int32

Code Reference

.spec.agents.probes.readinessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.agents.probes.readinessProbeSpec.periodSeconds: int32

Code Reference

.spec.agents.probes.readinessProbeSpec.successThreshold: int32

Code Reference

.spec.agents.probes.readinessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.agents.probes.startupProbeDisabled: bool

StartupProbeDisabled if true startupProbes are disabled

Code Reference

.spec.agents.probes.startupProbeSpec.failureThreshold: int32

Code Reference

.spec.agents.probes.startupProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.agents.probes.startupProbeSpec.periodSeconds: int32

Code Reference

.spec.agents.probes.startupProbeSpec.successThreshold: int32

Code Reference

.spec.agents.probes.startupProbeSpec.timeoutSeconds: int32

Code Reference

.spec.agents.pvcResizeMode: string

VolumeResizeMode specified resize mode for pvc

Code Reference

.spec.agents.resources: core.ResourceRequirements

Resources holds resource requests & limits

Links:

Code Reference

.spec.agents.schedulerName: string

SchedulerName define scheduler name used for group

Code Reference

.spec.agents.securityContext.addCapabilities: []string

AddCapabilities add new capabilities to containers

Code Reference

.spec.agents.securityContext.allowPrivilegeEscalation: bool

Code Reference

.spec.agents.securityContext.dropAllCapabilities: bool

DropAllCapabilities specifies if capabilities should be dropped for this pod containers Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.

Code Reference

.spec.agents.securityContext.fsGroup: int64

Code Reference

.spec.agents.securityContext.privileged: bool

Code Reference

.spec.agents.securityContext.readOnlyRootFilesystem: bool

Code Reference

.spec.agents.securityContext.runAsGroup: int64

Code Reference

.spec.agents.securityContext.runAsNonRoot: bool

Code Reference

.spec.agents.securityContext.runAsUser: int64

Code Reference

.spec.agents.securityContext.seccompProfile: core.SeccompProfile

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Links:

Code Reference

.spec.agents.securityContext.seLinuxOptions: core.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Links:

Code Reference

.spec.agents.securityContext.supplementalGroups: []int64

Code Reference

.spec.agents.securityContext.sysctls: map[string]intstr.IntOrString

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Map Value can be String or Int

Links:

Example:

sysctls:
  "kernel.shm_rmid_forced": "0"
  "net.core.somaxconn": 1024
  "kernel.msgmax": "65536"

Code Reference

.spec.agents.serviceAccountName: string

ServiceAccountName specifies the name of the service account used for Pods in this group.

Code Reference

.spec.agents.shutdownDelay: int

ShutdownDelay define how long operator should delay finalizer removal after shutdown

Code Reference

.spec.agents.shutdownMethod: string

ShutdownMethod describe procedure of member shutdown taken by Operator

Code Reference

.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

.spec.agents.sidecars: []core.Container

Sidecars specifies a list of additional containers to be started

Links:

Code Reference

.spec.agents.storageClassName: string

StorageClassName specifies the classname for storage of the servers.

Code Reference

.spec.agents.terminationGracePeriodSeconds: int64

TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation

Code Reference

.spec.agents.tolerations: []core.Toleration

Tolerations specifies the tolerations added to Pods in this group.

Links:

Code Reference

.spec.agents.volumeAllowShrink: bool

Deprecated: VolumeAllowShrink allows shrink the volume

Code Reference

.spec.agents.volumeClaimTemplate: core.PersistentVolumeClaim

VolumeClaimTemplate specifies a template for volume claims

Links:

Code Reference

.spec.agents.volumeMounts: []ServerGroupSpecVolumeMount

VolumeMounts define list of volume mounts mounted into server container

Links:

Code Reference

.spec.agents.volumes[int].configMap: core.ConfigMapVolumeSource

ConfigMap which should be mounted into pod

Links:

Code Reference

.spec.agents.volumes[int].emptyDir: core.EmptyDirVolumeSource

EmptyDir

Links:

Code Reference

.spec.agents.volumes[int].hostPath: core.HostPathVolumeSource

HostPath

Links:

Code Reference

.spec.agents.volumes[int].name: string

Name of volume

Code Reference

.spec.agents.volumes[int].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource

PersistentVolumeClaim

Links:

Code Reference

.spec.agents.volumes[int].secret: core.SecretVolumeSource

Secret which should be mounted into pod

Links:

Code Reference

.spec.allowUnsafeUpgrade: bool

AllowUnsafeUpgrade determines if upgrade on missing member or with not in sync shards is allowed

Code Reference

.spec.annotations: map[string]string

Annotations specifies the annotations added to all ArangoDeployment owned resources (pods, services, PVCs, PDBs).

Code Reference

.spec.annotationsIgnoreList: []string

AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored

Code Reference

.spec.annotationsMode: string

AnnotationsMode defines annotations mode which should be use while overriding annotations.

Possible Values:

  • disabled (default) - Disable annotations/labels override. Default if there is no annotations/labels set in ArangoDeployment
  • append - Add new annotations/labels without affecting old ones
  • replace - Replace existing annotations/labels

Code Reference

.spec.architecture: []string

Architecture defines the list of supported architectures. First element on the list is marked as default architecture.

Links:

Default Value: ['amd64']

Code Reference

.spec.auth.jwtSecretName: string

Code Reference

.spec.bootstrap.passwordSecretNames: map[string]string

PasswordSecretNames contains a map of username to password-secret-name

Code Reference

.spec.chaos.enabled: bool

Enabled switches the chaos monkey for a deployment on or off.

Code Reference

.spec.chaos.interval: int64

Interval is the time between events

Code Reference

.spec.chaos.kill-pod-probability: int

KillPodProbability is the chance of a pod being killed during an event

Code Reference

.spec.ClusterDomain: string

ClusterDomain define domain used in the kubernetes cluster. Required only of domain is not set to default (cluster.local)

Default Value: cluster.local

Code Reference

.spec.communicationMethod: string

CommunicationMethod define communication method used in deployment

Possible Values:

  • headless (default) - Define old communication mechanism, based on headless service.
  • dns - Define ClusterIP Service DNS based communication.
  • short-dns - Define ClusterIP Service DNS based communication. Use namespaced short DNS (used in migration)
  • headless-dns - Define Headless Service DNS based communication.
  • ip - Define ClusterIP Service IP based communication.

Code Reference

.spec.coordinators.affinity: core.PodAffinity

Affinity specified additional affinity settings in ArangoDB Pod definitions

Links:

Code Reference

.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

.spec.coordinators.annotations: map[string]string

Annotations specified the annotations added to Pods in this group.

Code Reference

.spec.coordinators.annotationsIgnoreList: []string

AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored

Code Reference

.spec.coordinators.annotationsMode: string

AnnotationsMode Define annotations mode which should be use while overriding annotations

Code Reference

.spec.coordinators.antiAffinity: core.PodAntiAffinity

AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.coordinators.args: []string

Args holds additional commandline arguments

Code Reference

.spec.coordinators.count: int

Count holds the requested number of servers

Code Reference

.spec.coordinators.entrypoint: string

Entrypoint overrides container executable

Code Reference

.spec.coordinators.envs[int].name: string

Code Reference

.spec.coordinators.envs[int].value: string

Code Reference

.spec.coordinators.ephemeralVolumes.apps.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.coordinators.ephemeralVolumes.temp.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.coordinators.exporterPort: uint16

ExporterPort define Port used by exporter

Code Reference

.spec.coordinators.extendedRotationCheck: bool

ExtendedRotationCheck extend checks for rotation

Code Reference

.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

.spec.coordinators.indexMethod: string

IndexMethod define group Indexing method

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

.spec.coordinators.initContainers.containers: []core.Container

Containers contains list of containers

Links:

Code Reference

.spec.coordinators.initContainers.mode: string

Mode keep container replace mode

Code Reference

.spec.coordinators.internalPort: int

InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members

Code Reference

.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

.spec.coordinators.labels: map[string]string

Labels specified the labels added to Pods in this group.

Code Reference

.spec.coordinators.labelsIgnoreList: []string

LabelsIgnoreList list regexp or plain definitions which labels should be ignored

Code Reference

.spec.coordinators.labelsMode: string

LabelsMode Define labels mode which should be use while overriding labels

Code Reference

.spec.coordinators.maxCount: int

MaxCount specifies a upper limit for count

Code Reference

.spec.coordinators.minCount: int

MinCount specifies a lower limit for count

Code Reference

.spec.coordinators.nodeAffinity: core.NodeAffinity

NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.coordinators.nodeSelector: map[string]string

NodeSelector speficies a set of selectors for nodes

Code Reference

.spec.coordinators.numactl.args: []string

Args define list of the numactl process

Default Value: []

Code Reference

.spec.coordinators.numactl.enabled: bool

Enabled define if numactl should be enabled

Default Value: false

Code Reference

.spec.coordinators.numactl.path: string

Path define numactl path within the container

Default Value: /usr/bin/numactl

Code Reference

.spec.coordinators.overrideDetectedNumberOfCores: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES Container Environment Variable

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:

Default Value: true

Code Reference

.spec.coordinators.overrideDetectedTotalMemory: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY Container Environment Variable

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:

Default Value: true

Code Reference

.spec.coordinators.podModes.network: string

Code Reference

.spec.coordinators.podModes.pid: string

Code Reference

.spec.coordinators.port: uint16

Port define Port used by member

Code Reference

.spec.coordinators.priorityClassName: string

PriorityClassName specifies a priority class name

Code Reference

.spec.coordinators.probes.livenessProbeDisabled: bool

LivenessProbeDisabled if true livenessProbes are disabled

Code Reference

.spec.coordinators.probes.livenessProbeSpec.failureThreshold: int32

Code Reference

.spec.coordinators.probes.livenessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.coordinators.probes.livenessProbeSpec.periodSeconds: int32

Code Reference

.spec.coordinators.probes.livenessProbeSpec.successThreshold: int32

Code Reference

.spec.coordinators.probes.livenessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.coordinators.probes.ReadinessProbeDisabled: bool

OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility.

Code Reference

.spec.coordinators.probes.readinessProbeDisabled: bool

ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility

Code Reference

.spec.coordinators.probes.readinessProbeSpec.failureThreshold: int32

Code Reference

.spec.coordinators.probes.readinessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.coordinators.probes.readinessProbeSpec.periodSeconds: int32

Code Reference

.spec.coordinators.probes.readinessProbeSpec.successThreshold: int32

Code Reference

.spec.coordinators.probes.readinessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.coordinators.probes.startupProbeDisabled: bool

StartupProbeDisabled if true startupProbes are disabled

Code Reference

.spec.coordinators.probes.startupProbeSpec.failureThreshold: int32

Code Reference

.spec.coordinators.probes.startupProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.coordinators.probes.startupProbeSpec.periodSeconds: int32

Code Reference

.spec.coordinators.probes.startupProbeSpec.successThreshold: int32

Code Reference

.spec.coordinators.probes.startupProbeSpec.timeoutSeconds: int32

Code Reference

.spec.coordinators.pvcResizeMode: string

VolumeResizeMode specified resize mode for pvc

Code Reference

.spec.coordinators.resources: core.ResourceRequirements

Resources holds resource requests & limits

Links:

Code Reference

.spec.coordinators.schedulerName: string

SchedulerName define scheduler name used for group

Code Reference

.spec.coordinators.securityContext.addCapabilities: []string

AddCapabilities add new capabilities to containers

Code Reference

.spec.coordinators.securityContext.allowPrivilegeEscalation: bool

Code Reference

.spec.coordinators.securityContext.dropAllCapabilities: bool

DropAllCapabilities specifies if capabilities should be dropped for this pod containers Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.

Code Reference

.spec.coordinators.securityContext.fsGroup: int64

Code Reference

.spec.coordinators.securityContext.privileged: bool

Code Reference

.spec.coordinators.securityContext.readOnlyRootFilesystem: bool

Code Reference

.spec.coordinators.securityContext.runAsGroup: int64

Code Reference

.spec.coordinators.securityContext.runAsNonRoot: bool

Code Reference

.spec.coordinators.securityContext.runAsUser: int64

Code Reference

.spec.coordinators.securityContext.seccompProfile: core.SeccompProfile

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Links:

Code Reference

.spec.coordinators.securityContext.seLinuxOptions: core.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Links:

Code Reference

.spec.coordinators.securityContext.supplementalGroups: []int64

Code Reference

.spec.coordinators.securityContext.sysctls: map[string]intstr.IntOrString

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Map Value can be String or Int

Links:

Example:

sysctls:
  "kernel.shm_rmid_forced": "0"
  "net.core.somaxconn": 1024
  "kernel.msgmax": "65536"

Code Reference

.spec.coordinators.serviceAccountName: string

ServiceAccountName specifies the name of the service account used for Pods in this group.

Code Reference

.spec.coordinators.shutdownDelay: int

ShutdownDelay define how long operator should delay finalizer removal after shutdown

Code Reference

.spec.coordinators.shutdownMethod: string

ShutdownMethod describe procedure of member shutdown taken by Operator

Code Reference

.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

.spec.coordinators.sidecars: []core.Container

Sidecars specifies a list of additional containers to be started

Links:

Code Reference

.spec.coordinators.storageClassName: string

StorageClassName specifies the classname for storage of the servers.

Code Reference

.spec.coordinators.terminationGracePeriodSeconds: int64

TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation

Code Reference

.spec.coordinators.tolerations: []core.Toleration

Tolerations specifies the tolerations added to Pods in this group.

Links:

Code Reference

.spec.coordinators.volumeAllowShrink: bool

Deprecated: VolumeAllowShrink allows shrink the volume

Code Reference

.spec.coordinators.volumeClaimTemplate: core.PersistentVolumeClaim

VolumeClaimTemplate specifies a template for volume claims

Links:

Code Reference

.spec.coordinators.volumeMounts: []ServerGroupSpecVolumeMount

VolumeMounts define list of volume mounts mounted into server container

Links:

Code Reference

.spec.coordinators.volumes[int].configMap: core.ConfigMapVolumeSource

ConfigMap which should be mounted into pod

Links:

Code Reference

.spec.coordinators.volumes[int].emptyDir: core.EmptyDirVolumeSource

EmptyDir

Links:

Code Reference

.spec.coordinators.volumes[int].hostPath: core.HostPathVolumeSource

HostPath

Links:

Code Reference

.spec.coordinators.volumes[int].name: string

Name of volume

Code Reference

.spec.coordinators.volumes[int].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource

PersistentVolumeClaim

Links:

Code Reference

.spec.coordinators.volumes[int].secret: core.SecretVolumeSource

Secret which should be mounted into pod

Links:

Code Reference

.spec.database.maintenance: bool

Maintenance manage maintenance mode on Cluster side. Requires maintenance feature to be enabled

Code Reference

.spec.dbservers.affinity: core.PodAffinity

Affinity specified additional affinity settings in ArangoDB Pod definitions

Links:

Code Reference

.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

.spec.dbservers.annotations: map[string]string

Annotations specified the annotations added to Pods in this group.

Code Reference

.spec.dbservers.annotationsIgnoreList: []string

AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored

Code Reference

.spec.dbservers.annotationsMode: string

AnnotationsMode Define annotations mode which should be use while overriding annotations

Code Reference

.spec.dbservers.antiAffinity: core.PodAntiAffinity

AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.dbservers.args: []string

Args holds additional commandline arguments

Code Reference

.spec.dbservers.count: int

Count holds the requested number of servers

Code Reference

.spec.dbservers.entrypoint: string

Entrypoint overrides container executable

Code Reference

.spec.dbservers.envs[int].name: string

Code Reference

.spec.dbservers.envs[int].value: string

Code Reference

.spec.dbservers.ephemeralVolumes.apps.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.dbservers.ephemeralVolumes.temp.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.dbservers.exporterPort: uint16

ExporterPort define Port used by exporter

Code Reference

.spec.dbservers.extendedRotationCheck: bool

ExtendedRotationCheck extend checks for rotation

Code Reference

.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

.spec.dbservers.indexMethod: string

IndexMethod define group Indexing method

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

.spec.dbservers.initContainers.containers: []core.Container

Containers contains list of containers

Links:

Code Reference

.spec.dbservers.initContainers.mode: string

Mode keep container replace mode

Code Reference

.spec.dbservers.internalPort: int

InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members

Code Reference

.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

.spec.dbservers.labels: map[string]string

Labels specified the labels added to Pods in this group.

Code Reference

.spec.dbservers.labelsIgnoreList: []string

LabelsIgnoreList list regexp or plain definitions which labels should be ignored

Code Reference

.spec.dbservers.labelsMode: string

LabelsMode Define labels mode which should be use while overriding labels

Code Reference

.spec.dbservers.maxCount: int

MaxCount specifies a upper limit for count

Code Reference

.spec.dbservers.minCount: int

MinCount specifies a lower limit for count

Code Reference

.spec.dbservers.nodeAffinity: core.NodeAffinity

NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.dbservers.nodeSelector: map[string]string

NodeSelector speficies a set of selectors for nodes

Code Reference

.spec.dbservers.numactl.args: []string

Args define list of the numactl process

Default Value: []

Code Reference

.spec.dbservers.numactl.enabled: bool

Enabled define if numactl should be enabled

Default Value: false

Code Reference

.spec.dbservers.numactl.path: string

Path define numactl path within the container

Default Value: /usr/bin/numactl

Code Reference

.spec.dbservers.overrideDetectedNumberOfCores: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES Container Environment Variable

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:

Default Value: true

Code Reference

.spec.dbservers.overrideDetectedTotalMemory: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY Container Environment Variable

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:

Default Value: true

Code Reference

.spec.dbservers.podModes.network: string

Code Reference

.spec.dbservers.podModes.pid: string

Code Reference

.spec.dbservers.port: uint16

Port define Port used by member

Code Reference

.spec.dbservers.priorityClassName: string

PriorityClassName specifies a priority class name

Code Reference

.spec.dbservers.probes.livenessProbeDisabled: bool

LivenessProbeDisabled if true livenessProbes are disabled

Code Reference

.spec.dbservers.probes.livenessProbeSpec.failureThreshold: int32

Code Reference

.spec.dbservers.probes.livenessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.dbservers.probes.livenessProbeSpec.periodSeconds: int32

Code Reference

.spec.dbservers.probes.livenessProbeSpec.successThreshold: int32

Code Reference

.spec.dbservers.probes.livenessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.dbservers.probes.ReadinessProbeDisabled: bool

OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility.

Code Reference

.spec.dbservers.probes.readinessProbeDisabled: bool

ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility

Code Reference

.spec.dbservers.probes.readinessProbeSpec.failureThreshold: int32

Code Reference

.spec.dbservers.probes.readinessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.dbservers.probes.readinessProbeSpec.periodSeconds: int32

Code Reference

.spec.dbservers.probes.readinessProbeSpec.successThreshold: int32

Code Reference

.spec.dbservers.probes.readinessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.dbservers.probes.startupProbeDisabled: bool

StartupProbeDisabled if true startupProbes are disabled

Code Reference

.spec.dbservers.probes.startupProbeSpec.failureThreshold: int32

Code Reference

.spec.dbservers.probes.startupProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.dbservers.probes.startupProbeSpec.periodSeconds: int32

Code Reference

.spec.dbservers.probes.startupProbeSpec.successThreshold: int32

Code Reference

.spec.dbservers.probes.startupProbeSpec.timeoutSeconds: int32

Code Reference

.spec.dbservers.pvcResizeMode: string

VolumeResizeMode specified resize mode for pvc

Code Reference

.spec.dbservers.resources: core.ResourceRequirements

Resources holds resource requests & limits

Links:

Code Reference

.spec.dbservers.schedulerName: string

SchedulerName define scheduler name used for group

Code Reference

.spec.dbservers.securityContext.addCapabilities: []string

AddCapabilities add new capabilities to containers

Code Reference

.spec.dbservers.securityContext.allowPrivilegeEscalation: bool

Code Reference

.spec.dbservers.securityContext.dropAllCapabilities: bool

DropAllCapabilities specifies if capabilities should be dropped for this pod containers Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.

Code Reference

.spec.dbservers.securityContext.fsGroup: int64

Code Reference

.spec.dbservers.securityContext.privileged: bool

Code Reference

.spec.dbservers.securityContext.readOnlyRootFilesystem: bool

Code Reference

.spec.dbservers.securityContext.runAsGroup: int64

Code Reference

.spec.dbservers.securityContext.runAsNonRoot: bool

Code Reference

.spec.dbservers.securityContext.runAsUser: int64

Code Reference

.spec.dbservers.securityContext.seccompProfile: core.SeccompProfile

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Links:

Code Reference

.spec.dbservers.securityContext.seLinuxOptions: core.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Links:

Code Reference

.spec.dbservers.securityContext.supplementalGroups: []int64

Code Reference

.spec.dbservers.securityContext.sysctls: map[string]intstr.IntOrString

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Map Value can be String or Int

Links:

Example:

sysctls:
  "kernel.shm_rmid_forced": "0"
  "net.core.somaxconn": 1024
  "kernel.msgmax": "65536"

Code Reference

.spec.dbservers.serviceAccountName: string

ServiceAccountName specifies the name of the service account used for Pods in this group.

Code Reference

.spec.dbservers.shutdownDelay: int

ShutdownDelay define how long operator should delay finalizer removal after shutdown

Code Reference

.spec.dbservers.shutdownMethod: string

ShutdownMethod describe procedure of member shutdown taken by Operator

Code Reference

.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

.spec.dbservers.sidecars: []core.Container

Sidecars specifies a list of additional containers to be started

Links:

Code Reference

.spec.dbservers.storageClassName: string

StorageClassName specifies the classname for storage of the servers.

Code Reference

.spec.dbservers.terminationGracePeriodSeconds: int64

TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation

Code Reference

.spec.dbservers.tolerations: []core.Toleration

Tolerations specifies the tolerations added to Pods in this group.

Links:

Code Reference

.spec.dbservers.volumeAllowShrink: bool

Deprecated: VolumeAllowShrink allows shrink the volume

Code Reference

.spec.dbservers.volumeClaimTemplate: core.PersistentVolumeClaim

VolumeClaimTemplate specifies a template for volume claims

Links:

Code Reference

.spec.dbservers.volumeMounts: []ServerGroupSpecVolumeMount

VolumeMounts define list of volume mounts mounted into server container

Links:

Code Reference

.spec.dbservers.volumes[int].configMap: core.ConfigMapVolumeSource

ConfigMap which should be mounted into pod

Links:

Code Reference

.spec.dbservers.volumes[int].emptyDir: core.EmptyDirVolumeSource

EmptyDir

Links:

Code Reference

.spec.dbservers.volumes[int].hostPath: core.HostPathVolumeSource

HostPath

Links:

Code Reference

.spec.dbservers.volumes[int].name: string

Name of volume

Code Reference

.spec.dbservers.volumes[int].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource

PersistentVolumeClaim

Links:

Code Reference

.spec.dbservers.volumes[int].secret: core.SecretVolumeSource

Secret which should be mounted into pod

Links:

Code Reference

.spec.disableIPv6: bool

DisableIPv6 setting prevents the use of IPv6 addresses by ArangoDB servers. This setting cannot be changed after the deployment has been created.

Default Value: false

Code Reference

.spec.downtimeAllowed: bool

DowntimeAllowed setting is used to allow automatic reconciliation actions that yield some downtime of the ArangoDB deployment. When this setting is set to false, no automatic action that may result in downtime is allowed. If the need for such an action is detected, an event is added to the ArangoDeployment. Once this setting is set to true, the automatic action is executed. Operations that may result in downtime are:

  • Rotating TLS CA certificate Note: It is still possible that there is some downtime when the Kubernetes cluster is down, or in a bad state, irrespective of the value of this setting.

Default Value: false

Code Reference

.spec.environment: string

Environment setting specifies the type of environment in which the deployment is created.

Possible Values:

  • Development (default) - This value optimizes the deployment for development use. It is possible to run a deployment on a small number of nodes (e.g. minikube).
  • Production - This value optimizes the deployment for production use. It puts required affinity constraints on all pods to avoid Agents & DB-Servers from running on the same machine.

Code Reference

.spec.externalAccess.advertisedEndpoint: string

AdvertisedEndpoint is passed to the coordinators/single servers for advertising a specific endpoint

Code Reference

.spec.externalAccess.loadBalancerIP: string

LoadBalancerIP define optional IP used to configure a load-balancer on, in case of Auto or LoadBalancer type.

Code Reference

.spec.externalAccess.loadBalancerSourceRanges: []string

LoadBalancerSourceRanges define LoadBalancerSourceRanges used for LoadBalancer Service type If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.

Links:

Code Reference

.spec.externalAccess.managedServiceNames: []string

ManagedServiceNames keeps names of services which are not managed by KubeArangoDB. It is only relevant when type of service is managed.

Code Reference

.spec.externalAccess.nodePort: int

NodePort define optional port used in case of Auto or NodePort type.

Code Reference

.spec.externalAccess.type: string

Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster.

Possible Values:

  • Auto (default) - Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
  • None - limit access to application running inside the Kubernetes cluster.
  • LoadBalancer - Create a Service of type LoadBalancer for the ArangoDB deployment.
  • NodePort - Create a Service of type NodePort for the ArangoDB deployment.

Code Reference

.spec.features.foxx.queues: bool

Code Reference

.spec.id.affinity: core.PodAffinity

Affinity specified additional affinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.id.antiAffinity: core.PodAntiAffinity

AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.id.entrypoint: string

Entrypoint overrides container executable

Code Reference

.spec.id.nodeAffinity: core.NodeAffinity

NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.id.nodeSelector: map[string]string

NodeSelector speficies a set of selectors for nodes

Code Reference

.spec.id.priorityClassName: string

PriorityClassName specifies a priority class name

Code Reference

.spec.id.resources: core.ResourceRequirements

Resources holds resource requests & limits

Links:

Code Reference

.spec.id.securityContext.addCapabilities: []string

AddCapabilities add new capabilities to containers

Code Reference

.spec.id.securityContext.allowPrivilegeEscalation: bool

Code Reference

.spec.id.securityContext.dropAllCapabilities: bool

DropAllCapabilities specifies if capabilities should be dropped for this pod containers Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.

Code Reference

.spec.id.securityContext.fsGroup: int64

Code Reference

.spec.id.securityContext.privileged: bool

Code Reference

.spec.id.securityContext.readOnlyRootFilesystem: bool

Code Reference

.spec.id.securityContext.runAsGroup: int64

Code Reference

.spec.id.securityContext.runAsNonRoot: bool

Code Reference

.spec.id.securityContext.runAsUser: int64

Code Reference

.spec.id.securityContext.seccompProfile: core.SeccompProfile

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Links:

Code Reference

.spec.id.securityContext.seLinuxOptions: core.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Links:

Code Reference

.spec.id.securityContext.supplementalGroups: []int64

Code Reference

.spec.id.securityContext.sysctls: map[string]intstr.IntOrString

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Map Value can be String or Int

Links:

Example:

sysctls:
  "kernel.shm_rmid_forced": "0"
  "net.core.somaxconn": 1024
  "kernel.msgmax": "65536"

Code Reference

.spec.id.serviceAccountName: string

ServiceAccountName specifies the name of the service account used for Pods in this group.

Code Reference

.spec.id.tolerations: []core.Toleration

Tolerations specifies the tolerations added to Pods in this group.

Links:

Code Reference

.spec.image: string

Image specifies the docker image to use for all ArangoDB servers. In a development environment this setting defaults to arangodb/arangodb:latest. For production environments this is a required setting without a default value. It is highly recommend to use explicit version (not latest) for production environments.

Code Reference

.spec.imageDiscoveryMode: string

ImageDiscoveryMode specifies the image discovery mode.

Possible Values:

  • kubelet (default) - Use sha256 of the discovered image in the pods
  • direct - Use image provided in the spec.image directly in the pods

Code Reference

.spec.imagePullPolicy: core.PullPolicy

ImagePullPolicy specifies the pull policy for the docker image to use for all ArangoDB servers.

Links:

Possible Values:

  • Always (default) - Means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
  • Never - Means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
  • IfNotPresent - Means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.

Code Reference

.spec.imagePullSecrets: []string

ImagePullSecrets specifies the list of image pull secrets for the docker image to use for all ArangoDB servers.

Code Reference

.spec.labels: map[string]string

Labels specifies the labels added to Pods in this group.

Code Reference

.spec.labelsIgnoreList: []string

LabelsIgnoreList list regexp or plain definitions which labels should be ignored

Code Reference

.spec.labelsMode: string

LabelsMode Define labels mode which should be use while overriding labels

Possible Values:

  • disabled (default) - Disable annotations/labels override. Default if there is no annotations/labels set in ArangoDeployment
  • append - Add new annotations/labels without affecting old ones
  • replace - Replace existing annotations/labels

Code Reference

.spec.license.secretName: string

Code Reference

.spec.lifecycle.resources: core.ResourceRequirements

Resources holds resource requests & limits

Links:

Code Reference

.spec.memberPropagationMode: string

MemberPropagationMode defines how changes to pod spec should be propogated. Changes to a pods configuration require a restart of that pod in almost all cases. Pods are restarted eagerly by default, which can cause more restarts than desired, especially when updating arangod as well as the operator. The propagation of the configuration changes can be deferred to the next restart, either triggered manually by the user or by another operation like an upgrade. This reduces the number of restarts for upgrading both the server and the operator from two to one.

Possible Values:

  • always (default) - Restart the member as soon as a configuration change is discovered
  • on-restart - Wait until the next restart to change the member configuration

Code Reference

.spec.metrics.authentication.jwtTokenSecretName: string

JWTTokenSecretName contains the name of the JWT kubernetes secret used for authentication

Code Reference

.spec.metrics.enabled: bool

Code Reference

.spec.metrics.image: string

deprecated

Code Reference

.spec.metrics.mode: string

deprecated

Code Reference

.spec.metrics.port: uint16

Code Reference

.spec.metrics.resources: core.ResourceRequirements

Resources holds resource requests & limits

Links:

Code Reference

.spec.metrics.serviceMonitor.enabled: bool

Code Reference

.spec.metrics.serviceMonitor.labels: map[string]string

Code Reference

.spec.metrics.tls: bool

Code Reference

.spec.mode: string

Mode specifies the type of ArangoDB deployment to create.

Possible Values:

  • Cluster (default) - Full cluster. Defaults to 3 Agents, 3 DB-Servers & 3 Coordinators.
  • ActiveFailover - Active-failover single pair. Defaults to 3 Agents and 2 single servers.
  • Single - Single server only (note this does not provide high availability or reliability).

This field is immutable: Change of the ArangoDeployment Mode is not possible after creation.

Code Reference

.spec.networkAttachedVolumes: bool

NetworkAttachedVolumes If set to true, a ResignLeadership operation will be triggered when a DB-Server pod is evicted (rather than a CleanOutServer operation). Furthermore, the pod will simply be redeployed on a different node, rather than cleaned and retired and replaced by a new member. You must only set this option to true if your persistent volumes are “movable” in the sense that they can be mounted from a different k8s node, like in the case of network attached volumes. If your persistent volumes are tied to a specific pod, you must leave this option on false.

Default Value: true

Code Reference

.spec.rebalancer.enabled: bool

Code Reference

.spec.rebalancer.optimizers.leader: bool

Code Reference

.spec.rebalancer.parallelMoves: int

Code Reference

.spec.rebalancer.readers.count: bool

deprecated does not work in Rebalancer V2 Count Enable Shard Count machanism

Code Reference

.spec.recovery.autoRecover: bool

Code Reference

.spec.restoreEncryptionSecret: string

RestoreEncryptionSecret specifies optional name of secret which contains encryption key used for restore

Code Reference

.spec.restoreFrom: string

RestoreFrom setting specifies a ArangoBackup resource name the cluster should be restored from. After a restore or failure to do so, the status of the deployment contains information about the restore operation in the restore key. It will contain some of the following fields:

  • requestedFrom: name of the ArangoBackup used to restore from.
  • message: optional message explaining why the restore failed.
  • state: state indicating if the restore was successful or not. Possible values: Restoring, Restored, RestoreFailed If the restoreFrom key is removed from the spec, the restore key is deleted as well. A new restore attempt is made if and only if either in the status restore is not set or if spec.restoreFrom and status.requestedFrom are different.

Code Reference

.spec.rocksdb.encryption.keySecretName: string

Code Reference

.spec.single.affinity: core.PodAffinity

Affinity specified additional affinity settings in ArangoDB Pod definitions

Links:

Code Reference

.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

.spec.single.annotations: map[string]string

Annotations specified the annotations added to Pods in this group.

Code Reference

.spec.single.annotationsIgnoreList: []string

AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored

Code Reference

.spec.single.annotationsMode: string

AnnotationsMode Define annotations mode which should be use while overriding annotations

Code Reference

.spec.single.antiAffinity: core.PodAntiAffinity

AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.single.args: []string

Args holds additional commandline arguments

Code Reference

.spec.single.count: int

Count holds the requested number of servers

Code Reference

.spec.single.entrypoint: string

Entrypoint overrides container executable

Code Reference

.spec.single.envs[int].name: string

Code Reference

.spec.single.envs[int].value: string

Code Reference

.spec.single.ephemeralVolumes.apps.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.single.ephemeralVolumes.temp.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.single.exporterPort: uint16

ExporterPort define Port used by exporter

Code Reference

.spec.single.extendedRotationCheck: bool

ExtendedRotationCheck extend checks for rotation

Code Reference

.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

.spec.single.indexMethod: string

IndexMethod define group Indexing method

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

.spec.single.initContainers.containers: []core.Container

Containers contains list of containers

Links:

Code Reference

.spec.single.initContainers.mode: string

Mode keep container replace mode

Code Reference

.spec.single.internalPort: int

InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members

Code Reference

.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

.spec.single.labels: map[string]string

Labels specified the labels added to Pods in this group.

Code Reference

.spec.single.labelsIgnoreList: []string

LabelsIgnoreList list regexp or plain definitions which labels should be ignored

Code Reference

.spec.single.labelsMode: string

LabelsMode Define labels mode which should be use while overriding labels

Code Reference

.spec.single.maxCount: int

MaxCount specifies a upper limit for count

Code Reference

.spec.single.minCount: int

MinCount specifies a lower limit for count

Code Reference

.spec.single.nodeAffinity: core.NodeAffinity

NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.single.nodeSelector: map[string]string

NodeSelector speficies a set of selectors for nodes

Code Reference

.spec.single.numactl.args: []string

Args define list of the numactl process

Default Value: []

Code Reference

.spec.single.numactl.enabled: bool

Enabled define if numactl should be enabled

Default Value: false

Code Reference

.spec.single.numactl.path: string

Path define numactl path within the container

Default Value: /usr/bin/numactl

Code Reference

.spec.single.overrideDetectedNumberOfCores: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES Container Environment Variable

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:

Default Value: true

Code Reference

.spec.single.overrideDetectedTotalMemory: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY Container Environment Variable

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:

Default Value: true

Code Reference

.spec.single.podModes.network: string

Code Reference

.spec.single.podModes.pid: string

Code Reference

.spec.single.port: uint16

Port define Port used by member

Code Reference

.spec.single.priorityClassName: string

PriorityClassName specifies a priority class name

Code Reference

.spec.single.probes.livenessProbeDisabled: bool

LivenessProbeDisabled if true livenessProbes are disabled

Code Reference

.spec.single.probes.livenessProbeSpec.failureThreshold: int32

Code Reference

.spec.single.probes.livenessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.single.probes.livenessProbeSpec.periodSeconds: int32

Code Reference

.spec.single.probes.livenessProbeSpec.successThreshold: int32

Code Reference

.spec.single.probes.livenessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.single.probes.ReadinessProbeDisabled: bool

OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility.

Code Reference

.spec.single.probes.readinessProbeDisabled: bool

ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility

Code Reference

.spec.single.probes.readinessProbeSpec.failureThreshold: int32

Code Reference

.spec.single.probes.readinessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.single.probes.readinessProbeSpec.periodSeconds: int32

Code Reference

.spec.single.probes.readinessProbeSpec.successThreshold: int32

Code Reference

.spec.single.probes.readinessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.single.probes.startupProbeDisabled: bool

StartupProbeDisabled if true startupProbes are disabled

Code Reference

.spec.single.probes.startupProbeSpec.failureThreshold: int32

Code Reference

.spec.single.probes.startupProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.single.probes.startupProbeSpec.periodSeconds: int32

Code Reference

.spec.single.probes.startupProbeSpec.successThreshold: int32

Code Reference

.spec.single.probes.startupProbeSpec.timeoutSeconds: int32

Code Reference

.spec.single.pvcResizeMode: string

VolumeResizeMode specified resize mode for pvc

Code Reference

.spec.single.resources: core.ResourceRequirements

Resources holds resource requests & limits

Links:

Code Reference

.spec.single.schedulerName: string

SchedulerName define scheduler name used for group

Code Reference

.spec.single.securityContext.addCapabilities: []string

AddCapabilities add new capabilities to containers

Code Reference

.spec.single.securityContext.allowPrivilegeEscalation: bool

Code Reference

.spec.single.securityContext.dropAllCapabilities: bool

DropAllCapabilities specifies if capabilities should be dropped for this pod containers Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.

Code Reference

.spec.single.securityContext.fsGroup: int64

Code Reference

.spec.single.securityContext.privileged: bool

Code Reference

.spec.single.securityContext.readOnlyRootFilesystem: bool

Code Reference

.spec.single.securityContext.runAsGroup: int64

Code Reference

.spec.single.securityContext.runAsNonRoot: bool

Code Reference

.spec.single.securityContext.runAsUser: int64

Code Reference

.spec.single.securityContext.seccompProfile: core.SeccompProfile

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Links:

Code Reference

.spec.single.securityContext.seLinuxOptions: core.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Links:

Code Reference

.spec.single.securityContext.supplementalGroups: []int64

Code Reference

.spec.single.securityContext.sysctls: map[string]intstr.IntOrString

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Map Value can be String or Int

Links:

Example:

sysctls:
  "kernel.shm_rmid_forced": "0"
  "net.core.somaxconn": 1024
  "kernel.msgmax": "65536"

Code Reference

.spec.single.serviceAccountName: string

ServiceAccountName specifies the name of the service account used for Pods in this group.

Code Reference

.spec.single.shutdownDelay: int

ShutdownDelay define how long operator should delay finalizer removal after shutdown

Code Reference

.spec.single.shutdownMethod: string

ShutdownMethod describe procedure of member shutdown taken by Operator

Code Reference

.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

.spec.single.sidecars: []core.Container

Sidecars specifies a list of additional containers to be started

Links:

Code Reference

.spec.single.storageClassName: string

StorageClassName specifies the classname for storage of the servers.

Code Reference

.spec.single.terminationGracePeriodSeconds: int64

TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation

Code Reference

.spec.single.tolerations: []core.Toleration

Tolerations specifies the tolerations added to Pods in this group.

Links:

Code Reference

.spec.single.volumeAllowShrink: bool

Deprecated: VolumeAllowShrink allows shrink the volume

Code Reference

.spec.single.volumeClaimTemplate: core.PersistentVolumeClaim

VolumeClaimTemplate specifies a template for volume claims

Links:

Code Reference

.spec.single.volumeMounts: []ServerGroupSpecVolumeMount

VolumeMounts define list of volume mounts mounted into server container

Links:

Code Reference

.spec.single.volumes[int].configMap: core.ConfigMapVolumeSource

ConfigMap which should be mounted into pod

Links:

Code Reference

.spec.single.volumes[int].emptyDir: core.EmptyDirVolumeSource

EmptyDir

Links:

Code Reference

.spec.single.volumes[int].hostPath: core.HostPathVolumeSource

HostPath

Links:

Code Reference

.spec.single.volumes[int].name: string

Name of volume

Code Reference

.spec.single.volumes[int].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource

PersistentVolumeClaim

Links:

Code Reference

.spec.single.volumes[int].secret: core.SecretVolumeSource

Secret which should be mounted into pod

Links:

Code Reference

.spec.storageEngine: string

StorageEngine specifies the type of storage engine used for all servers in the cluster. This setting cannot be changed after the cluster has been created.

Possible Values:

  • RocksDB (default) - To use the RocksDB storage engine.
  • MMFiles - To use the MMFiles storage engine. Deprecated.

Code Reference

.spec.sync.auth.clientCASecretName: string

Code Reference

.spec.sync.auth.jwtSecretName: string

Code Reference

.spec.sync.enabled: bool

Code Reference

.spec.sync.externalAccess.accessPackageSecretNames: []string

Code Reference

.spec.sync.externalAccess.advertisedEndpoint: string

AdvertisedEndpoint is passed to the coordinators/single servers for advertising a specific endpoint

Code Reference

.spec.sync.externalAccess.loadBalancerIP: string

LoadBalancerIP define optional IP used to configure a load-balancer on, in case of Auto or LoadBalancer type.

Code Reference

.spec.sync.externalAccess.loadBalancerSourceRanges: []string

LoadBalancerSourceRanges define LoadBalancerSourceRanges used for LoadBalancer Service type If specified and supported by the platform, this will restrict traffic through the cloud-provider load-balancer will be restricted to the specified client IPs. This field will be ignored if the cloud-provider does not support the feature.

Links:

Code Reference

.spec.sync.externalAccess.managedServiceNames: []string

ManagedServiceNames keeps names of services which are not managed by KubeArangoDB. It is only relevant when type of service is managed.

Code Reference

.spec.sync.externalAccess.masterEndpoint: []string

Code Reference

.spec.sync.externalAccess.nodePort: int

NodePort define optional port used in case of Auto or NodePort type.

Code Reference

.spec.sync.externalAccess.type: string

Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster.

Possible Values:

  • Auto (default) - Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
  • None - limit access to application running inside the Kubernetes cluster.
  • LoadBalancer - Create a Service of type LoadBalancer for the ArangoDB deployment.
  • NodePort - Create a Service of type NodePort for the ArangoDB deployment.

Code Reference

.spec.sync.image: string

Code Reference

.spec.sync.monitoring.tokenSecretName: string

Code Reference

.spec.sync.tls.altNames: []string

Code Reference

.spec.sync.tls.caSecretName: string

Code Reference

.spec.sync.tls.mode: string

Code Reference

.spec.sync.tls.sni.mapping.<string>: []string

Code Reference

.spec.sync.tls.ttl: string

Code Reference

.spec.syncmasters.affinity: core.PodAffinity

Affinity specified additional affinity settings in ArangoDB Pod definitions

Links:

Code Reference

.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

.spec.syncmasters.annotations: map[string]string

Annotations specified the annotations added to Pods in this group.

Code Reference

.spec.syncmasters.annotationsIgnoreList: []string

AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored

Code Reference

.spec.syncmasters.annotationsMode: string

AnnotationsMode Define annotations mode which should be use while overriding annotations

Code Reference

.spec.syncmasters.antiAffinity: core.PodAntiAffinity

AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.syncmasters.args: []string

Args holds additional commandline arguments

Code Reference

.spec.syncmasters.count: int

Count holds the requested number of servers

Code Reference

.spec.syncmasters.entrypoint: string

Entrypoint overrides container executable

Code Reference

.spec.syncmasters.envs[int].name: string

Code Reference

.spec.syncmasters.envs[int].value: string

Code Reference

.spec.syncmasters.ephemeralVolumes.apps.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.syncmasters.ephemeralVolumes.temp.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.syncmasters.exporterPort: uint16

ExporterPort define Port used by exporter

Code Reference

.spec.syncmasters.extendedRotationCheck: bool

ExtendedRotationCheck extend checks for rotation

Code Reference

.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

.spec.syncmasters.indexMethod: string

IndexMethod define group Indexing method

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

.spec.syncmasters.initContainers.containers: []core.Container

Containers contains list of containers

Links:

Code Reference

.spec.syncmasters.initContainers.mode: string

Mode keep container replace mode

Code Reference

.spec.syncmasters.internalPort: int

InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members

Code Reference

.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

.spec.syncmasters.labels: map[string]string

Labels specified the labels added to Pods in this group.

Code Reference

.spec.syncmasters.labelsIgnoreList: []string

LabelsIgnoreList list regexp or plain definitions which labels should be ignored

Code Reference

.spec.syncmasters.labelsMode: string

LabelsMode Define labels mode which should be use while overriding labels

Code Reference

.spec.syncmasters.maxCount: int

MaxCount specifies a upper limit for count

Code Reference

.spec.syncmasters.minCount: int

MinCount specifies a lower limit for count

Code Reference

.spec.syncmasters.nodeAffinity: core.NodeAffinity

NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.syncmasters.nodeSelector: map[string]string

NodeSelector speficies a set of selectors for nodes

Code Reference

.spec.syncmasters.numactl.args: []string

Args define list of the numactl process

Default Value: []

Code Reference

.spec.syncmasters.numactl.enabled: bool

Enabled define if numactl should be enabled

Default Value: false

Code Reference

.spec.syncmasters.numactl.path: string

Path define numactl path within the container

Default Value: /usr/bin/numactl

Code Reference

.spec.syncmasters.overrideDetectedNumberOfCores: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES Container Environment Variable

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:

Default Value: true

Code Reference

.spec.syncmasters.overrideDetectedTotalMemory: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY Container Environment Variable

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:

Default Value: true

Code Reference

.spec.syncmasters.podModes.network: string

Code Reference

.spec.syncmasters.podModes.pid: string

Code Reference

.spec.syncmasters.port: uint16

Port define Port used by member

Code Reference

.spec.syncmasters.priorityClassName: string

PriorityClassName specifies a priority class name

Code Reference

.spec.syncmasters.probes.livenessProbeDisabled: bool

LivenessProbeDisabled if true livenessProbes are disabled

Code Reference

.spec.syncmasters.probes.livenessProbeSpec.failureThreshold: int32

Code Reference

.spec.syncmasters.probes.livenessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.syncmasters.probes.livenessProbeSpec.periodSeconds: int32

Code Reference

.spec.syncmasters.probes.livenessProbeSpec.successThreshold: int32

Code Reference

.spec.syncmasters.probes.livenessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.syncmasters.probes.ReadinessProbeDisabled: bool

OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility.

Code Reference

.spec.syncmasters.probes.readinessProbeDisabled: bool

ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility

Code Reference

.spec.syncmasters.probes.readinessProbeSpec.failureThreshold: int32

Code Reference

.spec.syncmasters.probes.readinessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.syncmasters.probes.readinessProbeSpec.periodSeconds: int32

Code Reference

.spec.syncmasters.probes.readinessProbeSpec.successThreshold: int32

Code Reference

.spec.syncmasters.probes.readinessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.syncmasters.probes.startupProbeDisabled: bool

StartupProbeDisabled if true startupProbes are disabled

Code Reference

.spec.syncmasters.probes.startupProbeSpec.failureThreshold: int32

Code Reference

.spec.syncmasters.probes.startupProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.syncmasters.probes.startupProbeSpec.periodSeconds: int32

Code Reference

.spec.syncmasters.probes.startupProbeSpec.successThreshold: int32

Code Reference

.spec.syncmasters.probes.startupProbeSpec.timeoutSeconds: int32

Code Reference

.spec.syncmasters.pvcResizeMode: string

VolumeResizeMode specified resize mode for pvc

Code Reference

.spec.syncmasters.resources: core.ResourceRequirements

Resources holds resource requests & limits

Links:

Code Reference

.spec.syncmasters.schedulerName: string

SchedulerName define scheduler name used for group

Code Reference

.spec.syncmasters.securityContext.addCapabilities: []string

AddCapabilities add new capabilities to containers

Code Reference

.spec.syncmasters.securityContext.allowPrivilegeEscalation: bool

Code Reference

.spec.syncmasters.securityContext.dropAllCapabilities: bool

DropAllCapabilities specifies if capabilities should be dropped for this pod containers Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.

Code Reference

.spec.syncmasters.securityContext.fsGroup: int64

Code Reference

.spec.syncmasters.securityContext.privileged: bool

Code Reference

.spec.syncmasters.securityContext.readOnlyRootFilesystem: bool

Code Reference

.spec.syncmasters.securityContext.runAsGroup: int64

Code Reference

.spec.syncmasters.securityContext.runAsNonRoot: bool

Code Reference

.spec.syncmasters.securityContext.runAsUser: int64

Code Reference

.spec.syncmasters.securityContext.seccompProfile: core.SeccompProfile

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Links:

Code Reference

.spec.syncmasters.securityContext.seLinuxOptions: core.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Links:

Code Reference

.spec.syncmasters.securityContext.supplementalGroups: []int64

Code Reference

.spec.syncmasters.securityContext.sysctls: map[string]intstr.IntOrString

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Map Value can be String or Int

Links:

Example:

sysctls:
  "kernel.shm_rmid_forced": "0"
  "net.core.somaxconn": 1024
  "kernel.msgmax": "65536"

Code Reference

.spec.syncmasters.serviceAccountName: string

ServiceAccountName specifies the name of the service account used for Pods in this group.

Code Reference

.spec.syncmasters.shutdownDelay: int

ShutdownDelay define how long operator should delay finalizer removal after shutdown

Code Reference

.spec.syncmasters.shutdownMethod: string

ShutdownMethod describe procedure of member shutdown taken by Operator

Code Reference

.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

.spec.syncmasters.sidecars: []core.Container

Sidecars specifies a list of additional containers to be started

Links:

Code Reference

.spec.syncmasters.storageClassName: string

StorageClassName specifies the classname for storage of the servers.

Code Reference

.spec.syncmasters.terminationGracePeriodSeconds: int64

TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation

Code Reference

.spec.syncmasters.tolerations: []core.Toleration

Tolerations specifies the tolerations added to Pods in this group.

Links:

Code Reference

.spec.syncmasters.volumeAllowShrink: bool

Deprecated: VolumeAllowShrink allows shrink the volume

Code Reference

.spec.syncmasters.volumeClaimTemplate: core.PersistentVolumeClaim

VolumeClaimTemplate specifies a template for volume claims

Links:

Code Reference

.spec.syncmasters.volumeMounts: []ServerGroupSpecVolumeMount

VolumeMounts define list of volume mounts mounted into server container

Links:

Code Reference

.spec.syncmasters.volumes[int].configMap: core.ConfigMapVolumeSource

ConfigMap which should be mounted into pod

Links:

Code Reference

.spec.syncmasters.volumes[int].emptyDir: core.EmptyDirVolumeSource

EmptyDir

Links:

Code Reference

.spec.syncmasters.volumes[int].hostPath: core.HostPathVolumeSource

HostPath

Links:

Code Reference

.spec.syncmasters.volumes[int].name: string

Name of volume

Code Reference

.spec.syncmasters.volumes[int].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource

PersistentVolumeClaim

Links:

Code Reference

.spec.syncmasters.volumes[int].secret: core.SecretVolumeSource

Secret which should be mounted into pod

Links:

Code Reference

.spec.syncworkers.affinity: core.PodAffinity

Affinity specified additional affinity settings in ArangoDB Pod definitions

Links:

Code Reference

.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

.spec.syncworkers.annotations: map[string]string

Annotations specified the annotations added to Pods in this group.

Code Reference

.spec.syncworkers.annotationsIgnoreList: []string

AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored

Code Reference

.spec.syncworkers.annotationsMode: string

AnnotationsMode Define annotations mode which should be use while overriding annotations

Code Reference

.spec.syncworkers.antiAffinity: core.PodAntiAffinity

AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.syncworkers.args: []string

Args holds additional commandline arguments

Code Reference

.spec.syncworkers.count: int

Count holds the requested number of servers

Code Reference

.spec.syncworkers.entrypoint: string

Entrypoint overrides container executable

Code Reference

.spec.syncworkers.envs[int].name: string

Code Reference

.spec.syncworkers.envs[int].value: string

Code Reference

.spec.syncworkers.ephemeralVolumes.apps.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.syncworkers.ephemeralVolumes.temp.size: resource.Quantity

Size define size of the ephemeral volume

Links:

Code Reference

.spec.syncworkers.exporterPort: uint16

ExporterPort define Port used by exporter

Code Reference

.spec.syncworkers.extendedRotationCheck: bool

ExtendedRotationCheck extend checks for rotation

Code Reference

.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

.spec.syncworkers.indexMethod: string

IndexMethod define group Indexing method

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

.spec.syncworkers.initContainers.containers: []core.Container

Containers contains list of containers

Links:

Code Reference

.spec.syncworkers.initContainers.mode: string

Mode keep container replace mode

Code Reference

.spec.syncworkers.internalPort: int

InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members

Code Reference

.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

.spec.syncworkers.labels: map[string]string

Labels specified the labels added to Pods in this group.

Code Reference

.spec.syncworkers.labelsIgnoreList: []string

LabelsIgnoreList list regexp or plain definitions which labels should be ignored

Code Reference

.spec.syncworkers.labelsMode: string

LabelsMode Define labels mode which should be use while overriding labels

Code Reference

.spec.syncworkers.maxCount: int

MaxCount specifies a upper limit for count

Code Reference

.spec.syncworkers.minCount: int

MinCount specifies a lower limit for count

Code Reference

.spec.syncworkers.nodeAffinity: core.NodeAffinity

NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions

Links:

Code Reference

.spec.syncworkers.nodeSelector: map[string]string

NodeSelector speficies a set of selectors for nodes

Code Reference

.spec.syncworkers.numactl.args: []string

Args define list of the numactl process

Default Value: []

Code Reference

.spec.syncworkers.numactl.enabled: bool

Enabled define if numactl should be enabled

Default Value: false

Code Reference

.spec.syncworkers.numactl.path: string

Path define numactl path within the container

Default Value: /usr/bin/numactl

Code Reference

.spec.syncworkers.overrideDetectedNumberOfCores: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES Container Environment Variable

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:

Default Value: true

Code Reference

.spec.syncworkers.overrideDetectedTotalMemory: bool

Important: Values set by this feature override user-provided ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY Container Environment Variable

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:

Default Value: true

Code Reference

.spec.syncworkers.podModes.network: string

Code Reference

.spec.syncworkers.podModes.pid: string

Code Reference

.spec.syncworkers.port: uint16

Port define Port used by member

Code Reference

.spec.syncworkers.priorityClassName: string

PriorityClassName specifies a priority class name

Code Reference

.spec.syncworkers.probes.livenessProbeDisabled: bool

LivenessProbeDisabled if true livenessProbes are disabled

Code Reference

.spec.syncworkers.probes.livenessProbeSpec.failureThreshold: int32

Code Reference

.spec.syncworkers.probes.livenessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.syncworkers.probes.livenessProbeSpec.periodSeconds: int32

Code Reference

.spec.syncworkers.probes.livenessProbeSpec.successThreshold: int32

Code Reference

.spec.syncworkers.probes.livenessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.syncworkers.probes.ReadinessProbeDisabled: bool

OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility.

Code Reference

.spec.syncworkers.probes.readinessProbeDisabled: bool

ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility

Code Reference

.spec.syncworkers.probes.readinessProbeSpec.failureThreshold: int32

Code Reference

.spec.syncworkers.probes.readinessProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.syncworkers.probes.readinessProbeSpec.periodSeconds: int32

Code Reference

.spec.syncworkers.probes.readinessProbeSpec.successThreshold: int32

Code Reference

.spec.syncworkers.probes.readinessProbeSpec.timeoutSeconds: int32

Code Reference

.spec.syncworkers.probes.startupProbeDisabled: bool

StartupProbeDisabled if true startupProbes are disabled

Code Reference

.spec.syncworkers.probes.startupProbeSpec.failureThreshold: int32

Code Reference

.spec.syncworkers.probes.startupProbeSpec.initialDelaySeconds: int32

Code Reference

.spec.syncworkers.probes.startupProbeSpec.periodSeconds: int32

Code Reference

.spec.syncworkers.probes.startupProbeSpec.successThreshold: int32

Code Reference

.spec.syncworkers.probes.startupProbeSpec.timeoutSeconds: int32

Code Reference

.spec.syncworkers.pvcResizeMode: string

VolumeResizeMode specified resize mode for pvc

Code Reference

.spec.syncworkers.resources: core.ResourceRequirements

Resources holds resource requests & limits

Links:

Code Reference

.spec.syncworkers.schedulerName: string

SchedulerName define scheduler name used for group

Code Reference

.spec.syncworkers.securityContext.addCapabilities: []string

AddCapabilities add new capabilities to containers

Code Reference

.spec.syncworkers.securityContext.allowPrivilegeEscalation: bool

Code Reference

.spec.syncworkers.securityContext.dropAllCapabilities: bool

DropAllCapabilities specifies if capabilities should be dropped for this pod containers Deprecated: This field is added for backward compatibility. Will be removed in 1.1.0.

Code Reference

.spec.syncworkers.securityContext.fsGroup: int64

Code Reference

.spec.syncworkers.securityContext.privileged: bool

Code Reference

.spec.syncworkers.securityContext.readOnlyRootFilesystem: bool

Code Reference

.spec.syncworkers.securityContext.runAsGroup: int64

Code Reference

.spec.syncworkers.securityContext.runAsNonRoot: bool

Code Reference

.spec.syncworkers.securityContext.runAsUser: int64

Code Reference

.spec.syncworkers.securityContext.seccompProfile: core.SeccompProfile

SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set.

Links:

Code Reference

.spec.syncworkers.securityContext.seLinuxOptions: core.SELinuxOptions

SELinuxOptions are the labels to be applied to the container

Links:

Code Reference

.spec.syncworkers.securityContext.supplementalGroups: []int64

Code Reference

.spec.syncworkers.securityContext.sysctls: map[string]intstr.IntOrString

Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. Map Value can be String or Int

Links:

Example:

sysctls:
  "kernel.shm_rmid_forced": "0"
  "net.core.somaxconn": 1024
  "kernel.msgmax": "65536"

Code Reference

.spec.syncworkers.serviceAccountName: string

ServiceAccountName specifies the name of the service account used for Pods in this group.

Code Reference

.spec.syncworkers.shutdownDelay: int

ShutdownDelay define how long operator should delay finalizer removal after shutdown

Code Reference

.spec.syncworkers.shutdownMethod: string

ShutdownMethod describe procedure of member shutdown taken by Operator

Code Reference

.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

.spec.syncworkers.sidecars: []core.Container

Sidecars specifies a list of additional containers to be started

Links:

Code Reference

.spec.syncworkers.storageClassName: string

StorageClassName specifies the classname for storage of the servers.

Code Reference

.spec.syncworkers.terminationGracePeriodSeconds: int64

TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation

Code Reference

.spec.syncworkers.tolerations: []core.Toleration

Tolerations specifies the tolerations added to Pods in this group.

Links:

Code Reference

.spec.syncworkers.volumeAllowShrink: bool

Deprecated: VolumeAllowShrink allows shrink the volume

Code Reference

.spec.syncworkers.volumeClaimTemplate: core.PersistentVolumeClaim

VolumeClaimTemplate specifies a template for volume claims

Links:

Code Reference

.spec.syncworkers.volumeMounts: []ServerGroupSpecVolumeMount

VolumeMounts define list of volume mounts mounted into server container

Links:

Code Reference

.spec.syncworkers.volumes[int].configMap: core.ConfigMapVolumeSource

ConfigMap which should be mounted into pod

Links:

Code Reference

.spec.syncworkers.volumes[int].emptyDir: core.EmptyDirVolumeSource

EmptyDir

Links:

Code Reference

.spec.syncworkers.volumes[int].hostPath: core.HostPathVolumeSource

HostPath

Links:

Code Reference

.spec.syncworkers.volumes[int].name: string

Name of volume

Code Reference

.spec.syncworkers.volumes[int].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource

PersistentVolumeClaim

Links:

Code Reference

.spec.syncworkers.volumes[int].secret: core.SecretVolumeSource

Secret which should be mounted into pod

Links:

Code Reference

.spec.timeouts.actions: map[string]meta.Duration

Actions keep map of the actions timeouts.

Links:

Example:

actions:
  AddMember: 30m

Code Reference

.spec.timeouts.maintenanceGracePeriod: int64

MaintenanceGracePeriod action timeout

Code Reference

.spec.timezone: string

Timezone if specified, will set a timezone for deployment. Must be in format accepted by "tzdata", e.g. America/New_York or Europe/London

Code Reference

.spec.tls.altNames: []string

Code Reference

.spec.tls.caSecretName: string

Code Reference

.spec.tls.mode: string

Code Reference

.spec.tls.sni.mapping.<string>: []string

Code Reference

.spec.tls.ttl: string

Code Reference

.spec.topology.enabled: bool

Code Reference

.spec.topology.label: string

Code Reference

.spec.topology.zones: int

Code Reference

.spec.upgrade.autoUpgrade: bool

AutoUpgrade flag specifies if upgrade should be auto-injected, even if is not required (in case of stuck)

Default Value: false

Code Reference

.spec.upgrade.debugLog: bool

DebugLog flag specifies if containers running upgrade process should print more debugging information. This applies only to init containers.

Default Value: false

Code Reference