mirror of
https://github.com/arangodb/kube-arangodb.git
synced 2024-12-14 11:57:37 +00:00
Update doc (#1585)
This commit is contained in:
parent
9a41f13367
commit
e67f5a0f58
11 changed files with 949 additions and 949 deletions
|
@ -10,7 +10,7 @@ title: ArangoBackup V1
|
|||
|
||||
### .spec.backoff.iterations
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec_backoff.go#L31)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec_backoff.go#L31)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec_backoff.go#L29)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec_backoff.go#L29)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec_backoff.go#L33)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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)
|
||||
|
||||
|
@ -34,7 +34,7 @@ MaxIterations defines maximum number of iterations after backoff will be disable
|
|||
|
||||
### .spec.backoff.min_delay
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec_backoff.go#L27)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec_backoff.go#L27)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L54)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L54)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L84)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L84)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L92)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L92)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L77)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L77)</sup>
|
||||
|
||||
RepositoryURL is the URL path for file storage
|
||||
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
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L47)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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".
|
||||
|
||||
|
@ -114,7 +114,7 @@ Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "
|
|||
|
||||
### .spec.options.allowInconsistent
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L66)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L66)</sup>
|
||||
|
||||
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.
|
||||
|
@ -127,7 +127,7 @@ This field is **immutable**: can't be changed after backup creation
|
|||
|
||||
### .spec.options.timeout
|
||||
|
||||
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L61)</sup>
|
||||
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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.
|
||||
|
||||
|
@ -139,7 +139,7 @@ This field is **immutable**: can't be changed after backup creation
|
|||
|
||||
### .spec.policyName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L42)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L42)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L84)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L84)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L77)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L77)</sup>
|
||||
|
||||
RepositoryURL is the URL path for file storage
|
||||
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
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status.go#L36)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status.go#L36)</sup>
|
||||
|
||||
Available Determines if we can restore from ArangoBackup
|
||||
|
||||
|
@ -201,13 +201,13 @@ Available Determines if we can restore from ArangoBackup
|
|||
|
||||
### .status.backoff.iterations
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status_backoff.go#L30)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status_backoff.go#L30)</sup>
|
||||
|
||||
***
|
||||
|
||||
### .status.backup.downloaded
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status.go#L66)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status.go#L66)</sup>
|
||||
|
||||
Downloaded Determines if ArangoBackup has been downloaded.
|
||||
|
||||
|
@ -215,25 +215,25 @@ Downloaded Determines if ArangoBackup has been downloaded.
|
|||
|
||||
### .status.backup.id
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status.go#L56)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status.go#L56)</sup>
|
||||
|
||||
***
|
||||
|
||||
### .status.backup.imported
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status.go#L67)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status.go#L67)</sup>
|
||||
|
||||
***
|
||||
|
||||
### .status.backup.keys
|
||||
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status.go#L70)</sup>
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status.go#L70)</sup>
|
||||
|
||||
***
|
||||
|
||||
### .status.backup.numberOfDBServers
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status.go#L62)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status.go#L62)</sup>
|
||||
|
||||
NumberOfDBServers Cluster size of the Backup in ArangoDB
|
||||
|
||||
|
@ -241,13 +241,13 @@ NumberOfDBServers Cluster size of the Backup in ArangoDB
|
|||
|
||||
### .status.backup.potentiallyInconsistent
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status.go#L58)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status.go#L58)</sup>
|
||||
|
||||
***
|
||||
|
||||
### .status.backup.sizeInBytes
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status.go#L60)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status.go#L60)</sup>
|
||||
|
||||
SizeInBytes Size of the Backup in ArangoDB.
|
||||
|
||||
|
@ -255,7 +255,7 @@ SizeInBytes Size of the Backup in ArangoDB.
|
|||
|
||||
### .status.backup.uploaded
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status.go#L64)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status.go#L64)</sup>
|
||||
|
||||
Uploaded Determines if ArangoBackup has been uploaded
|
||||
|
||||
|
@ -263,13 +263,13 @@ Uploaded Determines if ArangoBackup has been uploaded
|
|||
|
||||
### .status.backup.version
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_status.go#L57)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_status.go#L57)</sup>
|
||||
|
||||
***
|
||||
|
||||
### .status.message
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L91)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_state.go#L91)</sup>
|
||||
|
||||
Message for the state this object is in.
|
||||
|
||||
|
@ -277,7 +277,7 @@ Message for the state this object is in.
|
|||
|
||||
### .status.progress.jobID
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L114)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_state.go#L114)</sup>
|
||||
|
||||
JobID ArangoDB job ID for uploading or downloading
|
||||
|
||||
|
@ -285,7 +285,7 @@ JobID ArangoDB job ID for uploading or downloading
|
|||
|
||||
### .status.progress.progress
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L117)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_state.go#L117)</sup>
|
||||
|
||||
Progress ArangoDB job progress in percents
|
||||
|
||||
|
@ -298,7 +298,7 @@ Example:
|
|||
|
||||
### .status.state
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L85)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_state.go#L85)</sup>
|
||||
|
||||
State holds the current high level state of the backup
|
||||
|
||||
|
|
|
@ -10,7 +10,7 @@ title: ArangoBackupPolicy V1
|
|||
|
||||
### .spec.allowConcurrent
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_policy_spec.go#L35)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_policy_spec.go#L35)</sup>
|
||||
|
||||
AllowConcurrent if false, ArangoBackup will not be created when previous Backups are not finished
|
||||
|
||||
|
@ -20,7 +20,7 @@ Default Value: `true`
|
|||
|
||||
### .spec.maxBackups
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_policy_spec.go#L43)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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.
|
||||
If not specified or 0 then no limit is applied
|
||||
|
@ -31,7 +31,7 @@ Default Value: `0`
|
|||
|
||||
### .spec.schedule
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_policy_spec.go#L32)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_policy_spec.go#L32)</sup>
|
||||
|
||||
Schedule is cron-compatible specification of backup schedule
|
||||
Parsed by https://godoc.org/github.com/robfig/cron
|
||||
|
@ -40,7 +40,7 @@ Parsed by https://godoc.org/github.com/robfig/cron
|
|||
|
||||
### .spec.selector
|
||||
|
||||
Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_policy_spec.go#L39)</sup>
|
||||
Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_policy_spec.go#L39)</sup>
|
||||
|
||||
DeploymentSelector Selector definition for selecting matching ArangoBackup Custom Resources.
|
||||
|
||||
|
@ -51,7 +51,7 @@ Links:
|
|||
|
||||
### .spec.template.backoff.iterations
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec_backoff.go#L31)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec_backoff.go#L31)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec_backoff.go#L29)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec_backoff.go#L29)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec_backoff.go#L33)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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)
|
||||
|
||||
|
@ -75,7 +75,7 @@ MaxIterations defines maximum number of iterations after backoff will be disable
|
|||
|
||||
### .spec.template.backoff.min_delay
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec_backoff.go#L27)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec_backoff.go#L27)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_policy_spec.go#L61)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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".
|
||||
|
||||
|
@ -91,7 +91,7 @@ Lifetime is the time after which the backup will be deleted. Format: "1.5h" or "
|
|||
|
||||
### .spec.template.options.allowInconsistent
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L66)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L66)</sup>
|
||||
|
||||
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.
|
||||
|
@ -104,7 +104,7 @@ This field is **immutable**: can't be changed after backup creation
|
|||
|
||||
### .spec.template.options.timeout
|
||||
|
||||
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L61)</sup>
|
||||
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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.
|
||||
|
||||
|
@ -116,7 +116,7 @@ This field is **immutable**: can't be changed after backup creation
|
|||
|
||||
### .spec.template.upload.autoDelete
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L84)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L84)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_spec.go#L77)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_spec.go#L77)</sup>
|
||||
|
||||
RepositoryURL is the URL path for file storage
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_policy_status.go#L33)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_policy_status.go#L33)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `meta.Time` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_policy_status.go#L31)</sup>
|
||||
Type: `meta.Time` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/backup/v1/backup_policy_status.go#L31)</sup>
|
||||
|
||||
Scheduled Next scheduled time in UTC
|
||||
|
||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -10,7 +10,7 @@ title: ArangoDeploymentReplication V1
|
|||
|
||||
### .spec.cancellation.ensureInSync
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/replication_spec.go#L38)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/replication/v1/replication_spec.go#L38)</sup>
|
||||
|
||||
EnsureInSync if it is true then during cancellation process data consistency is required.
|
||||
Default value is true.
|
||||
|
@ -19,7 +19,7 @@ Default value is true.
|
|||
|
||||
### .spec.cancellation.sourceReadOnly
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/replication_spec.go#L41)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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.
|
||||
Default value is false.
|
||||
|
@ -28,7 +28,7 @@ Default value is false.
|
|||
|
||||
### .spec.destination.auth.keyfileSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37)</sup>
|
||||
|
||||
KeyfileSecretName holds the name of a Secret containing a client authentication
|
||||
certificate formatted at keyfile in a `tls.keyfile` field.
|
||||
|
@ -40,7 +40,7 @@ the synchronization and fetch the synchronization status.
|
|||
|
||||
### .spec.destination.auth.userSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42)</sup>
|
||||
|
||||
UserSecretName holds the name of a Secret containing a `username` & `password`
|
||||
field used for basic authentication.
|
||||
|
@ -51,7 +51,7 @@ of the ArangoDB cluster at the endpoint.
|
|||
|
||||
### .spec.destination.deploymentName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/endpoint_spec.go#L36)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/replication/v1/endpoint_spec.go#L36)</sup>
|
||||
|
||||
DeploymentName holds the name of an ArangoDeployment resource.
|
||||
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
|
||||
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/endpoint_spec.go#L42)</sup>
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/replication/v1/endpoint_spec.go#L42)</sup>
|
||||
|
||||
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
|
||||
|
@ -73,7 +73,7 @@ Default Value: `[]`
|
|||
|
||||
### .spec.destination.tls.caSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/endpoint_tls_spec.go#L34)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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.
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37)</sup>
|
||||
|
||||
KeyfileSecretName holds the name of a Secret containing a client authentication
|
||||
certificate formatted at keyfile in a `tls.keyfile` field.
|
||||
|
@ -94,7 +94,7 @@ the synchronization and fetch the synchronization status.
|
|||
|
||||
### .spec.source.auth.userSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42)</sup>
|
||||
|
||||
UserSecretName holds the name of a Secret containing a `username` & `password`
|
||||
field used for basic authentication.
|
||||
|
@ -105,7 +105,7 @@ of the ArangoDB cluster at the endpoint.
|
|||
|
||||
### .spec.source.deploymentName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/endpoint_spec.go#L36)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/replication/v1/endpoint_spec.go#L36)</sup>
|
||||
|
||||
DeploymentName holds the name of an ArangoDeployment resource.
|
||||
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
|
||||
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/endpoint_spec.go#L42)</sup>
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/replication/v1/endpoint_spec.go#L42)</sup>
|
||||
|
||||
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
|
||||
|
@ -127,7 +127,7 @@ Default Value: `[]`
|
|||
|
||||
### .spec.source.tls.caSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/replication/v1/endpoint_tls_spec.go#L34)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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.
|
||||
This setting is required, unless `deploymentName` has been set.
|
||||
|
|
|
@ -10,7 +10,7 @@ title: ArangoJob V1
|
|||
|
||||
### .spec.arangoDeploymentName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/apps/v1/job_spec.go#L27)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/apps/v1/job_spec.go#L27)</sup>
|
||||
|
||||
ArangoDeploymentName holds the name of ArangoDeployment
|
||||
|
||||
|
@ -18,7 +18,7 @@ ArangoDeploymentName holds the name of ArangoDeployment
|
|||
|
||||
### .spec.jobTemplate
|
||||
|
||||
Type: `batch.JobSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/apps/v1/job_spec.go#L33)</sup>
|
||||
Type: `batch.JobSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/apps/v1/job_spec.go#L33)</sup>
|
||||
|
||||
JobTemplate holds the Kubernetes Job Template
|
||||
|
||||
|
|
|
@ -10,7 +10,7 @@ title: ArangoLocalStorage V1Alpha
|
|||
|
||||
### .spec.localPath
|
||||
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/storage/v1alpha/local_storage_spec.go#L36)</sup>
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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.
|
||||
|
||||
|
@ -18,7 +18,7 @@ LocalPath setting specifies one or more local directories (on the nodes) used to
|
|||
|
||||
### .spec.nodeSelector
|
||||
|
||||
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/storage/v1alpha/local_storage_spec.go#L43)</sup>
|
||||
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/storage/v1alpha/local_storage_spec.go#L43)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/storage/v1alpha/local_storage_pod_customization.go#L25)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/storage/v1alpha/local_storage_pod_customization.go#L25)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/storage/v1alpha/local_storage_spec.go#L45)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/storage/v1alpha/local_storage_spec.go#L45)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/storage/v1alpha/storage_class_spec.go#L42)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/storage/v1alpha/storage_class_spec.go#L42)</sup>
|
||||
|
||||
IsDefault setting specifies if the created `StorageClass` will
|
||||
be marked as default storage class.
|
||||
|
@ -53,7 +53,7 @@ Default Value: `false`
|
|||
|
||||
### .spec.storageClass.name
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/storage/v1alpha/storage_class_spec.go#L38)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/storage/v1alpha/storage_class_spec.go#L38)</sup>
|
||||
|
||||
Name setting specifies the name of the storage class that
|
||||
created `PersistentVolume` will use.
|
||||
|
@ -66,7 +66,7 @@ Default Value: `""`
|
|||
|
||||
### .spec.storageClass.reclaimPolicy
|
||||
|
||||
Type: `core.PersistentVolumeReclaimPolicy` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/storage/v1alpha/storage_class_spec.go#L46)</sup>
|
||||
Type: `core.PersistentVolumeReclaimPolicy` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/storage/v1alpha/storage_class_spec.go#L46)</sup>
|
||||
|
||||
ReclaimPolicy defines what happens to a persistent volume when released from its claim.
|
||||
|
||||
|
@ -77,7 +77,7 @@ Links:
|
|||
|
||||
### .spec.tolerations
|
||||
|
||||
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/storage/v1alpha/local_storage_spec.go#L41)</sup>
|
||||
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/storage/v1alpha/local_storage_spec.go#L41)</sup>
|
||||
|
||||
Tolerations specifies the tolerations added to pods of storage provisioner
|
||||
|
||||
|
|
|
@ -10,7 +10,7 @@ title: ArangoMLBatchJob V1Alpha1
|
|||
|
||||
### .spec
|
||||
|
||||
Type: `batch.Job` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/batchjob_spec.go#L33)</sup>
|
||||
Type: `batch.Job` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/batchjob_spec.go#L33)</sup>
|
||||
|
||||
Links:
|
||||
* [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#JobSpec)
|
||||
|
@ -19,7 +19,7 @@ Links:
|
|||
|
||||
### .status
|
||||
|
||||
Type: `batch.JobStatus` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/batchjob_status.go#L37)</sup>
|
||||
Type: `batch.JobStatus` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/batchjob_status.go#L37)</sup>
|
||||
|
||||
Links:
|
||||
* [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#JobStatus)
|
||||
|
@ -28,7 +28,7 @@ Links:
|
|||
|
||||
### .status.mlConditions
|
||||
|
||||
Type: `api.MLConditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/batchjob_status.go#L33)</sup>
|
||||
Type: `api.MLConditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/batchjob_status.go#L33)</sup>
|
||||
|
||||
MLConditions specific to the entire batch job
|
||||
|
||||
|
@ -36,7 +36,7 @@ MLConditions specific to the entire batch job
|
|||
|
||||
### .status.ref.name
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L46)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L46)</sup>
|
||||
|
||||
Name of the object
|
||||
|
||||
|
@ -44,7 +44,7 @@ Name of the object
|
|||
|
||||
### .status.ref.namespace
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L49)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L49)</sup>
|
||||
|
||||
Namespace of the object. Should default to the namespace of the parent object
|
||||
|
||||
|
@ -52,7 +52,7 @@ Namespace of the object. Should default to the namespace of the parent object
|
|||
|
||||
### .status.ref.uid
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L52)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L52)</sup>
|
||||
|
||||
UID keeps the information about object UID
|
||||
|
||||
|
|
|
@ -10,7 +10,7 @@ title: ArangoMLCronJob V1Alpha1
|
|||
|
||||
### .spec
|
||||
|
||||
Type: `batch.CronJobSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/cronjob_spec.go#L33)</sup>
|
||||
Type: `batch.CronJobSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/cronjob_spec.go#L33)</sup>
|
||||
|
||||
Links:
|
||||
* [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#CronJobSpec)
|
||||
|
@ -19,7 +19,7 @@ Links:
|
|||
|
||||
### .status
|
||||
|
||||
Type: `batch.CronJobStatus` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/cronjob_status.go#L37)</sup>
|
||||
Type: `batch.CronJobStatus` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/cronjob_status.go#L37)</sup>
|
||||
|
||||
Links:
|
||||
* [Kubernetes Documentation](https://godoc.org/k8s.io/api/batch/v1#CronJobStatus)
|
||||
|
@ -28,7 +28,7 @@ Links:
|
|||
|
||||
### .status.mlConditions
|
||||
|
||||
Type: `api.MLConditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/cronjob_status.go#L33)</sup>
|
||||
Type: `api.MLConditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/cronjob_status.go#L33)</sup>
|
||||
|
||||
MLConditions specific to the entire cron job
|
||||
|
||||
|
@ -36,7 +36,7 @@ MLConditions specific to the entire cron job
|
|||
|
||||
### .status.ref.name
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L46)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L46)</sup>
|
||||
|
||||
Name of the object
|
||||
|
||||
|
@ -44,7 +44,7 @@ Name of the object
|
|||
|
||||
### .status.ref.namespace
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L49)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L49)</sup>
|
||||
|
||||
Namespace of the object. Should default to the namespace of the parent object
|
||||
|
||||
|
@ -52,7 +52,7 @@ Namespace of the object. Should default to the namespace of the parent object
|
|||
|
||||
### .status.ref.uid
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L52)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L52)</sup>
|
||||
|
||||
UID keeps the information about object UID
|
||||
|
||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -10,7 +10,7 @@ title: ArangoMLStorage V1Alpha1
|
|||
|
||||
### .spec.backend.s3.allowInsecure
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L40)</sup>
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L40)</sup>
|
||||
|
||||
AllowInsecure if set to true, the Endpoint certificates won't be checked
|
||||
|
||||
|
@ -20,7 +20,7 @@ Default Value: `false`
|
|||
|
||||
### .spec.backend.s3.caSecret.name
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L46)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L46)</sup>
|
||||
|
||||
Name of the object
|
||||
|
||||
|
@ -28,7 +28,7 @@ Name of the object
|
|||
|
||||
### .spec.backend.s3.caSecret.namespace
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L49)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L49)</sup>
|
||||
|
||||
Namespace of the object. Should default to the namespace of the parent object
|
||||
|
||||
|
@ -36,7 +36,7 @@ Namespace of the object. Should default to the namespace of the parent object
|
|||
|
||||
### .spec.backend.s3.caSecret.uid
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L52)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L52)</sup>
|
||||
|
||||
UID keeps the information about object UID
|
||||
|
||||
|
@ -44,7 +44,7 @@ UID keeps the information about object UID
|
|||
|
||||
### .spec.backend.s3.credentialsSecret.name
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L46)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L46)</sup>
|
||||
|
||||
Name of the object
|
||||
|
||||
|
@ -52,7 +52,7 @@ Name of the object
|
|||
|
||||
### .spec.backend.s3.credentialsSecret.namespace
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L49)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L49)</sup>
|
||||
|
||||
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
|
|||
|
||||
### .spec.backend.s3.credentialsSecret.uid
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/object.go#L52)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/object.go#L52)</sup>
|
||||
|
||||
UID keeps the information about object UID
|
||||
|
||||
|
@ -68,7 +68,7 @@ UID keeps the information about object UID
|
|||
|
||||
### .spec.backend.s3.endpoint
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L34)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L34)</sup>
|
||||
|
||||
Endpoint specifies the S3 API-compatible endpoint which implements storage
|
||||
Required
|
||||
|
@ -77,7 +77,7 @@ Required
|
|||
|
||||
### .spec.backend.s3.region
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L49)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/storage_spec_backend_s3.go#L49)</sup>
|
||||
|
||||
Region defines the availability zone name.
|
||||
|
||||
|
@ -87,7 +87,7 @@ Default Value: `""`
|
|||
|
||||
### .spec.bucketName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/storage_spec.go#L30)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/storage_spec.go#L30)</sup>
|
||||
|
||||
BucketName specifies the name of the bucket
|
||||
Required
|
||||
|
@ -96,7 +96,7 @@ Required
|
|||
|
||||
### .spec.bucketPath
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/storage_spec.go#L34)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/storage_spec.go#L34)</sup>
|
||||
|
||||
BucketPath specifies the path within the bucket
|
||||
|
||||
|
@ -106,7 +106,7 @@ Default Value: `/`
|
|||
|
||||
### .spec.mode.sidecar.controllerListenPort
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L36)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/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
|
||||
|
||||
|
@ -116,7 +116,7 @@ Default Value: `9202`
|
|||
|
||||
### .spec.mode.sidecar.env
|
||||
|
||||
Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/envs.go#L33)</sup>
|
||||
Type: `core.EnvVar` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/envs.go#L33)</sup>
|
||||
|
||||
Env keeps the information about environment variables provided to the container
|
||||
|
||||
|
@ -127,7 +127,7 @@ Links:
|
|||
|
||||
### .spec.mode.sidecar.envFrom
|
||||
|
||||
Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/envs.go#L38)</sup>
|
||||
Type: `core.EnvFromSource` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/envs.go#L38)</sup>
|
||||
|
||||
EnvFrom keeps the information about environment variable sources provided to the container
|
||||
|
||||
|
@ -138,7 +138,7 @@ Links:
|
|||
|
||||
### .spec.mode.sidecar.image
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/image.go#L31)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/image.go#L31)</sup>
|
||||
|
||||
Image define image details
|
||||
|
||||
|
@ -146,7 +146,7 @@ Image define image details
|
|||
|
||||
### .spec.mode.sidecar.listenPort
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L32)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/storage_spec_mode_sidecar.go#L32)</sup>
|
||||
|
||||
ListenPort defines on which port the sidecar container will be listening for connections
|
||||
|
||||
|
@ -156,7 +156,7 @@ Default Value: `9201`
|
|||
|
||||
### .spec.mode.sidecar.pullPolicy
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/image.go#L35)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/image.go#L35)</sup>
|
||||
|
||||
PullPolicy define Image pull policy
|
||||
|
||||
|
@ -166,7 +166,7 @@ Default Value: `IfNotPresent`
|
|||
|
||||
### .spec.mode.sidecar.pullSecrets
|
||||
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/image.go#L38)</sup>
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/image.go#L38)</sup>
|
||||
|
||||
PullSecrets define Secrets used to pull Image from registry
|
||||
|
||||
|
@ -174,7 +174,7 @@ PullSecrets define Secrets used to pull Image from registry
|
|||
|
||||
### .spec.mode.sidecar.resources
|
||||
|
||||
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/resources.go#L34)</sup>
|
||||
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/resources.go#L34)</sup>
|
||||
|
||||
Resources holds resource requests & limits for container
|
||||
|
||||
|
@ -185,7 +185,7 @@ Links:
|
|||
|
||||
### .spec.mode.sidecar.securityContext
|
||||
|
||||
Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/shared/v1/security_container.go#L29)</sup>
|
||||
Type: `core.SecurityContext` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/shared/v1/security_container.go#L29)</sup>
|
||||
|
||||
PodSecurityContext holds pod-level security attributes and common container settings.
|
||||
|
||||
|
@ -196,7 +196,7 @@ Links:
|
|||
|
||||
### .status.conditions
|
||||
|
||||
Type: `api.Conditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/ml/v1alpha1/storage_status.go#L28)</sup>
|
||||
Type: `api.Conditions` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/ml/v1alpha1/storage_status.go#L28)</sup>
|
||||
|
||||
Conditions specific to the entire storage
|
||||
|
||||
|
|
|
@ -10,7 +10,7 @@ title: ArangoMember V1
|
|||
|
||||
### .spec.deletion_priority
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/deployment/v1/arango_member_spec.go#L47)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/deployment/v1/arango_member_spec.go#L47)</sup>
|
||||
|
||||
DeletionPriority define Deletion Priority.
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/deployment/v1/arango_member_spec.go#L36)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/deployment/v1/arango_member_spec.go#L36)</sup>
|
||||
|
||||
DeploymentUID define Deployment UID.
|
||||
|
||||
|
@ -28,7 +28,7 @@ DeploymentUID define Deployment UID.
|
|||
|
||||
### .spec.group
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/deployment/v1/arango_member_spec.go#L31)</sup>
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/deployment/v1/arango_member_spec.go#L31)</sup>
|
||||
|
||||
Group define Member Groups.
|
||||
|
||||
|
@ -36,13 +36,13 @@ Group define Member Groups.
|
|||
|
||||
### .spec.id
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/deployment/v1/arango_member_spec.go#L33)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/deployment/v1/arango_member_spec.go#L33)</sup>
|
||||
|
||||
***
|
||||
|
||||
### .spec.overrides.resources
|
||||
|
||||
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/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.37/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L38)</sup>
|
||||
|
||||
Resources holds resource requests & limits. Overrides template provided on the group level.
|
||||
|
||||
|
@ -53,7 +53,7 @@ Links:
|
|||
|
||||
### .spec.overrides.volumeClaimTemplate
|
||||
|
||||
Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/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.37/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.
|
||||
|
||||
|
@ -64,7 +64,7 @@ Links:
|
|||
|
||||
### .spec.template.checksum
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/deployment/v1/arango_member_pod_template.go#L60)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/deployment/v1/arango_member_pod_template.go#L60)</sup>
|
||||
|
||||
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
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/deployment/v1/arango_member_pod_template.go#L63)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/deployment/v1/arango_member_pod_template.go#L63)</sup>
|
||||
|
||||
Deprecated: Endpoint is not saved into the template
|
||||
|
||||
|
@ -80,7 +80,7 @@ Deprecated: Endpoint is not saved into the template
|
|||
|
||||
### .spec.template.podSpec
|
||||
|
||||
Type: `core.PodTemplateSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/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.37/pkg/apis/deployment/v1/arango_member_pod_template.go#L54)</sup>
|
||||
|
||||
PodSpec specifies the Pod Spec used for this Member.
|
||||
|
||||
|
@ -91,7 +91,7 @@ Links:
|
|||
|
||||
### .spec.template.podSpecChecksum
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/deployment/v1/arango_member_pod_template.go#L57)</sup>
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.37/pkg/apis/deployment/v1/arango_member_pod_template.go#L57)</sup>
|
||||
|
||||
PodSpecChecksum keep the Pod Spec Checksum (without ignored fields).
|
||||
|
||||
|
|
Loading…
Reference in a new issue