Thanos Compactor 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/compactor

Configure Thanos Compactor, the component compacting and deduplicating metrics stored by Thanos.

Note

See the upstream documentation for reference.

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 Compactor)

PROPERTIES:

Property	Type	Required	Nullable	Defined by
verticalCompaction	`boolean`	Optional	cannot be null	Compliant Kubernetes Apps Config
deduplication	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
persistence	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config
retentionResolutionRaw	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
retentionResolution5m	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
retentionResolution1h	`string`	Optional	cannot be null	Compliant Kubernetes Apps Config
resources	`object`	Optional	cannot be null	Compliant Kubernetes Apps Config

verticalCompaction¶

When enabled series of metrics from multiple replicas will be merged into one.

verticalCompaction

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

TYPE:

boolean (Thanos Vertical Compactor)

deduplication¶

Configure deduplication of metrics.

deduplication

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

TYPE:

string (Thanos Deduplication)

CONSTRAINTS:

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

Value	Explanation
`"none"`	Disable deduplication of metrics (default).
`"receiverReplicas"`	Enable light deduplication of metrics from different Thanos Receiver replicas.
`"prometheusReplicas"`	Enable heavy deduplication of metrics from different Prometheus replicas.

DEFAULTS:

The default value is:

"none"

persistence¶

Configure persistence for Thanos Compactor.

persistence

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

TYPE:

object (Thanos Compactor Persistence)

retentionResolutionRaw¶

An amount of time

retentionResolutionRaw

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

TYPE:

string (Time Range)

CONSTRAINTS:

pattern: the string must match the following regular expression:

^[0-9]+[hmsd]+$

try pattern

DEFAULTS:

The default value is:

"30d"

EXAMPLES:

300s

72h

3d

retentionResolution5m¶

An amount of time

retentionResolution5m

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

TYPE:

string (Time Range)

CONSTRAINTS:

pattern: the string must match the following regular expression:

^[0-9]+[hmsd]+$

try pattern

DEFAULTS:

The default value is:

"90d"

EXAMPLES:

300s

72h

3d

retentionResolution1h¶

An amount of time

retentionResolution1h

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

TYPE:

string (Time Range)

CONSTRAINTS:

pattern: the string must match the following regular expression:

^[0-9]+[hmsd]+$

try pattern

DEFAULTS:

The default value is:

"0s"

EXAMPLES:

300s

72h

3d

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

Return to the root config schema

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