Backup Job 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/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 |
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:
7
Return to the root config schema
Generated Sun Nov 17 03:51:36 UTC 2024 from elastisys/compliantkubernetes-apps@main