Rclone Sync 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/v0.39.2/config/schemas/config.yaml#/properties/objectStorage/properties/sync
Sync object storage from the primary site to a secondary site with Rclone.
| 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 Sync Config)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| activeDeadlineSeconds | number |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| enabled | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| dryrun | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| syncDefaultBuckets | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| defaultSchedule | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| buckets | array |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| destinationType | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| azure | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| s3 | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| swift | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| resources | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| encrypt | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
activeDeadlineSeconds¶
The maximum amount of time that the Rclone job is allowed to run (in seconds).
activeDeadlineSeconds
-
is optional
-
Type:
number(Rclone Cronjob Active Deadline Seconds) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number (Rclone Cronjob Active Deadline Seconds)
DEFAULTS:
The default value is:
14400
enabled¶
enabled
-
is optional
-
Type:
boolean(Rclone Sync Enable) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Rclone Sync Enable)
dryrun¶
Deploy Rclone with dryrun enabled.
dryrun
-
is optional
-
Type:
boolean(Rclone Sync Dryrun) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Rclone Sync Dryrun)
syncDefaultBuckets¶
Sync the buckets or containers set under .objectStorage.buckets.
syncDefaultBuckets
-
is optional
-
Type:
boolean(Rclone Sync Default Buckets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Rclone Sync Default Buckets)
defaultSchedule¶
Default schedule to run the sync CronJobs.
defaultSchedule
-
is optional
-
Type:
string(Rclone Sync Default Schedule) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Rclone Sync Default Schedule)
DEFAULTS:
The default value is:
"0 5 * * *"
buckets¶
Additional buckets to sync.
buckets
-
is optional
-
Type:
array(Rclone Sync Buckets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
array (Rclone Sync Buckets)
DEFAULTS:
The default value is:
[]
destinationType¶
Object storage type to use.
destinationType
-
is optional
-
Type:
string(Rclone Sync Destination Type) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Rclone Sync Destination Type)
CONSTRAINTS:
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"azure" |
|
"gcs" |
|
"s3" |
|
"swift" |
azure¶
Only supports Azure Public Cloud.
azure
-
is optional
-
Type:
object(Azure Backend Config) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Azure Backend Config)
s3¶
Supports both AWS and non-AWS implementations.
s3
-
is optional
-
Type:
object(S3 Backend Config) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (S3 Backend Config)
swift¶
Note
Supported as an option only for Harbor, Rclone, and Thanos.
swift
-
is optional
-
Type:
object(Swift Backend Config) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Swift Backend Config)
resources¶
Resource requests are used by the kube-scheduler to pick a node to schedule pods on.
Limits are enforced. Resources are commonly 'cpu' and 'memory'.
resources
-
is optional
-
Type:
object(Kubernetes Resource Requirements) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Kubernetes Resource Requirements)
EXAMPLES:
requests:
memory: 128Mi
cpu: 100m
limits:
memory: 256Mi
cpu: 250m
encrypt¶
Encrypt data when syncing and decrypt data when restoring.
encrypt
-
is optional
-
Type:
object(Rclone Crypt) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Rclone Crypt)
Return to the root config schema
Generated Thu Nov 14 16:14:40 UTC 2024 from elastisys/compliantkubernetes-apps@v0.39.2