Chapter 4. AlertRelabelConfig [monitoring.openshift.io/v1] Description AlertRelabelConfig defines a set of relabel configs for alerts. Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer). Type object Required spec 4.1. Specification Property Type Description apiVersion string APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources kind string Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds metadata ObjectMeta Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata spec object spec describes the desired state of this AlertRelabelConfig object. status object status describes the current state of this AlertRelabelConfig object. 4.1.1. .spec Description spec describes the desired state of this AlertRelabelConfig object. Type object Required configs Property Type Description configs array configs is a list of sequentially evaluated alert relabel configs. configs[] object RelabelConfig allows dynamic rewriting of label sets for alerts. See Prometheus documentation: - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config 4.1.2. .spec.configs Description configs is a list of sequentially evaluated alert relabel configs. Type array 4.1.3. .spec.configs[] Description RelabelConfig allows dynamic rewriting of label sets for alerts. See Prometheus documentation: - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs - https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config Type object Property Type Description action string action to perform based on regex matching. Must be one of: 'Replace', 'Keep', 'Drop', 'HashMod', 'LabelMap', 'LabelDrop', or 'LabelKeep'. Default is: 'Replace' modulus integer modulus to take of the hash of the source label values. This can be combined with the 'HashMod' action to set 'target_label' to the 'modulus' of a hash of the concatenated 'source_labels'. This is only valid if sourceLabels is not empty and action is not 'LabelKeep' or 'LabelDrop'. regex string regex against which the extracted value is matched. Default is: '(.*)' regex is required for all actions except 'HashMod' replacement string replacement value against which a regex replace is performed if the regular expression matches. This is required if the action is 'Replace' or 'LabelMap' and forbidden for actions 'LabelKeep' and 'LabelDrop'. Regex capture groups are available. Default is: 'USD1' separator string separator placed between concatenated source label values. When omitted, Prometheus will use its default value of ';'. sourceLabels array (string) sourceLabels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the 'Replace', 'Keep', and 'Drop' actions. Not allowed for actions 'LabelKeep' and 'LabelDrop'. targetLabel string targetLabel to which the resulting value is written in a 'Replace' action. It is required for 'Replace' and 'HashMod' actions and forbidden for actions 'LabelKeep' and 'LabelDrop'. Regex capture groups are available. 4.1.4. .status Description status describes the current state of this AlertRelabelConfig object. Type object Property Type Description conditions array conditions contains details on the state of the AlertRelabelConfig, may be empty. conditions[] object Condition contains details for one aspect of the current state of this API Resource. 4.1.5. .status.conditions Description conditions contains details on the state of the AlertRelabelConfig, may be empty. Type array 4.1.6. .status.conditions[] Description Condition contains details for one aspect of the current state of this API Resource. Type object Required lastTransitionTime message reason status type Property Type Description lastTransitionTime string lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. message string message is a human readable message indicating details about the transition. This may be an empty string. observedGeneration integer observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. reason string reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. status string status of the condition, one of True, False, Unknown. type string type of condition in CamelCase or in foo.example.com/CamelCase. 4.2. API endpoints The following API endpoints are available: /apis/monitoring.openshift.io/v1/alertrelabelconfigs GET : list objects of kind AlertRelabelConfig /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs DELETE : delete collection of AlertRelabelConfig GET : list objects of kind AlertRelabelConfig POST : create an AlertRelabelConfig /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name} DELETE : delete an AlertRelabelConfig GET : read the specified AlertRelabelConfig PATCH : partially update the specified AlertRelabelConfig PUT : replace the specified AlertRelabelConfig /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name}/status GET : read status of the specified AlertRelabelConfig PATCH : partially update status of the specified AlertRelabelConfig PUT : replace status of the specified AlertRelabelConfig 4.2.1. /apis/monitoring.openshift.io/v1/alertrelabelconfigs HTTP method GET Description list objects of kind AlertRelabelConfig Table 4.1. HTTP responses HTTP code Reponse body 200 - OK AlertRelabelConfigList schema 401 - Unauthorized Empty 4.2.2. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs HTTP method DELETE Description delete collection of AlertRelabelConfig Table 4.2. HTTP responses HTTP code Reponse body 200 - OK Status schema 401 - Unauthorized Empty HTTP method GET Description list objects of kind AlertRelabelConfig Table 4.3. HTTP responses HTTP code Reponse body 200 - OK AlertRelabelConfigList schema 401 - Unauthorized Empty HTTP method POST Description create an AlertRelabelConfig Table 4.4. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 4.5. Body parameters Parameter Type Description body AlertRelabelConfig schema Table 4.6. HTTP responses HTTP code Reponse body 200 - OK AlertRelabelConfig schema 201 - Created AlertRelabelConfig schema 202 - Accepted AlertRelabelConfig schema 401 - Unauthorized Empty 4.2.3. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name} Table 4.7. Global path parameters Parameter Type Description name string name of the AlertRelabelConfig HTTP method DELETE Description delete an AlertRelabelConfig Table 4.8. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed Table 4.9. HTTP responses HTTP code Reponse body 200 - OK Status schema 202 - Accepted Status schema 401 - Unauthorized Empty HTTP method GET Description read the specified AlertRelabelConfig Table 4.10. HTTP responses HTTP code Reponse body 200 - OK AlertRelabelConfig schema 401 - Unauthorized Empty HTTP method PATCH Description partially update the specified AlertRelabelConfig Table 4.11. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 4.12. HTTP responses HTTP code Reponse body 200 - OK AlertRelabelConfig schema 401 - Unauthorized Empty HTTP method PUT Description replace the specified AlertRelabelConfig Table 4.13. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 4.14. Body parameters Parameter Type Description body AlertRelabelConfig schema Table 4.15. HTTP responses HTTP code Reponse body 200 - OK AlertRelabelConfig schema 201 - Created AlertRelabelConfig schema 401 - Unauthorized Empty 4.2.4. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertrelabelconfigs/{name}/status Table 4.16. Global path parameters Parameter Type Description name string name of the AlertRelabelConfig HTTP method GET Description read status of the specified AlertRelabelConfig Table 4.17. HTTP responses HTTP code Reponse body 200 - OK AlertRelabelConfig schema 401 - Unauthorized Empty HTTP method PATCH Description partially update status of the specified AlertRelabelConfig Table 4.18. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 4.19. HTTP responses HTTP code Reponse body 200 - OK AlertRelabelConfig schema 401 - Unauthorized Empty HTTP method PUT Description replace status of the specified AlertRelabelConfig Table 4.20. Query parameters Parameter Type Description dryRun string When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed fieldValidation string fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. Table 4.21. Body parameters Parameter Type Description body AlertRelabelConfig schema Table 4.22. HTTP responses HTTP code Reponse body 200 - OK AlertRelabelConfig schema 201 - Created AlertRelabelConfig schema 401 - Unauthorized Empty

Commands: