Rclone Restore Config Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/config.yaml#/properties/objectStorage/properties/restore
Restore object storage from a secondary site to the primary site with Rclone.
Note
When enabled this will disable Rclone sync to prevent it from modifying the secondary site.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object (Rclone Restore Config)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| enabled | boolean |
Optional | cannot be null | Welkin Apps Config |
| dryrun | boolean |
Optional | cannot be null | Welkin Apps Config |
| addTargetsFromSync | boolean |
Optional | cannot be null | Welkin Apps Config |
| targets | array |
Optional | cannot be null | Welkin Apps Config |
| timestamp | string |
Optional | cannot be null | Welkin Apps Config |
| destinations | object |
Optional | cannot be null | Welkin Apps Config |
| sources | object |
Optional | cannot be null | Welkin Apps Config |
| decrypt | object |
Optional | cannot be null | Welkin Apps Config |
enabled¶
enabled
-
is optional
-
Type:
boolean(Rclone Restore Enable) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
boolean (Rclone Restore Enable)
dryrun¶
Deploy Rclone with dryrun enabled.
dryrun
-
is optional
-
Type:
boolean(Rclone Restore Dryrun) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
boolean (Rclone Restore Dryrun)
addTargetsFromSync¶
Automatically configure the restore from a secondary site to the primary site.
Essentially this will configure Rclone restore to do the inverse of Rclone sync.
addTargetsFromSync
-
is optional
-
Type:
boolean(Rclone Restore Targets From Sync) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
boolean (Rclone Restore Targets From Sync)
targets¶
Targets to restore
targets
-
is optional
-
Type:
object[](Rclone restore target) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object[] (Rclone restore target)
DEFAULTS:
The default value is:
[]
timestamp¶
Perform point-in-time restore if possible.
This is only supported for S3 sources.
timestamp
-
is optional
-
Type:
string(Rclone Restore Timestamp) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
string (Rclone Restore Timestamp)
destinations¶
Allows for complete or partial overrides of the destinations of the restore, the main object storage configuration.
destinations
-
is optional
-
Type:
object(Rclone Restore Destinations) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Rclone Restore Destinations)
DEFAULTS:
The default value is:
{}
sources¶
Allows for complete or partial overrides of the sources of the restore, the sync object storage configuration.
sources
-
is optional
-
Type:
object(Rclone Restore Sources) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Rclone Restore Sources)
DEFAULTS:
The default value is:
{}
decrypt¶
Encrypt data when syncing and decrypt data when restoring.
decrypt
-
is optional
-
Type:
object(Rclone Crypt) -
cannot be null
-
defined in: Welkin Apps Config
TYPE:
object (Rclone Crypt)
DEFAULTS:
The default value is:
{}
Return to the root config schema
Generated Thu Dec 19 03:51:01 UTC 2024 from elastisys/compliantkubernetes-apps@main