Compliant Kubernetes Apps Secrets 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/secrets.yaml
This describes the structure of the secrets for both the service and workload clusters.
Since these are intended to be encrypted each property should have the
encrypteddefinition combined withanyOf oroneOf` with the actual format.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | config/schemas/secrets.yaml |
TYPE:
object (Compliant Kubernetes Apps Secrets)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| objectStorage | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| grafana | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| harbor | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| thanos | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| user | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| opensearch | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| kubeapiMetricsPassword | string |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| alerts | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| kured | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| dex | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| issuers | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
| externalDns | object |
Optional | cannot be null | Compliant Kubernetes Apps Secrets |
objectStorage¶
Configuration options for using object storage in Compliant Kubernetes.
objectStorage
-
is optional
-
Type:
object(Object Storage Secrets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (Object Storage Secrets)
grafana¶
Configure secrets for Grafana.
grafana
-
is optional
-
Type:
object(Grafana Secrets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (Grafana Secrets)
harbor¶
Secret configuration options for Harbor.
harbor
-
is optional
-
Type:
object(Harbor Secret Config) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (Harbor Secret Config)
thanos¶
Secrets for Thanos.
thanos
-
is optional
-
Type:
object(Thanos Secrets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (Thanos Secrets)
user¶
Admin password for user Grafana and user Alertmanager.
user
-
is optional
-
Type:
object(User Secret Config) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (User Secret Config)
opensearch¶
Secrets for OpenSearch.
opensearch
-
is optional
-
Type:
object(OpenSearch Secrets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (OpenSearch Secrets)
kubeapiMetricsPassword¶
kubeapiMetricsPassword
-
is optional
-
Type:
string -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
string
alerts¶
Configure secrets for alerting.
alerts
-
is optional
-
Type:
object(Alerts Secrets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (Alerts Secrets)
kured¶
Notification secrets for Kured (Kubernetes Reboot Daemon).
kured
-
is optional
-
Type:
object(Kured Notification Secrets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (Kured Notification Secrets)
dex¶
Configure secrets for Dex.
dex
-
is optional
-
Type:
object(Dex Secrets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (Dex Secrets)
issuers¶
Configure secrets for issuers.
issuers
-
is optional
-
Type:
object(Issuers Secrets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (Issuers Secrets)
externalDns¶
Configure secrets for External DNS.
externalDns
-
is optional
-
Type:
object(External DNS Secrets) -
cannot be null
-
defined in: Compliant Kubernetes Apps Secrets
TYPE:
object (External DNS Secrets)
Definitions¶
encrypted¶
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/secrets.yaml#/$defs/encrypted"}
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
password¶
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/secrets.yaml#/$defs/password"}
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
token¶
Reference this group by using
{"$ref":"https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/config/schemas/secrets.yaml#/$defs/token"}
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
Generated Sun Jun 16 03:48:27 UTC 2024 from elastisys/compliantkubernetes-apps@main