Global options 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/global

Some common options used in various helm charts.

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 (Global options)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
ck8sVersion	`string`	Required	cannot be null	Compliant Kubernetes Apps Config
ck8sCloudProvider	`string`	Required	cannot be null	Compliant Kubernetes Apps Config
ck8sEnvironmentName	`string`	Required	cannot be null	Compliant Kubernetes Apps Config
ck8sFlavor	`string`	Required	cannot be null	Compliant Kubernetes Apps Config
baseDomain	`string`	Required	cannot be null	Compliant Kubernetes Apps Config
opsDomain	`string`	Required	cannot be null	Compliant Kubernetes Apps Config
scDomain	Merged	Optional	cannot be null	Compliant Kubernetes Apps Config
scOpsDomain	Merged	Optional	cannot be null	Compliant Kubernetes Apps Config
issuer	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
verifyTls	`boolean`	Optional	cannot be null	Compliant Kubernetes Apps Config
clusterDns	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
clusterName	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
clustersMonitoring	`array`	Optional	cannot be null	Compliant Kubernetes Apps Config
containerRuntime	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config

ck8sVersion¶

Use version number if you are exactly at a release tag. Otherwise use full commit hash of current commit. any, can be used to disable this validation.

ck8sVersion

is required
Type: string (Compliant Kubernetes Apps version)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (Compliant Kubernetes Apps version)

EXAMPLES:

v0.42.1

any

424442541a567646c232d949bad1af2b5b7cb885

ck8sCloudProvider¶

ck8sCloudProvider

is required
Type: string
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string

CONSTRAINTS:

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"aws"`
`"azure"`
`"baremetal"`
`"citycloud"`
`"elastx"`
`"exoscale"`
`"none"`
`"safespring"`
`"upcloud"`

ck8sEnvironmentName¶

ck8sEnvironmentName

is required
Type: string (Environment name)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (Environment name)

EXAMPLES:

my-ck8s-cluster

ck8sFlavor¶

ck8sFlavor

is required
Type: string
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string

CONSTRAINTS:

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"prod"`
`"dev"`
`"air-gapped"`

baseDomain¶

Domain intended for ingress usage in the workload cluster and to reach application developer facing services such as Grafana, Harbor and OpenSearch Dashboards. E.g. with 'prod.domain.com', OpenSearch Dashboards is reached via 'opensearch.prod.domain.com'.

baseDomain

is required
Type: string (Base Domain)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (Base Domain)

CONSTRAINTS:

hostname: the string must be a hostname, according to RFC 1123, section 2.1

opsDomain¶

Domain intended for ingress usage in the service cluster and to reach non-user facing services such as Thanos and OpenSearch. E.g. with 'ops.prod.domain.com', OpenSearch is reached via 'opensearch.ops.prod.domain.com'.

opsDomain

is required
Type: string
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string

CONSTRAINTS:

hostname: the string must be a hostname, according to RFC 1123, section 2.1

scDomain¶

If baseDomain for wc and sc are not the same, set the domain of the sc cluster.

scDomain

is optional
Type: string (Details)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (Details)

one (and only one) of

scOpsDomain¶

If opsDomain for wc and sc are not the same, set the ops domain of the sc cluster.

scOpsDomain

is optional
Type: string (Details)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (Details)

one (and only one) of

issuer¶

Default cert-manager issuer to use for issuing certificates for ingresses. Normally one of letsencrypt-staging or letsencrypt-prod.

issuer

is optional
Type: string
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string

CONSTRAINTS:

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"letsencrypt-staging"`
`"letsencrypt-prod"`

DEFAULTS:

The default value is:

"letsencrypt-staging"

verifyTls¶

Verify ingress certificates

verifyTls

is optional
Type: boolean
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

boolean

DEFAULTS:

The default value is:

true

clusterDns¶

IP of the cluster DNS in kubernetes

clusterDns

is optional
Type: string
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string

CONSTRAINTS:

unknown format: the value of this string must follow the format: ip-address

DEFAULTS:

The default value is:

"10.233.0.3"

clusterName¶

clusterName

is optional
Type: string
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string

clustersMonitoring¶

Configure the names of the workload clusters that sends metrics to the service cluster.

Mainly used to filter metrics.

clustersMonitoring

is optional
Type: string[]
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string[]

containerRuntime¶

containerRuntime

is optional
Type: string (Container runtime)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (Container runtime)

CONSTRAINTS:

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"containerd"`
`"docker"`

DEFAULTS:

The default value is:

"containerd"

Return to the root config schema

Generated Sat Jun 22 03:48:20 UTC 2024 from elastisys/compliantkubernetes-apps@main