mirror of
https://github.com/arangodb/kube-arangodb.git
synced 2024-12-14 11:57:37 +00:00
(Documentation) Do not use field type name for field URL hash (#1481)
This commit is contained in:
Nikita Vaniasin
GitHub
parent
686e51b7e4
commit
37daf6d71f
8 changed files with 2879 additions and 1452 deletions
|
|
@ -6,6 +6,7 @@
|
|||
- (Improvement) Use Async mode for backup creation
|
||||
- (Feature) (ML) CRD
|
||||
- (Bugfix) Proper handling of --agency.retries argument
|
||||
- (Documentation) Do not use field type name for field URL hash
|
||||
|
||||
## [1.2.35](https://github.com/arangodb/kube-arangodb/tree/1.2.35) (2023-11-06)
|
||||
- (Maintenance) Update go-driver to v1.6.0, update IsNotFound() checks
|
||||
|
|
|
|||
|
|
@ -2,39 +2,51 @@
|
|||
|
||||
## Spec
|
||||
|
||||
### .spec.backoff.iterations: integer
|
||||
### .spec.backoff.iterations
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L31)</sup>
|
||||
|
||||
Iterations defines number of iterations before reaching MaxDelay. Default to 5
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L31)
|
||||
***
|
||||
|
||||
### .spec.backoff.max_delay: integer
|
||||
### .spec.backoff.max_delay
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L29)</sup>
|
||||
|
||||
MaxDelay defines maximum delay in seconds. Default to 600
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L29)
|
||||
***
|
||||
|
||||
### .spec.backoff.max_iterations: integer
|
||||
### .spec.backoff.max_iterations
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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)
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L33)
|
||||
***
|
||||
|
||||
### .spec.backoff.min_delay: integer
|
||||
### .spec.backoff.min_delay
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L27)</sup>
|
||||
|
||||
MinDelay defines minimum delay in seconds. Default to 30
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L27)
|
||||
***
|
||||
|
||||
### .spec.deployment.name: string
|
||||
### .spec.deployment.name
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L54)</sup>
|
||||
|
||||
Name of the ArangoDeployment Custom Resource within same namespace as ArangoBackup Custom Resource.
|
||||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L54)
|
||||
***
|
||||
|
||||
### .spec.download.credentialsSecretName: string
|
||||
### .spec.download.credentialsSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
|
||||
|
||||
CredentialsSecretName is the name of the secret used while accessing repository
|
||||
|
||||
|
|
@ -43,17 +55,21 @@ Links:
|
|||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81)
|
||||
***
|
||||
|
||||
### .spec.download.id: string
|
||||
### .spec.download.id
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L89)</sup>
|
||||
|
||||
ID of the ArangoBackup to be downloaded
|
||||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L89)
|
||||
***
|
||||
|
||||
### .spec.download.repositoryURL: string
|
||||
### .spec.download.repositoryURL
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
|
@ -70,15 +86,19 @@ azure://test
|
|||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77)
|
||||
***
|
||||
|
||||
### .spec.lifetime: integer
|
||||
### .spec.lifetime
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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".
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L47)
|
||||
***
|
||||
|
||||
### .spec.options.allowInconsistent: boolean
|
||||
### .spec.options.allowInconsistent
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
|
@ -87,9 +107,11 @@ Default Value: `false`
|
|||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L66)
|
||||
***
|
||||
|
||||
### .spec.options.timeout: number
|
||||
### .spec.options.timeout
|
||||
|
||||
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
||||
|
|
@ -97,17 +119,21 @@ Default Value: `30`
|
|||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L61)
|
||||
***
|
||||
|
||||
### .spec.policyName: string
|
||||
### .spec.policyName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L42)</sup>
|
||||
|
||||
PolicyName name of the ArangoBackupPolicy which created this Custom Resource
|
||||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L42)
|
||||
***
|
||||
|
||||
### .spec.upload.credentialsSecretName: string
|
||||
### .spec.upload.credentialsSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
|
||||
|
||||
CredentialsSecretName is the name of the secret used while accessing repository
|
||||
|
||||
|
|
@ -116,9 +142,11 @@ Links:
|
|||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81)
|
||||
***
|
||||
|
||||
### .spec.upload.repositoryURL: string
|
||||
### .spec.upload.repositoryURL
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
|
@ -135,77 +163,103 @@ azure://test
|
|||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77)
|
||||
|
||||
## Status
|
||||
|
||||
### .status.available: boolean
|
||||
### .status.available
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L36)</sup>
|
||||
|
||||
Available Determines if we can restore from ArangoBackup
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L36)
|
||||
***
|
||||
|
||||
### .status.backoff.iterations: integer
|
||||
### .status.backoff.iterations
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status_backoff.go#L30)
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status_backoff.go#L30)</sup>
|
||||
|
||||
### .status.backup.downloaded: boolean
|
||||
***
|
||||
|
||||
### .status.backup.downloaded
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L66)</sup>
|
||||
|
||||
Downloaded Determines if ArangoBackup has been downloaded.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L66)
|
||||
***
|
||||
|
||||
### .status.backup.id: string
|
||||
### .status.backup.id
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L56)
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L56)</sup>
|
||||
|
||||
### .status.backup.imported: boolean
|
||||
***
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L67)
|
||||
### .status.backup.imported
|
||||
|
||||
### .status.backup.keys: array
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L67)</sup>
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L70)
|
||||
***
|
||||
|
||||
### .status.backup.numberOfDBServers: integer
|
||||
### .status.backup.keys
|
||||
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.35/pkg/apis/backup/v1/backup_status.go#L62)</sup>
|
||||
|
||||
NumberOfDBServers Cluster size of the Backup in ArangoDB
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L62)
|
||||
***
|
||||
|
||||
### .status.backup.potentiallyInconsistent: boolean
|
||||
### .status.backup.potentiallyInconsistent
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L58)
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L58)</sup>
|
||||
|
||||
### .status.backup.sizeInBytes: integer
|
||||
***
|
||||
|
||||
### .status.backup.sizeInBytes
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L60)</sup>
|
||||
|
||||
SizeInBytes Size of the Backup in ArangoDB.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L60)
|
||||
***
|
||||
|
||||
### .status.backup.uploaded: boolean
|
||||
### .status.backup.uploaded
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L64)</sup>
|
||||
|
||||
Uploaded Determines if ArangoBackup has been uploaded
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L64)
|
||||
***
|
||||
|
||||
### .status.backup.version: string
|
||||
### .status.backup.version
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L57)
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_status.go#L57)</sup>
|
||||
|
||||
### .status.message: string
|
||||
***
|
||||
|
||||
### .status.message
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L88)</sup>
|
||||
|
||||
Message for the state this object is in.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L88)
|
||||
***
|
||||
|
||||
### .status.progress.jobID: string
|
||||
### .status.progress.jobID
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L111)</sup>
|
||||
|
||||
JobID ArangoDB job ID for uploading or downloading
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L111)
|
||||
***
|
||||
|
||||
### .status.progress.progress: string
|
||||
### .status.progress.progress
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L114)</sup>
|
||||
|
||||
Progress ArangoDB job progress in percents
|
||||
|
||||
|
|
@ -214,9 +268,11 @@ Example:
|
|||
90%
|
||||
```
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L114)
|
||||
***
|
||||
|
||||
### .status.state: string
|
||||
### .status.state
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L82)</sup>
|
||||
|
||||
State holds the current high level state of the backup
|
||||
|
||||
|
|
@ -235,5 +291,3 @@ Possible Values:
|
|||
* Failed - state for failure
|
||||
* Unavailable - state when Backup is not available on the ArangoDB. It can happen in case of upgrades, node restarts etc.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_state.go#L82)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,70 +2,90 @@
|
|||
|
||||
## Spec
|
||||
|
||||
### .spec.allowConcurrent: boolean
|
||||
### .spec.allowConcurrent
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L35)</sup>
|
||||
|
||||
AllowConcurrent if false, ArangoBackup will not be created when previous Backups are not finished
|
||||
|
||||
Default Value: `true`
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L35)
|
||||
***
|
||||
|
||||
### .spec.maxBackups: integer
|
||||
### .spec.maxBackups
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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
|
||||
|
||||
Default Value: `0`
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L43)
|
||||
***
|
||||
|
||||
### .spec.schedule: string
|
||||
### .spec.schedule
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L32)
|
||||
***
|
||||
|
||||
### .spec.selector: meta.LabelSelector
|
||||
### .spec.selector
|
||||
|
||||
Type: `meta.LabelSelector` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L39)</sup>
|
||||
|
||||
DeploymentSelector Selector definition for selecting matching ArangoBackup Custom Resources.
|
||||
|
||||
Links:
|
||||
* [Kubernetes Documentation](https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#LabelSelector)
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L39)
|
||||
***
|
||||
|
||||
### .spec.template.backoff.iterations: integer
|
||||
### .spec.template.backoff.iterations
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L31)</sup>
|
||||
|
||||
Iterations defines number of iterations before reaching MaxDelay. Default to 5
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L31)
|
||||
***
|
||||
|
||||
### .spec.template.backoff.max_delay: integer
|
||||
### .spec.template.backoff.max_delay
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L29)</sup>
|
||||
|
||||
MaxDelay defines maximum delay in seconds. Default to 600
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L29)
|
||||
***
|
||||
|
||||
### .spec.template.backoff.max_iterations: integer
|
||||
### .spec.template.backoff.max_iterations
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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)
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L33)
|
||||
***
|
||||
|
||||
### .spec.template.backoff.min_delay: integer
|
||||
### .spec.template.backoff.min_delay
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L27)</sup>
|
||||
|
||||
MinDelay defines minimum delay in seconds. Default to 30
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec_backoff.go#L27)
|
||||
***
|
||||
|
||||
### .spec.template.lifetime: integer
|
||||
### .spec.template.lifetime
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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".
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_spec.go#L61)
|
||||
***
|
||||
|
||||
### .spec.template.options.allowInconsistent: boolean
|
||||
### .spec.template.options.allowInconsistent
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
|
@ -74,9 +94,11 @@ Default Value: `false`
|
|||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L66)
|
||||
***
|
||||
|
||||
### .spec.template.options.timeout: number
|
||||
### .spec.template.options.timeout
|
||||
|
||||
Type: `number` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
||||
|
|
@ -84,9 +106,11 @@ Default Value: `30`
|
|||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L61)
|
||||
***
|
||||
|
||||
### .spec.template.upload.credentialsSecretName: string
|
||||
### .spec.template.upload.credentialsSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81)</sup>
|
||||
|
||||
CredentialsSecretName is the name of the secret used while accessing repository
|
||||
|
||||
|
|
@ -95,9 +119,11 @@ Links:
|
|||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L81)
|
||||
***
|
||||
|
||||
### .spec.template.upload.repositoryURL: string
|
||||
### .spec.template.upload.repositoryURL
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
|
@ -114,19 +140,19 @@ azure://test
|
|||
|
||||
This field is **immutable**: can't be changed after backup creation
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_spec.go#L77)
|
||||
|
||||
## Status
|
||||
|
||||
### .status.message: string
|
||||
### .status.message
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_status.go#L33)</sup>
|
||||
|
||||
Message from the operator in case of failures - schedule not valid, ArangoBackupPolicy not valid
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_status.go#L33)
|
||||
***
|
||||
|
||||
### .status.scheduled: meta.Time
|
||||
### .status.scheduled
|
||||
|
||||
Type: `meta.Time` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_status.go#L31)</sup>
|
||||
|
||||
Scheduled Next scheduled time in UTC
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/backup/v1/backup_policy_status.go#L31)
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -2,21 +2,27 @@
|
|||
|
||||
## Spec
|
||||
|
||||
### .spec.cancellation.ensureInSync: boolean
|
||||
### .spec.cancellation.ensureInSync
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/replication_spec.go#L38)
|
||||
***
|
||||
|
||||
### .spec.cancellation.sourceReadOnly: boolean
|
||||
### .spec.cancellation.sourceReadOnly
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/replication_spec.go#L41)
|
||||
***
|
||||
|
||||
### .spec.destination.auth.keyfileSecretName: string
|
||||
### .spec.destination.auth.keyfileSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
|
@ -24,25 +30,31 @@ If `userSecretName` has not been set,
|
|||
the client authentication certificate found in the secret with this name is also used to configure
|
||||
the synchronization and fetch the synchronization status.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37)
|
||||
***
|
||||
|
||||
### .spec.destination.auth.userSecretName: string
|
||||
### .spec.destination.auth.userSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
The user identified by the username must have write access in the `_system` database
|
||||
of the ArangoDB cluster at the endpoint.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42)
|
||||
***
|
||||
|
||||
### .spec.destination.deploymentName: string
|
||||
### .spec.destination.deploymentName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L36)
|
||||
***
|
||||
|
||||
### .spec.destination.masterEndpoint: array
|
||||
### .spec.destination.masterEndpoint
|
||||
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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
|
||||
|
|
@ -51,16 +63,20 @@ Specifying this setting and `deploymentName` at the same time is not allowed.
|
|||
|
||||
Default Value: `[]`
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L42)
|
||||
***
|
||||
|
||||
### .spec.destination.tls.caSecretName: string
|
||||
### .spec.destination.tls.caSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_tls_spec.go#L34)
|
||||
***
|
||||
|
||||
### .spec.source.auth.keyfileSecretName: string
|
||||
### .spec.source.auth.keyfileSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
|
@ -68,25 +84,31 @@ If `userSecretName` has not been set,
|
|||
the client authentication certificate found in the secret with this name is also used to configure
|
||||
the synchronization and fetch the synchronization status.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L37)
|
||||
***
|
||||
|
||||
### .spec.source.auth.userSecretName: string
|
||||
### .spec.source.auth.userSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
The user identified by the username must have write access in the `_system` database
|
||||
of the ArangoDB cluster at the endpoint.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_authentication_spec.go#L42)
|
||||
***
|
||||
|
||||
### .spec.source.deploymentName: string
|
||||
### .spec.source.deploymentName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L36)
|
||||
***
|
||||
|
||||
### .spec.source.masterEndpoint: array
|
||||
### .spec.source.masterEndpoint
|
||||
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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
|
||||
|
|
@ -95,12 +117,12 @@ Specifying this setting and `deploymentName` at the same time is not allowed.
|
|||
|
||||
Default Value: `[]`
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_spec.go#L42)
|
||||
***
|
||||
|
||||
### .spec.source.tls.caSecretName: string
|
||||
### .spec.source.tls.caSecretName
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/replication/v1/endpoint_tls_spec.go#L34)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,40 +2,52 @@
|
|||
|
||||
## Spec
|
||||
|
||||
### .spec.localPath: array
|
||||
### .spec.localPath
|
||||
|
||||
Type: `array` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L36)
|
||||
***
|
||||
|
||||
### .spec.nodeSelector: object
|
||||
### .spec.nodeSelector
|
||||
|
||||
Type: `object` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L43)</sup>
|
||||
|
||||
NodeSelector setting specifies which nodes the operator will provision persistent volumes on.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L43)
|
||||
***
|
||||
|
||||
### .spec.podCustomization.priority: integer
|
||||
### .spec.podCustomization.priority
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_pod_customization.go#L25)</sup>
|
||||
|
||||
Priority if defined, sets the priority for pods of storage provisioner
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_pod_customization.go#L25)
|
||||
***
|
||||
|
||||
### .spec.privileged: boolean
|
||||
### .spec.privileged
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L45)</sup>
|
||||
|
||||
Privileged if set, passes Privileged flag to SecurityContext for pods of storage provisioner
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L45)
|
||||
***
|
||||
|
||||
### .spec.storageClass.isDefault: boolean
|
||||
### .spec.storageClass.isDefault
|
||||
|
||||
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L42)</sup>
|
||||
|
||||
IsDefault setting specifies if the created `StorageClass` will
|
||||
be marked as default storage class.
|
||||
|
||||
Default Value: `false`
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L42)
|
||||
***
|
||||
|
||||
### .spec.storageClass.name: string
|
||||
### .spec.storageClass.name
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L38)</sup>
|
||||
|
||||
Name setting specifies the name of the storage class that
|
||||
created `PersistentVolume` will use.
|
||||
|
|
@ -44,23 +56,25 @@ If a `StorageClass` with given name does not yet exist, it will be created.
|
|||
|
||||
Default Value: `""`
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L38)
|
||||
***
|
||||
|
||||
### .spec.storageClass.reclaimPolicy: core.PersistentVolumeReclaimPolicy
|
||||
### .spec.storageClass.reclaimPolicy
|
||||
|
||||
Type: `core.PersistentVolumeReclaimPolicy` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L46)</sup>
|
||||
|
||||
ReclaimPolicy defines what happens to a persistent volume when released from its claim.
|
||||
|
||||
Links:
|
||||
* [Documentation of core.PersistentVolumeReclaimPolicy](https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming)
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/storage_class_spec.go#L46)
|
||||
***
|
||||
|
||||
### .spec.tolerations: []core.Toleration
|
||||
### .spec.tolerations
|
||||
|
||||
Type: `[]core.Toleration` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L41)</sup>
|
||||
|
||||
Tolerations specifies the tolerations added to pods of storage provisioner
|
||||
|
||||
Links:
|
||||
* [Documentation of core.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#toleration-v1-core)
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/storage/v1alpha/local_storage_spec.go#L41)
|
||||
|
||||
|
|
|
|||
|
|
@ -2,72 +2,90 @@
|
|||
|
||||
## Spec
|
||||
|
||||
### .spec.deletion_priority: integer
|
||||
### .spec.deletion_priority
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L47)</sup>
|
||||
|
||||
DeletionPriority define Deletion Priority.
|
||||
Higher value means higher priority. Default is 0.
|
||||
Example: set 1 for Coordinator which should be deleted first and scale down coordinators by one.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L47)
|
||||
***
|
||||
|
||||
### .spec.deploymentUID: string
|
||||
### .spec.deploymentUID
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L36)</sup>
|
||||
|
||||
DeploymentUID define Deployment UID.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L36)
|
||||
***
|
||||
|
||||
### .spec.group: integer
|
||||
### .spec.group
|
||||
|
||||
Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L31)</sup>
|
||||
|
||||
Group define Member Groups.
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L31)
|
||||
***
|
||||
|
||||
### .spec.id: string
|
||||
### .spec.id
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L33)
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec.go#L33)</sup>
|
||||
|
||||
### .spec.overrides.resources: core.ResourceRequirements
|
||||
***
|
||||
|
||||
### .spec.overrides.resources
|
||||
|
||||
Type: `core.ResourceRequirements` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L38)</sup>
|
||||
|
||||
Resources holds resource requests & limits. Overrides template provided on the group level.
|
||||
|
||||
Links:
|
||||
* [Documentation of core.ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#resourcerequirements-v1-core)
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L38)
|
||||
***
|
||||
|
||||
### .spec.overrides.volumeClaimTemplate: core.PersistentVolumeClaim
|
||||
### .spec.overrides.volumeClaimTemplate
|
||||
|
||||
Type: `core.PersistentVolumeClaim` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/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.
|
||||
|
||||
Links:
|
||||
* [Documentation of core.PersistentVolumeClaim](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#persistentvolumeclaim-v1-core)
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_spec_overrides.go#L33)
|
||||
***
|
||||
|
||||
### .spec.template.checksum: string
|
||||
### .spec.template.checksum
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L60)</sup>
|
||||
|
||||
Checksum keep the Pod Spec Checksum (with ignored fields).
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L60)
|
||||
***
|
||||
|
||||
### .spec.template.endpoint: string
|
||||
### .spec.template.endpoint
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L63)</sup>
|
||||
|
||||
Deprecated: Endpoint is not saved into the template
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L63)
|
||||
***
|
||||
|
||||
### .spec.template.podSpec: core.PodTemplateSpec
|
||||
### .spec.template.podSpec
|
||||
|
||||
Type: `core.PodTemplateSpec` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L54)</sup>
|
||||
|
||||
PodSpec specifies the Pod Spec used for this Member.
|
||||
|
||||
Links:
|
||||
* [Documentation of core.PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#podtemplatespec-v1-core)
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L54)
|
||||
***
|
||||
|
||||
### .spec.template.podSpecChecksum: string
|
||||
### .spec.template.podSpecChecksum
|
||||
|
||||
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L57)</sup>
|
||||
|
||||
PodSpecChecksum keep the Pod Spec Checksum (without ignored fields).
|
||||
|
||||
[Code Reference](https://github.com/arangodb/kube-arangodb/blob/1.2.35/pkg/apis/deployment/v1/arango_member_pod_template.go#L57)
|
||||
|
||||
|
|
|
|||
|
|
@ -47,9 +47,13 @@ import (
|
|||
func (d DocDefinitions) RenderMarkdown(t *testing.T, repositoryPath string) []byte {
|
||||
out := bytes.NewBuffer(nil)
|
||||
|
||||
for _, el := range d {
|
||||
for i, el := range d {
|
||||
if i != 0 {
|
||||
write(t, out, "***\n\n")
|
||||
}
|
||||
|
||||
write(t, out, "### %s: %s\n\n", el.Path, el.Type)
|
||||
write(t, out, "### %s\n\n", el.Path)
|
||||
write(t, out, "Type: `%s` <sup>[\\[ref\\]](%s/%s#L%d)</sup>\n\n", el.Type, repositoryPath, el.File, el.Line)
|
||||
|
||||
if d := el.Important; d != nil {
|
||||
write(t, out, "**Important**: %s\n\n", *d)
|
||||
|
|
@ -115,8 +119,6 @@ func (d DocDefinitions) RenderMarkdown(t *testing.T, repositoryPath string) []by
|
|||
if d := el.Immutable; d != nil {
|
||||
write(t, out, "This field is **immutable**: %s\n\n", *d)
|
||||
}
|
||||
|
||||
write(t, out, "[Code Reference](%s/%s#L%d)\n\n", repositoryPath, el.File, el.Line)
|
||||
}
|
||||
|
||||
return out.Bytes()
|
||||
|
|
|
|||
Loading…
Reference in a new issue