Chapter 6. monitoring.rhobs/v1alpha1
The resource types are MonitoringStack
and ThanosQuerier.
6.1. MonitoringStack
MonitoringStack
is the Schema for the monitoringstacks API.
Name | Type | Description | Required |
---|---|---|---|
| string |
| true |
| string |
| true |
object |
Refer to the Kubernetes API documentation for the fields of the | true | |
object |
| true | |
object |
| false |
6.2. MonitoringStack.spec
MonitoringStackSpec
is the specification for the desired MonitoringStack
object.
Name | Type | Description | Required |
---|---|---|---|
object |
Define
Default: | false | |
| enum | Set log levels of configured components.
Enum:
Default: | false |
object |
Namespace selector for
| false | |
|
|
Define node selector for | false |
object | Define prometheus config.
Default: | false | |
object |
Label selector for
| false | |
object |
Define resources requests and limits for
Default: | false | |
| string |
Time duration to retain data. The string must match the regular expression
Default: | false |
|
Define tolerations for | false |
6.3. MonitoringStack.spec.alertmanagerConfig
Define Alertmanager
config.
Name | Type | Description | Required |
---|---|---|---|
| boolean |
Disables the deployment of Default: false | false |
object |
Configure TLS options for the | false |
6.4. MonitoringStack.spec.alertmanagerConfig.webTLSConfig
Configure TLS options for the Alertmanager
web server.
Name | Type | Description | Required |
---|---|---|---|
object | Reference to the TLS public certificate for the web server. | true | |
object | Reference to the root Certificate Authority used to verify the web server’s certificate. | true | |
object | Reference to the TLS private key for the web server. | true |
6.5. MonitoringStack.spec.alertmanagerConfig.webTLSConfig.certificate
Reference to the TLS public certificate for the web server.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | The name of the secret in the object’s namespace to select from. | true |
6.6. MonitoringStack.spec.alertmanagerConfig.webTLSConfig.certificateAuthority
Reference to the root Certificate Authority used to verify the web server’s certificate.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | The name of the secret in the object’s namespace to select from. | true |
6.7. MonitoringStack.spec.alertmanagerConfig.webTLSConfig.privateKey
Reference to the TLS private key for the web server.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | The name of the secret in the object’s namespace to select from. | true |
6.8. MonitoringStack.spec.namespaceSelector
Namespace selector for MonitoringStack
resources.
-
To monitor everything, set to empty map selector. For example,
namespaceSelector: {}
. -
To monitor resources in the namespace where the
MonitoringStack
instance was created, set to null. For example,namespaceSelector:
.
Name | Type | Description | Required |
---|---|---|---|
|
| false | |
|
|
| false |
6.9. MonitoringStack.spec.namespaceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
| string |
| true |
| string |
| true |
|
|
| false |
6.10. MonitoringStack.spec.prometheusConfig
Define Prometheus configuration.
Name | Type | Description | Required |
---|---|---|---|
| boolean |
Enable Prometheus to accept OpenTelemetry Metrics via the | false |
| boolean |
Enable Prometheus to be used as a receiver for the Prometheus remote write protocol. Defaults to the value of | false |
|
|
Define | false |
object | Define persistent volume claim for Prometheus. | false | |
| Define remote write for Prometheus. | false | |
| integer | Number of replicas/pods to deploy for a Prometheus deployment. Format: int32 Default: 2 Minimum: 0 | false |
| string | Default interval between scrapes. | false |
object | Configure TLS options for the Prometheus web server. | false |
6.11. MonitoringStack.spec.prometheusConfig.persistentVolumeClaim
Define persistent volume claim for Prometheus.
Name | Type | Description | Required |
---|---|---|---|
|
|
| false |
object |
If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source.
When the | false | |
object |
When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the
For backwards compatibility, when
There are three important differences between
Beta: Using this field requires the
Alpha: Using the namespace field of | false | |
object |
If For more information, see Kubernetes Docs | false | |
object |
| false | |
| string |
| false |
| string |
If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding
If unspecified and the For more information, see Kubernetes Docs
Beta: Using this field requires the | false |
| string |
| false |
| string |
| false |
6.12. MonitoringStack.spec.prometheusConfig.persistentVolumeClaim.dataSource
dataSource
field can be used to specify either:
-
An existing
VolumeSnapshot
object (snapshot.storage.k8s.io/VolumeSnapshot
) - An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource
feature gate is enabled, dataSource
contents will be copied to dataSourceRef
, and dataSourceRef
contents will be copied to dataSource
when dataSourceRef.namespace
is not specified. If the namespace is specified, then dataSourceRef
will not be copied to dataSource
.
Name | Type | Description | Required |
---|---|---|---|
| string |
| true |
| string |
| true |
| string |
| false |
6.13. MonitoringStack.spec.prometheusConfig.persistentVolumeClaim.dataSourceRef
dataSourceRef
specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim
object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner.
This field will replace the functionality of the dataSource
field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace
isn’t specified in dataSourceRef
, both fields (dataSource
and dataSourceRef
) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace
is specified in dataSourceRef
, dataSource
isn’t set to the same value and must be empty.
There are three important differences between dataSource
and dataSourceRef
:
-
While
dataSource
only allows two specific types of objects,dataSourceRef
allows any non-core object, as well asPersistentVolumeClaim
objects. -
While
dataSource
ignores disallowed values (dropping them),dataSourceRef
preserves all values, and generates an error if a disallowed value is specified. -
While
dataSource
only allows local objects,dataSourceRef
allows objects in any namespaces.
Beta: Using this field requires the AnyVolumeDataSource
feature gate to be enabled.
Alpha: Using the namespace field of dataSourceRef
requires the CrossNamespaceVolumeDataSource
feature gate to be enabled.
Name | Type | Description | Required |
---|---|---|---|
| string |
| true |
| string |
| true |
| string |
If | false |
| string |
Note that when a namespace is specified, a
Alpha: This field requires the | false |
6.14. MonitoringStack.spec.prometheusConfig.persistentVolumeClaim.resources
resources
represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure
feature is enabled users are allowed to specify resource requirements that are lower than the previous value but must still be higher than the capacity recorded in the status field of the claim.
For more information, see Kubernetes Docs
Name | Type | Description | Required |
---|---|---|---|
|
|
For more information, see Kubernetes Docs | false |
|
|
If For more information, see Kubernetes Docs | false |
6.15. MonitoringStack.spec.prometheusConfig.persistentVolumeClaim.selector
selector
is a label query over volumes to consider for binding.
Name | Type | Description | Required |
---|---|---|---|
|
| false | |
|
|
A single {key,value} in the | false |
6.16. MonitoringStack.spec.prometheusConfig.persistentVolumeClaim.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
| string |
| true |
| string |
| true |
|
|
If the operator is | false |
6.17. MonitoringStack.spec.prometheusConfig.remoteWrite[index]
RemoteWriteSpec
defines the configuration to write samples from Prometheus to a remote endpoint.
Name | Type | Description | Required |
---|---|---|---|
| string | The URL of the endpoint to send samples to. | true |
object | Authorization section for the URL.
| false | |
object | AzureAD for the URL.
| false | |
object | BasicAuth configuration for the URL.
| false | |
| string |
Warning: this field should not be used because the token value appears in clear-text. Prefer using Deprecated: this will be removed in a future release. | false |
| string | File from which to read bearer token for the URL.
Deprecated: this will be removed in a future release. Prefer using | false |
| boolean | Whether to enable HTTP2. | false |
| boolean | Configure whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.26.0. | false |
|
| Custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can’t be overwritten. It requires Prometheus >= v2.25.0. | false |
| enum | The Remote Write message’s version to use when writing to the endpoint.
Enum: | false |
object |
| false | |
| string | The name of the remote write queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate queues. It requires Prometheus >= v2.15.0. | false |
| string |
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. | false |
object | OAuth2 configuration for the URL.
| false | |
|
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. | false | |
| boolean |
Whether to use the proxy configuration defined by environment variables ( It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. | false |
| string |
| false |
object |
| false | |
| string | Timeout for requests to the remote write endpoint. | false |
| boolean |
Enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the It requires Prometheus >= v2.27.0. | false |
| boolean | Enables sending of native histograms, also known as sparse histograms over remote write. It requires Prometheus >= v2.40.0. | false |
object |
| false | |
object | TLS Config to use for the URL. | false | |
| The list of remote write relabel configurations. | false |
6.18. MonitoringStack.spec.prometheusConfig.remoteWrite[index].authorization
Authorization section for the URL.
- It requires Prometheus >= v2.26.0.
-
Cannot be set at the same time as
sigv4
,basicAuth
,oauth2
, orazureAd
.
Name | Type | Description | Required |
---|---|---|---|
object | Selects a key of a Secret in the namespace that contains the credentials for authentication. | false | |
| string |
File to read a secret from, mutually exclusive with | false |
| string | Defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" | false |
6.19. MonitoringStack.spec.prometheusConfig.remoteWrite[index].authorization.credentials
Selects a key of a Secret in the namespace that contains the credentials for authentication.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.20. MonitoringStack.spec.prometheusConfig.remoteWrite[index].azureAd
AzureAD for the URL.
- It requires Prometheus >= v2.45.0.
-
Cannot be set at the same time as
authorization
,basicAuth
,oauth2
, orsigv4
.
Name | Type | Description | Required |
---|---|---|---|
| enum | The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.
Enum: | false |
object |
| false | |
object |
| false | |
object |
| false |
6.21. MonitoringStack.spec.prometheusConfig.remoteWrite[index].azureAd.managedIdentity
ManagedIdentity defines the Azure User-assigned Managed identity.
-
Cannot be set at the same time as
oauth
orsdk
.
Name | Type | Description | Required |
---|---|---|---|
| string | The client id | true |
6.22. MonitoringStack.spec.prometheusConfig.remoteWrite[index].azureAd.oauth
OAuth
defines the oauth config that is being used to authenticate.
-
Cannot be set at the same time as
managedIdentity
orsdk
. - It requires Prometheus >= v2.48.0.
Name | Type | Description | Required |
---|---|---|---|
| string |
| true |
object |
| true | |
| string |
| true |
6.23. MonitoringStack.spec.prometheusConfig.remoteWrite[index].azureAd.oauth.clientSecret
clientSecret
specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.24. MonitoringStack.spec.prometheusConfig.remoteWrite[index].azureAd.sdk
SDK
defines the Azure SDK config that is being used to authenticate.
For more information, see Azure SDK Authentication.
-
Cannot be set at the same time as
oauth
ormanagedIdentity
. - It requires Prometheus >= 2.52.0.
Name | Type | Description | Required |
---|---|---|---|
| string |
| false |
6.25. MonitoringStack.spec.prometheusConfig.remoteWrite[index].basicAuth
BasicAuth configuration for the URL.
-
Cannot be set at the same time as
sigv4
,authorization
,oauth2
, orazureAd
.
Name | Type | Description | Required |
---|---|---|---|
object |
| false | |
object |
| false |
6.26. MonitoringStack.spec.prometheusConfig.remoteWrite[index].basicAuth.password
password
specifies a key of a Secret containing the password for authentication.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.27. MonitoringStack.spec.prometheusConfig.remoteWrite[index].basicAuth.username
username
specifies a key of a Secret containing the username for authentication.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.28. MonitoringStack.spec.prometheusConfig.remoteWrite[index].metadataConfig
MetadataConfig
configures the sending of series metadata to the remote storage.
Name | Type | Description | Required |
---|---|---|---|
| boolean | Defines whether metric metadata is sent to the remote storage or not. | false |
| string | Defines how frequently metric metadata is sent to the remote storage. | false |
6.29. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2
OAuth2 configuration for the URL.
- It requires Prometheus >= v2.27.0.
-
Cannot be set at the same time as
sigv4
,authorization
,basicAuth
, orazureAd
.
Name | Type | Description | Required |
---|---|---|---|
object |
| true | |
object |
| true | |
| string |
| true |
|
|
| false |
| string |
It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. | false |
|
ProxyConnectHeader optionally specifies headers to send to proxies during It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. | false | |
| boolean |
Whether to use the proxy configuration defined by environment variables ( It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. | false |
| string |
| false |
|
|
| false |
object | TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. | false |
6.30. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.clientId
clientId
specifies a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Name | Type | Description | Required |
---|---|---|---|
object | ConfigMap containing data to use for the targets. | false | |
object | Secret containing data to use for the targets. | false |
6.31. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.clientId.configMap
ConfigMap containing data to use for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key to select. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the ConfigMap or its key must be defined | false |
6.32. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.clientId.secret
Secret containing data to use for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.33. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.clientSecret
clientSecret
specifies a key of a Secret containing the OAuth2 client’s secret.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.34. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.proxyConnectHeader[key][index]
SecretKeySelector selects a key of a Secret.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.35. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.tlsConfig
TLS configuration to use when connecting to the OAuth2 server.
- It requires Prometheus >= v2.43.0.
Name | Type | Description | Required |
---|---|---|---|
object | Certificate authority used when verifying server certificates. | false | |
object | Client certificate to present when doing client-authentication. | false | |
| boolean | Disable target certificate validation. | false |
object | Secret containing the client key file for the targets. | false | |
| enum | Maximum acceptable TLS version. It requires Prometheus >= v2.41.0.
Enum: | false |
| enum | Minimum acceptable TLS version. It requires Prometheus >= v2.35.0.
Enum: | false |
| string | Used to verify the hostname for the targets. | false |
6.36. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.tlsConfig.ca
Certificate authority used when verifying server certificates.
Name | Type | Description | Required |
---|---|---|---|
object | ConfigMap containing data to use for the targets. | false | |
object | Secret containing data to use for the targets. | false |
6.37. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key to select. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the ConfigMap or its key must be defined | false |
6.38. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.tlsConfig.ca.secret
Secret containing data to use for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.39. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.tlsConfig.cert
Client certificate to present when doing client-authentication.
Name | Type | Description | Required |
---|---|---|---|
object | ConfigMap containing data to use for the targets. | false | |
object | Secret containing data to use for the targets. | false |
6.40. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key to select. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the ConfigMap or its key must be defined | false |
6.41. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.tlsConfig.cert.secret
Secret containing data to use for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.42. MonitoringStack.spec.prometheusConfig.remoteWrite[index].oauth2.tlsConfig.keySecret
Secret containing the client key file for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.43. MonitoringStack.spec.prometheusConfig.remoteWrite[index].proxyConnectHeader[key][index]
SecretKeySelector selects a key of a Secret.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.44. MonitoringStack.spec.prometheusConfig.remoteWrite[index].queueConfig
QueueConfig allows tuning of the remote write queue parameters.
Name | Type | Description | Required |
---|---|---|---|
| string |
| false |
| integer |
| false |
| string |
| false |
| integer |
| false |
| integer |
| false |
| integer |
| false |
| string |
| false |
| integer |
| false |
| boolean | Retry upon receiving a 429 status code from the remote-write storage. This is an experimental feature, it may change in any upcoming release in a breaking way. | false |
| string |
It requires Prometheus >= v2.50.0. | false |
6.45. MonitoringStack.spec.prometheusConfig.remoteWrite[index].sigv4
Sigv4 allows to configures AWS’s Signature Verification 4 for the URL.
- It requires Prometheus >= v2.26.0.
-
Cannot be set at the same time as
authorization
,basicAuth
,oauth2
, orazureAd
.
Name | Type | Description | Required |
---|---|---|---|
object |
| false | |
| string |
| false |
| string |
| false |
| string |
| false |
object |
| false |
6.46. MonitoringStack.spec.prometheusConfig.remoteWrite[index].sigv4.accessKey
AccessKey
is the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID
is used.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.47. MonitoringStack.spec.prometheusConfig.remoteWrite[index].sigv4.secretKey
SecretKey
is the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY
is used.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.48. MonitoringStack.spec.prometheusConfig.remoteWrite[index].tlsConfig
TLS Config to use for the URL.
Name | Type | Description | Required |
---|---|---|---|
object | Certificate authority used when verifying server certificates. | false | |
| string | Path to the CA cert in the Prometheus container to use for the targets. | false |
object | Client certificate to present when doing client-authentication. | false | |
| string | Path to the client cert file in the Prometheus container for the targets. | false |
| boolean | Disable target certificate validation. | false |
| string | Path to the client key file in the Prometheus container for the targets. | false |
object | Secret containing the client key file for the targets. | false | |
| enum | Maximum acceptable TLS version. It requires Prometheus >= v2.41.0.
Enum: | false |
| enum | Minimum acceptable TLS version. It requires Prometheus >= v2.35.0.
Enum: | false |
| string | Used to verify the hostname for the targets. | false |
6.49. MonitoringStack.spec.prometheusConfig.remoteWrite[index].tlsConfig.ca
Certificate authority used when verifying server certificates.
Name | Type | Description | Required |
---|---|---|---|
object | ConfigMap containing data to use for the targets. | false | |
object | Secret containing data to use for the targets. | false |
6.50. MonitoringStack.spec.prometheusConfig.remoteWrite[index].tlsConfig.ca.configMap
ConfigMap containing data to use for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key to select. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the ConfigMap or its key must be defined | false |
6.51. MonitoringStack.spec.prometheusConfig.remoteWrite[index].tlsConfig.ca.secret
Secret containing data to use for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.52. MonitoringStack.spec.prometheusConfig.remoteWrite[index].tlsConfig.cert
Client certificate to present when doing client-authentication.
Name | Type | Description | Required |
---|---|---|---|
object | ConfigMap containing data to use for the targets. | false | |
object | Secret containing data to use for the targets. | false |
6.53. MonitoringStack.spec.prometheusConfig.remoteWrite[index].tlsConfig.cert.configMap
ConfigMap containing data to use for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key to select. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the ConfigMap or its key must be defined | false |
6.54. MonitoringStack.spec.prometheusConfig.remoteWrite[index].tlsConfig.cert.secret
Secret containing data to use for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.55. MonitoringStack.spec.prometheusConfig.remoteWrite[index].tlsConfig.keySecret
Secret containing the client key file for the targets.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. For more information, see Kubernetes Docs | false |
| boolean | Specify whether the Secret or its key must be defined | false |
6.56. MonitoringStack.spec.prometheusConfig.remoteWrite[index].writeRelabelConfigs[index]
RelabelConfig allows dynamic rewriting of the label set for targets, alerts, scraped samples and remote write samples.
For more information, see Prometheus Docs
Name | Type | Description | Required |
---|---|---|---|
| enum | Action to perform based on the regex matching.
Enum:
Default: | false |
| integer | Modulus to take of the hash of the source label values.
Only applicable when the action is Format: int64 | false |
| string | Regular expression against which the extracted value is matched. | false |
| string | Replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. | false |
| string |
| false |
|
| The source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. | false |
| string | Label to which the resulting string is written in a replacement.
It is mandatory for Regex capture groups are available. | false |
6.57. MonitoringStack.spec.prometheusConfig.webTLSConfig
Configure TLS options for the Prometheus web server.
Name | Type | Description | Required |
---|---|---|---|
object | Reference to the TLS public certificate for the web server. | true | |
object | Reference to the root Certificate Authority used to verify the web server’s certificate. | true | |
object | Reference to the TLS private key for the web server. | true |
6.58. MonitoringStack.spec.prometheusConfig.webTLSConfig.certificate
Reference to the TLS public certificate for the web server.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | The name of the secret in the object’s namespace to select from. | true |
6.59. MonitoringStack.spec.prometheusConfig.webTLSConfig.certificateAuthority
Reference to the root Certificate Authority used to verify the web server’s certificate.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | The name of the secret in the object’s namespace to select from. | true |
6.60. MonitoringStack.spec.prometheusConfig.webTLSConfig.privateKey
Reference to the TLS private key for the web server.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | The name of the secret in the object’s namespace to select from. | true |
6.61. MonitoringStack.spec.resourceSelector
Label selector for MonitoringStack
resources.
-
To monitor everything, set to empty map selector. For example,
resourceSelector: {}
. -
To disable service discovery, set to null. For example,
resourceSelector:
.
Name | Type | Description | Required |
---|---|---|---|
|
| false | |
|
|
| false |
6.62. MonitoringStack.spec.resourceSelector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
| string |
| true |
| string |
| true |
|
|
| false |
6.63. MonitoringStack.spec.resources
Define resources requests and limits for MonitoringStack
pods.
Name | Type | Description | Required |
---|---|---|---|
|
This is an alpha field and requires enabling the This field is immutable. It can only be set for containers. | false | |
|
|
For more information, see Kubernetes Docs | false |
|
|
For more information, see Kubernetes Docs | false |
6.64. MonitoringStack.spec.resources.claims[index]
ResourceClaim
references one entry in PodSpec.ResourceClaims
.
Name | Type | Description | Required |
---|---|---|---|
| string |
| true |
| string |
| false |
6.65. MonitoringStack.spec.tolerations[index]
The pod this Toleration
is attached to tolerates any taint that matches the triple <key,value,effect>
using the matching operator <operator>
.
Name | Type | Description | Required |
---|---|---|---|
| string |
| false |
| string |
| false |
| string |
| false |
| integer |
Format: int64 | false |
| string |
| false |
6.66. MonitoringStack.status
MonitoringStackStatus
defines the observed state of the MonitoringStack
instance. It should always be reconstructable from the state of the cluster and/or outside world.
Name | Type | Description | Required |
---|---|---|---|
|
| true |
6.67. MonitoringStack.status.conditions[index]
Name | Type | Description | Required |
---|---|---|---|
| string |
Format: date-time | true |
| string |
| true |
| string |
| true |
| enum | status of the condition
Enum: | true |
| string |
| true |
| integer |
Format: int64 Minimum: 0 | false |
6.68. ThanosQuerier
ThanosQuerier outlines the Thanos querier components, managed by this stack
Name | Type | Description | Required |
---|---|---|---|
| string |
| true |
| string |
| true |
object |
Refer to the Kubernetes API documentation for the fields of the | true | |
object |
| false | |
| object |
| false |
6.69. ThanosQuerier.spec
ThanosQuerierSpec
defines a single Thanos Querier instance. This means a label selector by which MonitoringStack
instances to query are selected, and an optional namespace selector and a list of replica labels by which to deduplicate.
Name | Type | Description | Required |
---|---|---|---|
object | Selector to select monitoring stacks to unify. | true | |
object |
Selector to select which namespaces the | false | |
|
| false | |
object | Configure TLS options for the Thanos web server. | false |
6.70. ThanosQuerier.spec.selector
Selector to select monitoring stacks to unify.
Name | Type | Description | Required |
---|---|---|---|
|
| false | |
|
|
| false |
6.71. ThanosQuerier.spec.selector.matchExpressions[index]
A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
Name | Type | Description | Required |
---|---|---|---|
| string |
| true |
| string |
| true |
|
|
| false |
6.72. ThanosQuerier.spec.namespaceSelector
Selector to select which namespaces the MonitoringStack
objects are discovered from.
Name | Type | Description | Required |
---|---|---|---|
| boolean | Boolean describing whether all namespaces are selected in contrast to a list restricting them. | false |
|
| List of namespace names. | false |
6.73. ThanosQuerier.spec.webTLSConfig
Configure TLS options for the Thanos web server.
Name | Type | Description | Required |
---|---|---|---|
object | Reference to the TLS public certificate for the web server. | true | |
object | Reference to the root Certificate Authority used to verify the web server’s certificate. | true | |
object | Reference to the TLS private key for the web server. | true |
6.74. ThanosQuerier.spec.webTLSConfig.certificate
Reference to the TLS public certificate for the web server.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | The name of the secret in the object’s namespace to select from. | true |
6.75. ThanosQuerier.spec.webTLSConfig.certificateAuthority
Reference to the root Certificate Authority used to verify the web server’s certificate.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | The name of the secret in the object’s namespace to select from. | true |
6.76. ThanosQuerier.spec.webTLSConfig.privateKey
Reference to the TLS private key for the web server.
Name | Type | Description | Required |
---|---|---|---|
| string | The key of the secret to select from. Must be a valid secret key. | true |
| string | The name of the secret in the object’s namespace to select from. | true |