Rclone Sync Config Schema¶

Note

This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.

https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/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	Welkin Apps Config
enabled	`boolean`	Optional	cannot be null	Welkin Apps Config
dryrun	`boolean`	Optional	cannot be null	Welkin Apps Config
syncDefaultBuckets	`boolean`	Optional	cannot be null	Welkin Apps Config
defaultSchedule	`string`	Optional	cannot be null	Welkin Apps Config
buckets	`array`	Optional	cannot be null	Welkin Apps Config
destinationType	`string`	Optional	cannot be null	Welkin Apps Config
secondaryUrl	`string`	Optional	cannot be null	Welkin Apps Config
azure	`object`	Optional	cannot be null	Welkin Apps Config
s3	`object`	Optional	cannot be null	Welkin Apps Config
swift	`object`	Optional	cannot be null	Welkin Apps Config
resources	`object`	Optional	cannot be null	Welkin Apps Config
encrypt	`object`	Optional	cannot be null	Welkin Apps Config
sourceType	`string`	Optional	cannot be null	Welkin 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: Welkin Apps Config

TYPE:

number (Rclone Cronjob Active Deadline Seconds)

DEFAULTS:

The default value is:

enabled¶

enabled

is optional
Type: boolean (Rclone Sync Enable)
cannot be null
defined in: Welkin 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: Welkin 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: Welkin Apps Config

TYPE:

boolean (Rclone Sync Default Buckets)

defaultSchedule¶

Default schedule to run the sync CronJobs. Uses the Cron format, see https://en.wikipedia.org/wiki/Cron.

defaultSchedule

is optional
Type: string (Rclone Sync Default Schedule)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (Rclone Sync Default Schedule)

CONSTRAINTS:

pattern: the string must match the following regular expression:

^(((\*\/)?([0-5]?[0-9])((\,|\-|\/)([0-5]?[0-9]))*|\*)[^\S\r\n]+((\*\/)?((2[0-3]|1[0-9]|[0-9]|00))((\,|\-|\/)(2[0-3]|1[0-9]|[0-9]|00))*|\*)[^\S\r\n]+((\*\/)?([1-9]|[12][0-9]|3[01])((\,|\-|\/)([1-9]|[12][0-9]|3[01]))*|\*)[^\S\r\n]+((\*\/)?([1-9]|1[0-2])((\,|\-|\/)([1-9]|1[0-2]))*|\*|(jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec))[^\S\r\n]+((\*\/)?[0-6]((\,|\-|\/)[0-6])*|\*|00|(sun|mon|tue|wed|thu|fri|sat)))$|^@(annually|yearly|monthly|weekly|daily|hourly|reboot)$

try pattern

DEFAULTS:

The default value is:

"0 5 * * *"

buckets¶

Additional buckets to sync.

buckets

is optional
Type: object[] (Buckets to sync)
cannot be null
defined in: Welkin Apps Config

TYPE:

object[] (Buckets to sync)

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: Welkin 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"`

secondaryUrl¶

secondaryUrl

is optional
Type: string (Rclone Sync Secondary URL)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (Rclone Sync Secondary URL)

CONSTRAINTS:

URI: the string must be a URI, according to RFC 3986

azure¶

Only supports Azure Public Cloud.

azure

is optional
Type: object (Azure Backend Config)
cannot be null
defined in: Welkin 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: Welkin 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: Welkin 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: Welkin 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: Welkin Apps Config

TYPE:

object (Rclone Crypt)

sourceType¶

Object storage type to use. Defaults to .objectStorage.type

sourceType

is optional
Type: string (Rclone Sync Source Type)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (Rclone Sync Source Type)

EXAMPLES:

azure

gcs

s3

swift

Return to the root config schema

Generated Thu Dec 19 03:51:01 UTC 2024 from elastisys/compliantkubernetes-apps@main