Object Storage 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
Configuration options for using object storage in Compliant Kubernetes
This is used for:
- Fluentd audit logs
- Fluentd service cluster logs
- Harbor database backups and registry storage
- OpenSearch workload cluster log snapshots
- Rclone object storage sync source and restore destination
- Thanos metrics storage
- Velero resource backups and volume snapshots
Harbor, Rclone, and Thanos have additional configuration to use Swift.
| 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 (Object Storage Config)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| buckets | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| type | 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 |
| sync | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| restore | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
buckets¶
Buckets or containers for each respective application to use for application data or backup storage.
Keys are used as identifiers for buckets or containers, while the values are used as the bucket or container name.
Additional entries added here will have monitoring enabled.
buckets
-
is optional
-
Type:
object(Object Storage Buckets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Object Storage Buckets)
type¶
Object storage type to use.
In addition to this Harbor, Rclone, and Thanos have additional configuration to use Swift.
type
-
is optional
-
Type:
string(Object Storage Type) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Object Storage Type)
CONSTRAINTS:
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"azure" |
|
"gcs" |
|
"s3" |
|
"none" |
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)
sync¶
Sync object storage from the primary site to a secondary site with Rclone.
sync
-
is optional
-
Type:
object(Rclone Sync Config) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Rclone Sync Config)
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.
restore
-
is optional
-
Type:
object(Rclone Restore Config) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Rclone Restore Config)
Return to the root config schema
Generated Sat Jun 22 03:48:20 UTC 2024 from elastisys/compliantkubernetes-apps@main