Swift Backend 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/properties/restore/properties/sources/properties/swift
Note
Supported as an option only for Harbor, Rclone, and Thanos.
| 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 (Swift Backend Config)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| authVersion | integer |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| authUrl | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| region | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| domainId | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| domainName | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| projectDomainId | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| projectDomainName | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| projectId | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| projectName | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| segmentsContainerSuffix | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
authVersion¶
OpenStack authentication version.
Set 0 for auto detect from authentication url.
authVersion
-
is optional
-
Type:
integer(OpenStack Authentication Version) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
integer (OpenStack Authentication Version)
authUrl¶
OpenStack authentication URL.
Make sure to prepend the protocol (e.g. https://) and append the authentication version (e.g. /v3).
authUrl
-
is optional
-
Type:
string(OpenStack Authentication URL) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenStack Authentication URL)
CONSTRAINTS:
URI: the string must be a URI, according to RFC 3986
region¶
OpenStack region.
region
-
is optional
-
Type:
string(OpenStack Region) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenStack Region)
domainId¶
The user domain ID to use.
User domain is required when authenticating with username, set either domainId or domainName.
domainId
-
is optional
-
Type:
string(OpenStack Domain ID) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenStack Domain ID)
domainName¶
The user domain name to use.
User domain is required when authenticating with username, set either domainId or domainName.
domainName
-
is optional
-
Type:
string(OpenStack Domain Name) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenStack Domain Name)
projectDomainId¶
The project domain ID to use.
Project domain is required when authenticating with projectName, set either projectDomainId or projectDomainName.
projectDomainId
-
is optional
-
Type:
string(OpenStack Project Domain ID) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenStack Project Domain ID)
projectDomainName¶
The project domain name to use.
Project domain is required when authenticating with projectName, set either projectDomainId or projectDomainName.
projectDomainName
-
is optional
-
Type:
string(OpenStack Project Domain Name) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenStack Project Domain Name)
projectId¶
The project ID to use.
Project is required when authenticating with username, set either projectId or projectName.
projectId
-
is optional
-
Type:
string(OpenStack Project ID) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenStack Project ID)
projectName¶
The project name to use, requires project domain to be set.
Project is required when authenticating with username, set either projectId or projectName.
projectName
-
is optional
-
Type:
string(OpenStack Project Name) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (OpenStack Project Name)
segmentsContainerSuffix¶
The container suffix to use for segment containers.
These are created to store large objects with SLOs/DLOs, and with s3api middleware for multipart uploads.
segmentsContainerSuffix
-
is optional
-
Type:
string(Swift Segments Container Suffix) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string (Swift Segments Container Suffix)
DEFAULTS:
The default value is:
"+segments"
Return to the root config schema
Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main