Backup Job 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/harbor/properties/backup

Configuration options for Backup Job.

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 (Backup Job Config)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
enabled	`boolean`	Optional	cannot be null	Welkin Apps Config
ephemeralBackupStore	`object`	Optional	cannot be null	Welkin Apps Config
retentionDays	`number`	Optional	cannot be null	Welkin Apps Config
schedule	`string`	Optional	cannot be null	Welkin Apps Config

enabled¶

enabled

is optional
Type: boolean (Enable Harbor Backup)
cannot be null
defined in: Welkin Apps Config

TYPE:

boolean (Enable Harbor Backup)

DEFAULTS:

The default value is:

true

ephemeralBackupStore¶

EphemeralBackupStore configuration for Harbor

StorageSize defines how large the ephemeral volumes will be.

ephemeralBackupStore

is optional
Type: object (Ephemeral Backup Store Config)
cannot be null
defined in: Welkin Apps Config

TYPE:

object (Ephemeral Backup Store Config)

retentionDays¶

RetentionDays defines how old a backup should be before deleting it.

retentionDays

is optional
Type: number (Backup Retention Days)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (Backup Retention Days)

DEFAULTS:

The default value is:

schedule¶

schedule defines when the backup job for Harbor will run. This should be set to run shortly after Velero backups in the workload cluster, in order to ensure that images needed for Velero backups are backed up in Harbor. Uses the Cron format, see https://en.wikipedia.org/wiki/Cron.

schedule

is optional
Type: string (Schedule for backup job)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (Schedule for backup job)

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:

"30 0 * * *"

Return to the root config schema

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