mirrors/kube-arangodb
1
0
Fork 0
mirror of https://github.com/arangodb/kube-arangodb.git synced 2024-12-15 17:51:03 +00:00
Code Activity

[Feature] Update docs to 1.2.42 (#1684)

Browse source
This commit is contained in:
Adam Janikowski 2024-07-19 17:03:35 +02:00 committed by GitHub
parent 2e8c2709c5
commit dc9782a30b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
16 changed files with 1551 additions and 1551 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
docs/api/ArangoBackup.V1.md
View file

@ -10,7 +10,7 @@ title: ArangoBackup V1
### .spec.backoff.iterations ### .spec.backoff.iterations
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec_backoff.go#L31)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec_backoff.go#L31)</sup>
Iterations defines number of iterations before reaching MaxDelay. Default to 5 Iterations defines number of iterations before reaching MaxDelay. Default to 5
@ -18,7 +18,7 @@ Iterations defines number of iterations before reaching MaxDelay. Default to 5
### .spec.backoff.max_delay ### .spec.backoff.max_delay
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec_backoff.go#L29)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec_backoff.go#L29)</sup>
MaxDelay defines maximum delay in seconds. Default to 600 MaxDelay defines maximum delay in seconds. Default to 600
@ -26,7 +26,7 @@ MaxDelay defines maximum delay in seconds. Default to 600
### .spec.backoff.max_iterations ### .spec.backoff.max_iterations
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec_backoff.go#L33)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec_backoff.go#L33)</sup>
MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit) MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)
@ -34,7 +34,7 @@ MaxIterations defines maximum number of iterations after backoff will be disable
### .spec.backoff.min_delay ### .spec.backoff.min_delay
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec_backoff.go#L27)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec_backoff.go#L27)</sup>
MinDelay defines minimum delay in seconds. Default to 30 MinDelay defines minimum delay in seconds. Default to 30
@ -42,7 +42,7 @@ MinDelay defines minimum delay in seconds. Default to 30
### .spec.deployment.name ### .spec.deployment.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L54)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L54)</sup>
Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource. Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
@ -52,7 +52,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.download.autoDelete ### .spec.download.autoDelete
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L84)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L84)</sup>
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
@ -62,7 +62,7 @@ Default Value: `false`
### .spec.download.credentialsSecretName ### .spec.download.credentialsSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L81)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
CredentialsSecretName is the name of the secret used while accessing repository CredentialsSecretName is the name of the secret used while accessing repository
@ -75,7 +75,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.download.id ### .spec.download.id
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L92)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L92)</sup>
ID of the ArangoBackup to be downloaded ID of the ArangoBackup to be downloaded
@ -85,7 +85,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.download.repositoryURL ### .spec.download.repositoryURL
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L77)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L77)</sup>
RepositoryURL is the URL path for file storage RepositoryURL is the URL path for file storage
Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local. Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local.
@ -106,7 +106,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.lifetime ### .spec.lifetime
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L47)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L47)</sup>
Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m". Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".
@ -114,7 +114,7 @@ Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "
### .spec.options.allowInconsistent ### .spec.options.allowInconsistent
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L66)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L66)</sup>
AllowInconsistent flag for Backup creation request. 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. If this value is set to true, backup is taken even if we are not able to acquire lock.
@ -127,7 +127,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.options.timeout ### .spec.options.timeout
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L61)</sup> Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L61)</sup>
Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false. Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false.
@ -139,7 +139,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.policyName ### .spec.policyName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L42)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L42)</sup>
PolicyName name of the ArangoBackupPolicy which created this Custom Resource PolicyName name of the ArangoBackupPolicy which created this Custom Resource
@ -149,7 +149,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.upload.autoDelete ### .spec.upload.autoDelete
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L84)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L84)</sup>
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
@ -159,7 +159,7 @@ Default Value: `false`
### .spec.upload.credentialsSecretName ### .spec.upload.credentialsSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L81)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
CredentialsSecretName is the name of the secret used while accessing repository CredentialsSecretName is the name of the secret used while accessing repository
@ -172,7 +172,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.upload.repositoryURL ### .spec.upload.repositoryURL
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L77)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L77)</sup>
RepositoryURL is the URL path for file storage RepositoryURL is the URL path for file storage
Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local. Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local.
@ -193,7 +193,7 @@ This field is **immutable**: can't be changed after backup creation
### .status.available ### .status.available
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status.go#L36)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status.go#L36)</sup>
Available Determines if we can restore from ArangoBackup Available Determines if we can restore from ArangoBackup
@ -201,13 +201,13 @@ Available Determines if we can restore from ArangoBackup
### .status.backoff.iterations ### .status.backoff.iterations
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status_backoff.go#L30)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status_backoff.go#L30)</sup>
*** ***
### .status.backup.downloaded ### .status.backup.downloaded
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status.go#L66)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status.go#L66)</sup>
Downloaded Determines if ArangoBackup has been downloaded. Downloaded Determines if ArangoBackup has been downloaded.
@ -215,25 +215,25 @@ Downloaded Determines if ArangoBackup has been downloaded.
### .status.backup.id ### .status.backup.id
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status.go#L56)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status.go#L56)</sup>
*** ***
### .status.backup.imported ### .status.backup.imported
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status.go#L67)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status.go#L67)</sup>
*** ***
### .status.backup.keys ### .status.backup.keys
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status.go#L70)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status.go#L70)</sup>
*** ***
### .status.backup.numberOfDBServers ### .status.backup.numberOfDBServers
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status.go#L62)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status.go#L62)</sup>
NumberOfDBServers Cluster size of the Backup in ArangoDB NumberOfDBServers Cluster size of the Backup in ArangoDB
@ -241,13 +241,13 @@ NumberOfDBServers Cluster size of the Backup in ArangoDB
### .status.backup.potentiallyInconsistent ### .status.backup.potentiallyInconsistent
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status.go#L58)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status.go#L58)</sup>
*** ***
### .status.backup.sizeInBytes ### .status.backup.sizeInBytes
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status.go#L60)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status.go#L60)</sup>
SizeInBytes Size of the Backup in ArangoDB. SizeInBytes Size of the Backup in ArangoDB.
@ -255,7 +255,7 @@ SizeInBytes Size of the Backup in ArangoDB.
### .status.backup.uploaded ### .status.backup.uploaded
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status.go#L64)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status.go#L64)</sup>
Uploaded Determines if ArangoBackup has been uploaded Uploaded Determines if ArangoBackup has been uploaded
@ -263,13 +263,13 @@ Uploaded Determines if ArangoBackup has been uploaded
### .status.backup.version ### .status.backup.version
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_status.go#L57)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_status.go#L57)</sup>
*** ***
### .status.message ### .status.message
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_state.go#L91)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_state.go#L91)</sup>
Message for the state this object is in. Message for the state this object is in.
@ -277,7 +277,7 @@ Message for the state this object is in.
### .status.progress.jobID ### .status.progress.jobID
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_state.go#L114)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_state.go#L114)</sup>
JobID ArangoDB job ID for uploading or downloading JobID ArangoDB job ID for uploading or downloading
@ -285,7 +285,7 @@ JobID ArangoDB job ID for uploading or downloading
### .status.progress.progress ### .status.progress.progress
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_state.go#L117)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_state.go#L117)</sup>
Progress ArangoDB job progress in percents Progress ArangoDB job progress in percents
@ -298,7 +298,7 @@ Example:
### .status.state ### .status.state
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_state.go#L85)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_state.go#L85)</sup>
State holds the current high level state of the backup State holds the current high level state of the backup

32
docs/api/ArangoBackupPolicy.V1.md
View file

@ -10,7 +10,7 @@ title: ArangoBackupPolicy V1
### .spec.allowConcurrent ### .spec.allowConcurrent
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_policy_spec.go#L35)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_policy_spec.go#L35)</sup>
AllowConcurrent if false, ArangoBackup will not be created when previous Backups are not finished AllowConcurrent if false, ArangoBackup will not be created when previous Backups are not finished
@ -20,7 +20,7 @@ Default Value: `true`
### .spec.maxBackups ### .spec.maxBackups
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_policy_spec.go#L43)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_policy_spec.go#L43)</sup>
MaxBackups defines how many backups should be kept in history (per deployment). Oldest healthy Backups will be deleted. 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 If not specified or 0 then no limit is applied
@ -31,7 +31,7 @@ Default Value: `0`
### .spec.schedule ### .spec.schedule
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_policy_spec.go#L32)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_policy_spec.go#L32)</sup>
Schedule is cron-compatible specification of backup schedule Schedule is cron-compatible specification of backup schedule
Parsed by https://godoc.org/github.com/robfig/cron Parsed by https://godoc.org/github.com/robfig/cron
@ -40,7 +40,7 @@ Parsed by https://godoc.org/github.com/robfig/cron
### .spec.selector ### .spec.selector
Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_policy_spec.go#L39)</sup> Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_policy_spec.go#L39)</sup>
DeploymentSelector Selector definition for selecting matching ArangoBackup Custom Resources. DeploymentSelector Selector definition for selecting matching ArangoBackup Custom Resources.
@ -51,7 +51,7 @@ Links:
### .spec.template.backoff.iterations ### .spec.template.backoff.iterations
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec_backoff.go#L31)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec_backoff.go#L31)</sup>
Iterations defines number of iterations before reaching MaxDelay. Default to 5 Iterations defines number of iterations before reaching MaxDelay. Default to 5
@ -59,7 +59,7 @@ Iterations defines number of iterations before reaching MaxDelay. Default to 5
### .spec.template.backoff.max_delay ### .spec.template.backoff.max_delay
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec_backoff.go#L29)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec_backoff.go#L29)</sup>
MaxDelay defines maximum delay in seconds. Default to 600 MaxDelay defines maximum delay in seconds. Default to 600
@ -67,7 +67,7 @@ MaxDelay defines maximum delay in seconds. Default to 600
### .spec.template.backoff.max_iterations ### .spec.template.backoff.max_iterations
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec_backoff.go#L33)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec_backoff.go#L33)</sup>
MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit) MaxIterations defines maximum number of iterations after backoff will be disabled. Default to nil (no limit)
@ -75,7 +75,7 @@ MaxIterations defines maximum number of iterations after backoff will be disable
### .spec.template.backoff.min_delay ### .spec.template.backoff.min_delay
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec_backoff.go#L27)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec_backoff.go#L27)</sup>
MinDelay defines minimum delay in seconds. Default to 30 MinDelay defines minimum delay in seconds. Default to 30
@ -83,7 +83,7 @@ MinDelay defines minimum delay in seconds. Default to 30
### .spec.template.lifetime ### .spec.template.lifetime
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_policy_spec.go#L61)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_policy_spec.go#L61)</sup>
Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m". Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "2h45m".
@ -91,7 +91,7 @@ Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "
### .spec.template.options.allowInconsistent ### .spec.template.options.allowInconsistent
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L66)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L66)</sup>
AllowInconsistent flag for Backup creation request. 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. If this value is set to true, backup is taken even if we are not able to acquire lock.
@ -104,7 +104,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.template.options.timeout ### .spec.template.options.timeout
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L61)</sup> Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L61)</sup>
Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false. Timeout for Backup creation request in seconds. Works only when AsyncBackupCreation feature is set to false.
@ -116,7 +116,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.template.upload.autoDelete ### .spec.template.upload.autoDelete
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L84)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L84)</sup>
AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload AutoDelete removes the ArangoBackup resource (which removes the backup from the cluster) after successful upload
@ -126,7 +126,7 @@ Default Value: `false`
### .spec.template.upload.credentialsSecretName ### .spec.template.upload.credentialsSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L81)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
CredentialsSecretName is the name of the secret used while accessing repository CredentialsSecretName is the name of the secret used while accessing repository
@ -139,7 +139,7 @@ This field is **immutable**: can't be changed after backup creation
### .spec.template.upload.repositoryURL ### .spec.template.upload.repositoryURL
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_spec.go#L77)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_spec.go#L77)</sup>
RepositoryURL is the URL path for file storage RepositoryURL is the URL path for file storage
Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local. Same repositoryURL needs to be defined in `credentialsSecretName` if protocol is other than local.
@ -160,7 +160,7 @@ This field is **immutable**: can't be changed after backup creation
### .status.message ### .status.message
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_policy_status.go#L33)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_policy_status.go#L33)</sup>
Message from the operator in case of failures - schedule not valid, ArangoBackupPolicy not valid Message from the operator in case of failures - schedule not valid, ArangoBackupPolicy not valid
@ -168,7 +168,7 @@ Message from the operator in case of failures - schedule not valid, ArangoBackup
### .status.scheduled ### .status.scheduled
Type: `meta.Time` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/backup/v1/backup_policy_status.go#L31)</sup> Type: `meta.Time` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/backup/v1/backup_policy_status.go#L31)</sup>
Scheduled Next scheduled time in UTC Scheduled Next scheduled time in UTC

1296
docs/api/ArangoDeployment.V1.md
View file

File diff suppressed because it is too large Load diff

24
docs/api/ArangoDeploymentReplication.V1.md
View file

@ -10,7 +10,7 @@ title: ArangoDeploymentReplication V1
### .spec.cancellation.ensureInSync ### .spec.cancellation.ensureInSync
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/replication_spec.go#L38)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/replication_spec.go#L38)</sup>
EnsureInSync if it is true then during cancellation process data consistency is required. EnsureInSync if it is true then during cancellation process data consistency is required.
Default value is true. Default value is true.
@ -19,7 +19,7 @@ Default value is true.
### .spec.cancellation.sourceReadOnly ### .spec.cancellation.sourceReadOnly
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/replication_spec.go#L41)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/replication_spec.go#L41)</sup>
SourceReadOnly if it true then after cancellation source data center should be in read-only mode. SourceReadOnly if it true then after cancellation source data center should be in read-only mode.
Default value is false. Default value is false.
@ -28,7 +28,7 @@ Default value is false.
### .spec.destination.auth.keyfileSecretName ### .spec.destination.auth.keyfileSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37)</sup>
KeyfileSecretName holds the name of a Secret containing a client authentication KeyfileSecretName holds the name of a Secret containing a client authentication
certificate formatted at keyfile in a `tls.keyfile` field. certificate formatted at keyfile in a `tls.keyfile` field.
@ -40,7 +40,7 @@ the synchronization and fetch the synchronization status.
### .spec.destination.auth.userSecretName ### .spec.destination.auth.userSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42)</sup>
UserSecretName holds the name of a Secret containing a `username` & `password` UserSecretName holds the name of a Secret containing a `username` & `password`
field used for basic authentication. field used for basic authentication.
@ -51,7 +51,7 @@ of the ArangoDB cluster at the endpoint.
### .spec.destination.deploymentName ### .spec.destination.deploymentName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/endpoint_spec.go#L36)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/endpoint_spec.go#L36)</sup>
DeploymentName holds the name of an ArangoDeployment resource. DeploymentName holds the name of an ArangoDeployment resource.
If set, this provides default values for masterEndpoint, auth & tls. If set, this provides default values for masterEndpoint, auth & tls.
@ -60,7 +60,7 @@ If set, this provides default values for masterEndpoint, auth & tls.
### .spec.destination.masterEndpoint ### .spec.destination.masterEndpoint
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/endpoint_spec.go#L42)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/endpoint_spec.go#L42)</sup>
MasterEndpoint holds a list of URLs used to reach the syncmaster(s) 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 Use this setting if the source cluster is not running inside a Kubernetes cluster
@ -73,7 +73,7 @@ Default Value: `[]`
### .spec.destination.tls.caSecretName ### .spec.destination.tls.caSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/endpoint_tls_spec.go#L34)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/endpoint_tls_spec.go#L34)</sup>
CASecretName holds the name of a Secret containing a ca.crt public key for TLS validation. 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. This setting is required, unless `deploymentName` has been set.
@ -82,7 +82,7 @@ This setting is required, unless `deploymentName` has been set.
### .spec.source.auth.keyfileSecretName ### .spec.source.auth.keyfileSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37)</sup>
KeyfileSecretName holds the name of a Secret containing a client authentication KeyfileSecretName holds the name of a Secret containing a client authentication
certificate formatted at keyfile in a `tls.keyfile` field. certificate formatted at keyfile in a `tls.keyfile` field.
@ -94,7 +94,7 @@ the synchronization and fetch the synchronization status.
### .spec.source.auth.userSecretName ### .spec.source.auth.userSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42)</sup>
UserSecretName holds the name of a Secret containing a `username` & `password` UserSecretName holds the name of a Secret containing a `username` & `password`
field used for basic authentication. field used for basic authentication.
@ -105,7 +105,7 @@ of the ArangoDB cluster at the endpoint.
### .spec.source.deploymentName ### .spec.source.deploymentName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/endpoint_spec.go#L36)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/endpoint_spec.go#L36)</sup>
DeploymentName holds the name of an ArangoDeployment resource. DeploymentName holds the name of an ArangoDeployment resource.
If set, this provides default values for masterEndpoint, auth & tls. If set, this provides default values for masterEndpoint, auth & tls.
@ -114,7 +114,7 @@ If set, this provides default values for masterEndpoint, auth & tls.
### .spec.source.masterEndpoint ### .spec.source.masterEndpoint
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/endpoint_spec.go#L42)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/endpoint_spec.go#L42)</sup>
MasterEndpoint holds a list of URLs used to reach the syncmaster(s) 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 Use this setting if the source cluster is not running inside a Kubernetes cluster
@ -127,7 +127,7 @@ Default Value: `[]`
### .spec.source.tls.caSecretName ### .spec.source.tls.caSecretName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/replication/v1/endpoint_tls_spec.go#L34)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/replication/v1/endpoint_tls_spec.go#L34)</sup>
CASecretName holds the name of a Secret containing a ca.crt public key for TLS validation. 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. This setting is required, unless `deploymentName` has been set.

4
docs/api/ArangoJob.V1.md
View file

@ -10,7 +10,7 @@ title: ArangoJob V1
### .spec.arangoDeploymentName ### .spec.arangoDeploymentName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/apps/v1/job_spec.go#L27)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/apps/v1/job_spec.go#L27)</sup>
ArangoDeploymentName holds the name of ArangoDeployment ArangoDeploymentName holds the name of ArangoDeployment
@ -18,7 +18,7 @@ ArangoDeploymentName holds the name of ArangoDeployment
### .spec.jobTemplate ### .spec.jobTemplate
Type: `batch.JobSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/apps/v1/job_spec.go#L33)</sup> Type: `batch.JobSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/apps/v1/job_spec.go#L33)</sup>
JobTemplate holds the Kubernetes Job Template JobTemplate holds the Kubernetes Job Template

16
docs/api/ArangoLocalStorage.V1Alpha.md
View file

@ -10,7 +10,7 @@ title: ArangoLocalStorage V1Alpha
### .spec.localPath ### .spec.localPath
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/storage/v1alpha/local_storage_spec.go#L36)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/storage/v1alpha/local_storage_spec.go#L36)</sup>
LocalPath setting specifies one or more local directories (on the nodes) used to create persistent volumes in. LocalPath setting specifies one or more local directories (on the nodes) used to create persistent volumes in.
@ -18,7 +18,7 @@ LocalPath setting specifies one or more local directories (on the nodes) used to
### .spec.nodeSelector ### .spec.nodeSelector
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/storage/v1alpha/local_storage_spec.go#L43)</sup> Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/storage/v1alpha/local_storage_spec.go#L43)</sup>
NodeSelector setting specifies which nodes the operator will provision persistent volumes on. NodeSelector setting specifies which nodes the operator will provision persistent volumes on.
@ -26,7 +26,7 @@ NodeSelector setting specifies which nodes the operator will provision persisten
### .spec.podCustomization.priority ### .spec.podCustomization.priority
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/storage/v1alpha/local_storage_pod_customization.go#L25)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/storage/v1alpha/local_storage_pod_customization.go#L25)</sup>
Priority if defined, sets the priority for pods of storage provisioner Priority if defined, sets the priority for pods of storage provisioner
@ -34,7 +34,7 @@ Priority if defined, sets the priority for pods of storage provisioner
### .spec.privileged ### .spec.privileged
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/storage/v1alpha/local_storage_spec.go#L45)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/storage/v1alpha/local_storage_spec.go#L45)</sup>
Privileged if set, passes Privileged flag to SecurityContext for pods of storage provisioner Privileged if set, passes Privileged flag to SecurityContext for pods of storage provisioner
@ -42,7 +42,7 @@ Privileged if set, passes Privileged flag to SecurityContext for pods of storage
### .spec.storageClass.isDefault ### .spec.storageClass.isDefault
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/storage/v1alpha/storage_class_spec.go#L42)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/storage/v1alpha/storage_class_spec.go#L42)</sup>
IsDefault setting specifies if the created `StorageClass` will IsDefault setting specifies if the created `StorageClass` will
be marked as default storage class. be marked as default storage class.
@ -53,7 +53,7 @@ Default Value: `false`
### .spec.storageClass.name ### .spec.storageClass.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/storage/v1alpha/storage_class_spec.go#L38)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/storage/v1alpha/storage_class_spec.go#L38)</sup>
Name setting specifies the name of the storage class that Name setting specifies the name of the storage class that
created `PersistentVolume` will use. created `PersistentVolume` will use.
@ -66,7 +66,7 @@ Default Value: `""`
### .spec.storageClass.reclaimPolicy ### .spec.storageClass.reclaimPolicy
Type: `core.PersistentVolumeReclaimPolicy` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/storage/v1alpha/storage_class_spec.go#L46)</sup> Type: `core.PersistentVolumeReclaimPolicy` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/storage/v1alpha/storage_class_spec.go#L46)</sup>
ReclaimPolicy defines what happens to a persistent volume when released from its claim. ReclaimPolicy defines what happens to a persistent volume when released from its claim.
@ -77,7 +77,7 @@ Links:
### .spec.tolerations ### .spec.tolerations
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/storage/v1alpha/local_storage_spec.go#L41)</sup> Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/storage/v1alpha/local_storage_spec.go#L41)</sup>
Tolerations specifies the tolerations added to pods of storage provisioner Tolerations specifies the tolerations added to pods of storage provisioner

14
docs/api/ArangoMLBatchJob.V1Alpha1.md
View file

@ -10,7 +10,7 @@ title: ArangoMLBatchJob V1Alpha1
### .spec ### .spec
Type: `batch.Job` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/batchjob_spec.go#L33)</sup> Type: `batch.Job` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/batchjob_spec.go#L33)</sup>
Links: Links:
* [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#JobSpec) * [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#JobSpec)
@ -19,7 +19,7 @@ Links:
### .status ### .status
Type: `batch.JobStatus` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/batchjob_status.go#L37)</sup> Type: `batch.JobStatus` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/batchjob_status.go#L37)</sup>
Links: Links:
* [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#JobStatus) * [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#JobStatus)
@ -28,7 +28,7 @@ Links:
### .status.mlConditions ### .status.mlConditions
Type: `api.MLConditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/batchjob_status.go#L33)</sup> Type: `api.MLConditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/batchjob_status.go#L33)</sup>
MLConditions specific to the entire batch job MLConditions specific to the entire batch job
@ -36,7 +36,7 @@ MLConditions specific to the entire batch job
### .status.ref.checksum ### .status.ref.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -44,7 +44,7 @@ UID keeps the information about object Checksum
### .status.ref.name ### .status.ref.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -52,7 +52,7 @@ Name of the object
### .status.ref.namespace ### .status.ref.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -60,7 +60,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .status.ref.uid ### .status.ref.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID

14
docs/api/ArangoMLCronJob.V1Alpha1.md
View file

@ -10,7 +10,7 @@ title: ArangoMLCronJob V1Alpha1
### .spec ### .spec
Type: `batch.CronJobSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/cronjob_spec.go#L33)</sup> Type: `batch.CronJobSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/cronjob_spec.go#L33)</sup>
Links: Links:
* [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#CronJobSpec) * [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#CronJobSpec)
@ -19,7 +19,7 @@ Links:
### .status ### .status
Type: `batch.CronJobStatus` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/cronjob_status.go#L37)</sup> Type: `batch.CronJobStatus` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/cronjob_status.go#L37)</sup>
Links: Links:
* [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#CronJobStatus) * [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#CronJobStatus)
@ -28,7 +28,7 @@ Links:
### .status.mlConditions ### .status.mlConditions
Type: `api.MLConditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/cronjob_status.go#L33)</sup> Type: `api.MLConditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/cronjob_status.go#L33)</sup>
MLConditions specific to the entire cron job MLConditions specific to the entire cron job
@ -36,7 +36,7 @@ MLConditions specific to the entire cron job
### .status.ref.checksum ### .status.ref.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -44,7 +44,7 @@ UID keeps the information about object Checksum
### .status.ref.name ### .status.ref.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -52,7 +52,7 @@ Name of the object
### .status.ref.namespace ### .status.ref.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -60,7 +60,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .status.ref.uid ### .status.ref.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID

606
docs/api/ArangoMLExtension.V1Alpha1.md
View file

File diff suppressed because it is too large Load diff

632
docs/api/ArangoMLExtension.V1Beta1.md
View file

File diff suppressed because it is too large Load diff

62
docs/api/ArangoMLStorage.V1Alpha1.md
View file

@ -10,7 +10,7 @@ title: ArangoMLStorage V1Alpha1
### .spec.backend.s3.allowInsecure ### .spec.backend.s3.allowInsecure
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L40)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L40)</sup>
AllowInsecure if set to true, the Endpoint certificates won't be checked AllowInsecure if set to true, the Endpoint certificates won't be checked
@ -20,7 +20,7 @@ Default Value: `false`
### .spec.backend.s3.caSecret.checksum ### .spec.backend.s3.caSecret.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -28,7 +28,7 @@ UID keeps the information about object Checksum
### .spec.backend.s3.caSecret.name ### .spec.backend.s3.caSecret.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -36,7 +36,7 @@ Name of the object
### .spec.backend.s3.caSecret.namespace ### .spec.backend.s3.caSecret.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -44,7 +44,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .spec.backend.s3.caSecret.uid ### .spec.backend.s3.caSecret.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID
@ -52,7 +52,7 @@ UID keeps the information about object UID
### .spec.backend.s3.credentialsSecret.checksum ### .spec.backend.s3.credentialsSecret.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -60,7 +60,7 @@ UID keeps the information about object Checksum
### .spec.backend.s3.credentialsSecret.name ### .spec.backend.s3.credentialsSecret.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -68,7 +68,7 @@ Name of the object
### .spec.backend.s3.credentialsSecret.namespace ### .spec.backend.s3.credentialsSecret.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -76,7 +76,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .spec.backend.s3.credentialsSecret.uid ### .spec.backend.s3.credentialsSecret.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID
@ -84,7 +84,7 @@ UID keeps the information about object UID
### .spec.backend.s3.endpoint ### .spec.backend.s3.endpoint
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L34)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L34)</sup>
Endpoint specifies the S3 API-compatible endpoint which implements storage Endpoint specifies the S3 API-compatible endpoint which implements storage
Required Required
@ -93,7 +93,7 @@ Required
### .spec.backend.s3.region ### .spec.backend.s3.region
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L49)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L49)</sup>
Region defines the availability zone name. Region defines the availability zone name.
@ -103,7 +103,7 @@ Default Value: `""`
### .spec.bucketName ### .spec.bucketName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/storage_spec.go#L30)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/storage_spec.go#L30)</sup>
BucketName specifies the name of the bucket BucketName specifies the name of the bucket
Required Required
@ -112,7 +112,7 @@ Required
### .spec.bucketPath ### .spec.bucketPath
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/storage_spec.go#L34)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/storage_spec.go#L34)</sup>
BucketPath specifies the path within the bucket BucketPath specifies the path within the bucket
@ -122,7 +122,7 @@ Default Value: `/`
### .spec.mode.sidecar.args ### .spec.mode.sidecar.args
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L50)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L50)</sup>
Arguments to the entrypoint. Arguments to the entrypoint.
The container image's CMD is used if this is not provided. The container image's CMD is used if this is not provided.
@ -139,7 +139,7 @@ Links:
### .spec.mode.sidecar.command ### .spec.mode.sidecar.command
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L40)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L40)</sup>
Entrypoint array. Not executed within a shell. Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided. The container image's ENTRYPOINT is used if this is not provided.
@ -156,7 +156,7 @@ Links:
### .spec.mode.sidecar.controllerListenPort ### .spec.mode.sidecar.controllerListenPort
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L36)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L36)</sup>
ControllerListenPort defines on which port the sidecar container will be listening for controller requests ControllerListenPort defines on which port the sidecar container will be listening for controller requests
@ -166,7 +166,7 @@ Default Value: `9202`
### .spec.mode.sidecar.env ### .spec.mode.sidecar.env
Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L36)</sup> Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L36)</sup>
Env keeps the information about environment variables provided to the container Env keeps the information about environment variables provided to the container
@ -177,7 +177,7 @@ Links:
### .spec.mode.sidecar.envFrom ### .spec.mode.sidecar.envFrom
Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L41)</sup> Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L41)</sup>
EnvFrom keeps the information about environment variable sources provided to the container EnvFrom keeps the information about environment variable sources provided to the container
@ -188,7 +188,7 @@ Links:
### .spec.mode.sidecar.image ### .spec.mode.sidecar.image
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/image.go#L35)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/image.go#L35)</sup>
Image define image details Image define image details
@ -196,7 +196,7 @@ Image define image details
### .spec.mode.sidecar.imagePullPolicy ### .spec.mode.sidecar.imagePullPolicy
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/image.go#L39)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/image.go#L39)</sup>
ImagePullPolicy define Image pull policy ImagePullPolicy define Image pull policy
@ -206,7 +206,7 @@ Default Value: `IfNotPresent`
### .spec.mode.sidecar.lifecycle ### .spec.mode.sidecar.lifecycle
Type: `core.Lifecycle` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/lifecycle.go#L35)</sup> Type: `core.Lifecycle` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/lifecycle.go#L35)</sup>
Lifecycle keeps actions that the management system should take in response to container lifecycle events. Lifecycle keeps actions that the management system should take in response to container lifecycle events.
@ -214,7 +214,7 @@ Lifecycle keeps actions that the management system should take in response to co
### .spec.mode.sidecar.listenPort ### .spec.mode.sidecar.listenPort
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L32)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L32)</sup>
ListenPort defines on which port the sidecar container will be listening for connections ListenPort defines on which port the sidecar container will be listening for connections
@ -224,7 +224,7 @@ Default Value: `9201`
### .spec.mode.sidecar.livenessProbe ### .spec.mode.sidecar.livenessProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L37)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L37)</sup>
LivenessProbe keeps configuration of periodic probe of container liveness. LivenessProbe keeps configuration of periodic probe of container liveness.
Container will be restarted if the probe fails. Container will be restarted if the probe fails.
@ -236,7 +236,7 @@ Links:
### .spec.mode.sidecar.ports ### .spec.mode.sidecar.ports
Type: `[]core.ContainerPort` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/networking.go#L39)</sup> Type: `[]core.ContainerPort` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/networking.go#L39)</sup>
Ports contains list of ports to expose from the container. Not specifying a port here Ports contains list of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is DOES NOT prevent that port from being exposed. Any port which is
@ -247,7 +247,7 @@ accessible from the network.
### .spec.mode.sidecar.readinessProbe ### .spec.mode.sidecar.readinessProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L42)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L42)</sup>
ReadinessProbe keeps configuration of periodic probe of container service readiness. ReadinessProbe keeps configuration of periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails. Container will be removed from service endpoints if the probe fails.
@ -259,7 +259,7 @@ Links:
### .spec.mode.sidecar.resources ### .spec.mode.sidecar.resources
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/resources.go#L37)</sup> Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/resources.go#L37)</sup>
Resources holds resource requests & limits for container Resources holds resource requests & limits for container
@ -270,7 +270,7 @@ Links:
### .spec.mode.sidecar.securityContext ### .spec.mode.sidecar.securityContext
Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/security.go#L35)</sup> Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/security.go#L35)</sup>
SecurityContext holds container-level security attributes and common container settings. SecurityContext holds container-level security attributes and common container settings.
@ -281,7 +281,7 @@ Links:
### .spec.mode.sidecar.startupProbe ### .spec.mode.sidecar.startupProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L50)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L50)</sup>
StartupProbe indicates that the Pod has successfully initialized. StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully. If specified, no other probes are executed until this completes successfully.
@ -296,7 +296,7 @@ Links:
### .spec.mode.sidecar.volumeMounts ### .spec.mode.sidecar.volumeMounts
Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/volume_mounts.go#L35)</sup> Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/volume_mounts.go#L35)</sup>
VolumeMounts keeps list of pod volumes to mount into the container's filesystem. VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
@ -304,7 +304,7 @@ VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
### .spec.mode.sidecar.workingDir ### .spec.mode.sidecar.workingDir
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L55)</sup>
Container's working directory. Container's working directory.
If not specified, the container runtime's default will be used, which If not specified, the container runtime's default will be used, which
@ -314,7 +314,7 @@ might be configured in the container image.
### .status.conditions ### .status.conditions
Type: `api.Conditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1alpha1/storage_status.go#L28)</sup> Type: `api.Conditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1alpha1/storage_status.go#L28)</sup>
Conditions specific to the entire storage Conditions specific to the entire storage

28
docs/api/ArangoMLStorage.V1Beta1.md
View file

@ -10,7 +10,7 @@ title: ArangoMLStorage V1Beta1
### .spec.backend.s3.allowInsecure ### .spec.backend.s3.allowInsecure
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1beta1/storage_spec_backend_s3.go#L40)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1beta1/storage_spec_backend_s3.go#L40)</sup>
AllowInsecure if set to true, the Endpoint certificates won't be checked AllowInsecure if set to true, the Endpoint certificates won't be checked
@ -20,7 +20,7 @@ Default Value: `false`
### .spec.backend.s3.caSecret.checksum ### .spec.backend.s3.caSecret.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -28,7 +28,7 @@ UID keeps the information about object Checksum
### .spec.backend.s3.caSecret.name ### .spec.backend.s3.caSecret.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -36,7 +36,7 @@ Name of the object
### .spec.backend.s3.caSecret.namespace ### .spec.backend.s3.caSecret.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -44,7 +44,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .spec.backend.s3.caSecret.uid ### .spec.backend.s3.caSecret.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID
@ -52,7 +52,7 @@ UID keeps the information about object UID
### .spec.backend.s3.credentialsSecret.checksum ### .spec.backend.s3.credentialsSecret.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -60,7 +60,7 @@ UID keeps the information about object Checksum
### .spec.backend.s3.credentialsSecret.name ### .spec.backend.s3.credentialsSecret.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -68,7 +68,7 @@ Name of the object
### .spec.backend.s3.credentialsSecret.namespace ### .spec.backend.s3.credentialsSecret.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -76,7 +76,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .spec.backend.s3.credentialsSecret.uid ### .spec.backend.s3.credentialsSecret.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID
@ -84,7 +84,7 @@ UID keeps the information about object UID
### .spec.backend.s3.endpoint ### .spec.backend.s3.endpoint
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1beta1/storage_spec_backend_s3.go#L34)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1beta1/storage_spec_backend_s3.go#L34)</sup>
Endpoint specifies the S3 API-compatible endpoint which implements storage Endpoint specifies the S3 API-compatible endpoint which implements storage
Required Required
@ -93,7 +93,7 @@ Required
### .spec.backend.s3.region ### .spec.backend.s3.region
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1beta1/storage_spec_backend_s3.go#L49)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1beta1/storage_spec_backend_s3.go#L49)</sup>
Region defines the availability zone name. Region defines the availability zone name.
@ -103,7 +103,7 @@ Default Value: `""`
### .spec.bucketName ### .spec.bucketName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1beta1/storage_spec.go#L30)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1beta1/storage_spec.go#L30)</sup>
BucketName specifies the name of the bucket BucketName specifies the name of the bucket
Required Required
@ -112,7 +112,7 @@ Required
### .spec.bucketPath ### .spec.bucketPath
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1beta1/storage_spec.go#L34)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1beta1/storage_spec.go#L34)</sup>
BucketPath specifies the path within the bucket BucketPath specifies the path within the bucket
@ -122,7 +122,7 @@ Default Value: `/`
### .status.conditions ### .status.conditions
Type: `api.Conditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/ml/v1beta1/storage_status.go#L28)</sup> Type: `api.Conditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/ml/v1beta1/storage_status.go#L28)</sup>
Conditions specific to the entire storage Conditions specific to the entire storage

20
docs/api/ArangoMember.V1.md
View file

@ -10,7 +10,7 @@ title: ArangoMember V1
### .spec.deletion_priority ### .spec.deletion_priority
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/deployment/v1/arango_member_spec.go#L48)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/arango_member_spec.go#L48)</sup>
DeletionPriority define Deletion Priority. DeletionPriority define Deletion Priority.
Higher value means higher priority. Default is 0. Higher value means higher priority. Default is 0.
@ -20,7 +20,7 @@ Example: set 1 for Coordinator which should be deleted first and scale down coor
### .spec.deploymentUID ### .spec.deploymentUID
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/deployment/v1/arango_member_spec.go#L37)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/arango_member_spec.go#L37)</sup>
DeploymentUID define Deployment UID. DeploymentUID define Deployment UID.
@ -28,7 +28,7 @@ DeploymentUID define Deployment UID.
### .spec.group ### .spec.group
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/deployment/v1/arango_member_spec.go#L32)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/arango_member_spec.go#L32)</sup>
Group define Member Groups. Group define Member Groups.
@ -36,13 +36,13 @@ Group define Member Groups.
### .spec.id ### .spec.id
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/deployment/v1/arango_member_spec.go#L34)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/arango_member_spec.go#L34)</sup>
*** ***
### .spec.overrides.resources ### .spec.overrides.resources
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L38)</sup> Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L38)</sup>
Resources holds resource requests & limits. Overrides template provided on the group level. Resources holds resource requests & limits. Overrides template provided on the group level.
@ -53,7 +53,7 @@ Links:
### .spec.overrides.volumeClaimTemplate ### .spec.overrides.volumeClaimTemplate
Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L33)</sup> Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L33)</sup>
VolumeClaimTemplate specifies a template for volume claims. Overrides template provided on the group level. VolumeClaimTemplate specifies a template for volume claims. Overrides template provided on the group level.
@ -64,7 +64,7 @@ Links:
### .spec.template.checksum ### .spec.template.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/deployment/v1/arango_member_pod_template.go#L60)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/arango_member_pod_template.go#L60)</sup>
Checksum keep the Pod Spec Checksum (with ignored fields). Checksum keep the Pod Spec Checksum (with ignored fields).
@ -72,7 +72,7 @@ Checksum keep the Pod Spec Checksum (with ignored fields).
### .spec.template.endpoint ### .spec.template.endpoint
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/deployment/v1/arango_member_pod_template.go#L63)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/arango_member_pod_template.go#L63)</sup>
> [!WARNING] > [!WARNING]
> ***DEPRECATED*** > ***DEPRECATED***
@ -83,7 +83,7 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
### .spec.template.podSpec ### .spec.template.podSpec
Type: `core.PodTemplateSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/deployment/v1/arango_member_pod_template.go#L54)</sup> Type: `core.PodTemplateSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/arango_member_pod_template.go#L54)</sup>
PodSpec specifies the Pod Spec used for this Member. PodSpec specifies the Pod Spec used for this Member.
@ -94,7 +94,7 @@ Links:
### .spec.template.podSpecChecksum ### .spec.template.podSpecChecksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/deployment/v1/arango_member_pod_template.go#L57)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/deployment/v1/arango_member_pod_template.go#L57)</sup>
PodSpecChecksum keep the Pod Spec Checksum (without ignored fields). PodSpecChecksum keep the Pod Spec Checksum (without ignored fields).

72
docs/api/ArangoProfile.V1Alpha1.md
View file

@ -10,7 +10,7 @@ title: ArangoProfile V1Alpha1
### .spec.selectors.label ### .spec.selectors.label
Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/profile_selectors.go#L32)</sup> Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/profile_selectors.go#L32)</sup>
Label keeps information about label selector Label keeps information about label selector
@ -18,7 +18,7 @@ Label keeps information about label selector
### .spec.template.container.all.env ### .spec.template.container.all.env
Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L36)</sup> Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L36)</sup>
Env keeps the information about environment variables provided to the container Env keeps the information about environment variables provided to the container
@ -29,7 +29,7 @@ Links:
### .spec.template.container.all.envFrom ### .spec.template.container.all.envFrom
Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L41)</sup> Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L41)</sup>
EnvFrom keeps the information about environment variable sources provided to the container EnvFrom keeps the information about environment variable sources provided to the container
@ -40,7 +40,7 @@ Links:
### .spec.template.container.all.volumeMounts ### .spec.template.container.all.volumeMounts
Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/volume_mounts.go#L35)</sup> Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/volume_mounts.go#L35)</sup>
VolumeMounts keeps list of pod volumes to mount into the container's filesystem. VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
@ -48,7 +48,7 @@ VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
### .spec.template.container.containers.\<string\>.args ### .spec.template.container.containers.\<string\>.args
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L50)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L50)</sup>
Arguments to the entrypoint. Arguments to the entrypoint.
The container image's CMD is used if this is not provided. The container image's CMD is used if this is not provided.
@ -65,7 +65,7 @@ Links:
### .spec.template.container.containers.\<string\>.command ### .spec.template.container.containers.\<string\>.command
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L40)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L40)</sup>
Entrypoint array. Not executed within a shell. Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided. The container image's ENTRYPOINT is used if this is not provided.
@ -82,7 +82,7 @@ Links:
### .spec.template.container.containers.\<string\>.env ### .spec.template.container.containers.\<string\>.env
Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L36)</sup> Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L36)</sup>
Env keeps the information about environment variables provided to the container Env keeps the information about environment variables provided to the container
@ -93,7 +93,7 @@ Links:
### .spec.template.container.containers.\<string\>.envFrom ### .spec.template.container.containers.\<string\>.envFrom
Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L41)</sup> Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/environments.go#L41)</sup>
EnvFrom keeps the information about environment variable sources provided to the container EnvFrom keeps the information about environment variable sources provided to the container
@ -104,7 +104,7 @@ Links:
### .spec.template.container.containers.\<string\>.image ### .spec.template.container.containers.\<string\>.image
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/image.go#L35)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/image.go#L35)</sup>
Image define image details Image define image details
@ -112,7 +112,7 @@ Image define image details
### .spec.template.container.containers.\<string\>.imagePullPolicy ### .spec.template.container.containers.\<string\>.imagePullPolicy
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/image.go#L39)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/image.go#L39)</sup>
ImagePullPolicy define Image pull policy ImagePullPolicy define Image pull policy
@ -122,7 +122,7 @@ Default Value: `IfNotPresent`
### .spec.template.container.containers.\<string\>.lifecycle ### .spec.template.container.containers.\<string\>.lifecycle
Type: `core.Lifecycle` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/lifecycle.go#L35)</sup> Type: `core.Lifecycle` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/lifecycle.go#L35)</sup>
Lifecycle keeps actions that the management system should take in response to container lifecycle events. Lifecycle keeps actions that the management system should take in response to container lifecycle events.
@ -130,7 +130,7 @@ Lifecycle keeps actions that the management system should take in response to co
### .spec.template.container.containers.\<string\>.livenessProbe ### .spec.template.container.containers.\<string\>.livenessProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L37)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L37)</sup>
LivenessProbe keeps configuration of periodic probe of container liveness. LivenessProbe keeps configuration of periodic probe of container liveness.
Container will be restarted if the probe fails. Container will be restarted if the probe fails.
@ -142,7 +142,7 @@ Links:
### .spec.template.container.containers.\<string\>.ports ### .spec.template.container.containers.\<string\>.ports
Type: `[]core.ContainerPort` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/networking.go#L39)</sup> Type: `[]core.ContainerPort` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/networking.go#L39)</sup>
Ports contains list of ports to expose from the container. Not specifying a port here Ports contains list of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is DOES NOT prevent that port from being exposed. Any port which is
@ -153,7 +153,7 @@ accessible from the network.
### .spec.template.container.containers.\<string\>.readinessProbe ### .spec.template.container.containers.\<string\>.readinessProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L42)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L42)</sup>
ReadinessProbe keeps configuration of periodic probe of container service readiness. ReadinessProbe keeps configuration of periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails. Container will be removed from service endpoints if the probe fails.
@ -165,7 +165,7 @@ Links:
### .spec.template.container.containers.\<string\>.resources ### .spec.template.container.containers.\<string\>.resources
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/resources.go#L37)</sup> Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/resources.go#L37)</sup>
Resources holds resource requests & limits for container Resources holds resource requests & limits for container
@ -176,7 +176,7 @@ Links:
### .spec.template.container.containers.\<string\>.securityContext ### .spec.template.container.containers.\<string\>.securityContext
Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/security.go#L35)</sup> Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/security.go#L35)</sup>
SecurityContext holds container-level security attributes and common container settings. SecurityContext holds container-level security attributes and common container settings.
@ -187,7 +187,7 @@ Links:
### .spec.template.container.containers.\<string\>.startupProbe ### .spec.template.container.containers.\<string\>.startupProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L50)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/probes.go#L50)</sup>
StartupProbe indicates that the Pod has successfully initialized. StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully. If specified, no other probes are executed until this completes successfully.
@ -202,7 +202,7 @@ Links:
### .spec.template.container.containers.\<string\>.volumeMounts ### .spec.template.container.containers.\<string\>.volumeMounts
Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/volume_mounts.go#L35)</sup> Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/volume_mounts.go#L35)</sup>
VolumeMounts keeps list of pod volumes to mount into the container's filesystem. VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
@ -210,7 +210,7 @@ VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
### .spec.template.container.containers.\<string\>.workingDir ### .spec.template.container.containers.\<string\>.workingDir
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/container/resources/core.go#L55)</sup>
Container's working directory. Container's working directory.
If not specified, the container runtime's default will be used, which If not specified, the container runtime's default will be used, which
@ -220,7 +220,7 @@ might be configured in the container image.
### .spec.template.pod.affinity ### .spec.template.pod.affinity
Type: `core.Affinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/scheduling.go#L44)</sup> Type: `core.Affinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/scheduling.go#L44)</sup>
Affinity defines scheduling constraints for workload Affinity defines scheduling constraints for workload
@ -231,7 +231,7 @@ Links:
### .spec.template.pod.annotations ### .spec.template.pod.annotations
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/metadata.go#L45)</sup> Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/metadata.go#L45)</sup>
Annotations is an unstructured key value map stored with a resource that may be Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not set by external tools to store and retrieve arbitrary metadata. They are not
@ -244,7 +244,7 @@ Links:
### .spec.template.pod.automountServiceAccountToken ### .spec.template.pod.automountServiceAccountToken
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/service_account.go#L38)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/service_account.go#L38)</sup>
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
@ -252,7 +252,7 @@ AutomountServiceAccountToken indicates whether a service account token should be
### .spec.template.pod.hostIPC ### .spec.template.pod.hostIPC
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/namespace.go#L42)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/namespace.go#L42)</sup>
HostIPC defines to use the host's ipc namespace. HostIPC defines to use the host's ipc namespace.
@ -262,7 +262,7 @@ Default Value: `false`
### .spec.template.pod.hostNetwork ### .spec.template.pod.hostNetwork
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/namespace.go#L36)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/namespace.go#L36)</sup>
HostNetwork requests Host network for this pod. Use the host's network namespace. HostNetwork requests Host network for this pod. Use the host's network namespace.
If this option is set, the ports that will be used must be specified. If this option is set, the ports that will be used must be specified.
@ -273,7 +273,7 @@ Default Value: `false`
### .spec.template.pod.hostPID ### .spec.template.pod.hostPID
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/namespace.go#L39)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/namespace.go#L39)</sup>
HostPID define to use the host's pid namespace. HostPID define to use the host's pid namespace.
@ -283,7 +283,7 @@ Default Value: `false`
### .spec.template.pod.imagePullSecrets ### .spec.template.pod.imagePullSecrets
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/image.go#L36)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/image.go#L36)</sup>
ImagePullSecrets define Secrets used to pull Image from registry ImagePullSecrets define Secrets used to pull Image from registry
@ -291,7 +291,7 @@ ImagePullSecrets define Secrets used to pull Image from registry
### .spec.template.pod.labels ### .spec.template.pod.labels
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/metadata.go#L39)</sup> Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/metadata.go#L39)</sup>
Map of string keys and values that can be used to organize and categorize Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers (scope and select) objects. May match selectors of replication controllers
@ -304,7 +304,7 @@ Links:
### .spec.template.pod.nodeSelector ### .spec.template.pod.nodeSelector
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/scheduling.go#L39)</sup> Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/scheduling.go#L39)</sup>
NodeSelector is a selector that must be true for the workload to fit on a node. NodeSelector is a selector that must be true for the workload to fit on a node.
@ -315,7 +315,7 @@ Links:
### .spec.template.pod.ownerReferences ### .spec.template.pod.ownerReferences
Type: `meta.OwnerReference` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/metadata.go#L52)</sup> Type: `meta.OwnerReference` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/metadata.go#L52)</sup>
List of objects depended by this object. If ALL objects in the list have List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller, been deleted, this object will be garbage collected. If this object is managed by a controller,
@ -326,7 +326,7 @@ There cannot be more than one managing controller.
### .spec.template.pod.podSecurityContext ### .spec.template.pod.podSecurityContext
Type: `core.PodSecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/security.go#L35)</sup> Type: `core.PodSecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/security.go#L35)</sup>
PodSecurityContext holds pod-level security attributes and common container settings. PodSecurityContext holds pod-level security attributes and common container settings.
@ -337,7 +337,7 @@ Links:
### .spec.template.pod.schedulerName ### .spec.template.pod.schedulerName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/scheduling.go#L54)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/scheduling.go#L54)</sup>
SchedulerName specifies, the pod will be dispatched by specified scheduler. SchedulerName specifies, the pod will be dispatched by specified scheduler.
If not specified, the pod will be dispatched by default scheduler. If not specified, the pod will be dispatched by default scheduler.
@ -348,7 +348,7 @@ Default Value: `""`
### .spec.template.pod.serviceAccountName ### .spec.template.pod.serviceAccountName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/service_account.go#L35)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/service_account.go#L35)</sup>
ServiceAccountName is the name of the ServiceAccount to use to run this pod. ServiceAccountName is the name of the ServiceAccount to use to run this pod.
@ -359,7 +359,7 @@ Links:
### .spec.template.pod.shareProcessNamespace ### .spec.template.pod.shareProcessNamespace
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/namespace.go#L48)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/namespace.go#L48)</sup>
ShareProcessNamespace defines to share a single process namespace between all of the containers in a pod. ShareProcessNamespace defines to share a single process namespace between all of the containers in a pod.
When this is set containers will be able to view and signal processes from other containers When this is set containers will be able to view and signal processes from other containers
@ -372,7 +372,7 @@ Default Value: `false`
### .spec.template.pod.tolerations ### .spec.template.pod.tolerations
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/scheduling.go#L49)</sup> Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/scheduling.go#L49)</sup>
Tolerations defines tolerations Tolerations defines tolerations
@ -383,7 +383,7 @@ Links:
### .spec.template.pod.volumes ### .spec.template.pod.volumes
Type: `[]core.Volume` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/pod/resources/volumes.go#L36)</sup> Type: `[]core.Volume` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/pod/resources/volumes.go#L36)</sup>
Volumes keeps list of volumes that can be mounted by containers belonging to the pod. Volumes keeps list of volumes that can be mounted by containers belonging to the pod.
@ -394,5 +394,5 @@ Links:
### .spec.template.priority ### .spec.template.priority
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1alpha1/profile_template.go#L30)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1alpha1/profile_template.go#L30)</sup>

72
docs/api/ArangoProfile.V1Beta1.md
View file

@ -10,7 +10,7 @@ title: ArangoProfile V1Beta1
### .spec.selectors.label ### .spec.selectors.label
Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/profile_selectors.go#L32)</sup> Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/profile_selectors.go#L32)</sup>
Label keeps information about label selector Label keeps information about label selector
@ -18,7 +18,7 @@ Label keeps information about label selector
### .spec.template.container.all.env ### .spec.template.container.all.env
Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L36)</sup> Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L36)</sup>
Env keeps the information about environment variables provided to the container Env keeps the information about environment variables provided to the container
@ -29,7 +29,7 @@ Links:
### .spec.template.container.all.envFrom ### .spec.template.container.all.envFrom
Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L41)</sup> Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L41)</sup>
EnvFrom keeps the information about environment variable sources provided to the container EnvFrom keeps the information about environment variable sources provided to the container
@ -40,7 +40,7 @@ Links:
### .spec.template.container.all.volumeMounts ### .spec.template.container.all.volumeMounts
Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/volume_mounts.go#L35)</sup> Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/volume_mounts.go#L35)</sup>
VolumeMounts keeps list of pod volumes to mount into the container's filesystem. VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
@ -48,7 +48,7 @@ VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
### .spec.template.container.containers.\<string\>.args ### .spec.template.container.containers.\<string\>.args
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/core.go#L50)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/core.go#L50)</sup>
Arguments to the entrypoint. Arguments to the entrypoint.
The container image's CMD is used if this is not provided. The container image's CMD is used if this is not provided.
@ -65,7 +65,7 @@ Links:
### .spec.template.container.containers.\<string\>.command ### .spec.template.container.containers.\<string\>.command
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/core.go#L40)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/core.go#L40)</sup>
Entrypoint array. Not executed within a shell. Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided. The container image's ENTRYPOINT is used if this is not provided.
@ -82,7 +82,7 @@ Links:
### .spec.template.container.containers.\<string\>.env ### .spec.template.container.containers.\<string\>.env
Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L36)</sup> Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L36)</sup>
Env keeps the information about environment variables provided to the container Env keeps the information about environment variables provided to the container
@ -93,7 +93,7 @@ Links:
### .spec.template.container.containers.\<string\>.envFrom ### .spec.template.container.containers.\<string\>.envFrom
Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L41)</sup> Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L41)</sup>
EnvFrom keeps the information about environment variable sources provided to the container EnvFrom keeps the information about environment variable sources provided to the container
@ -104,7 +104,7 @@ Links:
### .spec.template.container.containers.\<string\>.image ### .spec.template.container.containers.\<string\>.image
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/image.go#L35)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/image.go#L35)</sup>
Image define image details Image define image details
@ -112,7 +112,7 @@ Image define image details
### .spec.template.container.containers.\<string\>.imagePullPolicy ### .spec.template.container.containers.\<string\>.imagePullPolicy
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/image.go#L39)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/image.go#L39)</sup>
ImagePullPolicy define Image pull policy ImagePullPolicy define Image pull policy
@ -122,7 +122,7 @@ Default Value: `IfNotPresent`
### .spec.template.container.containers.\<string\>.lifecycle ### .spec.template.container.containers.\<string\>.lifecycle
Type: `core.Lifecycle` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/lifecycle.go#L35)</sup> Type: `core.Lifecycle` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/lifecycle.go#L35)</sup>
Lifecycle keeps actions that the management system should take in response to container lifecycle events. Lifecycle keeps actions that the management system should take in response to container lifecycle events.
@ -130,7 +130,7 @@ Lifecycle keeps actions that the management system should take in response to co
### .spec.template.container.containers.\<string\>.livenessProbe ### .spec.template.container.containers.\<string\>.livenessProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L37)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L37)</sup>
LivenessProbe keeps configuration of periodic probe of container liveness. LivenessProbe keeps configuration of periodic probe of container liveness.
Container will be restarted if the probe fails. Container will be restarted if the probe fails.
@ -142,7 +142,7 @@ Links:
### .spec.template.container.containers.\<string\>.ports ### .spec.template.container.containers.\<string\>.ports
Type: `[]core.ContainerPort` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/networking.go#L39)</sup> Type: `[]core.ContainerPort` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/networking.go#L39)</sup>
Ports contains list of ports to expose from the container. Not specifying a port here Ports contains list of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is DOES NOT prevent that port from being exposed. Any port which is
@ -153,7 +153,7 @@ accessible from the network.
### .spec.template.container.containers.\<string\>.readinessProbe ### .spec.template.container.containers.\<string\>.readinessProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L42)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L42)</sup>
ReadinessProbe keeps configuration of periodic probe of container service readiness. ReadinessProbe keeps configuration of periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails. Container will be removed from service endpoints if the probe fails.
@ -165,7 +165,7 @@ Links:
### .spec.template.container.containers.\<string\>.resources ### .spec.template.container.containers.\<string\>.resources
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/resources.go#L37)</sup> Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/resources.go#L37)</sup>
Resources holds resource requests & limits for container Resources holds resource requests & limits for container
@ -176,7 +176,7 @@ Links:
### .spec.template.container.containers.\<string\>.securityContext ### .spec.template.container.containers.\<string\>.securityContext
Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/security.go#L35)</sup> Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/security.go#L35)</sup>
SecurityContext holds container-level security attributes and common container settings. SecurityContext holds container-level security attributes and common container settings.
@ -187,7 +187,7 @@ Links:
### .spec.template.container.containers.\<string\>.startupProbe ### .spec.template.container.containers.\<string\>.startupProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L50)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L50)</sup>
StartupProbe indicates that the Pod has successfully initialized. StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully. If specified, no other probes are executed until this completes successfully.
@ -202,7 +202,7 @@ Links:
### .spec.template.container.containers.\<string\>.volumeMounts ### .spec.template.container.containers.\<string\>.volumeMounts
Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/volume_mounts.go#L35)</sup> Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/volume_mounts.go#L35)</sup>
VolumeMounts keeps list of pod volumes to mount into the container's filesystem. VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
@ -210,7 +210,7 @@ VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
### .spec.template.container.containers.\<string\>.workingDir ### .spec.template.container.containers.\<string\>.workingDir
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/core.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/core.go#L55)</sup>
Container's working directory. Container's working directory.
If not specified, the container runtime's default will be used, which If not specified, the container runtime's default will be used, which
@ -220,7 +220,7 @@ might be configured in the container image.
### .spec.template.pod.affinity ### .spec.template.pod.affinity
Type: `core.Affinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L44)</sup> Type: `core.Affinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L44)</sup>
Affinity defines scheduling constraints for workload Affinity defines scheduling constraints for workload
@ -231,7 +231,7 @@ Links:
### .spec.template.pod.annotations ### .spec.template.pod.annotations
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L45)</sup> Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L45)</sup>
Annotations is an unstructured key value map stored with a resource that may be Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not set by external tools to store and retrieve arbitrary metadata. They are not
@ -244,7 +244,7 @@ Links:
### .spec.template.pod.automountServiceAccountToken ### .spec.template.pod.automountServiceAccountToken
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/service_account.go#L38)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/service_account.go#L38)</sup>
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
@ -252,7 +252,7 @@ AutomountServiceAccountToken indicates whether a service account token should be
### .spec.template.pod.hostIPC ### .spec.template.pod.hostIPC
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L42)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L42)</sup>
HostIPC defines to use the host's ipc namespace. HostIPC defines to use the host's ipc namespace.
@ -262,7 +262,7 @@ Default Value: `false`
### .spec.template.pod.hostNetwork ### .spec.template.pod.hostNetwork
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L36)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L36)</sup>
HostNetwork requests Host network for this pod. Use the host's network namespace. HostNetwork requests Host network for this pod. Use the host's network namespace.
If this option is set, the ports that will be used must be specified. If this option is set, the ports that will be used must be specified.
@ -273,7 +273,7 @@ Default Value: `false`
### .spec.template.pod.hostPID ### .spec.template.pod.hostPID
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L39)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L39)</sup>
HostPID define to use the host's pid namespace. HostPID define to use the host's pid namespace.
@ -283,7 +283,7 @@ Default Value: `false`
### .spec.template.pod.imagePullSecrets ### .spec.template.pod.imagePullSecrets
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/image.go#L36)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/image.go#L36)</sup>
ImagePullSecrets define Secrets used to pull Image from registry ImagePullSecrets define Secrets used to pull Image from registry
@ -291,7 +291,7 @@ ImagePullSecrets define Secrets used to pull Image from registry
### .spec.template.pod.labels ### .spec.template.pod.labels
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L39)</sup> Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L39)</sup>
Map of string keys and values that can be used to organize and categorize Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers (scope and select) objects. May match selectors of replication controllers
@ -304,7 +304,7 @@ Links:
### .spec.template.pod.nodeSelector ### .spec.template.pod.nodeSelector
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L39)</sup> Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L39)</sup>
NodeSelector is a selector that must be true for the workload to fit on a node. NodeSelector is a selector that must be true for the workload to fit on a node.
@ -315,7 +315,7 @@ Links:
### .spec.template.pod.ownerReferences ### .spec.template.pod.ownerReferences
Type: `meta.OwnerReference` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L52)</sup> Type: `meta.OwnerReference` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L52)</sup>
List of objects depended by this object. If ALL objects in the list have List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller, been deleted, this object will be garbage collected. If this object is managed by a controller,
@ -326,7 +326,7 @@ There cannot be more than one managing controller.
### .spec.template.pod.podSecurityContext ### .spec.template.pod.podSecurityContext
Type: `core.PodSecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/security.go#L35)</sup> Type: `core.PodSecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/security.go#L35)</sup>
PodSecurityContext holds pod-level security attributes and common container settings. PodSecurityContext holds pod-level security attributes and common container settings.
@ -337,7 +337,7 @@ Links:
### .spec.template.pod.schedulerName ### .spec.template.pod.schedulerName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L54)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L54)</sup>
SchedulerName specifies, the pod will be dispatched by specified scheduler. SchedulerName specifies, the pod will be dispatched by specified scheduler.
If not specified, the pod will be dispatched by default scheduler. If not specified, the pod will be dispatched by default scheduler.
@ -348,7 +348,7 @@ Default Value: `""`
### .spec.template.pod.serviceAccountName ### .spec.template.pod.serviceAccountName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/service_account.go#L35)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/service_account.go#L35)</sup>
ServiceAccountName is the name of the ServiceAccount to use to run this pod. ServiceAccountName is the name of the ServiceAccount to use to run this pod.
@ -359,7 +359,7 @@ Links:
### .spec.template.pod.shareProcessNamespace ### .spec.template.pod.shareProcessNamespace
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L48)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L48)</sup>
ShareProcessNamespace defines to share a single process namespace between all of the containers in a pod. ShareProcessNamespace defines to share a single process namespace between all of the containers in a pod.
When this is set containers will be able to view and signal processes from other containers When this is set containers will be able to view and signal processes from other containers
@ -372,7 +372,7 @@ Default Value: `false`
### .spec.template.pod.tolerations ### .spec.template.pod.tolerations
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L49)</sup> Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L49)</sup>
Tolerations defines tolerations Tolerations defines tolerations
@ -383,7 +383,7 @@ Links:
### .spec.template.pod.volumes ### .spec.template.pod.volumes
Type: `[]core.Volume` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/volumes.go#L36)</sup> Type: `[]core.Volume` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/volumes.go#L36)</sup>
Volumes keeps list of volumes that can be mounted by containers belonging to the pod. Volumes keeps list of volumes that can be mounted by containers belonging to the pod.
@ -394,5 +394,5 @@ Links:
### .spec.template.priority ### .spec.template.priority
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/profile_template.go#L30)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/profile_template.go#L30)</sup>

148
docs/api/GraphAnalyticsEngine.V1Alpha1.md
View file

@ -10,7 +10,7 @@ title: GraphAnalyticsEngine V1Alpha1
### .spec.deployment.affinity ### .spec.deployment.affinity
Type: `core.Affinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L44)</sup> Type: `core.Affinity` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L44)</sup>
Affinity defines scheduling constraints for workload Affinity defines scheduling constraints for workload
@ -21,7 +21,7 @@ Links:
### .spec.deployment.annotations ### .spec.deployment.annotations
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L45)</sup> Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L45)</sup>
Annotations is an unstructured key value map stored with a resource that may be Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not set by external tools to store and retrieve arbitrary metadata. They are not
@ -34,7 +34,7 @@ Links:
### .spec.deployment.args ### .spec.deployment.args
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/core.go#L50)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/core.go#L50)</sup>
Arguments to the entrypoint. Arguments to the entrypoint.
The container image's CMD is used if this is not provided. The container image's CMD is used if this is not provided.
@ -51,7 +51,7 @@ Links:
### .spec.deployment.automountServiceAccountToken ### .spec.deployment.automountServiceAccountToken
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/service_account.go#L38)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/service_account.go#L38)</sup>
AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.
@ -59,7 +59,7 @@ AutomountServiceAccountToken indicates whether a service account token should be
### .spec.deployment.command ### .spec.deployment.command
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/core.go#L40)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/core.go#L40)</sup>
Entrypoint array. Not executed within a shell. Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided. The container image's ENTRYPOINT is used if this is not provided.
@ -76,7 +76,7 @@ Links:
### .spec.deployment.env ### .spec.deployment.env
Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L36)</sup> Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L36)</sup>
Env keeps the information about environment variables provided to the container Env keeps the information about environment variables provided to the container
@ -87,7 +87,7 @@ Links:
### .spec.deployment.envFrom ### .spec.deployment.envFrom
Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L41)</sup> Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L41)</sup>
EnvFrom keeps the information about environment variable sources provided to the container EnvFrom keeps the information about environment variable sources provided to the container
@ -98,7 +98,7 @@ Links:
### .spec.deployment.hostIPC ### .spec.deployment.hostIPC
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L42)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L42)</sup>
HostIPC defines to use the host's ipc namespace. HostIPC defines to use the host's ipc namespace.
@ -108,7 +108,7 @@ Default Value: `false`
### .spec.deployment.hostNetwork ### .spec.deployment.hostNetwork
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L36)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L36)</sup>
HostNetwork requests Host network for this pod. Use the host's network namespace. HostNetwork requests Host network for this pod. Use the host's network namespace.
If this option is set, the ports that will be used must be specified. If this option is set, the ports that will be used must be specified.
@ -119,7 +119,7 @@ Default Value: `false`
### .spec.deployment.hostPID ### .spec.deployment.hostPID
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L39)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L39)</sup>
HostPID define to use the host's pid namespace. HostPID define to use the host's pid namespace.
@ -129,7 +129,7 @@ Default Value: `false`
### .spec.deployment.image ### .spec.deployment.image
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/image.go#L35)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/image.go#L35)</sup>
Image define image details Image define image details
@ -137,7 +137,7 @@ Image define image details
### .spec.deployment.imagePullPolicy ### .spec.deployment.imagePullPolicy
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/image.go#L39)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/image.go#L39)</sup>
ImagePullPolicy define Image pull policy ImagePullPolicy define Image pull policy
@ -147,7 +147,7 @@ Default Value: `IfNotPresent`
### .spec.deployment.imagePullSecrets ### .spec.deployment.imagePullSecrets
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/image.go#L36)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/image.go#L36)</sup>
ImagePullSecrets define Secrets used to pull Image from registry ImagePullSecrets define Secrets used to pull Image from registry
@ -155,7 +155,7 @@ ImagePullSecrets define Secrets used to pull Image from registry
### .spec.deployment.labels ### .spec.deployment.labels
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L39)</sup> Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L39)</sup>
Map of string keys and values that can be used to organize and categorize Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers (scope and select) objects. May match selectors of replication controllers
@ -168,7 +168,7 @@ Links:
### .spec.deployment.lifecycle ### .spec.deployment.lifecycle
Type: `core.Lifecycle` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/lifecycle.go#L35)</sup> Type: `core.Lifecycle` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/lifecycle.go#L35)</sup>
Lifecycle keeps actions that the management system should take in response to container lifecycle events. Lifecycle keeps actions that the management system should take in response to container lifecycle events.
@ -176,7 +176,7 @@ Lifecycle keeps actions that the management system should take in response to co
### .spec.deployment.livenessProbe ### .spec.deployment.livenessProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L37)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L37)</sup>
LivenessProbe keeps configuration of periodic probe of container liveness. LivenessProbe keeps configuration of periodic probe of container liveness.
Container will be restarted if the probe fails. Container will be restarted if the probe fails.
@ -188,7 +188,7 @@ Links:
### .spec.deployment.nodeSelector ### .spec.deployment.nodeSelector
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L39)</sup> Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L39)</sup>
NodeSelector is a selector that must be true for the workload to fit on a node. NodeSelector is a selector that must be true for the workload to fit on a node.
@ -199,7 +199,7 @@ Links:
### .spec.deployment.ownerReferences ### .spec.deployment.ownerReferences
Type: `meta.OwnerReference` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L52)</sup> Type: `meta.OwnerReference` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/metadata.go#L52)</sup>
List of objects depended by this object. If ALL objects in the list have List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller, been deleted, this object will be garbage collected. If this object is managed by a controller,
@ -210,7 +210,7 @@ There cannot be more than one managing controller.
### .spec.deployment.podSecurityContext ### .spec.deployment.podSecurityContext
Type: `core.PodSecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/security.go#L35)</sup> Type: `core.PodSecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/security.go#L35)</sup>
PodSecurityContext holds pod-level security attributes and common container settings. PodSecurityContext holds pod-level security attributes and common container settings.
@ -221,7 +221,7 @@ Links:
### .spec.deployment.port ### .spec.deployment.port
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/analytics/v1alpha1/gae_spec_deployment.go#L50)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/analytics/v1alpha1/gae_spec_deployment.go#L50)</sup>
Port defines on which port the container will be listening for connections Port defines on which port the container will be listening for connections
@ -229,7 +229,7 @@ Port defines on which port the container will be listening for connections
### .spec.deployment.ports ### .spec.deployment.ports
Type: `[]core.ContainerPort` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/networking.go#L39)</sup> Type: `[]core.ContainerPort` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/networking.go#L39)</sup>
Ports contains list of ports to expose from the container. Not specifying a port here Ports contains list of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is DOES NOT prevent that port from being exposed. Any port which is
@ -240,7 +240,7 @@ accessible from the network.
### .spec.deployment.readinessProbe ### .spec.deployment.readinessProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L42)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L42)</sup>
ReadinessProbe keeps configuration of periodic probe of container service readiness. ReadinessProbe keeps configuration of periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails. Container will be removed from service endpoints if the probe fails.
@ -252,7 +252,7 @@ Links:
### .spec.deployment.resources ### .spec.deployment.resources
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/resources.go#L37)</sup> Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/resources.go#L37)</sup>
Resources holds resource requests & limits for container Resources holds resource requests & limits for container
@ -263,7 +263,7 @@ Links:
### .spec.deployment.schedulerName ### .spec.deployment.schedulerName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L54)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L54)</sup>
SchedulerName specifies, the pod will be dispatched by specified scheduler. SchedulerName specifies, the pod will be dispatched by specified scheduler.
If not specified, the pod will be dispatched by default scheduler. If not specified, the pod will be dispatched by default scheduler.
@ -274,7 +274,7 @@ Default Value: `""`
### .spec.deployment.securityContext ### .spec.deployment.securityContext
Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/security.go#L35)</sup> Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/security.go#L35)</sup>
SecurityContext holds container-level security attributes and common container settings. SecurityContext holds container-level security attributes and common container settings.
@ -285,7 +285,7 @@ Links:
### .spec.deployment.service.type ### .spec.deployment.service.type
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/analytics/v1alpha1/gae_spec_deployment_service.go#L38)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/analytics/v1alpha1/gae_spec_deployment_service.go#L38)</sup>
Type determines how the Service is exposed Type determines how the Service is exposed
@ -303,7 +303,7 @@ Possible Values:
### .spec.deployment.serviceAccountName ### .spec.deployment.serviceAccountName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/service_account.go#L35)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/service_account.go#L35)</sup>
ServiceAccountName is the name of the ServiceAccount to use to run this pod. ServiceAccountName is the name of the ServiceAccount to use to run this pod.
@ -314,7 +314,7 @@ Links:
### .spec.deployment.shareProcessNamespace ### .spec.deployment.shareProcessNamespace
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L48)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/namespace.go#L48)</sup>
ShareProcessNamespace defines to share a single process namespace between all of the containers in a pod. ShareProcessNamespace defines to share a single process namespace between all of the containers in a pod.
When this is set containers will be able to view and signal processes from other containers When this is set containers will be able to view and signal processes from other containers
@ -327,7 +327,7 @@ Default Value: `false`
### .spec.deployment.startupProbe ### .spec.deployment.startupProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L50)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L50)</sup>
StartupProbe indicates that the Pod has successfully initialized. StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully. If specified, no other probes are executed until this completes successfully.
@ -342,7 +342,7 @@ Links:
### .spec.deployment.tls.altNames ### .spec.deployment.tls.altNames
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/tls.go#L28)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/tls.go#L28)</sup>
AltNames define TLS AltNames used when TLS on the ArangoDB is enabled AltNames define TLS AltNames used when TLS on the ArangoDB is enabled
@ -350,7 +350,7 @@ AltNames define TLS AltNames used when TLS on the ArangoDB is enabled
### .spec.deployment.tls.enabled ### .spec.deployment.tls.enabled
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/tls.go#L25)</sup> Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/tls.go#L25)</sup>
Enabled define if TLS Should be enabled. If is not set then default is taken from ArangoDeployment settings Enabled define if TLS Should be enabled. If is not set then default is taken from ArangoDeployment settings
@ -358,7 +358,7 @@ Enabled define if TLS Should be enabled. If is not set then default is taken fro
### .spec.deployment.tolerations ### .spec.deployment.tolerations
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L49)</sup> Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/scheduling.go#L49)</sup>
Tolerations defines tolerations Tolerations defines tolerations
@ -369,7 +369,7 @@ Links:
### .spec.deployment.volumeMounts ### .spec.deployment.volumeMounts
Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/volume_mounts.go#L35)</sup> Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/volume_mounts.go#L35)</sup>
VolumeMounts keeps list of pod volumes to mount into the container's filesystem. VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
@ -377,7 +377,7 @@ VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
### .spec.deployment.volumes ### .spec.deployment.volumes
Type: `[]core.Volume` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/pod/resources/volumes.go#L36)</sup> Type: `[]core.Volume` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/pod/resources/volumes.go#L36)</sup>
Volumes keeps list of volumes that can be mounted by containers belonging to the pod. Volumes keeps list of volumes that can be mounted by containers belonging to the pod.
@ -388,7 +388,7 @@ Links:
### .spec.deployment.workingDir ### .spec.deployment.workingDir
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/core.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/core.go#L55)</sup>
Container's working directory. Container's working directory.
If not specified, the container runtime's default will be used, which If not specified, the container runtime's default will be used, which
@ -398,7 +398,7 @@ might be configured in the container image.
### .spec.deploymentName ### .spec.deploymentName
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/analytics/v1alpha1/gae_spec.go#L31)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/analytics/v1alpha1/gae_spec.go#L31)</sup>
DeploymentName define deployment name used in the object. Immutable DeploymentName define deployment name used in the object. Immutable
@ -406,7 +406,7 @@ DeploymentName define deployment name used in the object. Immutable
### .spec.integrationSidecar.args ### .spec.integrationSidecar.args
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/core.go#L50)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/core.go#L50)</sup>
Arguments to the entrypoint. Arguments to the entrypoint.
The container image's CMD is used if this is not provided. The container image's CMD is used if this is not provided.
@ -423,7 +423,7 @@ Links:
### .spec.integrationSidecar.command ### .spec.integrationSidecar.command
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/core.go#L40)</sup> Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/core.go#L40)</sup>
Entrypoint array. Not executed within a shell. Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided. The container image's ENTRYPOINT is used if this is not provided.
@ -440,7 +440,7 @@ Links:
### .spec.integrationSidecar.controllerListenPort ### .spec.integrationSidecar.controllerListenPort
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/integration.go#L36)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/integration.go#L36)</sup>
ControllerListenPort defines on which port the sidecar container will be listening for controller requests ControllerListenPort defines on which port the sidecar container will be listening for controller requests
@ -450,7 +450,7 @@ Default Value: `9202`
### .spec.integrationSidecar.env ### .spec.integrationSidecar.env
Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L36)</sup> Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L36)</sup>
Env keeps the information about environment variables provided to the container Env keeps the information about environment variables provided to the container
@ -461,7 +461,7 @@ Links:
### .spec.integrationSidecar.envFrom ### .spec.integrationSidecar.envFrom
Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L41)</sup> Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/environments.go#L41)</sup>
EnvFrom keeps the information about environment variable sources provided to the container EnvFrom keeps the information about environment variable sources provided to the container
@ -472,7 +472,7 @@ Links:
### .spec.integrationSidecar.image ### .spec.integrationSidecar.image
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/image.go#L35)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/image.go#L35)</sup>
Image define image details Image define image details
@ -480,7 +480,7 @@ Image define image details
### .spec.integrationSidecar.imagePullPolicy ### .spec.integrationSidecar.imagePullPolicy
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/image.go#L39)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/image.go#L39)</sup>
ImagePullPolicy define Image pull policy ImagePullPolicy define Image pull policy
@ -490,7 +490,7 @@ Default Value: `IfNotPresent`
### .spec.integrationSidecar.lifecycle ### .spec.integrationSidecar.lifecycle
Type: `core.Lifecycle` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/lifecycle.go#L35)</sup> Type: `core.Lifecycle` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/lifecycle.go#L35)</sup>
Lifecycle keeps actions that the management system should take in response to container lifecycle events. Lifecycle keeps actions that the management system should take in response to container lifecycle events.
@ -498,7 +498,7 @@ Lifecycle keeps actions that the management system should take in response to co
### .spec.integrationSidecar.listenPort ### .spec.integrationSidecar.listenPort
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/integration.go#L32)</sup> Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/integration.go#L32)</sup>
ListenPort defines on which port the sidecar container will be listening for connections ListenPort defines on which port the sidecar container will be listening for connections
@ -508,7 +508,7 @@ Default Value: `9201`
### .spec.integrationSidecar.livenessProbe ### .spec.integrationSidecar.livenessProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L37)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L37)</sup>
LivenessProbe keeps configuration of periodic probe of container liveness. LivenessProbe keeps configuration of periodic probe of container liveness.
Container will be restarted if the probe fails. Container will be restarted if the probe fails.
@ -520,7 +520,7 @@ Links:
### .spec.integrationSidecar.ports ### .spec.integrationSidecar.ports
Type: `[]core.ContainerPort` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/networking.go#L39)</sup> Type: `[]core.ContainerPort` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/networking.go#L39)</sup>
Ports contains list of ports to expose from the container. Not specifying a port here Ports contains list of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is DOES NOT prevent that port from being exposed. Any port which is
@ -531,7 +531,7 @@ accessible from the network.
### .spec.integrationSidecar.readinessProbe ### .spec.integrationSidecar.readinessProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L42)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L42)</sup>
ReadinessProbe keeps configuration of periodic probe of container service readiness. ReadinessProbe keeps configuration of periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails. Container will be removed from service endpoints if the probe fails.
@ -543,7 +543,7 @@ Links:
### .spec.integrationSidecar.resources ### .spec.integrationSidecar.resources
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/resources.go#L37)</sup> Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/resources.go#L37)</sup>
Resources holds resource requests & limits for container Resources holds resource requests & limits for container
@ -554,7 +554,7 @@ Links:
### .spec.integrationSidecar.securityContext ### .spec.integrationSidecar.securityContext
Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/security.go#L35)</sup> Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/security.go#L35)</sup>
SecurityContext holds container-level security attributes and common container settings. SecurityContext holds container-level security attributes and common container settings.
@ -565,7 +565,7 @@ Links:
### .spec.integrationSidecar.startupProbe ### .spec.integrationSidecar.startupProbe
Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L50)</sup> Type: `core.Probe` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/probes.go#L50)</sup>
StartupProbe indicates that the Pod has successfully initialized. StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully. If specified, no other probes are executed until this completes successfully.
@ -580,7 +580,7 @@ Links:
### .spec.integrationSidecar.volumeMounts ### .spec.integrationSidecar.volumeMounts
Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/volume_mounts.go#L35)</sup> Type: `[]core.VolumeMount` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/volume_mounts.go#L35)</sup>
VolumeMounts keeps list of pod volumes to mount into the container's filesystem. VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
@ -588,7 +588,7 @@ VolumeMounts keeps list of pod volumes to mount into the container's filesystem.
### .spec.integrationSidecar.workingDir ### .spec.integrationSidecar.workingDir
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/scheduler/v1beta1/container/resources/core.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/scheduler/v1beta1/container/resources/core.go#L55)</sup>
Container's working directory. Container's working directory.
If not specified, the container runtime's default will be used, which If not specified, the container runtime's default will be used, which
@ -598,7 +598,7 @@ might be configured in the container image.
### .status.arangoDB.deployment.checksum ### .status.arangoDB.deployment.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -606,7 +606,7 @@ UID keeps the information about object Checksum
### .status.arangoDB.deployment.name ### .status.arangoDB.deployment.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -614,7 +614,7 @@ Name of the object
### .status.arangoDB.deployment.namespace ### .status.arangoDB.deployment.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -622,7 +622,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .status.arangoDB.deployment.uid ### .status.arangoDB.deployment.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID
@ -630,7 +630,7 @@ UID keeps the information about object UID
### .status.arangoDB.secret.checksum ### .status.arangoDB.secret.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -638,7 +638,7 @@ UID keeps the information about object Checksum
### .status.arangoDB.secret.name ### .status.arangoDB.secret.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -646,7 +646,7 @@ Name of the object
### .status.arangoDB.secret.namespace ### .status.arangoDB.secret.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -654,7 +654,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .status.arangoDB.secret.uid ### .status.arangoDB.secret.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID
@ -662,7 +662,7 @@ UID keeps the information about object UID
### .status.arangoDB.tls.checksum ### .status.arangoDB.tls.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -670,7 +670,7 @@ UID keeps the information about object Checksum
### .status.arangoDB.tls.name ### .status.arangoDB.tls.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -678,7 +678,7 @@ Name of the object
### .status.arangoDB.tls.namespace ### .status.arangoDB.tls.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -686,7 +686,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .status.arangoDB.tls.uid ### .status.arangoDB.tls.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID
@ -694,7 +694,7 @@ UID keeps the information about object UID
### .status.conditions ### .status.conditions
Type: `api.Conditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/analytics/v1alpha1/gae_status.go#L30)</sup> Type: `api.Conditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/analytics/v1alpha1/gae_status.go#L30)</sup>
Conditions specific to the entire extension Conditions specific to the entire extension
@ -702,7 +702,7 @@ Conditions specific to the entire extension
### .status.reconciliation.service.checksum ### .status.reconciliation.service.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -710,7 +710,7 @@ UID keeps the information about object Checksum
### .status.reconciliation.service.name ### .status.reconciliation.service.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -718,7 +718,7 @@ Name of the object
### .status.reconciliation.service.namespace ### .status.reconciliation.service.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -726,7 +726,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .status.reconciliation.service.uid ### .status.reconciliation.service.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID
@ -734,7 +734,7 @@ UID keeps the information about object UID
### .status.reconciliation.statefulSet.checksum ### .status.reconciliation.statefulSet.checksum
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L61)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L61)</sup>
UID keeps the information about object Checksum UID keeps the information about object Checksum
@ -742,7 +742,7 @@ UID keeps the information about object Checksum
### .status.reconciliation.statefulSet.name ### .status.reconciliation.statefulSet.name
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L52)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L52)</sup>
Name of the object Name of the object
@ -750,7 +750,7 @@ Name of the object
### .status.reconciliation.statefulSet.namespace ### .status.reconciliation.statefulSet.namespace
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L55)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L55)</sup>
Namespace of the object. Should default to the namespace of the parent object Namespace of the object. Should default to the namespace of the parent object
@ -758,7 +758,7 @@ Namespace of the object. Should default to the namespace of the parent object
### .status.reconciliation.statefulSet.uid ### .status.reconciliation.statefulSet.uid
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.41/pkg/apis/shared/v1/object.go#L58)</sup> Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.42/pkg/apis/shared/v1/object.go#L58)</sup>
UID keeps the information about object UID UID keeps the information about object UID