From 9466811ef2bd280dec496c5ccf071b1abb4039a4 Mon Sep 17 00:00:00 2001 From: Nikita Vaniasin Date: Thu, 9 Nov 2023 11:16:52 +0100 Subject: [PATCH] Sync improvements for docs for 1.2.35 (#1482) --- docs/api/ArangoBackup.V1.md | 176 +- docs/api/ArangoBackupPolicy.V1.md | 92 +- docs/api/ArangoDeployment.V1.md | 3876 +++++++++++++------- docs/api/ArangoDeploymentReplication.V1.md | 72 +- docs/api/ArangoLocalStorage.V1Alpha.md | 48 +- docs/api/ArangoMember.V1.md | 60 +- docs/features/README.md | 63 +- docs/features/rebalancer_v2.md | 4 +- 8 files changed, 2908 insertions(+), 1483 deletions(-) diff --git a/docs/api/ArangoBackup.V1.md b/docs/api/ArangoBackup.V1.md index 7578c2c6a..868b4979f 100644 --- a/docs/api/ArangoBackup.V1.md +++ b/docs/api/ArangoBackup.V1.md @@ -2,39 +2,51 @@ ## Spec -### .spec.backoff.iterations: integer +### .spec.backoff.iterations + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L31) Iterations defines number of iterations before reaching MaxDelay. Default to 5 -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L31) +*** + +### .spec.backoff.max_delay -### .spec.backoff.max_delay: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L29) MaxDelay defines maximum delay in seconds. Default to 600 -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L29) +*** -### .spec.backoff.max_iterations: integer +### .spec.backoff.max_iterations + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L33) MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L33) +*** + +### .spec.backoff.min_delay -### .spec.backoff.min_delay: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L27) MinDelay defines minimum delay in seconds. Default to 30 -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L27) +*** -### .spec.deployment.name: string +### .spec.deployment.name + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L54) Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource. This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L54) +*** + +### .spec.download.credentialsSecretName -### .spec.download.credentialsSecretName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81) CredentialsSecretName is the name of the secret used while accessing repository @@ -43,17 +55,21 @@ Links: This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81) +*** -### .spec.download.id: string +### .spec.download.id + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L89) ID of the ArangoBackup to be downloaded This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L89) +*** + +### .spec.download.repositoryURL -### .spec.download.repositoryURL: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77) RepositoryURL is the URL path for file storage Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local. @@ -70,15 +86,19 @@ azure://test This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77) +*** -### .spec.lifetime: integer +### .spec.lifetime + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L47) Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m". -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L47) +*** + +### .spec.options.allowInconsistent -### .spec.options.allowInconsistent: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L66) AllowInconsistent flag for Backup creation request. If this value is set to true, backup is taken even if we are not able to acquire lock. @@ -87,27 +107,33 @@ Default Value: `false` This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L66) +*** -### .spec.options.timeout: number +### .spec.options.timeout -Timeout for Backup creation request in seconds. +Type: `number` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L61) + +Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false. Default Value: `30` This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L61) +*** + +### .spec.policyName -### .spec.policyName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L42) PolicyName name of the ArangoBackupPolicy which created this Custom Resource This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L42) +*** -### .spec.upload.credentialsSecretName: string +### .spec.upload.credentialsSecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81) CredentialsSecretName is the name of the secret used while accessing repository @@ -116,9 +142,11 @@ Links: This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81) +*** + +### .spec.upload.repositoryURL -### .spec.upload.repositoryURL: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77) RepositoryURL is the URL path for file storage Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local. @@ -135,77 +163,103 @@ azure://test This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77) - ## Status -### .status.available: boolean +### .status.available + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L36) Available Determines if we can restore from ArangoBackup -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L36) +*** -### .status.backoff.iterations: integer +### .status.backoff.iterations -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status_backoff.go#L30) +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status_backoff.go#L30) -### .status.backup.downloaded: boolean +*** + +### .status.backup.downloaded + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L66) Downloaded Determines if ArangoBackup has been downloaded. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L66) +*** + +### .status.backup.id + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L56) -### .status.backup.id: string +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L56) +### .status.backup.imported -### .status.backup.imported: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L67) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L67) +*** -### .status.backup.keys: array +### .status.backup.keys -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L70) +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L70) -### .status.backup.numberOfDBServers: integer +*** + +### .status.backup.numberOfDBServers + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L62) NumberOfDBServers Cluster size of the Backup in ArangoDB -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L62) +*** + +### .status.backup.potentiallyInconsistent + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L58) -### .status.backup.potentiallyInconsistent: boolean +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L58) +### .status.backup.sizeInBytes -### .status.backup.sizeInBytes: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L60) SizeInBytes Size of the Backup in ArangoDB. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L60) +*** -### .status.backup.uploaded: boolean +### .status.backup.uploaded + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L64) Uploaded Determines if ArangoBackup has been uploaded -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L64) +*** + +### .status.backup.version -### .status.backup.version: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L57) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L57) +*** -### .status.message: string +### .status.message + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L88) Message for the state this object is in. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L86) +*** + +### .status.progress.jobID -### .status.progress.jobID: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L111) JobID ArangoDB job ID for uploading or downloading -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L109) +*** -### .status.progress.progress: string +### .status.progress.progress + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L114) Progress ArangoDB job progress in percents @@ -214,9 +268,11 @@ Example: 90% ``` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L112) +*** + +### .status.state -### .status.state: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L82) State holds the current high level state of the backup @@ -235,5 +291,3 @@ Possible Values: * Failed - state for failure * Unavailable - state when Backup is not available on the ArangoDB. It can happen in case of upgrades, node restarts etc. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L80) - diff --git a/docs/api/ArangoBackupPolicy.V1.md b/docs/api/ArangoBackupPolicy.V1.md index f911fa043..bc554cf96 100644 --- a/docs/api/ArangoBackupPolicy.V1.md +++ b/docs/api/ArangoBackupPolicy.V1.md @@ -2,70 +2,90 @@ ## Spec -### .spec.allowConcurrent: boolean +### .spec.allowConcurrent + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L35) AllowConcurrent if false, ArangoBackup will not be created when previous Backups are not finished Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L35) +*** + +### .spec.maxBackups -### .spec.maxBackups: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L43) MaxBackups defines how many backups should be kept in history (per deployment). Oldest healthy Backups will be deleted. If not specified or 0 then no limit is applied Default Value: `0` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L43) +*** + +### .spec.schedule -### .spec.schedule: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L32) Schedule is cron-compatible specification of backup schedule Parsed by https://godoc.org/github.com/robfig/cron -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L32) +*** -### .spec.selector: meta.LabelSelector +### .spec.selector + +Type: `meta.LabelSelector` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L39) DeploymentSelector Selector definition for selecting matching ArangoBackup Custom Resources. Links: * [Kubernetes Documentation](https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#LabelSelector) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L39) +*** + +### .spec.template.backoff.iterations -### .spec.template.backoff.iterations: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L31) Iterations defines number of iterations before reaching MaxDelay. Default to 5 -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L31) +*** -### .spec.template.backoff.max_delay: integer +### .spec.template.backoff.max_delay + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L29) MaxDelay defines maximum delay in seconds. Default to 600 -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L29) +*** + +### .spec.template.backoff.max_iterations -### .spec.template.backoff.max_iterations: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L33) MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L33) +*** -### .spec.template.backoff.min_delay: integer +### .spec.template.backoff.min_delay + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L27) MinDelay defines minimum delay in seconds. Default to 30 -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L27) +*** + +### .spec.template.lifetime -### .spec.template.lifetime: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L61) Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m". -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L61) +*** -### .spec.template.options.allowInconsistent: boolean +### .spec.template.options.allowInconsistent + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L66) AllowInconsistent flag for Backup creation request. If this value is set to true, backup is taken even if we are not able to acquire lock. @@ -74,19 +94,23 @@ Default Value: `false` This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L66) +*** + +### .spec.template.options.timeout -### .spec.template.options.timeout: number +Type: `number` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L61) -Timeout for Backup creation request in seconds. +Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false. Default Value: `30` This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L61) +*** -### .spec.template.upload.credentialsSecretName: string +### .spec.template.upload.credentialsSecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81) CredentialsSecretName is the name of the secret used while accessing repository @@ -95,9 +119,11 @@ Links: This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81) +*** + +### .spec.template.upload.repositoryURL -### .spec.template.upload.repositoryURL: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77) RepositoryURL is the URL path for file storage Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local. @@ -114,19 +140,19 @@ azure://test This field is **immutable**: can't be changed after backup creation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77) - ## Status -### .status.message: string +### .status.message + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_status.go#L33) Message from the operator in case of failures - schedule not valid, ArangoBackupPolicy not valid -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_status.go#L33) +*** -### .status.scheduled: meta.Time +### .status.scheduled -Scheduled Next scheduled time in UTC +Type: `meta.Time` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_status.go#L31) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_status.go#L31) +Scheduled Next scheduled time in UTC diff --git a/docs/api/ArangoDeployment.V1.md b/docs/api/ArangoDeployment.V1.md index 65e1c4af3..c86266c30 100644 --- a/docs/api/ArangoDeployment.V1.md +++ b/docs/api/ArangoDeployment.V1.md @@ -2,61 +2,77 @@ ## Spec -### .spec.agents.affinity: core.PodAffinity +### .spec.agents.affinity + +Type: `core.PodAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) +*** + +### .spec.agents.allowMemberRecreation -### .spec.agents.allowMemberRecreation: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) AllowMemberRecreation allows to recreate member. This setting changes the member recreation logic based on group: - For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`) - For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) +*** -### .spec.agents.annotations: object +### .spec.agents.annotations + +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) Annotations specified the annotations added to Pods in this group. Annotations are merged with `spec.annotations`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) +*** + +### .spec.agents.annotationsIgnoreList -### .spec.agents.annotationsIgnoreList: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) +*** -### .spec.agents.annotationsMode: string +### .spec.agents.annotationsMode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) +*** + +### .spec.agents.antiAffinity -### .spec.agents.antiAffinity: core.PodAntiAffinity +Type: `core.PodAntiAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) +*** + +### .spec.agents.args -### .spec.agents.args: []string +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) Args setting specifies additional command-line arguments passed to all servers of this group. Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) +*** -### .spec.agents.count: integer +### .spec.agents.count + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) Count setting specifies the number of servers to start for the given group. For the Agent group, this value must be a positive, odd number. @@ -65,59 +81,77 @@ for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`). For the `syncworkers` group, it is highly recommended to use the same number as for the `dbservers` group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) +*** + +### .spec.agents.entrypoint -### .spec.agents.entrypoint: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) Entrypoint overrides container executable -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) +*** + +### .spec.agents.envs\[int\].name -### .spec.agents.envs\[int\].name: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) +*** -### .spec.agents.envs\[int\].value: string +### .spec.agents.envs\[int\].value -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) -### .spec.agents.ephemeralVolumes.apps.size: resource.Quantity +*** + +### .spec.agents.ephemeralVolumes.apps.size + +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** + +### .spec.agents.ephemeralVolumes.temp.size -### .spec.agents.ephemeralVolumes.temp.size: resource.Quantity +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** -### .spec.agents.exporterPort: integer +### .spec.agents.exporterPort + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) ExporterPort define Port used by exporter -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) +*** + +### .spec.agents.extendedRotationCheck -### .spec.agents.extendedRotationCheck: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) ExtendedRotationCheck extend checks for rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) +*** + +### .spec.agents.externalPortEnabled -### .spec.agents.externalPortEnabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) +*** -### .spec.agents.indexMethod: string +### .spec.agents.indexMethod + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) IndexMethod define group Indexing method @@ -125,60 +159,78 @@ 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) +*** + +### .spec.agents.initContainers.containers -### .spec.agents.initContainers.containers: []core.Container +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) Containers contains list of containers Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) +*** + +### .spec.agents.initContainers.mode -### .spec.agents.initContainers.mode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) Mode keep container replace mode -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) +*** -### .spec.agents.internalPort: integer +### .spec.agents.internalPort + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) +*** + +### .spec.agents.internalPortProtocol -### .spec.agents.internalPortProtocol: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) +*** + +### .spec.agents.labels -### .spec.agents.labels: object +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) Labels specified the labels added to Pods in this group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) +*** -### .spec.agents.labelsIgnoreList: array +### .spec.agents.labelsIgnoreList + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) +*** + +### .spec.agents.labelsMode -### .spec.agents.labelsMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) +*** + +### .spec.agents.maxCount -### .spec.agents.maxCount: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) +*** -### .spec.agents.memoryReservation: integer +### .spec.agents.memoryReservation + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value. If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent. @@ -189,57 +241,71 @@ Links: Default Value: `0` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) +*** + +### .spec.agents.minCount -### .spec.agents.minCount: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) +*** + +### .spec.agents.nodeAffinity -### .spec.agents.nodeAffinity: core.NodeAffinity +Type: `core.NodeAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) +*** -### .spec.agents.nodeSelector: map[string]string +### .spec.agents.nodeSelector + +Type: `map[string]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) +*** + +### .spec.agents.numactl.args -### .spec.agents.numactl.args: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) Args define list of the numactl process Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) +*** + +### .spec.agents.numactl.enabled -### .spec.agents.numactl.enabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) Enabled define if numactl should be enabled Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) +*** -### .spec.agents.numactl.path: string +### .spec.agents.numactl.path + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) Path define numactl path within the container Default Value: `/usr/bin/numactl` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) +*** + +### .spec.agents.overrideDetectedNumberOfCores -### .spec.agents.overrideDetectedNumberOfCores: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable @@ -251,9 +317,11 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) +*** + +### .spec.agents.overrideDetectedTotalMemory -### .spec.agents.overrideDetectedTotalMemory: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable @@ -265,23 +333,31 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) +*** + +### .spec.agents.podModes.network + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) + +*** -### .spec.agents.podModes.network: string +### .spec.agents.podModes.pid -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) -### .spec.agents.podModes.pid: string +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) +### .spec.agents.port -### .spec.agents.port: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) Port define Port used by member -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) +*** -### .spec.agents.priorityClassName: string +### .spec.agents.priorityClassName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) PriorityClassName specifies a priority class name Will be forwarded to the pod spec. @@ -289,17 +365,21 @@ Will be forwarded to the pod spec. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) +*** + +### .spec.agents.probes.livenessProbeDisabled -### .spec.agents.probes.livenessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) +*** + +### .spec.agents.probes.livenessProbeSpec.failureThreshold -### .spec.agents.probes.livenessProbeSpec.failureThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -307,58 +387,72 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** -### .spec.agents.probes.livenessProbeSpec.initialDelaySeconds: integer +### .spec.agents.probes.livenessProbeSpec.initialDelaySeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.agents.probes.livenessProbeSpec.periodSeconds -### .spec.agents.probes.livenessProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** + +### .spec.agents.probes.livenessProbeSpec.successThreshold -### .spec.agents.probes.livenessProbeSpec.successThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** -### .spec.agents.probes.livenessProbeSpec.timeoutSeconds: integer +### .spec.agents.probes.livenessProbeSpec.timeoutSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.agents.probes.ReadinessProbeDisabled -### .spec.agents.probes.ReadinessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) +*** + +### .spec.agents.probes.readinessProbeDisabled -### .spec.agents.probes.readinessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) +*** -### .spec.agents.probes.readinessProbeSpec.failureThreshold: integer +### .spec.agents.probes.readinessProbeSpec.failureThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -366,51 +460,63 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** + +### .spec.agents.probes.readinessProbeSpec.initialDelaySeconds -### .spec.agents.probes.readinessProbeSpec.initialDelaySeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.agents.probes.readinessProbeSpec.periodSeconds -### .spec.agents.probes.readinessProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** -### .spec.agents.probes.readinessProbeSpec.successThreshold: integer +### .spec.agents.probes.readinessProbeSpec.successThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** + +### .spec.agents.probes.readinessProbeSpec.timeoutSeconds -### .spec.agents.probes.readinessProbeSpec.timeoutSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** -### .spec.agents.probes.startupProbeDisabled: boolean +### .spec.agents.probes.startupProbeDisabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) StartupProbeDisabled if true startupProbes are disabled -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) +*** + +### .spec.agents.probes.startupProbeSpec.failureThreshold -### .spec.agents.probes.startupProbeSpec.failureThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -418,45 +524,55 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** -### .spec.agents.probes.startupProbeSpec.initialDelaySeconds: integer +### .spec.agents.probes.startupProbeSpec.initialDelaySeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.agents.probes.startupProbeSpec.periodSeconds -### .spec.agents.probes.startupProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** + +### .spec.agents.probes.startupProbeSpec.successThreshold -### .spec.agents.probes.startupProbeSpec.successThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** -### .spec.agents.probes.startupProbeSpec.timeoutSeconds: integer +### .spec.agents.probes.startupProbeSpec.timeoutSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.agents.pvcResizeMode -### .spec.agents.pvcResizeMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) VolumeResizeMode specified resize mode for PVCs and PVs @@ -464,105 +580,135 @@ Possible Values: * runtime (default) - PVC will be resized in Pod runtime (EKS, GKE) * rotate - Pod will be shutdown and PVC will be resized (AKS) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) +*** + +### .spec.agents.resources -### .spec.agents.resources: core.ResourceRequirements +Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) Resources holds resource requests & limits Links: * [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) +*** -### .spec.agents.schedulerName: string +### .spec.agents.schedulerName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) SchedulerName define scheduler name used for group -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) +*** + +### .spec.agents.securityContext.addCapabilities -### .spec.agents.securityContext.addCapabilities: []core.Capability +Type: `[]core.Capability` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) AddCapabilities add new capabilities to containers -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) +*** + +### .spec.agents.securityContext.allowPrivilegeEscalation -### .spec.agents.securityContext.allowPrivilegeEscalation: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) +*** -### .spec.agents.securityContext.dropAllCapabilities: boolean +### .spec.agents.securityContext.dropAllCapabilities + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) +*** + +### .spec.agents.securityContext.fsGroup -### .spec.agents.securityContext.fsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) FSGroup is a special supplemental group that applies to all containers in a pod. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) +*** + +### .spec.agents.securityContext.privileged -### .spec.agents.securityContext.privileged: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) Privileged If true, runs container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) +*** -### .spec.agents.securityContext.readOnlyRootFilesystem: boolean +### .spec.agents.securityContext.readOnlyRootFilesystem + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) +*** + +### .spec.agents.securityContext.runAsGroup -### .spec.agents.securityContext.runAsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) RunAsGroup is the GID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) +*** + +### .spec.agents.securityContext.runAsNonRoot -### .spec.agents.securityContext.runAsNonRoot: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) RunAsNonRoot if true, indicates that the container must run as a non-root user. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) +*** -### .spec.agents.securityContext.runAsUser: integer +### .spec.agents.securityContext.runAsUser + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) RunAsUser is the UID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) +*** + +### .spec.agents.securityContext.seccompProfile -### .spec.agents.securityContext.seccompProfile: core.SeccompProfile +Type: `core.SeccompProfile` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. Links: * [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) +*** + +### .spec.agents.securityContext.seLinuxOptions -### .spec.agents.securityContext.seLinuxOptions: core.SELinuxOptions +Type: `core.SELinuxOptions` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) SELinuxOptions are the labels to be applied to the container Links: * [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) +*** -### .spec.agents.securityContext.supplementalGroups: array +### .spec.agents.securityContext.supplementalGroups + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) +*** + +### .spec.agents.securityContext.sysctls -### .spec.agents.securityContext.sysctls: map[string]intstr.IntOrString +Type: `map[string]intstr.IntOrString` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. @@ -579,9 +725,11 @@ sysctls: "kernel.msgmax": "65536" ``` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) +*** + +### .spec.agents.serviceAccountName -### .spec.agents.serviceAccountName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created for each server of this group. If empty, it defaults to using the @@ -592,49 +740,63 @@ deployment of the operator, we grant the rights to 'get' all 'pod' resources. If you are using a different service account, please grant these rights to that service account. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) +*** -### .spec.agents.shutdownDelay: integer +### .spec.agents.shutdownDelay + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) +*** + +### .spec.agents.shutdownMethod -### .spec.agents.shutdownMethod: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) +*** + +### .spec.agents.sidecarCoreNames -### .spec.agents.sidecarCoreNames: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) +*** -### .spec.agents.sidecars: []core.Container +### .spec.agents.sidecars + +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) +*** + +### .spec.agents.storageClassName -### .spec.agents.storageClassName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) StorageClassName specifies the classname for storage of the servers. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) +*** + +### .spec.agents.terminationGracePeriodSeconds -### .spec.agents.terminationGracePeriodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) +*** -### .spec.agents.tolerations: []core.Toleration +### .spec.agents.tolerations + +Type: `[]core.Toleration` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) Tolerations specifies the tolerations added to Pods in this group. By default, suitable tolerations are set for the following keys with the `NoExecute` effect: @@ -646,15 +808,19 @@ For more information on tolerations, consult the https://kubernetes.io/docs/conc Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) +*** + +### .spec.agents.volumeAllowShrink -### .spec.agents.volumeAllowShrink: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) +*** + +### .spec.agents.volumeClaimTemplate -### .spec.agents.volumeClaimTemplate: core.PersistentVolumeClaim +Type: `core.PersistentVolumeClaim` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group. This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`. @@ -666,87 +832,109 @@ and `iops` is not forwarded to the pods resource requirements. Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) +*** -### .spec.agents.volumeMounts: []ServerGroupSpecVolumeMount +### .spec.agents.volumeMounts + +Type: `[]ServerGroupSpecVolumeMount` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) +*** + +### .spec.agents.volumes\[int\].configMap -### .spec.agents.volumes\[int\].configMap: core.ConfigMapVolumeSource +Type: `core.ConfigMapVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) ConfigMap which should be mounted into pod Links: * [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) +*** + +### .spec.agents.volumes\[int\].emptyDir -### .spec.agents.volumes\[int\].emptyDir: core.EmptyDirVolumeSource +Type: `core.EmptyDirVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) EmptyDir Links: * [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) +*** -### .spec.agents.volumes\[int\].hostPath: core.HostPathVolumeSource +### .spec.agents.volumes\[int\].hostPath + +Type: `core.HostPathVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) HostPath Links: * [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) +*** + +### .spec.agents.volumes\[int\].name -### .spec.agents.volumes\[int\].name: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) Name of volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) +*** + +### .spec.agents.volumes\[int\].persistentVolumeClaim -### .spec.agents.volumes\[int\].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource +Type: `core.PersistentVolumeClaimVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) PersistentVolumeClaim Links: * [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) +*** -### .spec.agents.volumes\[int\].secret: core.SecretVolumeSource +### .spec.agents.volumes\[int\].secret + +Type: `core.SecretVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) Secret which should be mounted into pod Links: * [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) +*** + +### .spec.allowUnsafeUpgrade -### .spec.allowUnsafeUpgrade: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L163) AllowUnsafeUpgrade determines if upgrade on missing member or with not in sync shards is allowed -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L163) +*** + +### .spec.annotations -### .spec.annotations: object +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L126) Annotations specifies the annotations added to all ArangoDeployment owned resources (pods, services, PVC’s, PDB’s). -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L126) +*** -### .spec.annotationsIgnoreList: array +### .spec.annotationsIgnoreList + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L129) AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L129) +*** + +### .spec.annotationsMode -### .spec.annotationsMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L135) AnnotationsMode defines annotations mode which should be use while overriding annotations. @@ -755,9 +943,11 @@ Possible Values: * append - Add new annotations/labels without affecting old ones * replace - Replace existing annotations/labels -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L135) +*** + +### .spec.architecture -### .spec.architecture: []string +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L265) Architecture defines the list of supported architectures. First element on the list is marked as default architecture. @@ -774,9 +964,11 @@ Links: Default Value: `['amd64']` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L265) +*** -### .spec.auth.jwtSecretName: string +### .spec.auth.jwtSecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/authentication_spec.go#L40) JWTSecretName setting specifies the name of a kubernetes `Secret` that contains the JWT token used for accessing all ArangoDB servers. @@ -788,9 +980,11 @@ If you specify a name of a `Secret` that does not exist, a random token is creat and stored in a `Secret` with given name. Changing a JWT token results in restarting of a whole cluster. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/authentication_spec.go#L40) +*** + +### .spec.bootstrap.passwordSecretNames -### .spec.bootstrap.passwordSecretNames: map[string]string +Type: `map[string]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/bootstrap.go#L62) PasswordSecretNames contains a map of username to password-secret-name This setting specifies a secret name for the credentials per specific users. @@ -804,36 +998,46 @@ There are two magic values for the secret name: Links: * [How to set root user password](/docs/how-to/set_root_user_password.md) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/bootstrap.go#L62) +*** + +### .spec.chaos.enabled -### .spec.chaos.enabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/chaos_spec.go#L33) Enabled switches the chaos monkey for a deployment on or off. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/chaos_spec.go#L33) +*** -### .spec.chaos.interval: integer +### .spec.chaos.interval + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/chaos_spec.go#L35) Interval is the time between events -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/chaos_spec.go#L35) +*** + +### .spec.chaos.kill-pod-probability -### .spec.chaos.kill-pod-probability: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/chaos_spec.go#L37) KillPodProbability is the chance of a pod being killed during an event -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/chaos_spec.go#L37) +*** -### .spec.ClusterDomain: string +### .spec.ClusterDomain + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L237) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L237) +*** + +### .spec.communicationMethod -### .spec.communicationMethod: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L245) CommunicationMethod define communication method used in deployment @@ -844,63 +1048,79 @@ Possible Values: * headless-dns - Define Headless Service DNS based communication. * ip - Define ClusterIP Service IP based communication. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L245) +*** -### .spec.coordinators.affinity: core.PodAffinity +### .spec.coordinators.affinity + +Type: `core.PodAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) +*** + +### .spec.coordinators.allowMemberRecreation -### .spec.coordinators.allowMemberRecreation: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) AllowMemberRecreation allows to recreate member. This setting changes the member recreation logic based on group: - For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`) - For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) +*** + +### .spec.coordinators.annotations -### .spec.coordinators.annotations: object +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) Annotations specified the annotations added to Pods in this group. Annotations are merged with `spec.annotations`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) +*** -### .spec.coordinators.annotationsIgnoreList: array +### .spec.coordinators.annotationsIgnoreList + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) +*** + +### .spec.coordinators.annotationsMode -### .spec.coordinators.annotationsMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) +*** + +### .spec.coordinators.antiAffinity -### .spec.coordinators.antiAffinity: core.PodAntiAffinity +Type: `core.PodAntiAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) +*** -### .spec.coordinators.args: []string +### .spec.coordinators.args + +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) Args setting specifies additional command-line arguments passed to all servers of this group. Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) +*** + +### .spec.coordinators.count -### .spec.coordinators.count: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) Count setting specifies the number of servers to start for the given group. For the Agent group, this value must be a positive, odd number. @@ -909,59 +1129,77 @@ for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`). For the `syncworkers` group, it is highly recommended to use the same number as for the `dbservers` group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) +*** + +### .spec.coordinators.entrypoint -### .spec.coordinators.entrypoint: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) Entrypoint overrides container executable -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) +*** -### .spec.coordinators.envs\[int\].name: string +### .spec.coordinators.envs\[int\].name -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) -### .spec.coordinators.envs\[int\].value: string +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) +### .spec.coordinators.envs\[int\].value -### .spec.coordinators.ephemeralVolumes.apps.size: resource.Quantity +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) + +*** + +### .spec.coordinators.ephemeralVolumes.apps.size + +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** -### .spec.coordinators.ephemeralVolumes.temp.size: resource.Quantity +### .spec.coordinators.ephemeralVolumes.temp.size + +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** + +### .spec.coordinators.exporterPort -### .spec.coordinators.exporterPort: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) ExporterPort define Port used by exporter -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) +*** + +### .spec.coordinators.extendedRotationCheck -### .spec.coordinators.extendedRotationCheck: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) ExtendedRotationCheck extend checks for rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) +*** -### .spec.coordinators.externalPortEnabled: boolean +### .spec.coordinators.externalPortEnabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) +*** + +### .spec.coordinators.indexMethod -### .spec.coordinators.indexMethod: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) IndexMethod define group Indexing method @@ -969,60 +1207,78 @@ 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) +*** + +### .spec.coordinators.initContainers.containers -### .spec.coordinators.initContainers.containers: []core.Container +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) Containers contains list of containers Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) +*** -### .spec.coordinators.initContainers.mode: string +### .spec.coordinators.initContainers.mode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) Mode keep container replace mode -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) +*** + +### .spec.coordinators.internalPort -### .spec.coordinators.internalPort: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) +*** + +### .spec.coordinators.internalPortProtocol -### .spec.coordinators.internalPortProtocol: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) +*** -### .spec.coordinators.labels: object +### .spec.coordinators.labels + +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) Labels specified the labels added to Pods in this group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) +*** + +### .spec.coordinators.labelsIgnoreList -### .spec.coordinators.labelsIgnoreList: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) +*** + +### .spec.coordinators.labelsMode -### .spec.coordinators.labelsMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) +*** -### .spec.coordinators.maxCount: integer +### .spec.coordinators.maxCount + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) +*** + +### .spec.coordinators.memoryReservation -### .spec.coordinators.memoryReservation: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value. If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent. @@ -1033,57 +1289,71 @@ Links: Default Value: `0` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) +*** + +### .spec.coordinators.minCount -### .spec.coordinators.minCount: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) +*** -### .spec.coordinators.nodeAffinity: core.NodeAffinity +### .spec.coordinators.nodeAffinity + +Type: `core.NodeAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) +*** + +### .spec.coordinators.nodeSelector -### .spec.coordinators.nodeSelector: map[string]string +Type: `map[string]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) +*** + +### .spec.coordinators.numactl.args -### .spec.coordinators.numactl.args: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) Args define list of the numactl process Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) +*** -### .spec.coordinators.numactl.enabled: boolean +### .spec.coordinators.numactl.enabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) Enabled define if numactl should be enabled Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) +*** + +### .spec.coordinators.numactl.path -### .spec.coordinators.numactl.path: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) Path define numactl path within the container Default Value: `/usr/bin/numactl` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) +*** + +### .spec.coordinators.overrideDetectedNumberOfCores -### .spec.coordinators.overrideDetectedNumberOfCores: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable @@ -1095,9 +1365,11 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) +*** -### .spec.coordinators.overrideDetectedTotalMemory: boolean +### .spec.coordinators.overrideDetectedTotalMemory + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable @@ -1109,23 +1381,31 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) +*** + +### .spec.coordinators.podModes.network + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) -### .spec.coordinators.podModes.network: string +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) +### .spec.coordinators.podModes.pid -### .spec.coordinators.podModes.pid: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) +*** -### .spec.coordinators.port: integer +### .spec.coordinators.port + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) Port define Port used by member -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) +*** + +### .spec.coordinators.priorityClassName -### .spec.coordinators.priorityClassName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) PriorityClassName specifies a priority class name Will be forwarded to the pod spec. @@ -1133,17 +1413,21 @@ Will be forwarded to the pod spec. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) +*** + +### .spec.coordinators.probes.livenessProbeDisabled -### .spec.coordinators.probes.livenessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) +*** -### .spec.coordinators.probes.livenessProbeSpec.failureThreshold: integer +### .spec.coordinators.probes.livenessProbeSpec.failureThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -1151,58 +1435,72 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** + +### .spec.coordinators.probes.livenessProbeSpec.initialDelaySeconds -### .spec.coordinators.probes.livenessProbeSpec.initialDelaySeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.coordinators.probes.livenessProbeSpec.periodSeconds -### .spec.coordinators.probes.livenessProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** -### .spec.coordinators.probes.livenessProbeSpec.successThreshold: integer +### .spec.coordinators.probes.livenessProbeSpec.successThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** + +### .spec.coordinators.probes.livenessProbeSpec.timeoutSeconds -### .spec.coordinators.probes.livenessProbeSpec.timeoutSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.coordinators.probes.ReadinessProbeDisabled -### .spec.coordinators.probes.ReadinessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) +*** -### .spec.coordinators.probes.readinessProbeDisabled: boolean +### .spec.coordinators.probes.readinessProbeDisabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) +*** + +### .spec.coordinators.probes.readinessProbeSpec.failureThreshold -### .spec.coordinators.probes.readinessProbeSpec.failureThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -1210,51 +1508,63 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** -### .spec.coordinators.probes.readinessProbeSpec.initialDelaySeconds: integer +### .spec.coordinators.probes.readinessProbeSpec.initialDelaySeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.coordinators.probes.readinessProbeSpec.periodSeconds -### .spec.coordinators.probes.readinessProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** -### .spec.coordinators.probes.readinessProbeSpec.successThreshold: integer +### .spec.coordinators.probes.readinessProbeSpec.successThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** + +### .spec.coordinators.probes.readinessProbeSpec.timeoutSeconds -### .spec.coordinators.probes.readinessProbeSpec.timeoutSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.coordinators.probes.startupProbeDisabled -### .spec.coordinators.probes.startupProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) StartupProbeDisabled if true startupProbes are disabled -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) +*** -### .spec.coordinators.probes.startupProbeSpec.failureThreshold: integer +### .spec.coordinators.probes.startupProbeSpec.failureThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -1262,45 +1572,55 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** + +### .spec.coordinators.probes.startupProbeSpec.initialDelaySeconds -### .spec.coordinators.probes.startupProbeSpec.initialDelaySeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.coordinators.probes.startupProbeSpec.periodSeconds -### .spec.coordinators.probes.startupProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** -### .spec.coordinators.probes.startupProbeSpec.successThreshold: integer +### .spec.coordinators.probes.startupProbeSpec.successThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** + +### .spec.coordinators.probes.startupProbeSpec.timeoutSeconds -### .spec.coordinators.probes.startupProbeSpec.timeoutSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.coordinators.pvcResizeMode -### .spec.coordinators.pvcResizeMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) VolumeResizeMode specified resize mode for PVCs and PVs @@ -1308,105 +1628,135 @@ Possible Values: * runtime (default) - PVC will be resized in Pod runtime (EKS, GKE) * rotate - Pod will be shutdown and PVC will be resized (AKS) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) +*** -### .spec.coordinators.resources: core.ResourceRequirements +### .spec.coordinators.resources + +Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) Resources holds resource requests & limits Links: * [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) +*** + +### .spec.coordinators.schedulerName -### .spec.coordinators.schedulerName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) SchedulerName define scheduler name used for group -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) +*** + +### .spec.coordinators.securityContext.addCapabilities -### .spec.coordinators.securityContext.addCapabilities: []core.Capability +Type: `[]core.Capability` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) AddCapabilities add new capabilities to containers -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) +*** -### .spec.coordinators.securityContext.allowPrivilegeEscalation: boolean +### .spec.coordinators.securityContext.allowPrivilegeEscalation + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) +*** + +### .spec.coordinators.securityContext.dropAllCapabilities -### .spec.coordinators.securityContext.dropAllCapabilities: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) +*** + +### .spec.coordinators.securityContext.fsGroup -### .spec.coordinators.securityContext.fsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) FSGroup is a special supplemental group that applies to all containers in a pod. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) +*** -### .spec.coordinators.securityContext.privileged: boolean +### .spec.coordinators.securityContext.privileged + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) Privileged If true, runs container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) +*** + +### .spec.coordinators.securityContext.readOnlyRootFilesystem -### .spec.coordinators.securityContext.readOnlyRootFilesystem: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) +*** + +### .spec.coordinators.securityContext.runAsGroup -### .spec.coordinators.securityContext.runAsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) RunAsGroup is the GID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) +*** -### .spec.coordinators.securityContext.runAsNonRoot: boolean +### .spec.coordinators.securityContext.runAsNonRoot + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) RunAsNonRoot if true, indicates that the container must run as a non-root user. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) +*** + +### .spec.coordinators.securityContext.runAsUser -### .spec.coordinators.securityContext.runAsUser: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) RunAsUser is the UID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) +*** + +### .spec.coordinators.securityContext.seccompProfile -### .spec.coordinators.securityContext.seccompProfile: core.SeccompProfile +Type: `core.SeccompProfile` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. Links: * [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) +*** -### .spec.coordinators.securityContext.seLinuxOptions: core.SELinuxOptions +### .spec.coordinators.securityContext.seLinuxOptions + +Type: `core.SELinuxOptions` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) SELinuxOptions are the labels to be applied to the container Links: * [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) +*** + +### .spec.coordinators.securityContext.supplementalGroups -### .spec.coordinators.securityContext.supplementalGroups: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) +*** + +### .spec.coordinators.securityContext.sysctls -### .spec.coordinators.securityContext.sysctls: map[string]intstr.IntOrString +Type: `map[string]intstr.IntOrString` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. @@ -1423,9 +1773,11 @@ sysctls: "kernel.msgmax": "65536" ``` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) +*** -### .spec.coordinators.serviceAccountName: string +### .spec.coordinators.serviceAccountName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created for each server of this group. If empty, it defaults to using the @@ -1436,49 +1788,63 @@ deployment of the operator, we grant the rights to 'get' all 'pod' resources. If you are using a different service account, please grant these rights to that service account. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) +*** + +### .spec.coordinators.shutdownDelay -### .spec.coordinators.shutdownDelay: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) +*** + +### .spec.coordinators.shutdownMethod -### .spec.coordinators.shutdownMethod: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) +*** -### .spec.coordinators.sidecarCoreNames: array +### .spec.coordinators.sidecarCoreNames + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) +*** + +### .spec.coordinators.sidecars -### .spec.coordinators.sidecars: []core.Container +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) +*** + +### .spec.coordinators.storageClassName -### .spec.coordinators.storageClassName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) StorageClassName specifies the classname for storage of the servers. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) +*** -### .spec.coordinators.terminationGracePeriodSeconds: integer +### .spec.coordinators.terminationGracePeriodSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) +*** + +### .spec.coordinators.tolerations -### .spec.coordinators.tolerations: []core.Toleration +Type: `[]core.Toleration` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) Tolerations specifies the tolerations added to Pods in this group. By default, suitable tolerations are set for the following keys with the `NoExecute` effect: @@ -1490,15 +1856,19 @@ For more information on tolerations, consult the https://kubernetes.io/docs/conc Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) +*** + +### .spec.coordinators.volumeAllowShrink -### .spec.coordinators.volumeAllowShrink: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) +*** -### .spec.coordinators.volumeClaimTemplate: core.PersistentVolumeClaim +### .spec.coordinators.volumeClaimTemplate + +Type: `core.PersistentVolumeClaim` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group. This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`. @@ -1510,129 +1880,161 @@ and `iops` is not forwarded to the pods resource requirements. Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) +*** + +### .spec.coordinators.volumeMounts -### .spec.coordinators.volumeMounts: []ServerGroupSpecVolumeMount +Type: `[]ServerGroupSpecVolumeMount` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) +*** + +### .spec.coordinators.volumes\[int\].configMap -### .spec.coordinators.volumes\[int\].configMap: core.ConfigMapVolumeSource +Type: `core.ConfigMapVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) ConfigMap which should be mounted into pod Links: * [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) +*** -### .spec.coordinators.volumes\[int\].emptyDir: core.EmptyDirVolumeSource +### .spec.coordinators.volumes\[int\].emptyDir + +Type: `core.EmptyDirVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) EmptyDir Links: * [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) +*** + +### .spec.coordinators.volumes\[int\].hostPath -### .spec.coordinators.volumes\[int\].hostPath: core.HostPathVolumeSource +Type: `core.HostPathVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) HostPath Links: * [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) +*** + +### .spec.coordinators.volumes\[int\].name -### .spec.coordinators.volumes\[int\].name: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) Name of volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) +*** -### .spec.coordinators.volumes\[int\].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource +### .spec.coordinators.volumes\[int\].persistentVolumeClaim + +Type: `core.PersistentVolumeClaimVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) PersistentVolumeClaim Links: * [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) +*** + +### .spec.coordinators.volumes\[int\].secret -### .spec.coordinators.volumes\[int\].secret: core.SecretVolumeSource +Type: `core.SecretVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) Secret which should be mounted into pod Links: * [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) +*** + +### .spec.database.maintenance -### .spec.database.maintenance: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/database_spec.go#L25) Maintenance manage maintenance mode on Cluster side. Requires maintenance feature to be enabled -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/database_spec.go#L25) +*** -### .spec.dbservers.affinity: core.PodAffinity +### .spec.dbservers.affinity + +Type: `core.PodAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) +*** + +### .spec.dbservers.allowMemberRecreation -### .spec.dbservers.allowMemberRecreation: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) AllowMemberRecreation allows to recreate member. This setting changes the member recreation logic based on group: - For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`) - For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) +*** + +### .spec.dbservers.annotations -### .spec.dbservers.annotations: object +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) Annotations specified the annotations added to Pods in this group. Annotations are merged with `spec.annotations`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) +*** -### .spec.dbservers.annotationsIgnoreList: array +### .spec.dbservers.annotationsIgnoreList + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) +*** + +### .spec.dbservers.annotationsMode -### .spec.dbservers.annotationsMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) +*** -### .spec.dbservers.antiAffinity: core.PodAntiAffinity +### .spec.dbservers.antiAffinity + +Type: `core.PodAntiAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) +*** + +### .spec.dbservers.args -### .spec.dbservers.args: []string +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) Args setting specifies additional command-line arguments passed to all servers of this group. Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) +*** -### .spec.dbservers.count: integer +### .spec.dbservers.count + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) Count setting specifies the number of servers to start for the given group. For the Agent group, this value must be a positive, odd number. @@ -1641,59 +2043,77 @@ for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`). For the `syncworkers` group, it is highly recommended to use the same number as for the `dbservers` group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) +*** + +### .spec.dbservers.entrypoint -### .spec.dbservers.entrypoint: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) Entrypoint overrides container executable -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) +*** + +### .spec.dbservers.envs\[int\].name -### .spec.dbservers.envs\[int\].name: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) +*** -### .spec.dbservers.envs\[int\].value: string +### .spec.dbservers.envs\[int\].value -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) -### .spec.dbservers.ephemeralVolumes.apps.size: resource.Quantity +*** + +### .spec.dbservers.ephemeralVolumes.apps.size + +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** + +### .spec.dbservers.ephemeralVolumes.temp.size -### .spec.dbservers.ephemeralVolumes.temp.size: resource.Quantity +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** -### .spec.dbservers.exporterPort: integer +### .spec.dbservers.exporterPort + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) ExporterPort define Port used by exporter -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) +*** + +### .spec.dbservers.extendedRotationCheck -### .spec.dbservers.extendedRotationCheck: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) ExtendedRotationCheck extend checks for rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) +*** + +### .spec.dbservers.externalPortEnabled -### .spec.dbservers.externalPortEnabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) +*** -### .spec.dbservers.indexMethod: string +### .spec.dbservers.indexMethod + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) IndexMethod define group Indexing method @@ -1701,60 +2121,78 @@ 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) +*** + +### .spec.dbservers.initContainers.containers -### .spec.dbservers.initContainers.containers: []core.Container +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) Containers contains list of containers Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) +*** + +### .spec.dbservers.initContainers.mode -### .spec.dbservers.initContainers.mode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) Mode keep container replace mode -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) +*** -### .spec.dbservers.internalPort: integer +### .spec.dbservers.internalPort + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) +*** + +### .spec.dbservers.internalPortProtocol -### .spec.dbservers.internalPortProtocol: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) +*** + +### .spec.dbservers.labels -### .spec.dbservers.labels: object +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) Labels specified the labels added to Pods in this group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) +*** -### .spec.dbservers.labelsIgnoreList: array +### .spec.dbservers.labelsIgnoreList + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) +*** + +### .spec.dbservers.labelsMode -### .spec.dbservers.labelsMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) +*** + +### .spec.dbservers.maxCount -### .spec.dbservers.maxCount: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) +*** -### .spec.dbservers.memoryReservation: integer +### .spec.dbservers.memoryReservation + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value. If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent. @@ -1765,57 +2203,71 @@ Links: Default Value: `0` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) +*** + +### .spec.dbservers.minCount -### .spec.dbservers.minCount: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) +*** + +### .spec.dbservers.nodeAffinity -### .spec.dbservers.nodeAffinity: core.NodeAffinity +Type: `core.NodeAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) +*** -### .spec.dbservers.nodeSelector: map[string]string +### .spec.dbservers.nodeSelector + +Type: `map[string]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) +*** + +### .spec.dbservers.numactl.args -### .spec.dbservers.numactl.args: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) Args define list of the numactl process Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) +*** + +### .spec.dbservers.numactl.enabled -### .spec.dbservers.numactl.enabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) Enabled define if numactl should be enabled Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) +*** -### .spec.dbservers.numactl.path: string +### .spec.dbservers.numactl.path + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) Path define numactl path within the container Default Value: `/usr/bin/numactl` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) +*** + +### .spec.dbservers.overrideDetectedNumberOfCores -### .spec.dbservers.overrideDetectedNumberOfCores: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable @@ -1827,9 +2279,11 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) +*** + +### .spec.dbservers.overrideDetectedTotalMemory -### .spec.dbservers.overrideDetectedTotalMemory: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable @@ -1841,23 +2295,31 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) +*** -### .spec.dbservers.podModes.network: string +### .spec.dbservers.podModes.network -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) -### .spec.dbservers.podModes.pid: string +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) +### .spec.dbservers.podModes.pid -### .spec.dbservers.port: integer +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) + +*** + +### .spec.dbservers.port + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) Port define Port used by member -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) +*** -### .spec.dbservers.priorityClassName: string +### .spec.dbservers.priorityClassName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) PriorityClassName specifies a priority class name Will be forwarded to the pod spec. @@ -1865,17 +2327,21 @@ Will be forwarded to the pod spec. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) +*** + +### .spec.dbservers.probes.livenessProbeDisabled -### .spec.dbservers.probes.livenessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) +*** + +### .spec.dbservers.probes.livenessProbeSpec.failureThreshold -### .spec.dbservers.probes.livenessProbeSpec.failureThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -1883,58 +2349,72 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** -### .spec.dbservers.probes.livenessProbeSpec.initialDelaySeconds: integer +### .spec.dbservers.probes.livenessProbeSpec.initialDelaySeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.dbservers.probes.livenessProbeSpec.periodSeconds -### .spec.dbservers.probes.livenessProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** + +### .spec.dbservers.probes.livenessProbeSpec.successThreshold -### .spec.dbservers.probes.livenessProbeSpec.successThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** -### .spec.dbservers.probes.livenessProbeSpec.timeoutSeconds: integer +### .spec.dbservers.probes.livenessProbeSpec.timeoutSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.dbservers.probes.ReadinessProbeDisabled -### .spec.dbservers.probes.ReadinessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) +*** + +### .spec.dbservers.probes.readinessProbeDisabled -### .spec.dbservers.probes.readinessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) +*** -### .spec.dbservers.probes.readinessProbeSpec.failureThreshold: integer +### .spec.dbservers.probes.readinessProbeSpec.failureThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -1942,51 +2422,63 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** + +### .spec.dbservers.probes.readinessProbeSpec.initialDelaySeconds -### .spec.dbservers.probes.readinessProbeSpec.initialDelaySeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.dbservers.probes.readinessProbeSpec.periodSeconds -### .spec.dbservers.probes.readinessProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** -### .spec.dbservers.probes.readinessProbeSpec.successThreshold: integer +### .spec.dbservers.probes.readinessProbeSpec.successThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** + +### .spec.dbservers.probes.readinessProbeSpec.timeoutSeconds -### .spec.dbservers.probes.readinessProbeSpec.timeoutSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.dbservers.probes.startupProbeDisabled -### .spec.dbservers.probes.startupProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) StartupProbeDisabled if true startupProbes are disabled -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) +*** -### .spec.dbservers.probes.startupProbeSpec.failureThreshold: integer +### .spec.dbservers.probes.startupProbeSpec.failureThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -1994,45 +2486,55 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** + +### .spec.dbservers.probes.startupProbeSpec.initialDelaySeconds -### .spec.dbservers.probes.startupProbeSpec.initialDelaySeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** -### .spec.dbservers.probes.startupProbeSpec.periodSeconds: integer +### .spec.dbservers.probes.startupProbeSpec.periodSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** + +### .spec.dbservers.probes.startupProbeSpec.successThreshold -### .spec.dbservers.probes.startupProbeSpec.successThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** -### .spec.dbservers.probes.startupProbeSpec.timeoutSeconds: integer +### .spec.dbservers.probes.startupProbeSpec.timeoutSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.dbservers.pvcResizeMode -### .spec.dbservers.pvcResizeMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) VolumeResizeMode specified resize mode for PVCs and PVs @@ -2040,105 +2542,135 @@ Possible Values: * runtime (default) - PVC will be resized in Pod runtime (EKS, GKE) * rotate - Pod will be shutdown and PVC will be resized (AKS) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) +*** + +### .spec.dbservers.resources -### .spec.dbservers.resources: core.ResourceRequirements +Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) Resources holds resource requests & limits Links: * [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) +*** -### .spec.dbservers.schedulerName: string +### .spec.dbservers.schedulerName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) SchedulerName define scheduler name used for group -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) +*** + +### .spec.dbservers.securityContext.addCapabilities -### .spec.dbservers.securityContext.addCapabilities: []core.Capability +Type: `[]core.Capability` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) AddCapabilities add new capabilities to containers -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) +*** + +### .spec.dbservers.securityContext.allowPrivilegeEscalation -### .spec.dbservers.securityContext.allowPrivilegeEscalation: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) +*** -### .spec.dbservers.securityContext.dropAllCapabilities: boolean +### .spec.dbservers.securityContext.dropAllCapabilities + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) +*** + +### .spec.dbservers.securityContext.fsGroup -### .spec.dbservers.securityContext.fsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) FSGroup is a special supplemental group that applies to all containers in a pod. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) +*** + +### .spec.dbservers.securityContext.privileged -### .spec.dbservers.securityContext.privileged: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) Privileged If true, runs container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) +*** -### .spec.dbservers.securityContext.readOnlyRootFilesystem: boolean +### .spec.dbservers.securityContext.readOnlyRootFilesystem + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) +*** + +### .spec.dbservers.securityContext.runAsGroup -### .spec.dbservers.securityContext.runAsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) RunAsGroup is the GID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) +*** + +### .spec.dbservers.securityContext.runAsNonRoot -### .spec.dbservers.securityContext.runAsNonRoot: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) RunAsNonRoot if true, indicates that the container must run as a non-root user. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) +*** -### .spec.dbservers.securityContext.runAsUser: integer +### .spec.dbservers.securityContext.runAsUser + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) RunAsUser is the UID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) +*** + +### .spec.dbservers.securityContext.seccompProfile -### .spec.dbservers.securityContext.seccompProfile: core.SeccompProfile +Type: `core.SeccompProfile` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. Links: * [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) +*** + +### .spec.dbservers.securityContext.seLinuxOptions -### .spec.dbservers.securityContext.seLinuxOptions: core.SELinuxOptions +Type: `core.SELinuxOptions` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) SELinuxOptions are the labels to be applied to the container Links: * [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) +*** -### .spec.dbservers.securityContext.supplementalGroups: array +### .spec.dbservers.securityContext.supplementalGroups + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) +*** + +### .spec.dbservers.securityContext.sysctls -### .spec.dbservers.securityContext.sysctls: map[string]intstr.IntOrString +Type: `map[string]intstr.IntOrString` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. @@ -2155,9 +2687,11 @@ sysctls: "kernel.msgmax": "65536" ``` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) +*** + +### .spec.dbservers.serviceAccountName -### .spec.dbservers.serviceAccountName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created for each server of this group. If empty, it defaults to using the @@ -2168,49 +2702,63 @@ deployment of the operator, we grant the rights to 'get' all 'pod' resources. If you are using a different service account, please grant these rights to that service account. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) +*** -### .spec.dbservers.shutdownDelay: integer +### .spec.dbservers.shutdownDelay + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) +*** + +### .spec.dbservers.shutdownMethod -### .spec.dbservers.shutdownMethod: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) +*** + +### .spec.dbservers.sidecarCoreNames -### .spec.dbservers.sidecarCoreNames: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) +*** -### .spec.dbservers.sidecars: []core.Container +### .spec.dbservers.sidecars + +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) +*** + +### .spec.dbservers.storageClassName -### .spec.dbservers.storageClassName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) StorageClassName specifies the classname for storage of the servers. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) +*** + +### .spec.dbservers.terminationGracePeriodSeconds -### .spec.dbservers.terminationGracePeriodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) +*** -### .spec.dbservers.tolerations: []core.Toleration +### .spec.dbservers.tolerations + +Type: `[]core.Toleration` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) Tolerations specifies the tolerations added to Pods in this group. By default, suitable tolerations are set for the following keys with the `NoExecute` effect: @@ -2222,15 +2770,19 @@ For more information on tolerations, consult the https://kubernetes.io/docs/conc Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) +*** + +### .spec.dbservers.volumeAllowShrink -### .spec.dbservers.volumeAllowShrink: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) +*** + +### .spec.dbservers.volumeClaimTemplate -### .spec.dbservers.volumeClaimTemplate: core.PersistentVolumeClaim +Type: `core.PersistentVolumeClaim` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group. This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`. @@ -2242,78 +2794,96 @@ and `iops` is not forwarded to the pods resource requirements. Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) +*** -### .spec.dbservers.volumeMounts: []ServerGroupSpecVolumeMount +### .spec.dbservers.volumeMounts + +Type: `[]ServerGroupSpecVolumeMount` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) +*** + +### .spec.dbservers.volumes\[int\].configMap -### .spec.dbservers.volumes\[int\].configMap: core.ConfigMapVolumeSource +Type: `core.ConfigMapVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) ConfigMap which should be mounted into pod Links: * [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) +*** + +### .spec.dbservers.volumes\[int\].emptyDir -### .spec.dbservers.volumes\[int\].emptyDir: core.EmptyDirVolumeSource +Type: `core.EmptyDirVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) EmptyDir Links: * [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) +*** -### .spec.dbservers.volumes\[int\].hostPath: core.HostPathVolumeSource +### .spec.dbservers.volumes\[int\].hostPath + +Type: `core.HostPathVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) HostPath Links: * [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) +*** + +### .spec.dbservers.volumes\[int\].name -### .spec.dbservers.volumes\[int\].name: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) Name of volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) +*** + +### .spec.dbservers.volumes\[int\].persistentVolumeClaim -### .spec.dbservers.volumes\[int\].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource +Type: `core.PersistentVolumeClaimVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) PersistentVolumeClaim Links: * [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) +*** -### .spec.dbservers.volumes\[int\].secret: core.SecretVolumeSource +### .spec.dbservers.volumes\[int\].secret + +Type: `core.SecretVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) Secret which should be mounted into pod Links: * [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) +*** + +### .spec.disableIPv6 -### .spec.disableIPv6: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L109) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L109) +*** + +### .spec.downtimeAllowed -### .spec.downtimeAllowed: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L104) 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. @@ -2325,9 +2895,11 @@ Note: It is still possible that there is some downtime when the Kubernetes clust Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L104) +*** -### .spec.environment: string +### .spec.environment + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L65) Environment setting specifies the type of environment in which the deployment is created. @@ -2335,22 +2907,28 @@ 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L65) +*** + +### .spec.externalAccess.advertisedEndpoint -### .spec.externalAccess.advertisedEndpoint: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L58) AdvertisedEndpoint is passed to the coordinators/single servers for advertising a specific endpoint -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L58) +*** + +### .spec.externalAccess.loadBalancerIP -### .spec.externalAccess.loadBalancerIP: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L48) LoadBalancerIP define optional IP used to configure a load-balancer on, in case of Auto or LoadBalancer type. If you do not specify this setting, an IP will be chosen automatically by the load-balancer provisioner. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L48) +*** -### .spec.externalAccess.loadBalancerSourceRanges: array +### .spec.externalAccess.loadBalancerSourceRanges + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L55) LoadBalancerSourceRanges define LoadBalancerSourceRanges used for LoadBalancer Service type If specified and supported by the platform, this will restrict traffic through the cloud-provider @@ -2360,24 +2938,30 @@ cloud-provider does not support the feature. Links: * [Cloud Provider Firewall](https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L55) +*** + +### .spec.externalAccess.managedServiceNames -### .spec.externalAccess.managedServiceNames: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L62) ManagedServiceNames keeps names of services which are not managed by KubeArangoDB. It is only relevant when type of service is `managed`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L62) +*** + +### .spec.externalAccess.nodePort -### .spec.externalAccess.nodePort: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L44) NodePort define optional port used in case of Auto or NodePort type. This setting is used when `spec.externalAccess.type` is set to `NodePort` or `Auto`. If you do not specify this setting, a random port will be chosen automatically. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L44) +*** -### .spec.externalAccess.type: string +### .spec.externalAccess.type + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L39) Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster. @@ -2387,148 +2971,190 @@ Possible Values: * LoadBalancer - Create a Service of type LoadBalancer for the ArangoDB deployment. * NodePort - Create a Service of type NodePort for the ArangoDB deployment. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L39) +*** + +### .spec.features.foxx.queues + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_features.go#L24) -### .spec.features.foxx.queues: boolean +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_features.go#L24) +### .spec.id.affinity -### .spec.id.affinity: core.PodAffinity +Type: `core.PodAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L44) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L44) +*** -### .spec.id.antiAffinity: core.PodAntiAffinity +### .spec.id.antiAffinity + +Type: `core.PodAntiAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L40) AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L40) +*** + +### .spec.id.entrypoint -### .spec.id.entrypoint: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L28) Entrypoint overrides container executable -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L28) +*** -### .spec.id.nodeAffinity: core.NodeAffinity +### .spec.id.nodeAffinity + +Type: `core.NodeAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L48) NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L48) +*** + +### .spec.id.nodeSelector -### .spec.id.nodeSelector: object +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L34) NodeSelector specifies a set of selectors for nodes -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L34) +*** -### .spec.id.priorityClassName: string +### .spec.id.priorityClassName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L36) PriorityClassName specifies a priority class name -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L36) +*** + +### .spec.id.resources -### .spec.id.resources: core.ResourceRequirements +Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L56) Resources holds resource requests & limits Links: * [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L56) +*** + +### .spec.id.securityContext.addCapabilities -### .spec.id.securityContext.addCapabilities: []core.Capability +Type: `[]core.Capability` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) AddCapabilities add new capabilities to containers -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) +*** -### .spec.id.securityContext.allowPrivilegeEscalation: boolean +### .spec.id.securityContext.allowPrivilegeEscalation + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) +*** + +### .spec.id.securityContext.dropAllCapabilities -### .spec.id.securityContext.dropAllCapabilities: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) +*** + +### .spec.id.securityContext.fsGroup -### .spec.id.securityContext.fsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) FSGroup is a special supplemental group that applies to all containers in a pod. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) +*** -### .spec.id.securityContext.privileged: boolean +### .spec.id.securityContext.privileged + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) Privileged If true, runs container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) +*** + +### .spec.id.securityContext.readOnlyRootFilesystem -### .spec.id.securityContext.readOnlyRootFilesystem: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) +*** + +### .spec.id.securityContext.runAsGroup -### .spec.id.securityContext.runAsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) RunAsGroup is the GID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) +*** -### .spec.id.securityContext.runAsNonRoot: boolean +### .spec.id.securityContext.runAsNonRoot + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) RunAsNonRoot if true, indicates that the container must run as a non-root user. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) +*** + +### .spec.id.securityContext.runAsUser -### .spec.id.securityContext.runAsUser: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) RunAsUser is the UID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) +*** + +### .spec.id.securityContext.seccompProfile -### .spec.id.securityContext.seccompProfile: core.SeccompProfile +Type: `core.SeccompProfile` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. Links: * [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) +*** -### .spec.id.securityContext.seLinuxOptions: core.SELinuxOptions +### .spec.id.securityContext.seLinuxOptions + +Type: `core.SELinuxOptions` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) SELinuxOptions are the labels to be applied to the container Links: * [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) +*** + +### .spec.id.securityContext.supplementalGroups -### .spec.id.securityContext.supplementalGroups: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) +*** + +### .spec.id.securityContext.sysctls -### .spec.id.securityContext.sysctls: map[string]intstr.IntOrString +Type: `map[string]intstr.IntOrString` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. @@ -2545,33 +3171,41 @@ sysctls: "kernel.msgmax": "65536" ``` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) +*** -### .spec.id.serviceAccountName: string +### .spec.id.serviceAccountName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L50) ServiceAccountName specifies the name of the service account used for Pods in this group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L50) +*** + +### .spec.id.tolerations -### .spec.id.tolerations: []core.Toleration +Type: `[]core.Toleration` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L32) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_id_group_spec.go#L32) +*** + +### .spec.image -### .spec.image: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L78) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L78) +*** -### .spec.imageDiscoveryMode: string +### .spec.imageDiscoveryMode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L94) ImageDiscoveryMode specifies the image discovery mode. @@ -2579,9 +3213,11 @@ 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L94) +*** + +### .spec.imagePullPolicy -### .spec.imagePullPolicy: core.PullPolicy +Type: `core.PullPolicy` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L86) ImagePullPolicy specifies the pull policy for the docker image to use for all ArangoDB servers. @@ -2593,27 +3229,35 @@ Possible Values: * 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L86) +*** + +### .spec.imagePullSecrets -### .spec.imagePullSecrets: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L89) ImagePullSecrets specifies the list of image pull secrets for the docker image to use for all ArangoDB servers. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L89) +*** -### .spec.labels: object +### .spec.labels + +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L138) Labels specifies the labels added to Pods in this group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L138) +*** + +### .spec.labelsIgnoreList -### .spec.labelsIgnoreList: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L141) LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L141) +*** + +### .spec.labelsMode -### .spec.labelsMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L147) LabelsMode Define labels mode which should be use while overriding labels @@ -2622,26 +3266,32 @@ Possible Values: * append - Add new annotations/labels without affecting old ones * replace - Replace existing annotations/labels -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L147) +*** -### .spec.license.secretName: string +### .spec.license.secretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/license_spec.go#L33) SecretName setting specifies the name of a kubernetes `Secret` that contains the license key token used for enterprise images. This value is not used for the Community Edition. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/license_spec.go#L33) +*** + +### .spec.lifecycle.resources -### .spec.lifecycle.resources: core.ResourceRequirements +Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/lifecycle_spec.go#L31) Resources holds resource requests & limits Links: * [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/lifecycle_spec.go#L31) +*** + +### .spec.memberPropagationMode -### .spec.memberPropagationMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L220) MemberPropagationMode defines how changes to pod spec should be propogated. Changes to a pod’s configuration require a restart of that pod in almost all cases. @@ -2653,15 +3303,19 @@ 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L220) +*** -### .spec.metrics.authentication.jwtTokenSecretName: string +### .spec.metrics.authentication.jwtTokenSecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L34) JWTTokenSecretName contains the name of the JWT kubernetes secret used for authentication -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L34) +*** + +### .spec.metrics.enabled -### .spec.metrics.enabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L81) Enabled if this is set to `true`, the operator runs a sidecar container for every Agent, DB-Server, Coordinator and Single server. @@ -2671,42 +3325,56 @@ Links: Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L81) +*** + +### .spec.metrics.image -### .spec.metrics.image: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L83) deprecated -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L83) +*** -### .spec.metrics.mode: string +### .spec.metrics.mode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L90) deprecated -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L90) +*** + +### .spec.metrics.port + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L99) -### .spec.metrics.port: integer +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L99) +### .spec.metrics.resources -### .spec.metrics.resources: core.ResourceRequirements +Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L88) Resources holds resource requests & limits Links: * [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L88) +*** -### .spec.metrics.serviceMonitor.enabled: boolean +### .spec.metrics.serviceMonitor.enabled -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_service_monitor_spec.go#L24) +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_service_monitor_spec.go#L24) -### .spec.metrics.serviceMonitor.labels: object +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_service_monitor_spec.go#L25) +### .spec.metrics.serviceMonitor.labels -### .spec.metrics.tls: boolean +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_service_monitor_spec.go#L25) + +*** + +### .spec.metrics.tls + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L95) TLS defines if TLS should be enabled on Metrics exporter endpoint. This option will enable TLS only if TLS is enabled on ArangoDeployment, @@ -2714,9 +3382,11 @@ otherwise `true` value will not take any effect. Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_metrics_spec.go#L95) +*** -### .spec.mode: string +### .spec.mode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L60) Mode specifies the type of ArangoDB deployment to create. @@ -2727,9 +3397,11 @@ Possible Values: This field is **immutable**: Change of the ArangoDeployment Mode is not possible after creation. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L60) +*** + +### .spec.networkAttachedVolumes -### .spec.networkAttachedVolumes: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L123) NetworkAttachedVolumes If set to `true`, a ResignLeadership operation will be triggered when a DB-Server pod is evicted (rather than a CleanOutServer operation). @@ -2739,38 +3411,52 @@ If your persistent volumes are tied to a specific pod, you must leave this optio Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L123) +*** + +### .spec.rebalancer.enabled -### .spec.rebalancer.enabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L26) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L26) +*** -### .spec.rebalancer.optimizers.leader: boolean +### .spec.rebalancer.optimizers.leader -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L74) +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L74) -### .spec.rebalancer.parallelMoves: integer +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L28) +### .spec.rebalancer.parallelMoves -### .spec.rebalancer.readers.count: boolean +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L28) + +*** + +### .spec.rebalancer.readers.count + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L62) deprecated does not work in Rebalancer V2 Count Enable Shard Count machanism -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rebalancer_spec.go#L62) +*** -### .spec.recovery.autoRecover: boolean +### .spec.recovery.autoRecover -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/recovery_spec.go#L26) +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/recovery_spec.go#L26) -### .spec.restoreEncryptionSecret: string +*** + +### .spec.restoreEncryptionSecret + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L160) RestoreEncryptionSecret specifies optional name of secret which contains encryption key used for restore -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L160) +*** + +### .spec.restoreFrom -### .spec.restoreFrom: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L157) 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. @@ -2781,9 +3467,11 @@ It will contain some of the following fields: 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L157) +*** -### .spec.rocksdb.encryption.keySecretName: string +### .spec.rocksdb.encryption.keySecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rocksdb_spec.go#L37) KeySecretName setting specifies the name of a Kubernetes `Secret` that contains an encryption key used for encrypting all data stored by ArangoDB servers. When an encryption key is used, encryption of the data in the cluster is enabled, without it encryption is disabled. @@ -2792,63 +3480,79 @@ This requires the Enterprise Edition. The encryption key cannot be changed after the cluster has been created. The secret specified by this setting, must have a data field named 'key' containing an encryption key that is exactly 32 bytes long. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/rocksdb_spec.go#L37) +*** + +### .spec.single.affinity -### .spec.single.affinity: core.PodAffinity +Type: `core.PodAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) +*** + +### .spec.single.allowMemberRecreation -### .spec.single.allowMemberRecreation: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) AllowMemberRecreation allows to recreate member. This setting changes the member recreation logic based on group: - For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`) - For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) +*** -### .spec.single.annotations: object +### .spec.single.annotations + +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) Annotations specified the annotations added to Pods in this group. Annotations are merged with `spec.annotations`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) +*** + +### .spec.single.annotationsIgnoreList -### .spec.single.annotationsIgnoreList: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) +*** + +### .spec.single.annotationsMode -### .spec.single.annotationsMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) +*** -### .spec.single.antiAffinity: core.PodAntiAffinity +### .spec.single.antiAffinity + +Type: `core.PodAntiAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) +*** + +### .spec.single.args -### .spec.single.args: []string +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) Args setting specifies additional command-line arguments passed to all servers of this group. Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) +*** + +### .spec.single.count -### .spec.single.count: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) Count setting specifies the number of servers to start for the given group. For the Agent group, this value must be a positive, odd number. @@ -2857,59 +3561,77 @@ for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`). For the `syncworkers` group, it is highly recommended to use the same number as for the `dbservers` group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) +*** -### .spec.single.entrypoint: string +### .spec.single.entrypoint + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) Entrypoint overrides container executable -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) +*** + +### .spec.single.envs\[int\].name + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) -### .spec.single.envs\[int\].name: string +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) +### .spec.single.envs\[int\].value -### .spec.single.envs\[int\].value: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) +*** -### .spec.single.ephemeralVolumes.apps.size: resource.Quantity +### .spec.single.ephemeralVolumes.apps.size + +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** + +### .spec.single.ephemeralVolumes.temp.size -### .spec.single.ephemeralVolumes.temp.size: resource.Quantity +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** + +### .spec.single.exporterPort -### .spec.single.exporterPort: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) ExporterPort define Port used by exporter -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) +*** -### .spec.single.extendedRotationCheck: boolean +### .spec.single.extendedRotationCheck + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) ExtendedRotationCheck extend checks for rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) +*** + +### .spec.single.externalPortEnabled -### .spec.single.externalPortEnabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) +*** + +### .spec.single.indexMethod -### .spec.single.indexMethod: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) IndexMethod define group Indexing method @@ -2917,60 +3639,78 @@ 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) +*** -### .spec.single.initContainers.containers: []core.Container +### .spec.single.initContainers.containers + +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) Containers contains list of containers Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) +*** + +### .spec.single.initContainers.mode -### .spec.single.initContainers.mode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) Mode keep container replace mode -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) +*** + +### .spec.single.internalPort -### .spec.single.internalPort: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) +*** -### .spec.single.internalPortProtocol: string +### .spec.single.internalPortProtocol + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) +*** + +### .spec.single.labels -### .spec.single.labels: object +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) Labels specified the labels added to Pods in this group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) +*** + +### .spec.single.labelsIgnoreList -### .spec.single.labelsIgnoreList: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) +*** -### .spec.single.labelsMode: string +### .spec.single.labelsMode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) +*** + +### .spec.single.maxCount -### .spec.single.maxCount: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) +*** + +### .spec.single.memoryReservation -### .spec.single.memoryReservation: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value. If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent. @@ -2981,57 +3721,71 @@ Links: Default Value: `0` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) +*** -### .spec.single.minCount: integer +### .spec.single.minCount + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) +*** + +### .spec.single.nodeAffinity -### .spec.single.nodeAffinity: core.NodeAffinity +Type: `core.NodeAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) +*** + +### .spec.single.nodeSelector -### .spec.single.nodeSelector: map[string]string +Type: `map[string]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) +*** -### .spec.single.numactl.args: array +### .spec.single.numactl.args + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) Args define list of the numactl process Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) +*** + +### .spec.single.numactl.enabled -### .spec.single.numactl.enabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) Enabled define if numactl should be enabled Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) +*** + +### .spec.single.numactl.path -### .spec.single.numactl.path: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) Path define numactl path within the container Default Value: `/usr/bin/numactl` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) +*** -### .spec.single.overrideDetectedNumberOfCores: boolean +### .spec.single.overrideDetectedNumberOfCores + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable @@ -3043,9 +3797,11 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) +*** + +### .spec.single.overrideDetectedTotalMemory -### .spec.single.overrideDetectedTotalMemory: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable @@ -3057,23 +3813,31 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) +*** + +### .spec.single.podModes.network -### .spec.single.podModes.network: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) +*** -### .spec.single.podModes.pid: string +### .spec.single.podModes.pid -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) -### .spec.single.port: integer +*** + +### .spec.single.port + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) Port define Port used by member -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) +*** + +### .spec.single.priorityClassName -### .spec.single.priorityClassName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) PriorityClassName specifies a priority class name Will be forwarded to the pod spec. @@ -3081,17 +3845,21 @@ Will be forwarded to the pod spec. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) +*** -### .spec.single.probes.livenessProbeDisabled: boolean +### .spec.single.probes.livenessProbeDisabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) +*** + +### .spec.single.probes.livenessProbeSpec.failureThreshold -### .spec.single.probes.livenessProbeSpec.failureThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -3099,58 +3867,72 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** + +### .spec.single.probes.livenessProbeSpec.initialDelaySeconds -### .spec.single.probes.livenessProbeSpec.initialDelaySeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** -### .spec.single.probes.livenessProbeSpec.periodSeconds: integer +### .spec.single.probes.livenessProbeSpec.periodSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** + +### .spec.single.probes.livenessProbeSpec.successThreshold -### .spec.single.probes.livenessProbeSpec.successThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** + +### .spec.single.probes.livenessProbeSpec.timeoutSeconds -### .spec.single.probes.livenessProbeSpec.timeoutSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** -### .spec.single.probes.ReadinessProbeDisabled: boolean +### .spec.single.probes.ReadinessProbeDisabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) +*** + +### .spec.single.probes.readinessProbeDisabled -### .spec.single.probes.readinessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) +*** + +### .spec.single.probes.readinessProbeSpec.failureThreshold -### .spec.single.probes.readinessProbeSpec.failureThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -3158,51 +3940,63 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** -### .spec.single.probes.readinessProbeSpec.initialDelaySeconds: integer +### .spec.single.probes.readinessProbeSpec.initialDelaySeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.single.probes.readinessProbeSpec.periodSeconds -### .spec.single.probes.readinessProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** -### .spec.single.probes.readinessProbeSpec.successThreshold: integer +### .spec.single.probes.readinessProbeSpec.successThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** + +### .spec.single.probes.readinessProbeSpec.timeoutSeconds -### .spec.single.probes.readinessProbeSpec.timeoutSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** -### .spec.single.probes.startupProbeDisabled: boolean +### .spec.single.probes.startupProbeDisabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) StartupProbeDisabled if true startupProbes are disabled -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) +*** + +### .spec.single.probes.startupProbeSpec.failureThreshold -### .spec.single.probes.startupProbeSpec.failureThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -3210,45 +4004,55 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** -### .spec.single.probes.startupProbeSpec.initialDelaySeconds: integer +### .spec.single.probes.startupProbeSpec.initialDelaySeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.single.probes.startupProbeSpec.periodSeconds -### .spec.single.probes.startupProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** -### .spec.single.probes.startupProbeSpec.successThreshold: integer +### .spec.single.probes.startupProbeSpec.successThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** + +### .spec.single.probes.startupProbeSpec.timeoutSeconds -### .spec.single.probes.startupProbeSpec.timeoutSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** -### .spec.single.pvcResizeMode: string +### .spec.single.pvcResizeMode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) VolumeResizeMode specified resize mode for PVCs and PVs @@ -3256,105 +4060,135 @@ Possible Values: * runtime (default) - PVC will be resized in Pod runtime (EKS, GKE) * rotate - Pod will be shutdown and PVC will be resized (AKS) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) +*** + +### .spec.single.resources -### .spec.single.resources: core.ResourceRequirements +Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) Resources holds resource requests & limits Links: * [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) +*** -### .spec.single.schedulerName: string +### .spec.single.schedulerName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) SchedulerName define scheduler name used for group -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) +*** + +### .spec.single.securityContext.addCapabilities -### .spec.single.securityContext.addCapabilities: []core.Capability +Type: `[]core.Capability` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) AddCapabilities add new capabilities to containers -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) +*** -### .spec.single.securityContext.allowPrivilegeEscalation: boolean +### .spec.single.securityContext.allowPrivilegeEscalation + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) +*** + +### .spec.single.securityContext.dropAllCapabilities -### .spec.single.securityContext.dropAllCapabilities: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) +*** -### .spec.single.securityContext.fsGroup: integer +### .spec.single.securityContext.fsGroup + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) FSGroup is a special supplemental group that applies to all containers in a pod. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) +*** + +### .spec.single.securityContext.privileged -### .spec.single.securityContext.privileged: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) Privileged If true, runs container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) +*** -### .spec.single.securityContext.readOnlyRootFilesystem: boolean +### .spec.single.securityContext.readOnlyRootFilesystem + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) +*** + +### .spec.single.securityContext.runAsGroup -### .spec.single.securityContext.runAsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) RunAsGroup is the GID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) +*** -### .spec.single.securityContext.runAsNonRoot: boolean +### .spec.single.securityContext.runAsNonRoot + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) RunAsNonRoot if true, indicates that the container must run as a non-root user. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) +*** + +### .spec.single.securityContext.runAsUser -### .spec.single.securityContext.runAsUser: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) RunAsUser is the UID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) +*** -### .spec.single.securityContext.seccompProfile: core.SeccompProfile +### .spec.single.securityContext.seccompProfile + +Type: `core.SeccompProfile` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. Links: * [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) +*** + +### .spec.single.securityContext.seLinuxOptions -### .spec.single.securityContext.seLinuxOptions: core.SELinuxOptions +Type: `core.SELinuxOptions` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) SELinuxOptions are the labels to be applied to the container Links: * [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) +*** -### .spec.single.securityContext.supplementalGroups: array +### .spec.single.securityContext.supplementalGroups + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) +*** + +### .spec.single.securityContext.sysctls -### .spec.single.securityContext.sysctls: map[string]intstr.IntOrString +Type: `map[string]intstr.IntOrString` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. @@ -3371,9 +4205,11 @@ sysctls: "kernel.msgmax": "65536" ``` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) +*** -### .spec.single.serviceAccountName: string +### .spec.single.serviceAccountName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created for each server of this group. If empty, it defaults to using the @@ -3384,49 +4220,63 @@ deployment of the operator, we grant the rights to 'get' all 'pod' resources. If you are using a different service account, please grant these rights to that service account. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) +*** + +### .spec.single.shutdownDelay -### .spec.single.shutdownDelay: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) +*** -### .spec.single.shutdownMethod: string +### .spec.single.shutdownMethod + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) +*** + +### .spec.single.sidecarCoreNames -### .spec.single.sidecarCoreNames: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) +*** -### .spec.single.sidecars: []core.Container +### .spec.single.sidecars + +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) +*** + +### .spec.single.storageClassName -### .spec.single.storageClassName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) StorageClassName specifies the classname for storage of the servers. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) +*** -### .spec.single.terminationGracePeriodSeconds: integer +### .spec.single.terminationGracePeriodSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) +*** + +### .spec.single.tolerations -### .spec.single.tolerations: []core.Toleration +Type: `[]core.Toleration` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) Tolerations specifies the tolerations added to Pods in this group. By default, suitable tolerations are set for the following keys with the `NoExecute` effect: @@ -3438,15 +4288,19 @@ For more information on tolerations, consult the https://kubernetes.io/docs/conc Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) +*** -### .spec.single.volumeAllowShrink: boolean +### .spec.single.volumeAllowShrink + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) +*** + +### .spec.single.volumeClaimTemplate -### .spec.single.volumeClaimTemplate: core.PersistentVolumeClaim +Type: `core.PersistentVolumeClaim` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group. This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`. @@ -3458,69 +4312,85 @@ and `iops` is not forwarded to the pods resource requirements. Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) +*** -### .spec.single.volumeMounts: []ServerGroupSpecVolumeMount +### .spec.single.volumeMounts + +Type: `[]ServerGroupSpecVolumeMount` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) +*** + +### .spec.single.volumes\[int\].configMap -### .spec.single.volumes\[int\].configMap: core.ConfigMapVolumeSource +Type: `core.ConfigMapVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) ConfigMap which should be mounted into pod Links: * [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) +*** -### .spec.single.volumes\[int\].emptyDir: core.EmptyDirVolumeSource +### .spec.single.volumes\[int\].emptyDir + +Type: `core.EmptyDirVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) EmptyDir Links: * [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) +*** + +### .spec.single.volumes\[int\].hostPath -### .spec.single.volumes\[int\].hostPath: core.HostPathVolumeSource +Type: `core.HostPathVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) HostPath Links: * [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) +*** -### .spec.single.volumes\[int\].name: string +### .spec.single.volumes\[int\].name + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) Name of volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) +*** + +### .spec.single.volumes\[int\].persistentVolumeClaim -### .spec.single.volumes\[int\].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource +Type: `core.PersistentVolumeClaimVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) PersistentVolumeClaim Links: * [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) +*** -### .spec.single.volumes\[int\].secret: core.SecretVolumeSource +### .spec.single.volumes\[int\].secret + +Type: `core.SecretVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) Secret which should be mounted into pod Links: * [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) +*** + +### .spec.storageEngine -### .spec.storageEngine: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L72) StorageEngine specifies the type of storage engine used for all servers in the cluster. @@ -3530,18 +4400,22 @@ Possible Values: This field is **immutable**: This setting cannot be changed after the cluster has been created. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L72) +*** -### .spec.sync.auth.clientCASecretName: string +### .spec.sync.auth.clientCASecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_authentication_spec.go#L41) ClientCASecretName setting specifies the name of a kubernetes `Secret` that contains a PEM encoded CA certificate used for client certificate verification in all ArangoSync master servers. This is a required setting when `spec.sync.enabled` is `true`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_authentication_spec.go#L41) +*** + +### .spec.sync.auth.jwtSecretName -### .spec.sync.auth.jwtSecretName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_authentication_spec.go#L36) JWTSecretName setting specifies the name of a kubernetes `Secret` that contains the JWT token used for accessing all ArangoSync master servers. @@ -3549,9 +4423,11 @@ When not specified, the `spec.auth.jwtSecretName` value is used. If you specify a name of a `Secret` that does not exist, a random token is created and stored in a `Secret` with given name. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_authentication_spec.go#L36) +*** -### .spec.sync.enabled: boolean +### .spec.sync.enabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_spec.go#L34) Enabled setting enables/disables support for data center 2 data center replication in the cluster. When enabled, the cluster will contain @@ -3559,9 +4435,11 @@ a number of `syncmaster` & `syncworker` servers. Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_spec.go#L34) +*** + +### .spec.sync.externalAccess.accessPackageSecretNames -### .spec.sync.externalAccess.accessPackageSecretNames: []string +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_external_access_spec.go#L49) AccessPackageSecretNames setting specifies the names of zero of more `Secrets` that will be created by the deployment operator containing "access packages". An access package contains those `Secrets` that are needed @@ -3573,22 +4451,28 @@ Completely removing the setting results in not modifying the list. Links: * [See the ArangoDeploymentReplication specification](deployment-replication-resource-reference.md) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_external_access_spec.go#L49) +*** -### .spec.sync.externalAccess.advertisedEndpoint: string +### .spec.sync.externalAccess.advertisedEndpoint + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L58) AdvertisedEndpoint is passed to the coordinators/single servers for advertising a specific endpoint -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L58) +*** + +### .spec.sync.externalAccess.loadBalancerIP -### .spec.sync.externalAccess.loadBalancerIP: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L48) LoadBalancerIP define optional IP used to configure a load-balancer on, in case of Auto or LoadBalancer type. If you do not specify this setting, an IP will be chosen automatically by the load-balancer provisioner. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L48) +*** -### .spec.sync.externalAccess.loadBalancerSourceRanges: array +### .spec.sync.externalAccess.loadBalancerSourceRanges + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L55) LoadBalancerSourceRanges define LoadBalancerSourceRanges used for LoadBalancer Service type If specified and supported by the platform, this will restrict traffic through the cloud-provider @@ -3598,33 +4482,41 @@ cloud-provider does not support the feature. Links: * [Cloud Provider Firewall](https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L55) +*** + +### .spec.sync.externalAccess.managedServiceNames -### .spec.sync.externalAccess.managedServiceNames: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L62) ManagedServiceNames keeps names of services which are not managed by KubeArangoDB. It is only relevant when type of service is `managed`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L62) +*** -### .spec.sync.externalAccess.masterEndpoint: []string +### .spec.sync.externalAccess.masterEndpoint + +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_external_access_spec.go#L40) MasterEndpoint setting specifies the master endpoint(s) advertised by the ArangoSync SyncMasters. If not set, this setting defaults to: - If `spec.sync.externalAccess.loadBalancerIP` is set, it defaults to `https://:<8629>`. - Otherwise it defaults to `https://:<8629>`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_external_access_spec.go#L40) +*** + +### .spec.sync.externalAccess.nodePort -### .spec.sync.externalAccess.nodePort: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L44) NodePort define optional port used in case of Auto or NodePort type. This setting is used when `spec.externalAccess.type` is set to `NodePort` or `Auto`. If you do not specify this setting, a random port will be chosen automatically. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L44) +*** -### .spec.sync.externalAccess.type: string +### .spec.sync.externalAccess.type + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L39) Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster. @@ -3634,29 +4526,37 @@ Possible Values: * LoadBalancer - Create a Service of type LoadBalancer for the ArangoDB deployment. * NodePort - Create a Service of type NodePort for the ArangoDB deployment. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/external_access_spec.go#L39) +*** + +### .spec.sync.image -### .spec.sync.image: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_spec.go#L40) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_spec.go#L40) +*** -### .spec.sync.monitoring.tokenSecretName: string +### .spec.sync.monitoring.tokenSecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_monitoring_spec.go#L34) TokenSecretName setting specifies the name of a kubernetes `Secret` that contains the bearer token used for accessing all monitoring endpoints of all arangod/arangosync servers. When not specified, no monitoring token is used. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/sync_monitoring_spec.go#L34) +*** + +### .spec.sync.tls.altNames -### .spec.sync.tls.altNames: []string +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L72) AltNames setting specifies a list of alternate names that will be added to all generated certificates. These names can be DNS names or email addresses. The default value is empty. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L72) +*** -### .spec.sync.tls.caSecretName: string +### .spec.sync.tls.caSecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L67) CASecretName setting specifies the name of a kubernetes `Secret` that contains a standard CA certificate + private key used to sign certificates for individual @@ -3669,17 +4569,23 @@ The specified `Secret`, must contain the following data fields: - `ca.crt` PEM encoded public key of the CA certificate - `ca.key` PEM encoded private key of the CA certificate -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L67) +*** + +### .spec.sync.tls.mode -### .spec.sync.tls.mode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L81) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L81) +*** -### .spec.sync.tls.sni.mapping.\: array +### .spec.sync.tls.sni.mapping.\ -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_sni_spec.go#L30) +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_sni_spec.go#L30) -### .spec.sync.tls.ttl: string +*** + +### .spec.sync.tls.ttl + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L79) TTL setting specifies the time to live of all generated server certificates. When the server certificate is about to expire, it will be automatically replaced @@ -3689,63 +4595,79 @@ will be set to 10 years. Default Value: `"2160h" (about 3 months)` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L79) +*** -### .spec.syncmasters.affinity: core.PodAffinity +### .spec.syncmasters.affinity + +Type: `core.PodAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) +*** + +### .spec.syncmasters.allowMemberRecreation -### .spec.syncmasters.allowMemberRecreation: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) AllowMemberRecreation allows to recreate member. This setting changes the member recreation logic based on group: - For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`) - For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) +*** -### .spec.syncmasters.annotations: object +### .spec.syncmasters.annotations + +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) Annotations specified the annotations added to Pods in this group. Annotations are merged with `spec.annotations`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) +*** + +### .spec.syncmasters.annotationsIgnoreList -### .spec.syncmasters.annotationsIgnoreList: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) +*** -### .spec.syncmasters.annotationsMode: string +### .spec.syncmasters.annotationsMode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) +*** + +### .spec.syncmasters.antiAffinity -### .spec.syncmasters.antiAffinity: core.PodAntiAffinity +Type: `core.PodAntiAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) +*** -### .spec.syncmasters.args: []string +### .spec.syncmasters.args + +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) Args setting specifies additional command-line arguments passed to all servers of this group. Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) +*** + +### .spec.syncmasters.count -### .spec.syncmasters.count: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) Count setting specifies the number of servers to start for the given group. For the Agent group, this value must be a positive, odd number. @@ -3754,59 +4676,77 @@ for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`). For the `syncworkers` group, it is highly recommended to use the same number as for the `dbservers` group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) +*** -### .spec.syncmasters.entrypoint: string +### .spec.syncmasters.entrypoint + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) Entrypoint overrides container executable -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) +*** + +### .spec.syncmasters.envs\[int\].name -### .spec.syncmasters.envs\[int\].name: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) +*** -### .spec.syncmasters.envs\[int\].value: string +### .spec.syncmasters.envs\[int\].value -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) -### .spec.syncmasters.ephemeralVolumes.apps.size: resource.Quantity +*** + +### .spec.syncmasters.ephemeralVolumes.apps.size + +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** -### .spec.syncmasters.ephemeralVolumes.temp.size: resource.Quantity +### .spec.syncmasters.ephemeralVolumes.temp.size + +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** + +### .spec.syncmasters.exporterPort -### .spec.syncmasters.exporterPort: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) ExporterPort define Port used by exporter -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) +*** -### .spec.syncmasters.extendedRotationCheck: boolean +### .spec.syncmasters.extendedRotationCheck + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) ExtendedRotationCheck extend checks for rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) +*** + +### .spec.syncmasters.externalPortEnabled -### .spec.syncmasters.externalPortEnabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) +*** -### .spec.syncmasters.indexMethod: string +### .spec.syncmasters.indexMethod + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) IndexMethod define group Indexing method @@ -3814,60 +4754,78 @@ 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) +*** + +### .spec.syncmasters.initContainers.containers -### .spec.syncmasters.initContainers.containers: []core.Container +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) Containers contains list of containers Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) +*** -### .spec.syncmasters.initContainers.mode: string +### .spec.syncmasters.initContainers.mode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) Mode keep container replace mode -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) +*** + +### .spec.syncmasters.internalPort -### .spec.syncmasters.internalPort: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) +*** -### .spec.syncmasters.internalPortProtocol: string +### .spec.syncmasters.internalPortProtocol + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) +*** + +### .spec.syncmasters.labels -### .spec.syncmasters.labels: object +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) Labels specified the labels added to Pods in this group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) +*** -### .spec.syncmasters.labelsIgnoreList: array +### .spec.syncmasters.labelsIgnoreList + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) +*** + +### .spec.syncmasters.labelsMode -### .spec.syncmasters.labelsMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) +*** -### .spec.syncmasters.maxCount: integer +### .spec.syncmasters.maxCount + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) +*** + +### .spec.syncmasters.memoryReservation -### .spec.syncmasters.memoryReservation: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value. If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent. @@ -3878,57 +4836,71 @@ Links: Default Value: `0` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) +*** -### .spec.syncmasters.minCount: integer +### .spec.syncmasters.minCount + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) +*** + +### .spec.syncmasters.nodeAffinity -### .spec.syncmasters.nodeAffinity: core.NodeAffinity +Type: `core.NodeAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) +*** -### .spec.syncmasters.nodeSelector: map[string]string +### .spec.syncmasters.nodeSelector + +Type: `map[string]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) +*** + +### .spec.syncmasters.numactl.args -### .spec.syncmasters.numactl.args: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) Args define list of the numactl process Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) +*** -### .spec.syncmasters.numactl.enabled: boolean +### .spec.syncmasters.numactl.enabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) Enabled define if numactl should be enabled Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) +*** + +### .spec.syncmasters.numactl.path -### .spec.syncmasters.numactl.path: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) Path define numactl path within the container Default Value: `/usr/bin/numactl` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) +*** -### .spec.syncmasters.overrideDetectedNumberOfCores: boolean +### .spec.syncmasters.overrideDetectedNumberOfCores + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable @@ -3940,9 +4912,11 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) +*** + +### .spec.syncmasters.overrideDetectedTotalMemory -### .spec.syncmasters.overrideDetectedTotalMemory: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable @@ -3954,23 +4928,31 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) +*** -### .spec.syncmasters.podModes.network: string +### .spec.syncmasters.podModes.network -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) -### .spec.syncmasters.podModes.pid: string +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) +### .spec.syncmasters.podModes.pid -### .spec.syncmasters.port: integer +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) + +*** + +### .spec.syncmasters.port + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) Port define Port used by member -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) +*** + +### .spec.syncmasters.priorityClassName -### .spec.syncmasters.priorityClassName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) PriorityClassName specifies a priority class name Will be forwarded to the pod spec. @@ -3978,17 +4960,21 @@ Will be forwarded to the pod spec. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) +*** -### .spec.syncmasters.probes.livenessProbeDisabled: boolean +### .spec.syncmasters.probes.livenessProbeDisabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) +*** + +### .spec.syncmasters.probes.livenessProbeSpec.failureThreshold -### .spec.syncmasters.probes.livenessProbeSpec.failureThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -3996,58 +4982,72 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** -### .spec.syncmasters.probes.livenessProbeSpec.initialDelaySeconds: integer +### .spec.syncmasters.probes.livenessProbeSpec.initialDelaySeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.syncmasters.probes.livenessProbeSpec.periodSeconds -### .spec.syncmasters.probes.livenessProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** -### .spec.syncmasters.probes.livenessProbeSpec.successThreshold: integer +### .spec.syncmasters.probes.livenessProbeSpec.successThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** + +### .spec.syncmasters.probes.livenessProbeSpec.timeoutSeconds -### .spec.syncmasters.probes.livenessProbeSpec.timeoutSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** -### .spec.syncmasters.probes.ReadinessProbeDisabled: boolean +### .spec.syncmasters.probes.ReadinessProbeDisabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) +*** + +### .spec.syncmasters.probes.readinessProbeDisabled -### .spec.syncmasters.probes.readinessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) +*** -### .spec.syncmasters.probes.readinessProbeSpec.failureThreshold: integer +### .spec.syncmasters.probes.readinessProbeSpec.failureThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -4055,51 +5055,63 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** + +### .spec.syncmasters.probes.readinessProbeSpec.initialDelaySeconds -### .spec.syncmasters.probes.readinessProbeSpec.initialDelaySeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** -### .spec.syncmasters.probes.readinessProbeSpec.periodSeconds: integer +### .spec.syncmasters.probes.readinessProbeSpec.periodSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** + +### .spec.syncmasters.probes.readinessProbeSpec.successThreshold -### .spec.syncmasters.probes.readinessProbeSpec.successThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** -### .spec.syncmasters.probes.readinessProbeSpec.timeoutSeconds: integer +### .spec.syncmasters.probes.readinessProbeSpec.timeoutSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.syncmasters.probes.startupProbeDisabled -### .spec.syncmasters.probes.startupProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) StartupProbeDisabled if true startupProbes are disabled -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) +*** -### .spec.syncmasters.probes.startupProbeSpec.failureThreshold: integer +### .spec.syncmasters.probes.startupProbeSpec.failureThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -4107,45 +5119,55 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** + +### .spec.syncmasters.probes.startupProbeSpec.initialDelaySeconds -### .spec.syncmasters.probes.startupProbeSpec.initialDelaySeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** -### .spec.syncmasters.probes.startupProbeSpec.periodSeconds: integer +### .spec.syncmasters.probes.startupProbeSpec.periodSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** + +### .spec.syncmasters.probes.startupProbeSpec.successThreshold -### .spec.syncmasters.probes.startupProbeSpec.successThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** -### .spec.syncmasters.probes.startupProbeSpec.timeoutSeconds: integer +### .spec.syncmasters.probes.startupProbeSpec.timeoutSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.syncmasters.pvcResizeMode -### .spec.syncmasters.pvcResizeMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) VolumeResizeMode specified resize mode for PVCs and PVs @@ -4153,105 +5175,135 @@ Possible Values: * runtime (default) - PVC will be resized in Pod runtime (EKS, GKE) * rotate - Pod will be shutdown and PVC will be resized (AKS) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) +*** -### .spec.syncmasters.resources: core.ResourceRequirements +### .spec.syncmasters.resources + +Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) Resources holds resource requests & limits Links: * [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) +*** + +### .spec.syncmasters.schedulerName -### .spec.syncmasters.schedulerName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) SchedulerName define scheduler name used for group -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) +*** -### .spec.syncmasters.securityContext.addCapabilities: []core.Capability +### .spec.syncmasters.securityContext.addCapabilities + +Type: `[]core.Capability` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) AddCapabilities add new capabilities to containers -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) +*** + +### .spec.syncmasters.securityContext.allowPrivilegeEscalation -### .spec.syncmasters.securityContext.allowPrivilegeEscalation: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) +*** -### .spec.syncmasters.securityContext.dropAllCapabilities: boolean +### .spec.syncmasters.securityContext.dropAllCapabilities + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) +*** + +### .spec.syncmasters.securityContext.fsGroup -### .spec.syncmasters.securityContext.fsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) FSGroup is a special supplemental group that applies to all containers in a pod. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) +*** -### .spec.syncmasters.securityContext.privileged: boolean +### .spec.syncmasters.securityContext.privileged + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) Privileged If true, runs container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) +*** + +### .spec.syncmasters.securityContext.readOnlyRootFilesystem -### .spec.syncmasters.securityContext.readOnlyRootFilesystem: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) +*** -### .spec.syncmasters.securityContext.runAsGroup: integer +### .spec.syncmasters.securityContext.runAsGroup + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) RunAsGroup is the GID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) +*** + +### .spec.syncmasters.securityContext.runAsNonRoot -### .spec.syncmasters.securityContext.runAsNonRoot: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) RunAsNonRoot if true, indicates that the container must run as a non-root user. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) +*** -### .spec.syncmasters.securityContext.runAsUser: integer +### .spec.syncmasters.securityContext.runAsUser + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) RunAsUser is the UID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) +*** + +### .spec.syncmasters.securityContext.seccompProfile -### .spec.syncmasters.securityContext.seccompProfile: core.SeccompProfile +Type: `core.SeccompProfile` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. Links: * [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) +*** -### .spec.syncmasters.securityContext.seLinuxOptions: core.SELinuxOptions +### .spec.syncmasters.securityContext.seLinuxOptions + +Type: `core.SELinuxOptions` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) SELinuxOptions are the labels to be applied to the container Links: * [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) +*** + +### .spec.syncmasters.securityContext.supplementalGroups -### .spec.syncmasters.securityContext.supplementalGroups: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) +*** -### .spec.syncmasters.securityContext.sysctls: map[string]intstr.IntOrString +### .spec.syncmasters.securityContext.sysctls + +Type: `map[string]intstr.IntOrString` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. @@ -4268,9 +5320,11 @@ sysctls: "kernel.msgmax": "65536" ``` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) +*** + +### .spec.syncmasters.serviceAccountName -### .spec.syncmasters.serviceAccountName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created for each server of this group. If empty, it defaults to using the @@ -4281,49 +5335,63 @@ deployment of the operator, we grant the rights to 'get' all 'pod' resources. If you are using a different service account, please grant these rights to that service account. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) +*** -### .spec.syncmasters.shutdownDelay: integer +### .spec.syncmasters.shutdownDelay + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) +*** + +### .spec.syncmasters.shutdownMethod -### .spec.syncmasters.shutdownMethod: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) +*** -### .spec.syncmasters.sidecarCoreNames: array +### .spec.syncmasters.sidecarCoreNames + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) +*** + +### .spec.syncmasters.sidecars -### .spec.syncmasters.sidecars: []core.Container +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) +*** -### .spec.syncmasters.storageClassName: string +### .spec.syncmasters.storageClassName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) StorageClassName specifies the classname for storage of the servers. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) +*** + +### .spec.syncmasters.terminationGracePeriodSeconds -### .spec.syncmasters.terminationGracePeriodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) +*** -### .spec.syncmasters.tolerations: []core.Toleration +### .spec.syncmasters.tolerations + +Type: `[]core.Toleration` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) Tolerations specifies the tolerations added to Pods in this group. By default, suitable tolerations are set for the following keys with the `NoExecute` effect: @@ -4335,15 +5403,19 @@ For more information on tolerations, consult the https://kubernetes.io/docs/conc Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) +*** + +### .spec.syncmasters.volumeAllowShrink -### .spec.syncmasters.volumeAllowShrink: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) +*** -### .spec.syncmasters.volumeClaimTemplate: core.PersistentVolumeClaim +### .spec.syncmasters.volumeClaimTemplate + +Type: `core.PersistentVolumeClaim` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group. This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`. @@ -4355,123 +5427,153 @@ and `iops` is not forwarded to the pods resource requirements. Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) +*** + +### .spec.syncmasters.volumeMounts -### .spec.syncmasters.volumeMounts: []ServerGroupSpecVolumeMount +Type: `[]ServerGroupSpecVolumeMount` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) +*** -### .spec.syncmasters.volumes\[int\].configMap: core.ConfigMapVolumeSource +### .spec.syncmasters.volumes\[int\].configMap + +Type: `core.ConfigMapVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) ConfigMap which should be mounted into pod Links: * [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) +*** + +### .spec.syncmasters.volumes\[int\].emptyDir -### .spec.syncmasters.volumes\[int\].emptyDir: core.EmptyDirVolumeSource +Type: `core.EmptyDirVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) EmptyDir Links: * [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) +*** -### .spec.syncmasters.volumes\[int\].hostPath: core.HostPathVolumeSource +### .spec.syncmasters.volumes\[int\].hostPath + +Type: `core.HostPathVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) HostPath Links: * [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) +*** + +### .spec.syncmasters.volumes\[int\].name -### .spec.syncmasters.volumes\[int\].name: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) Name of volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) +*** -### .spec.syncmasters.volumes\[int\].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource +### .spec.syncmasters.volumes\[int\].persistentVolumeClaim + +Type: `core.PersistentVolumeClaimVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) PersistentVolumeClaim Links: * [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) +*** + +### .spec.syncmasters.volumes\[int\].secret -### .spec.syncmasters.volumes\[int\].secret: core.SecretVolumeSource +Type: `core.SecretVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) Secret which should be mounted into pod Links: * [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) +*** -### .spec.syncworkers.affinity: core.PodAffinity +### .spec.syncworkers.affinity + +Type: `core.PodAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L180) +*** + +### .spec.syncworkers.allowMemberRecreation -### .spec.syncworkers.allowMemberRecreation: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) AllowMemberRecreation allows to recreate member. This setting changes the member recreation logic based on group: - For Sync Masters, Sync Workers, Coordinator and DB-Servers it determines if a member can be recreated in case of failure (default `true`) - For Agents and Single this value is hardcoded to `false` and the value provided in spec is ignored. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L222) +*** -### .spec.syncworkers.annotations: object +### .spec.syncworkers.annotations + +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) Annotations specified the annotations added to Pods in this group. Annotations are merged with `spec.annotations`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L125) +*** + +### .spec.syncworkers.annotationsIgnoreList -### .spec.syncworkers.annotationsIgnoreList: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) AnnotationsIgnoreList list regexp or plain definitions which annotations should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L127) +*** -### .spec.syncworkers.annotationsMode: string +### .spec.syncworkers.annotationsMode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) AnnotationsMode Define annotations mode which should be use while overriding annotations -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L129) +*** + +### .spec.syncworkers.antiAffinity -### .spec.syncworkers.antiAffinity: core.PodAntiAffinity +Type: `core.PodAntiAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) AntiAffinity specified additional antiAffinity settings in ArangoDB Pod definitions Links: * [Documentation of core.Pod.AntiAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podantiaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L176) +*** -### .spec.syncworkers.args: []string +### .spec.syncworkers.args + +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) Args setting specifies additional command-line arguments passed to all servers of this group. Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L85) +*** + +### .spec.syncworkers.count -### .spec.syncworkers.count: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) Count setting specifies the number of servers to start for the given group. For the Agent group, this value must be a positive, odd number. @@ -4480,59 +5582,77 @@ for `spec.mode: Single` and `2` for `spec.mode: ActiveFailover`). For the `syncworkers` group, it is highly recommended to use the same number as for the `dbservers` group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L77) +*** -### .spec.syncworkers.entrypoint: string +### .spec.syncworkers.entrypoint + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) Entrypoint overrides container executable -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L87) +*** + +### .spec.syncworkers.envs\[int\].name + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) + +*** -### .spec.syncworkers.envs\[int\].name: string +### .spec.syncworkers.envs\[int\].value -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L26) +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) -### .spec.syncworkers.envs\[int\].value: string +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_env_var.go#L27) +### .spec.syncworkers.ephemeralVolumes.apps.size -### .spec.syncworkers.ephemeralVolumes.apps.size: resource.Quantity +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** -### .spec.syncworkers.ephemeralVolumes.temp.size: resource.Quantity +### .spec.syncworkers.ephemeralVolumes.temp.size + +Type: `resource.Quantity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) Size define size of the ephemeral volume Links: * [Documentation of resource.Quantity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#quantity-resource-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_ephemeral_volumes.go#L64) +*** + +### .spec.syncworkers.exporterPort -### .spec.syncworkers.exporterPort: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) ExporterPort define Port used by exporter -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L235) +*** -### .spec.syncworkers.extendedRotationCheck: boolean +### .spec.syncworkers.extendedRotationCheck + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) ExtendedRotationCheck extend checks for rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L205) +*** + +### .spec.syncworkers.externalPortEnabled -### .spec.syncworkers.externalPortEnabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L217) +*** -### .spec.syncworkers.indexMethod: string +### .spec.syncworkers.indexMethod + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) IndexMethod define group Indexing method @@ -4540,60 +5660,78 @@ 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L228) +*** + +### .spec.syncworkers.initContainers.containers -### .spec.syncworkers.initContainers.containers: []core.Container +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) Containers contains list of containers Links: * [Documentation of core.Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#container-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L91) +*** -### .spec.syncworkers.initContainers.mode: string +### .spec.syncworkers.initContainers.mode + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) Mode keep container replace mode -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_init_containers.go#L94) +*** + +### .spec.syncworkers.internalPort -### .spec.syncworkers.internalPort: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) InternalPort define port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L213) +*** -### .spec.syncworkers.internalPortProtocol: string +### .spec.syncworkers.internalPortProtocol + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) InternalPortProtocol define protocol of port used in internal communication, can be accessed over localhost via sidecar. Only for ArangoD members -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L215) +*** + +### .spec.syncworkers.labels -### .spec.syncworkers.labels: object +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) Labels specified the labels added to Pods in this group. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L131) +*** -### .spec.syncworkers.labelsIgnoreList: array +### .spec.syncworkers.labelsIgnoreList + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) LabelsIgnoreList list regexp or plain definitions which labels should be ignored -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L133) +*** + +### .spec.syncworkers.labelsMode -### .spec.syncworkers.labelsMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) LabelsMode Define labels mode which should be use while overriding labels -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L135) +*** -### .spec.syncworkers.maxCount: integer +### .spec.syncworkers.maxCount + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) MaxCount specifies a maximum for the count of servers. If set, a specification is invalid if `count > maxCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L81) +*** + +### .spec.syncworkers.memoryReservation -### .spec.syncworkers.memoryReservation: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) MemoryReservation determines the system reservation of memory while calculating `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` value. If this field is set, `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` is reduced by a specified value in percent. @@ -4604,57 +5742,71 @@ Links: Default Value: `0` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L107) +*** -### .spec.syncworkers.minCount: integer +### .spec.syncworkers.minCount + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) MinCount specifies a minimum for the count of servers. If set, a specification is invalid if `count < minCount`. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L79) +*** + +### .spec.syncworkers.nodeAffinity -### .spec.syncworkers.nodeAffinity: core.NodeAffinity +Type: `core.NodeAffinity` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) NodeAffinity specified additional nodeAffinity settings in ArangoDB Pod definitions Links: * [Documentation of code.NodeAffinity](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#nodeaffinity-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L184) +*** -### .spec.syncworkers.nodeSelector: map[string]string +### .spec.syncworkers.nodeSelector + +Type: `map[string]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) NodeSelector setting specifies a set of labels to be used as `nodeSelector` for Pods of this node. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L150) +*** + +### .spec.syncworkers.numactl.args -### .spec.syncworkers.numactl.args: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) Args define list of the numactl process Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L38) +*** -### .spec.syncworkers.numactl.enabled: boolean +### .spec.syncworkers.numactl.enabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) Enabled define if numactl should be enabled Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L30) +*** + +### .spec.syncworkers.numactl.path -### .spec.syncworkers.numactl.path: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) Path define numactl path within the container Default Value: `/usr/bin/numactl` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_numactl_spec.go#L34) +*** -### .spec.syncworkers.overrideDetectedNumberOfCores: boolean +### .spec.syncworkers.overrideDetectedNumberOfCores + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` Container Environment Variable @@ -4666,9 +5818,11 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L113) +*** + +### .spec.syncworkers.overrideDetectedTotalMemory -### .spec.syncworkers.overrideDetectedTotalMemory: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) **Important**: Values set by this feature override user-provided `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` Container Environment Variable @@ -4680,23 +5834,31 @@ Links: Default Value: `true` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L101) +*** + +### .spec.syncworkers.podModes.network + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) -### .spec.syncworkers.podModes.network: string +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L31) +### .spec.syncworkers.podModes.pid -### .spec.syncworkers.podModes.pid: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec_pod_modes.go#L32) +*** -### .spec.syncworkers.port: integer +### .spec.syncworkers.port + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) Port define Port used by member -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L233) +*** + +### .spec.syncworkers.priorityClassName -### .spec.syncworkers.priorityClassName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) PriorityClassName specifies a priority class name Will be forwarded to the pod spec. @@ -4704,17 +5866,21 @@ Will be forwarded to the pod spec. Links: * [Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L156) +*** -### .spec.syncworkers.probes.livenessProbeDisabled: boolean +### .spec.syncworkers.probes.livenessProbeDisabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) LivenessProbeDisabled if set to true, the operator does not generate a liveness probe for new pods belonging to this group Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L245) +*** + +### .spec.syncworkers.probes.livenessProbeSpec.failureThreshold -### .spec.syncworkers.probes.livenessProbeSpec.failureThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -4722,58 +5888,72 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** -### .spec.syncworkers.probes.livenessProbeSpec.initialDelaySeconds: integer +### .spec.syncworkers.probes.livenessProbeSpec.initialDelaySeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** + +### .spec.syncworkers.probes.livenessProbeSpec.periodSeconds -### .spec.syncworkers.probes.livenessProbeSpec.periodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** -### .spec.syncworkers.probes.livenessProbeSpec.successThreshold: integer +### .spec.syncworkers.probes.livenessProbeSpec.successThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** + +### .spec.syncworkers.probes.livenessProbeSpec.timeoutSeconds -### .spec.syncworkers.probes.livenessProbeSpec.timeoutSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** -### .spec.syncworkers.probes.ReadinessProbeDisabled: boolean +### .spec.syncworkers.probes.ReadinessProbeDisabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) OldReadinessProbeDisabled if true readinessProbes are disabled Deprecated: This field is deprecated, keept only for backward compatibility. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L252) +*** + +### .spec.syncworkers.probes.readinessProbeDisabled -### .spec.syncworkers.probes.readinessProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) ReadinessProbeDisabled override flag for probe disabled in good manner (lowercase) with backward compatibility -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L254) +*** -### .spec.syncworkers.probes.readinessProbeSpec.failureThreshold: integer +### .spec.syncworkers.probes.readinessProbeSpec.failureThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -4781,51 +5961,63 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** + +### .spec.syncworkers.probes.readinessProbeSpec.initialDelaySeconds -### .spec.syncworkers.probes.readinessProbeSpec.initialDelaySeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** -### .spec.syncworkers.probes.readinessProbeSpec.periodSeconds: integer +### .spec.syncworkers.probes.readinessProbeSpec.periodSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** + +### .spec.syncworkers.probes.readinessProbeSpec.successThreshold -### .spec.syncworkers.probes.readinessProbeSpec.successThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** -### .spec.syncworkers.probes.readinessProbeSpec.timeoutSeconds: integer +### .spec.syncworkers.probes.readinessProbeSpec.timeoutSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.syncworkers.probes.startupProbeDisabled -### .spec.syncworkers.probes.startupProbeDisabled: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) StartupProbeDisabled if true startupProbes are disabled -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L259) +*** -### .spec.syncworkers.probes.startupProbeSpec.failureThreshold: integer +### .spec.syncworkers.probes.startupProbeSpec.failureThreshold + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) FailureThreshold when a Pod starts and the probe fails, Kubernetes will try failureThreshold times before giving up. Giving up means restarting the container. @@ -4833,45 +6025,55 @@ Minimum value is 1. Default Value: `3` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L295) +*** + +### .spec.syncworkers.probes.startupProbeSpec.initialDelaySeconds -### .spec.syncworkers.probes.startupProbeSpec.initialDelaySeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) InitialDelaySeconds specifies number of seconds after the container has started before liveness or readiness probes are initiated. Minimum value is 0. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L278) +*** -### .spec.syncworkers.probes.startupProbeSpec.periodSeconds: integer +### .spec.syncworkers.probes.startupProbeSpec.periodSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) PeriodSeconds How often (in seconds) to perform the probe. Minimum value is 1. Default Value: `10` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L282) +*** + +### .spec.syncworkers.probes.startupProbeSpec.successThreshold -### .spec.syncworkers.probes.startupProbeSpec.successThreshold: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) SuccessThreshold Minimum consecutive successes for the probe to be considered successful after having failed. Minimum value is 1. Default Value: `1` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L290) +*** -### .spec.syncworkers.probes.startupProbeSpec.timeoutSeconds: integer +### .spec.syncworkers.probes.startupProbeSpec.timeoutSeconds + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) TimeoutSeconds specifies number of seconds after which the probe times out Minimum value is 1. Default Value: `2` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L286) +*** + +### .spec.syncworkers.pvcResizeMode -### .spec.syncworkers.pvcResizeMode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) VolumeResizeMode specified resize mode for PVCs and PVs @@ -4879,105 +6081,135 @@ Possible Values: * runtime (default) - PVC will be resized in Pod runtime (EKS, GKE) * rotate - Pod will be shutdown and PVC will be resized (AKS) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L170) +*** -### .spec.syncworkers.resources: core.ResourceRequirements +### .spec.syncworkers.resources + +Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) Resources holds resource requests & limits Links: * [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L95) +*** + +### .spec.syncworkers.schedulerName -### .spec.syncworkers.schedulerName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) SchedulerName define scheduler name used for group -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L89) +*** -### .spec.syncworkers.securityContext.addCapabilities: []core.Capability +### .spec.syncworkers.securityContext.addCapabilities + +Type: `[]core.Capability` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) AddCapabilities add new capabilities to containers -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L46) +*** + +### .spec.syncworkers.securityContext.allowPrivilegeEscalation -### .spec.syncworkers.securityContext.allowPrivilegeEscalation: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) AllowPrivilegeEscalation Controls whether a process can gain more privileges than its parent process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L49) +*** -### .spec.syncworkers.securityContext.dropAllCapabilities: boolean +### .spec.syncworkers.securityContext.dropAllCapabilities + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L43) +*** + +### .spec.syncworkers.securityContext.fsGroup -### .spec.syncworkers.securityContext.fsGroup: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) FSGroup is a special supplemental group that applies to all containers in a pod. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L66) +*** -### .spec.syncworkers.securityContext.privileged: boolean +### .spec.syncworkers.securityContext.privileged + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) Privileged If true, runs container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L52) +*** + +### .spec.syncworkers.securityContext.readOnlyRootFilesystem -### .spec.syncworkers.securityContext.readOnlyRootFilesystem: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) ReadOnlyRootFilesystem if true, mounts the container's root filesystem as read-only. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L54) +*** -### .spec.syncworkers.securityContext.runAsGroup: integer +### .spec.syncworkers.securityContext.runAsGroup + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) RunAsGroup is the GID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L60) +*** + +### .spec.syncworkers.securityContext.runAsNonRoot -### .spec.syncworkers.securityContext.runAsNonRoot: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) RunAsNonRoot if true, indicates that the container must run as a non-root user. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L56) +*** -### .spec.syncworkers.securityContext.runAsUser: integer +### .spec.syncworkers.securityContext.runAsUser + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) RunAsUser is the UID to run the entrypoint of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L58) +*** + +### .spec.syncworkers.securityContext.seccompProfile -### .spec.syncworkers.securityContext.seccompProfile: core.SeccompProfile +Type: `core.SeccompProfile` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) SeccompProfile defines a pod/container's seccomp profile settings. Only one profile source may be set. Links: * [Documentation of core.SeccompProfile](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#seccompprofile-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L82) +*** -### .spec.syncworkers.securityContext.seLinuxOptions: core.SELinuxOptions +### .spec.syncworkers.securityContext.seLinuxOptions + +Type: `core.SELinuxOptions` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) SELinuxOptions are the labels to be applied to the container Links: * [Documentation of core.SELinuxOptions](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#selinuxoptions-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L87) +*** + +### .spec.syncworkers.securityContext.supplementalGroups -### .spec.syncworkers.securityContext.supplementalGroups: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) SupplementalGroups is a list of groups applied to the first process run in each container, in addition to the container's primary GID, the fsGroup (if specified), and group memberships defined in the container image for the uid of the container process. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L64) +*** -### .spec.syncworkers.securityContext.sysctls: map[string]intstr.IntOrString +### .spec.syncworkers.securityContext.sysctls + +Type: `map[string]intstr.IntOrString` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch. @@ -4994,9 +6226,11 @@ sysctls: "kernel.msgmax": "65536" ``` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_security_context_spec.go#L77) +*** + +### .spec.syncworkers.serviceAccountName -### .spec.syncworkers.serviceAccountName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) ServiceAccountName setting specifies the `serviceAccountName` for the `Pods` created for each server of this group. If empty, it defaults to using the @@ -5007,49 +6241,63 @@ deployment of the operator, we grant the rights to 'get' all 'pod' resources. If you are using a different service account, please grant these rights to that service account. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L146) +*** -### .spec.syncworkers.shutdownDelay: integer +### .spec.syncworkers.shutdownDelay + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) ShutdownDelay define how long operator should delay finalizer removal after shutdown -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L211) +*** + +### .spec.syncworkers.shutdownMethod -### .spec.syncworkers.shutdownMethod: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) ShutdownMethod describe procedure of member shutdown taken by Operator -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L209) +*** -### .spec.syncworkers.sidecarCoreNames: array +### .spec.syncworkers.sidecarCoreNames + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L187) +*** + +### .spec.syncworkers.sidecars -### .spec.syncworkers.sidecars: []core.Container +Type: `[]core.Container` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L191) +*** -### .spec.syncworkers.storageClassName: string +### .spec.syncworkers.storageClassName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) StorageClassName specifies the classname for storage of the servers. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L91) +*** + +### .spec.syncworkers.terminationGracePeriodSeconds -### .spec.syncworkers.terminationGracePeriodSeconds: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) TerminationGracePeriodSeconds override default TerminationGracePeriodSeconds for pods - via silent rotation -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L224) +*** -### .spec.syncworkers.tolerations: []core.Toleration +### .spec.syncworkers.tolerations + +Type: `[]core.Toleration` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) Tolerations specifies the tolerations added to Pods in this group. By default, suitable tolerations are set for the following keys with the `NoExecute` effect: @@ -5061,15 +6309,19 @@ For more information on tolerations, consult the https://kubernetes.io/docs/conc Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L122) +*** + +### .spec.syncworkers.volumeAllowShrink -### .spec.syncworkers.volumeAllowShrink: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) Deprecated: VolumeAllowShrink allows shrink the volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L172) +*** -### .spec.syncworkers.volumeClaimTemplate: core.PersistentVolumeClaim +### .spec.syncworkers.volumeClaimTemplate + +Type: `core.PersistentVolumeClaim` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) VolumeClaimTemplate specifies a volumeClaimTemplate used by operator to create to volume claims for pods of this group. This setting is not available for group `coordinators`, `syncmasters` & `syncworkers`. @@ -5081,69 +6333,85 @@ and `iops` is not forwarded to the pods resource requirements. Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L165) +*** + +### .spec.syncworkers.volumeMounts -### .spec.syncworkers.volumeMounts: []ServerGroupSpecVolumeMount +Type: `[]ServerGroupSpecVolumeMount` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_spec.go#L201) +*** -### .spec.syncworkers.volumes\[int\].configMap: core.ConfigMapVolumeSource +### .spec.syncworkers.volumes\[int\].configMap + +Type: `core.ConfigMapVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) ConfigMap which should be mounted into pod Links: * [Documentation of core.ConfigMapVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmapvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L138) +*** + +### .spec.syncworkers.volumes\[int\].emptyDir -### .spec.syncworkers.volumes\[int\].emptyDir: core.EmptyDirVolumeSource +Type: `core.EmptyDirVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) EmptyDir Links: * [Documentation of core.EmptyDirVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#emptydirvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L143) +*** -### .spec.syncworkers.volumes\[int\].hostPath: core.HostPathVolumeSource +### .spec.syncworkers.volumes\[int\].hostPath + +Type: `core.HostPathVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) HostPath Links: * [Documentation of core.HostPathVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#hostpathvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L148) +*** + +### .spec.syncworkers.volumes\[int\].name -### .spec.syncworkers.volumes\[int\].name: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) Name of volume -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L128) +*** -### .spec.syncworkers.volumes\[int\].persistentVolumeClaim: core.PersistentVolumeClaimVolumeSource +### .spec.syncworkers.volumes\[int\].persistentVolumeClaim + +Type: `core.PersistentVolumeClaimVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) PersistentVolumeClaim Links: * [Documentation of core.PersistentVolumeClaimVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaimvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L153) +*** + +### .spec.syncworkers.volumes\[int\].secret -### .spec.syncworkers.volumes\[int\].secret: core.SecretVolumeSource +Type: `core.SecretVolumeSource` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) Secret which should be mounted into pod Links: * [Documentation of core.SecretVolumeSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#secretvolumesource-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/server_group_volume.go#L133) +*** -### .spec.timeouts.actions: map[string]meta.Duration +### .spec.timeouts.actions + +Type: `map[string]meta.Duration` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/timeouts.go#L44) Actions keep map of the actions timeouts. @@ -5157,30 +6425,38 @@ actions: AddMember: 30m ``` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/timeouts.go#L44) +*** + +### .spec.timeouts.maintenanceGracePeriod -### .spec.timeouts.maintenanceGracePeriod: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/timeouts.go#L36) MaintenanceGracePeriod action timeout -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/timeouts.go#L36) +*** -### .spec.timezone: string +### .spec.timezone + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L269) 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](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_spec.go#L269) +*** + +### .spec.tls.altNames -### .spec.tls.altNames: []string +Type: `[]string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L72) AltNames setting specifies a list of alternate names that will be added to all generated certificates. These names can be DNS names or email addresses. The default value is empty. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L72) +*** -### .spec.tls.caSecretName: string +### .spec.tls.caSecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L67) CASecretName setting specifies the name of a kubernetes `Secret` that contains a standard CA certificate + private key used to sign certificates for individual @@ -5193,17 +6469,23 @@ The specified `Secret`, must contain the following data fields: - `ca.crt` PEM encoded public key of the CA certificate - `ca.key` PEM encoded private key of the CA certificate -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L67) +*** + +### .spec.tls.mode -### .spec.tls.mode: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L81) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L81) +*** -### .spec.tls.sni.mapping.\: array +### .spec.tls.sni.mapping.\ -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_sni_spec.go#L30) +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_sni_spec.go#L30) -### .spec.tls.ttl: string +*** + +### .spec.tls.ttl + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L79) TTL setting specifies the time to live of all generated server certificates. When the server certificate is about to expire, it will be automatically replaced @@ -5213,34 +6495,42 @@ will be set to 10 years. Default Value: `"2160h" (about 3 months)` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/tls_spec.go#L79) +*** + +### .spec.topology.enabled + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/topology_spec.go#L26) -### .spec.topology.enabled: boolean +*** -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/topology_spec.go#L26) +### .spec.topology.label -### .spec.topology.label: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/topology_spec.go#L28) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/topology_spec.go#L28) +*** -### .spec.topology.zones: integer +### .spec.topology.zones -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/topology_spec.go#L27) +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/topology_spec.go#L27) -### .spec.upgrade.autoUpgrade: boolean +*** + +### .spec.upgrade.autoUpgrade + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_upgrade_spec.go#L26) AutoUpgrade flag specifies if upgrade should be auto-injected, even if is not required (in case of stuck) Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_upgrade_spec.go#L26) +*** -### .spec.upgrade.debugLog: boolean +### .spec.upgrade.debugLog + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_upgrade_spec.go#L30) DebugLog flag specifies if containers running upgrade process should print more debugging information. This applies only to init containers. Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/deployment_upgrade_spec.go#L30) - diff --git a/docs/api/ArangoDeploymentReplication.V1.md b/docs/api/ArangoDeploymentReplication.V1.md index 210fe03c7..7fb616857 100644 --- a/docs/api/ArangoDeploymentReplication.V1.md +++ b/docs/api/ArangoDeploymentReplication.V1.md @@ -2,21 +2,27 @@ ## Spec -### .spec.cancellation.ensureInSync: boolean +### .spec.cancellation.ensureInSync + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/replication_spec.go#L38) EnsureInSync if it is true then during cancellation process data consistency is required. Default value is true. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/replication_spec.go#L38) +*** + +### .spec.cancellation.sourceReadOnly -### .spec.cancellation.sourceReadOnly: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/replication_spec.go#L41) SourceReadOnly if it true then after cancellation source data center should be in read-only mode. Default value is false. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/replication_spec.go#L41) +*** -### .spec.destination.auth.keyfileSecretName: string +### .spec.destination.auth.keyfileSecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37) KeyfileSecretName holds the name of a Secret containing a client authentication certificate formatted at keyfile in a `tls.keyfile` field. @@ -24,25 +30,31 @@ If `userSecretName` has not been set, the client authentication certificate found in the secret with this name is also used to configure the synchronization and fetch the synchronization status. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37) +*** + +### .spec.destination.auth.userSecretName -### .spec.destination.auth.userSecretName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42) UserSecretName holds the name of a Secret containing a `username` & `password` field used for basic authentication. The user identified by the username must have write access in the `_system` database of the ArangoDB cluster at the endpoint. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42) +*** -### .spec.destination.deploymentName: string +### .spec.destination.deploymentName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L36) DeploymentName holds the name of an ArangoDeployment resource. If set, this provides default values for masterEndpoint, auth & tls. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L36) +*** + +### .spec.destination.masterEndpoint -### .spec.destination.masterEndpoint: array +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L42) MasterEndpoint holds a list of URLs used to reach the syncmaster(s) Use this setting if the source cluster is not running inside a Kubernetes cluster @@ -51,16 +63,20 @@ Specifying this setting and `deploymentName` at the same time is not allowed. Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L42) +*** + +### .spec.destination.tls.caSecretName -### .spec.destination.tls.caSecretName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_tls_spec.go#L34) CASecretName holds the name of a Secret containing a ca.crt public key for TLS validation. This setting is required, unless `deploymentName` has been set. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_tls_spec.go#L34) +*** -### .spec.source.auth.keyfileSecretName: string +### .spec.source.auth.keyfileSecretName + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37) KeyfileSecretName holds the name of a Secret containing a client authentication certificate formatted at keyfile in a `tls.keyfile` field. @@ -68,25 +84,31 @@ If `userSecretName` has not been set, the client authentication certificate found in the secret with this name is also used to configure the synchronization and fetch the synchronization status. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37) +*** + +### .spec.source.auth.userSecretName -### .spec.source.auth.userSecretName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42) UserSecretName holds the name of a Secret containing a `username` & `password` field used for basic authentication. The user identified by the username must have write access in the `_system` database of the ArangoDB cluster at the endpoint. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42) +*** + +### .spec.source.deploymentName -### .spec.source.deploymentName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L36) DeploymentName holds the name of an ArangoDeployment resource. If set, this provides default values for masterEndpoint, auth & tls. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L36) +*** -### .spec.source.masterEndpoint: array +### .spec.source.masterEndpoint + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L42) MasterEndpoint holds a list of URLs used to reach the syncmaster(s) Use this setting if the source cluster is not running inside a Kubernetes cluster @@ -95,12 +117,12 @@ Specifying this setting and `deploymentName` at the same time is not allowed. Default Value: `[]` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L42) +*** + +### .spec.source.tls.caSecretName -### .spec.source.tls.caSecretName: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_tls_spec.go#L34) CASecretName holds the name of a Secret containing a ca.crt public key for TLS validation. This setting is required, unless `deploymentName` has been set. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_tls_spec.go#L34) - diff --git a/docs/api/ArangoLocalStorage.V1Alpha.md b/docs/api/ArangoLocalStorage.V1Alpha.md index 3bc6dd793..4c5c6fef9 100644 --- a/docs/api/ArangoLocalStorage.V1Alpha.md +++ b/docs/api/ArangoLocalStorage.V1Alpha.md @@ -2,40 +2,52 @@ ## Spec -### .spec.localPath: array +### .spec.localPath + +Type: `array` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L36) LocalPath setting specifies one or more local directories (on the nodes) used to create persistent volumes in. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L36) +*** + +### .spec.nodeSelector -### .spec.nodeSelector: object +Type: `object` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L43) NodeSelector setting specifies which nodes the operator will provision persistent volumes on. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L43) +*** + +### .spec.podCustomization.priority -### .spec.podCustomization.priority: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_pod_customization.go#L25) Priority if defined, sets the priority for pods of storage provisioner -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_pod_customization.go#L25) +*** -### .spec.privileged: boolean +### .spec.privileged + +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L45) Privileged if set, passes Privileged flag to SecurityContext for pods of storage provisioner -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L45) +*** + +### .spec.storageClass.isDefault -### .spec.storageClass.isDefault: boolean +Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L42) IsDefault setting specifies if the created `StorageClass` will be marked as default storage class. Default Value: `false` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L42) +*** -### .spec.storageClass.name: string +### .spec.storageClass.name + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L38) Name setting specifies the name of the storage class that created `PersistentVolume` will use. @@ -44,23 +56,25 @@ If a `StorageClass` with given name does not yet exist, it will be created. Default Value: `""` -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L38) +*** + +### .spec.storageClass.reclaimPolicy -### .spec.storageClass.reclaimPolicy: core.PersistentVolumeReclaimPolicy +Type: `core.PersistentVolumeReclaimPolicy` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L46) ReclaimPolicy defines what happens to a persistent volume when released from its claim. Links: * [Documentation of core.PersistentVolumeReclaimPolicy](https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L46) +*** -### .spec.tolerations: []core.Toleration +### .spec.tolerations + +Type: `[]core.Toleration` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L41) Tolerations specifies the tolerations added to pods of storage provisioner Links: * [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L41) - diff --git a/docs/api/ArangoMember.V1.md b/docs/api/ArangoMember.V1.md index bd648477f..cb75e48df 100644 --- a/docs/api/ArangoMember.V1.md +++ b/docs/api/ArangoMember.V1.md @@ -2,72 +2,90 @@ ## Spec -### .spec.deletion_priority: integer +### .spec.deletion_priority + +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L47) DeletionPriority define Deletion Priority. Higher value means higher priority. Default is 0. Example: set 1 for Coordinator which should be deleted first and scale down coordinators by one. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L47) +*** + +### .spec.deploymentUID -### .spec.deploymentUID: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L36) DeploymentUID define Deployment UID. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L36) +*** + +### .spec.group -### .spec.group: integer +Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L31) Group define Member Groups. -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L31) +*** -### .spec.id: string +### .spec.id -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L33) +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L33) -### .spec.overrides.resources: core.ResourceRequirements +*** + +### .spec.overrides.resources + +Type: `core.ResourceRequirements` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L38) Resources holds resource requests & limits. Overrides template provided on the group level. Links: * [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L38) +*** + +### .spec.overrides.volumeClaimTemplate -### .spec.overrides.volumeClaimTemplate: core.PersistentVolumeClaim +Type: `core.PersistentVolumeClaim` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L33) VolumeClaimTemplate specifies a template for volume claims. Overrides template provided on the group level. Links: * [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L33) +*** -### .spec.template.checksum: string +### .spec.template.checksum + +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L60) Checksum keep the Pod Spec Checksum (with ignored fields). -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L60) +*** + +### .spec.template.endpoint -### .spec.template.endpoint: string +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L63) Deprecated: Endpoint is not saved into the template -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L63) +*** + +### .spec.template.podSpec -### .spec.template.podSpec: core.PodTemplateSpec +Type: `core.PodTemplateSpec` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L54) PodSpec specifies the Pod Spec used for this Member. Links: * [Documentation of core.PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podtemplatespec-v1-core) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L54) +*** -### .spec.template.podSpecChecksum: string +### .spec.template.podSpecChecksum -PodSpecChecksum keep the Pod Spec Checksum (without ignored fields). +Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L57) -[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L57) +PodSpecChecksum keep the Pod Spec Checksum (without ignored fields). diff --git a/docs/features/README.md b/docs/features/README.md index 7b14cda09..092638f62 100644 --- a/docs/features/README.md +++ b/docs/features/README.md @@ -1,5 +1,37 @@ ## List of Community Edition features +| Feature | Operator Version | Introduced | ArangoDB Version | ArangoDB Edition | State | Enabled | Flag | Remarks | +|:----------------------------------------------------------------|:-----------------|:-----------|:-----------------|:----------------------|:-------------|:--------|:------------------------------------------------------|:--------------------------------------------------------------------------------------| +| Create backups asynchronously | 1.2.35 | 1.2.35 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.async-backup-creation | Create backups asynchronously to avoid blocking the operator and reaching the timeout | +| Enforced ResignLeadership | 1.2.34 | 1.2.34 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.enforced-resign-leadership | Enforce ResignLeadership and ensure that Leaders are moved from restarted DBServer | +| Copy resources spec to init containers | 1.2.33 | 1.2.33 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.init-containers-copy-resources | Copy resources spec to built-in init containers if they are not specified | +| [Rebalancer V2](rebalancer_v2.md) | 1.2.31 | 1.2.31 | >= 3.10.0 | Community, Enterprise | Alpha | False | --deployment.feature.rebalancer-v2 | N/A | +| [Secured containers](secured_containers.md) | 1.2.31 | 1.2.31 | >= 3.8.0 | Community, Enterprise | Alpha | False | --deployment.feature.secured-containers | If set to True Operator will run containers in secure mode | +| Version Check V2 | 1.2.31 | 1.2.31 | >= 3.8.0 | Community, Enterprise | Alpha | False | --deployment.feature.upgrade-version-check-V2 | N/A | +| [Operator Ephemeral Volumes](ephemeral_volumes.md) | 1.2.31 | 1.2.2 | >= 3.8.0 | Community, Enterprise | Beta | False | --deployment.feature.ephemeral-volumes | N/A | +| [Force Rebuild Out Synced Shards](rebuild_out_synced_shards.md) | 1.2.27 | 1.2.27 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.force-rebuild-out-synced-shards | It should be used only if user is aware of the risks. | +| [Spec Default Restore](deployment_spec_defaults.md) | 1.2.25 | 1.2.21 | >= 3.8.0 | Community, Enterprise | Beta | True | --deployment.feature.deployment-spec-defaults-restore | If set to False Operator will not change ArangoDeployment Spec | +| Version Check | 1.2.23 | 1.1.4 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.upgrade-version-check | N/A | +| [Failover Leader service](failover_leader_service.md) | 1.2.13 | 1.2.13 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.failover-leadership | N/A | +| Graceful Restart | 1.2.5 | 1.0.7 | >= 3.8.0 | Community, Enterprise | Production | True | ---deployment.feature.graceful-shutdown | N/A | +| Optional Graceful Restart | 1.2.0 | 1.2.5 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.optional-graceful-shutdown | N/A | +| Operator Internal Metrics Exporter | 1.2.0 | 1.2.0 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.metrics-exporter | N/A | +| Operator Maintenance Management Support | 1.2.0 | 1.0.7 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.maintenance | N/A | +| Encryption Key Rotation Support | 1.2.0 | 1.0.3 | >= 3.8.0 | Enterprise | NotSupported | False | --deployment.feature.encryption-rotation | N/A | +| TLS Runtime Rotation Support | 1.1.0 | 1.0.4 | >= 3.8.0 | Enterprise | Production | True | --deployment.feature.tls-rotation | N/A | +| JWT Rotation Support | 1.1.0 | 1.0.3 | >= 3.8.0 | Enterprise | Production | True | --deployment.feature.jwt-rotation | N/A | +| Operator Single Mode | 1.0.4 | 1.0.4 | >= 3.8.0 | Community, Enterprise | Production | False | --mode.single | Only 1 instance of Operator allowed in namespace when feature is enabled | +| TLS SNI Support | 1.0.3 | 1.0.3 | >= 3.8.0 | Enterprise | Production | True | --deployment.feature.tls-sni | N/A | +| Disabling of liveness probes | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A | +| Pod Disruption Budgets | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A | +| Prometheus Metrics Exporter | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | Prometheus required | +| Sidecar Containers | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A | +| Volume Claim Templates | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A | +| Volume Resizing | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A | + + +## List of Enterprise Edition features + | Feature | Operator Version | Introduced | ArangoDB Version | ArangoDB Edition | State | Enabled | Flag | Remarks | |:-----------------------------------------------------|:-----------------|:-----------|:-----------------|:-----------------|:-----------|:--------|:-----|:----------------------------------------------------------------------------| | AgencyCache | 1.2.30 | 1.2.30 | >= 3.8.0 | Enterprise | Production | True | N/A | Enable Agency Cache mechanism in the Operator (Increase limit of the nodes) | @@ -8,34 +40,3 @@ | [TopologyAwareness](../design/topology_awareness.md) | 1.2.4 | 1.2.4 | >= 3.8.0 | Enterprise | Production | True | N/A | N/A | -## List of Enterprise Edition features - -| Feature | Operator Version | Introduced | ArangoDB Version | ArangoDB Edition | State | Enabled | Flag | Remarks | -|:----------------------------------------------------------------|:-----------------|:-----------|:-----------------|:----------------------|:-------------|:--------|:------------------------------------------------------|:-----------------------------------------------------------------------------------| -| Enforced ResignLeadership | 1.2.34 | 1.2.34 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.enforced-resign-leadership | Enforce ResignLeadership and ensure that Leaders are moved from restarted DBServer | -| Copy resources spec to init containers | 1.2.33 | 1.2.33 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.init-containers-copy-resources | Copy resources spec to built-in init containers if they are not specified | -| [Rebalancer V2](rebalancer_v2.md) | 1.2.31 | 1.2.31 | >= 3.10.0 | Community, Enterprise | Alpha | False | --deployment.feature.rebalancer-v2 | N/A | -| [Secured containers](secured_containers.md) | 1.2.31 | 1.2.31 | >= 3.8.0 | Community, Enterprise | Alpha | False | --deployment.feature.secured-containers | If set to True Operator will run containers in secure mode | -| Version Check V2 | 1.2.31 | 1.2.31 | >= 3.8.0 | Community, Enterprise | Alpha | False | --deployment.feature.upgrade-version-check-V2 | N/A | -| [Operator Ephemeral Volumes](ephemeral_volumes.md) | 1.2.31 | 1.2.2 | >= 3.8.0 | Community, Enterprise | Beta | False | --deployment.feature.ephemeral-volumes | N/A | -| [Force Rebuild Out Synced Shards](rebuild_out_synced_shards.md) | 1.2.27 | 1.2.27 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.force-rebuild-out-synced-shards | It should be used only if user is aware of the risks. | -| [Spec Default Restore](deployment_spec_defaults.md) | 1.2.25 | 1.2.21 | >= 3.8.0 | Community, Enterprise | Beta | True | --deployment.feature.deployment-spec-defaults-restore | If set to False Operator will not change ArangoDeployment Spec | -| Version Check | 1.2.23 | 1.1.4 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.upgrade-version-check | N/A | -| [Failover Leader service](failover_leader_service.md) | 1.2.13 | 1.2.13 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.failover-leadership | N/A | -| Graceful Restart | 1.2.5 | 1.0.7 | >= 3.8.0 | Community, Enterprise | Production | True | ---deployment.feature.graceful-shutdown | N/A | -| Optional Graceful Restart | 1.2.0 | 1.2.5 | >= 3.8.0 | Community, Enterprise | Production | False | --deployment.feature.optional-graceful-shutdown | N/A | -| Operator Internal Metrics Exporter | 1.2.0 | 1.2.0 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.metrics-exporter | N/A | -| Operator Maintenance Management Support | 1.2.0 | 1.0.7 | >= 3.8.0 | Community, Enterprise | Production | True | --deployment.feature.maintenance | N/A | -| Encryption Key Rotation Support | 1.2.0 | 1.0.3 | >= 3.8.0 | Enterprise | NotSupported | False | --deployment.feature.encryption-rotation | N/A | -| TLS Runtime Rotation Support | 1.1.0 | 1.0.4 | >= 3.8.0 | Enterprise | Production | True | --deployment.feature.tls-rotation | N/A | -| JWT Rotation Support | 1.1.0 | 1.0.3 | >= 3.8.0 | Enterprise | Production | True | --deployment.feature.jwt-rotation | N/A | -| Operator Single Mode | 1.0.4 | 1.0.4 | >= 3.8.0 | Community, Enterprise | Production | False | --mode.single | Only 1 instance of Operator allowed in namespace when feature is enabled | -| TLS SNI Support | 1.0.3 | 1.0.3 | >= 3.8.0 | Enterprise | Production | True | --deployment.feature.tls-sni | N/A | -| Disabling of liveness probes | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A | -| Pod Disruption Budgets | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A | -| Prometheus Metrics Exporter | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | Prometheus required | -| Sidecar Containers | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A | -| Volume Claim Templates | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A | -| Volume Resizing | 0.3.11 | 0.3.10 | >= 3.8.0 | Community, Enterprise | Production | True | N/A | N/A | - - diff --git a/docs/features/rebalancer_v2.md b/docs/features/rebalancer_v2.md index b29fdda73..e970f76b3 100644 --- a/docs/features/rebalancer_v2.md +++ b/docs/features/rebalancer_v2.md @@ -2,9 +2,9 @@ ## Overview -ArangoDB as of 3.10.0 provide Cluster Rebalancer functionality via [api](https://www.arangodb.com/docs/stable/http/cluster.html#rebalance). +ArangoDB as of 3.10.0 provides Cluster Rebalancer functionality via [api](https://www.arangodb.com/docs/stable/http/cluster.html#rebalance). -Operator will use above functionality to check shard movement plan and enforce it on the Cluster. +Operator will use the above functionality to check shard movement plan and enforce it on the Cluster. ## How to use