Thanos Receiver 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/thanos/properties/receiver

Configure Thanos Receiver, the component ingesting metrics collected by Prometheus and storing them in object storage.

Also called ingesting receiver upstream.

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 (Thanos Receiver)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
enabled	`boolean`	Optional	cannot be null	Compliant Kubernetes Apps Config
mode	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
basic_auth	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
subdomain	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
outOfOrderTimeWindow	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
tsdbRetention	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
replicaCount	`number`	Optional	cannot be null	Compliant Kubernetes Apps Config
persistence	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
resources	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
topologySpreadConstraints	`array`	Optional	cannot be null	Compliant Kubernetes Apps Config
affinity	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config

enabled¶

enabled

is optional
Type: boolean (Thanos Receiver Enabled)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

boolean (Thanos Receiver Enabled)

DEFAULTS:

The default value is:

true

mode¶

mode

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

TYPE:

string (Thanos Receiver Mode)

CONSTRAINTS:

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

Value	Explanation
`"standalone"`	Run only the ingesting receiver
`"dual-mode"`	Run both the routing and ingesting receiver

DEFAULTS:

The default value is:

"dual-mode"

basic_auth¶

Configure authentication to Thanos Receiver,

basic_auth

is optional
Type: object (Thanos Receiver Basic Auth)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

object (Thanos Receiver Basic Auth)

subdomain¶

Subdomain of opsDomain that the Ingress to Thanos Receive will be created with.

Note

Must be set for both service and workload clusters.

subdomain

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

TYPE:

string (Thanos Receive Subdomain)

CONSTRAINTS:

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

DEFAULTS:

The default value is:

"thanos-receiver"

outOfOrderTimeWindow¶

outOfOrderTimeWindow

is optional
Type: string (Thanos Out Of Order Time Window)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

string (Thanos Out Of Order Time Window)

DEFAULTS:

The default value is:

"600s"

tsdbRetention¶

tsdbRetention

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

TYPE:

string (Thanos TSDB Retention)

DEFAULTS:

The default value is:

"15d"

replicaCount¶

replicaCount

is optional
Type: number (Thanos Receiver Replcias)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

number (Thanos Receiver Replcias)

DEFAULTS:

The default value is:

persistence¶

Configure persistence for Thanos Receiver.

persistence

is optional
Type: object (Thanos Receiver Persistence)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

object (Thanos Receiver Persistence)

resources¶

Resource requests are used by the kube-scheduler to pick a node to schedule pods on.

Limits are enforced. Resources are commonly 'cpu' and 'memory'.

resources

is optional
Type: object (Kubernetes Resource Requirements)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

object (Kubernetes Resource Requirements)

EXAMPLES:

requests:
  memory: 128Mi
  cpu: 100m
limits:
  memory: 256Mi
  cpu: 250m

topologySpreadConstraints¶

TopologySpreadConstraints describes how pods should spread across topology domains.

topologySpreadConstraints

is optional
Type: an array of merged types (Details)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

an array of merged types (Details)

affinity¶

Affinity is a group of affinity scheduling rules.

affinity

is optional
Type: object (Affinity)
cannot be null
defined in: Compliant Kubernetes Apps Config

TYPE:

object (Affinity)

Return to the root config schema

Generated Sun Jun 23 03:48:25 UTC 2024 from elastisys/compliantkubernetes-apps@main