Thanos 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/thanos
Configuration for Thanos.
Thanos ingests metrics sent from Prometheus in both the service and workload clusters, and stores them in object storage.
This requires that objectStorage is configured, and will use the bucket or container set in objectStorage.buckets.thanos.
Note
Thanos and its components are installed in the service cluster, so this configuration mainly applies there.
| 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 Config)
PROPERTIES:
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| enabled | boolean |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| objectStorage | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| bucketweb | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| compactor | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| queryFrontend | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| query | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| receiveDistributor | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| receiver | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| ruler | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| storegateway | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
| metrics | object |
Optional | cannot be null | Compliant Kubernetes Apps Config |
enabled¶
Note
Must be set for both service and workload cluster.
enabled
-
is optional
-
Type:
boolean(Thanos Enabled) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean (Thanos Enabled)
DEFAULTS:
The default value is:
true
objectStorage¶
Configure Object Storage for Thanos.
Allows for using OpenStack Swift as the object storage backend type.
objectStorage
-
is optional
-
Type:
object(Thanos Object Storage) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Thanos Object Storage)
bucketweb¶
Configure Thanos Bucket Web, the UI to view the state of the bucket or container in use by Thanos.
bucketweb
-
is optional
-
Type:
object(Thanos Bucket Web) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Thanos Bucket Web)
compactor¶
Configure Thanos Compactor, the component compacting and deduplicating metrics stored by Thanos.
Note
See the upstream documentation for reference.
compactor
-
is optional
-
Type:
object(Thanos Compactor) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Thanos Compactor)
queryFrontend¶
Configure Thanos Query Frontend, the component serving query requests from Grafana.
queryFrontend
-
is optional
-
Type:
object(Thanos Query Frontend) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Thanos Query Frontend)
query¶
Configure Thanos Query, the component executing metric queries.
query
-
is optional
-
Type:
object(Thanos Query) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Thanos Query)
receiveDistributor¶
Configure Thanos Receive Distributor, the component serving remote write requests from Prometheus.
Also called routing receiver upstream.
receiveDistributor
-
is optional
-
Type:
object(Thanos Receive Distributor) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Thanos Receive Distributor)
receiver¶
Configure Thanos Receiver, the component ingesting metrics collected by Prometheus and storing them in object storage.
Also called ingesting receiver upstream.
receiver
-
is optional
-
Type:
object(Thanos Receiver) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Thanos Receiver)
ruler¶
Configure Thanos Ruler, the component evaluating alerting and recording rules.
ruler
-
is optional
-
Type:
object(Thanos Ruler) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Thanos Ruler)
storegateway¶
Configure Thanos Store Gateway, the component fetching metrics from object storage.
storegateway
-
is optional
-
Type:
object(Thanos Store Gateway) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Thanos Store Gateway)
metrics¶
Configure metrics collected from Thanos.
metrics
-
is optional
-
Type:
object(Thanos Metrics) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
object (Thanos Metrics)
Return to the root config schema
Generated Sat Jun 22 03:48:20 UTC 2024 from elastisys/compliantkubernetes-apps@main