Skip to content

Commit

Permalink
sync-gh-pages: docs and Helm chart 1.2.37 (#1586)
Browse files Browse the repository at this point in the history
  • Loading branch information
jwierzbo authored Jan 24, 2024
1 parent 0117f9b commit 1240ec3
Show file tree
Hide file tree
Showing 13 changed files with 1,538 additions and 1,125 deletions.
82 changes: 51 additions & 31 deletions docs/api/ArangoBackup.V1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,62 +10,72 @@ 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

***

### .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

***

### .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)

***

### .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

***

### .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.

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.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

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

Links:
* [Defining a secret for backup upload or download](/docs/backup-resource.md#defining-a-secret-for-backup-upload-or-download)
* [Defining a secret for backup upload or download](../backup-resource.md#defining-a-secret-for-backup-upload-or-download)

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#L89)</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

Expand All @@ -75,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.
Expand All @@ -96,15 +106,15 @@ 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".

***

### .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.
Expand All @@ -117,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.

Expand All @@ -129,30 +139,40 @@ 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

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.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

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

Links:
* [Defining a secret for backup upload or download](/docs/backup-resource.md#defining-a-secret-for-backup-upload-or-download)
* [Defining a secret for backup upload or download](../backup-resource.md#defining-a-secret-for-backup-upload-or-download)

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.
Expand All @@ -173,99 +193,99 @@ 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

***

### .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.

***

### .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

***

### .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.

***

### .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

***

### .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.

***

### .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

***

### .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

Expand All @@ -278,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

Expand Down
Loading

0 comments on commit 1240ec3

Please sign in to comment.