{ "description": "SLO is the Schema for the SLOs API. Resource manages Grafana SLOs. Official documentation https://grafana.com/docs/grafana-cloud/alerting-and-irm/slo/API documentation https://grafana.com/docs/grafana-cloud/alerting-and-irm/slo/api/Additional Information On Alerting Rule Annotations and Labels https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/#templating/", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": "string" }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": "string" }, "metadata": { "type": "object" }, "spec": { "description": "SLOSpec defines the desired state of SLO", "properties": { "deletionPolicy": { "default": "Delete", "description": "DeletionPolicy specifies what will happen to the underlying external\nwhen this managed resource is deleted - either \"Delete\" or \"Orphan\" the\nexternal resource.\nThis field is planned to be deprecated in favor of the ManagementPolicies\nfield in a future release. Currently, both could be set independently and\nnon-default values would be honored if the feature flag is enabled.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223", "enum": [ "Orphan", "Delete" ], "type": "string" }, "forProvider": { "properties": { "alerting": { "description": "term error budget burn is very high, the\nlong-term error budget burn rate is high, or when the remaining\nerror budget is below a certain threshold. Annotations and Labels support templating. (see below for nested schema)\nConfigures the alerting rules that will be generated for each\ntime window associated with the SLO. Grafana SLOs can generate\nalerts when the short-term error budget burn is very high, the\nlong-term error budget burn rate is high, or when the remaining\nerror budget is below a certain threshold. Annotations and Labels support templating.", "items": { "properties": { "advancedOptions": { "description": "(Block List, Max: 1) Advanced Options for Alert Rules (see below for nested schema)\nAdvanced Options for Alert Rules", "items": { "properties": { "minFailures": { "description": "(Number) Minimum number of failed events to trigger an alert\nMinimum number of failed events to trigger an alert", "type": "number" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "annotation": { "description": "(Block List) Annotations will be attached to all alerts generated by any of these rules. (see below for nested schema)\nAnnotations will be attached to all alerts generated by any of these rules.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "fastburn": { "description": "(Block List, Max: 1) Alerting Rules generated for Fast Burn alerts (see below for nested schema)\nAlerting Rules generated for Fast Burn alerts", "items": { "properties": { "annotation": { "description": "(Block List) Annotations will be attached to all alerts generated by any of these rules. (see below for nested schema)\nAnnotations to attach only to Fast Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nLabels to attach only to Fast Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nLabels will be attached to all alerts generated by any of these rules.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "slowburn": { "description": "(Block List, Max: 1) Alerting Rules generated for Slow Burn alerts (see below for nested schema)\nAlerting Rules generated for Slow Burn alerts", "items": { "properties": { "annotation": { "description": "(Block List) Annotations will be attached to all alerts generated by any of these rules. (see below for nested schema)\nAnnotations to attach only to Slow Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nLabels to attach only to Slow Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "description": { "description": "text field that can provide more context to an SLO.\nDescription is a free-text field that can provide more context to an SLO.", "type": "string" }, "destinationDatasource": { "description": "(Block List, Min: 1, Max: 1) Destination Datasource sets the datasource defined for an SLO (see below for nested schema)\nDestination Datasource sets the datasource defined for an SLO", "items": { "properties": { "ref": { "description": "Reference to a DataSource in oss to populate uid.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "policy": { "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "selector": { "description": "Selector for a DataSource in oss to populate uid.", "properties": { "matchControllerRef": { "description": "MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected.", "type": "boolean" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "MatchLabels ensures an object with matching labels is selected.", "type": "object" }, "policy": { "description": "Policies for selection.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "uid": { "description": "(String) UID for the Datasource\nUID for the Datasource", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "folderUid": { "description": "(String) UID for the SLO folder\nUID for the SLO folder", "type": "string" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nAdditional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - \"^[a-zA-Z_][a-zA-Z0-9_]*$\"", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "name": { "description": "(String) Name should be a short description of your indicator. Consider names like \"API Availability\"\nName should be a short description of your indicator. Consider names like \"API Availability\"", "type": "string" }, "objectives": { "description": "(Block List, Min: 1) Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget. (see below for nested schema)\nOver each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.", "items": { "properties": { "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nValue between 0 and 1. If the value of the query is above the objective, the SLO is met.", "type": "number" }, "window": { "description": "parsable time duration string like 24h, 60m. This is the time window the objective is measured over.\nA Prometheus-parsable time duration string like 24h, 60m. This is the time window the objective is measured over.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "query": { "description": "(Block List, Min: 1) Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported. (see below for nested schema)\nQuery describes the indicator that will be measured against the objective. Freeform Query types are currently supported.", "items": { "properties": { "freeform": { "description": "(Block List, Max: 1) (see below for nested schema)", "items": { "properties": { "query": { "description": "(Block List, Min: 1) Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported. (see below for nested schema)\nFreeform Query Field - valid promQl", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "grafanaQueries": { "description": "(Block List, Max: 1) Array for holding a set of grafana queries (see below for nested schema)\nArray for holding a set of grafana queries", "items": { "properties": { "grafanaQueries": { "description": "(Block List, Max: 1) Array for holding a set of grafana queries (see below for nested schema)\nQuery Object - Array of Grafana Query JSON objects", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "ratio": { "description": "(Block List, Max: 1) (see below for nested schema)", "items": { "properties": { "groupByLabels": { "description": "label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - \"^[a-zA-Z_][a-zA-Z0-9_]*$\"\nDefines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - \"^[a-zA-Z_][a-zA-Z0-9_]*$\"", "items": { "type": "string" }, "type": "array" }, "successMetric": { "description": "(String) Counter metric for success events (numerator)\nCounter metric for success events (numerator)", "type": "string" }, "totalMetric": { "description": "(String) Metric for total events (denominator)\nMetric for total events (denominator)", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "type": { "description": "(String) Query type must be one of: \"freeform\", \"query\", \"ratio\", \"grafana_queries\" or \"threshold\"\nQuery type must be one of: \"freeform\", \"query\", \"ratio\", \"grafana_queries\" or \"threshold\"", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "searchExpression": { "description": "(String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.\nThe name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.", "type": "string" }, "uuid": { "description": "(String) UUID for the SLO. Custom UUIDs can be set. If not provided, a random UUID will be generated by the API.\nUUID for the SLO. Custom UUIDs can be set. If not provided, a random UUID will be generated by the API.", "type": "string" } }, "type": "object", "additionalProperties": false }, "initProvider": { "description": "THIS IS A BETA FIELD. It will be honored\nunless the Management Policies feature flag is disabled.\nInitProvider holds the same fields as ForProvider, with the exception\nof Identifier and other resource reference fields. The fields that are\nin InitProvider are merged into ForProvider when the resource is created.\nThe same fields are also added to the terraform ignore_changes hook, to\navoid updating them after creation. This is useful for fields that are\nrequired on creation, but we do not desire to update them after creation,\nfor example because of an external controller is managing them, like an\nautoscaler.", "properties": { "alerting": { "description": "term error budget burn is very high, the\nlong-term error budget burn rate is high, or when the remaining\nerror budget is below a certain threshold. Annotations and Labels support templating. (see below for nested schema)\nConfigures the alerting rules that will be generated for each\ntime window associated with the SLO. Grafana SLOs can generate\nalerts when the short-term error budget burn is very high, the\nlong-term error budget burn rate is high, or when the remaining\nerror budget is below a certain threshold. Annotations and Labels support templating.", "items": { "properties": { "advancedOptions": { "description": "(Block List, Max: 1) Advanced Options for Alert Rules (see below for nested schema)\nAdvanced Options for Alert Rules", "items": { "properties": { "minFailures": { "description": "(Number) Minimum number of failed events to trigger an alert\nMinimum number of failed events to trigger an alert", "type": "number" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "annotation": { "description": "(Block List) Annotations will be attached to all alerts generated by any of these rules. (see below for nested schema)\nAnnotations will be attached to all alerts generated by any of these rules.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "fastburn": { "description": "(Block List, Max: 1) Alerting Rules generated for Fast Burn alerts (see below for nested schema)\nAlerting Rules generated for Fast Burn alerts", "items": { "properties": { "annotation": { "description": "(Block List) Annotations will be attached to all alerts generated by any of these rules. (see below for nested schema)\nAnnotations to attach only to Fast Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nLabels to attach only to Fast Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nLabels will be attached to all alerts generated by any of these rules.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "slowburn": { "description": "(Block List, Max: 1) Alerting Rules generated for Slow Burn alerts (see below for nested schema)\nAlerting Rules generated for Slow Burn alerts", "items": { "properties": { "annotation": { "description": "(Block List) Annotations will be attached to all alerts generated by any of these rules. (see below for nested schema)\nAnnotations to attach only to Slow Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nLabels to attach only to Slow Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "description": { "description": "text field that can provide more context to an SLO.\nDescription is a free-text field that can provide more context to an SLO.", "type": "string" }, "destinationDatasource": { "description": "(Block List, Min: 1, Max: 1) Destination Datasource sets the datasource defined for an SLO (see below for nested schema)\nDestination Datasource sets the datasource defined for an SLO", "items": { "properties": { "ref": { "description": "Reference to a DataSource in oss to populate uid.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "policy": { "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "selector": { "description": "Selector for a DataSource in oss to populate uid.", "properties": { "matchControllerRef": { "description": "MatchControllerRef ensures an object with the same controller reference\nas the selecting object is selected.", "type": "boolean" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "MatchLabels ensures an object with matching labels is selected.", "type": "object" }, "policy": { "description": "Policies for selection.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "type": "object", "additionalProperties": false }, "uid": { "description": "(String) UID for the Datasource\nUID for the Datasource", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "folderUid": { "description": "(String) UID for the SLO folder\nUID for the SLO folder", "type": "string" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nAdditional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - \"^[a-zA-Z_][a-zA-Z0-9_]*$\"", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "name": { "description": "(String) Name should be a short description of your indicator. Consider names like \"API Availability\"\nName should be a short description of your indicator. Consider names like \"API Availability\"", "type": "string" }, "objectives": { "description": "(Block List, Min: 1) Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget. (see below for nested schema)\nOver each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.", "items": { "properties": { "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nValue between 0 and 1. If the value of the query is above the objective, the SLO is met.", "type": "number" }, "window": { "description": "parsable time duration string like 24h, 60m. This is the time window the objective is measured over.\nA Prometheus-parsable time duration string like 24h, 60m. This is the time window the objective is measured over.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "query": { "description": "(Block List, Min: 1) Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported. (see below for nested schema)\nQuery describes the indicator that will be measured against the objective. Freeform Query types are currently supported.", "items": { "properties": { "freeform": { "description": "(Block List, Max: 1) (see below for nested schema)", "items": { "properties": { "query": { "description": "(Block List, Min: 1) Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported. (see below for nested schema)\nFreeform Query Field - valid promQl", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "grafanaQueries": { "description": "(Block List, Max: 1) Array for holding a set of grafana queries (see below for nested schema)\nArray for holding a set of grafana queries", "items": { "properties": { "grafanaQueries": { "description": "(Block List, Max: 1) Array for holding a set of grafana queries (see below for nested schema)\nQuery Object - Array of Grafana Query JSON objects", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "ratio": { "description": "(Block List, Max: 1) (see below for nested schema)", "items": { "properties": { "groupByLabels": { "description": "label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - \"^[a-zA-Z_][a-zA-Z0-9_]*$\"\nDefines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - \"^[a-zA-Z_][a-zA-Z0-9_]*$\"", "items": { "type": "string" }, "type": "array" }, "successMetric": { "description": "(String) Counter metric for success events (numerator)\nCounter metric for success events (numerator)", "type": "string" }, "totalMetric": { "description": "(String) Metric for total events (denominator)\nMetric for total events (denominator)", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "type": { "description": "(String) Query type must be one of: \"freeform\", \"query\", \"ratio\", \"grafana_queries\" or \"threshold\"\nQuery type must be one of: \"freeform\", \"query\", \"ratio\", \"grafana_queries\" or \"threshold\"", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "searchExpression": { "description": "(String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.\nThe name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.", "type": "string" }, "uuid": { "description": "(String) UUID for the SLO. Custom UUIDs can be set. If not provided, a random UUID will be generated by the API.\nUUID for the SLO. Custom UUIDs can be set. If not provided, a random UUID will be generated by the API.", "type": "string" } }, "type": "object", "additionalProperties": false }, "managementPolicies": { "default": [ "*" ], "description": "THIS IS A BETA FIELD. It is on by default but can be opted out\nthrough a Crossplane feature flag.\nManagementPolicies specify the array of actions Crossplane is allowed to\ntake on the managed and external resources.\nThis field is planned to replace the DeletionPolicy field in a future\nrelease. Currently, both could be set independently and non-default\nvalues would be honored if the feature flag is enabled. If both are\ncustom, the DeletionPolicy field will be ignored.\nSee the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223\nand this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md", "items": { "description": "A ManagementAction represents an action that the Crossplane controllers\ncan take on an external resource.", "enum": [ "Observe", "Create", "Update", "Delete", "LateInitialize", "*" ], "type": "string" }, "type": "array" }, "providerConfigRef": { "default": { "name": "default" }, "description": "ProviderConfigReference specifies how the provider that will be used to\ncreate, observe, update, and delete this managed resource should be\nconfigured.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "policy": { "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "publishConnectionDetailsTo": { "description": "PublishConnectionDetailsTo specifies the connection secret config which\ncontains a name, metadata and a reference to secret store config to\nwhich any connection details for this managed resource should be written.\nConnection details frequently include the endpoint, username,\nand password required to connect to the managed resource.", "properties": { "configRef": { "default": { "name": "default" }, "description": "SecretStoreConfigRef specifies which secret store config should be used\nfor this ConnectionSecret.", "properties": { "name": { "description": "Name of the referenced object.", "type": "string" }, "policy": { "description": "Policies for referencing.", "properties": { "resolution": { "default": "Required", "description": "Resolution specifies whether resolution of this reference is required.\nThe default is 'Required', which means the reconcile will fail if the\nreference cannot be resolved. 'Optional' means this reference will be\na no-op if it cannot be resolved.", "enum": [ "Required", "Optional" ], "type": "string" }, "resolve": { "description": "Resolve specifies when this reference should be resolved. The default\nis 'IfNotPresent', which will attempt to resolve the reference only when\nthe corresponding field is not present. Use 'Always' to resolve the\nreference on every reconcile.", "enum": [ "Always", "IfNotPresent" ], "type": "string" } }, "type": "object", "additionalProperties": false } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "metadata": { "description": "Metadata is the metadata for connection secret.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations are the annotations to be added to connection secret.\n- For Kubernetes secrets, this will be used as \"metadata.annotations\".\n- It is up to Secret Store implementation for others store types.", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, "description": "Labels are the labels/tags to be added to connection secret.\n- For Kubernetes secrets, this will be used as \"metadata.labels\".\n- It is up to Secret Store implementation for others store types.", "type": "object" }, "type": { "description": "Type is the SecretType for the connection secret.\n- Only valid for Kubernetes Secret Stores.", "type": "string" } }, "type": "object", "additionalProperties": false }, "name": { "description": "Name is the name of the connection secret.", "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "writeConnectionSecretToRef": { "description": "WriteConnectionSecretToReference specifies the namespace and name of a\nSecret to which any connection details for this managed resource should\nbe written. Connection details frequently include the endpoint, username,\nand password required to connect to the managed resource.\nThis field is planned to be replaced in a future release in favor of\nPublishConnectionDetailsTo. Currently, both could be set independently\nand connection details would be published to both without affecting\neach other.", "properties": { "name": { "description": "Name of the secret.", "type": "string" }, "namespace": { "description": "Namespace of the secret.", "type": "string" } }, "required": [ "name", "namespace" ], "type": "object", "additionalProperties": false } }, "required": [ "forProvider" ], "type": "object", "x-kubernetes-validations": [ { "message": "spec.forProvider.description is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.description) || (has(self.initProvider) && has(self.initProvider.description))" }, { "message": "spec.forProvider.destinationDatasource is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.destinationDatasource) || (has(self.initProvider) && has(self.initProvider.destinationDatasource))" }, { "message": "spec.forProvider.name is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.name) || (has(self.initProvider) && has(self.initProvider.name))" }, { "message": "spec.forProvider.objectives is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.objectives) || (has(self.initProvider) && has(self.initProvider.objectives))" }, { "message": "spec.forProvider.query is a required parameter", "rule": "!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.query) || (has(self.initProvider) && has(self.initProvider.query))" } ], "additionalProperties": false }, "status": { "description": "SLOStatus defines the observed state of SLO.", "properties": { "atProvider": { "properties": { "alerting": { "description": "term error budget burn is very high, the\nlong-term error budget burn rate is high, or when the remaining\nerror budget is below a certain threshold. Annotations and Labels support templating. (see below for nested schema)\nConfigures the alerting rules that will be generated for each\ntime window associated with the SLO. Grafana SLOs can generate\nalerts when the short-term error budget burn is very high, the\nlong-term error budget burn rate is high, or when the remaining\nerror budget is below a certain threshold. Annotations and Labels support templating.", "items": { "properties": { "advancedOptions": { "description": "(Block List, Max: 1) Advanced Options for Alert Rules (see below for nested schema)\nAdvanced Options for Alert Rules", "items": { "properties": { "minFailures": { "description": "(Number) Minimum number of failed events to trigger an alert\nMinimum number of failed events to trigger an alert", "type": "number" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "annotation": { "description": "(Block List) Annotations will be attached to all alerts generated by any of these rules. (see below for nested schema)\nAnnotations will be attached to all alerts generated by any of these rules.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "fastburn": { "description": "(Block List, Max: 1) Alerting Rules generated for Fast Burn alerts (see below for nested schema)\nAlerting Rules generated for Fast Burn alerts", "items": { "properties": { "annotation": { "description": "(Block List) Annotations will be attached to all alerts generated by any of these rules. (see below for nested schema)\nAnnotations to attach only to Fast Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nLabels to attach only to Fast Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nLabels will be attached to all alerts generated by any of these rules.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "slowburn": { "description": "(Block List, Max: 1) Alerting Rules generated for Slow Burn alerts (see below for nested schema)\nAlerting Rules generated for Slow Burn alerts", "items": { "properties": { "annotation": { "description": "(Block List) Annotations will be attached to all alerts generated by any of these rules. (see below for nested schema)\nAnnotations to attach only to Slow Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nLabels to attach only to Slow Burn alerts.", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "description": { "description": "text field that can provide more context to an SLO.\nDescription is a free-text field that can provide more context to an SLO.", "type": "string" }, "destinationDatasource": { "description": "(Block List, Min: 1, Max: 1) Destination Datasource sets the datasource defined for an SLO (see below for nested schema)\nDestination Datasource sets the datasource defined for an SLO", "items": { "properties": { "uid": { "description": "(String) UID for the Datasource\nUID for the Datasource", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "folderUid": { "description": "(String) UID for the SLO folder\nUID for the SLO folder", "type": "string" }, "id": { "description": "(String) The ID of this resource.", "type": "string" }, "label": { "description": "\"^[a-zA-Z_][a-zA-Z0-9_]*$\" (see below for nested schema)\nAdditional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - \"^[a-zA-Z_][a-zA-Z0-9_]*$\"", "items": { "properties": { "key": { "description": "(String) Key for filtering and identification\nKey for filtering and identification", "type": "string" }, "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nTemplatable value", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "name": { "description": "(String) Name should be a short description of your indicator. Consider names like \"API Availability\"\nName should be a short description of your indicator. Consider names like \"API Availability\"", "type": "string" }, "objectives": { "description": "(Block List, Min: 1) Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget. (see below for nested schema)\nOver each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.", "items": { "properties": { "value": { "description": "(Number) Value between 0 and 1. If the value of the query is above the objective, the SLO is met.\nValue between 0 and 1. If the value of the query is above the objective, the SLO is met.", "type": "number" }, "window": { "description": "parsable time duration string like 24h, 60m. This is the time window the objective is measured over.\nA Prometheus-parsable time duration string like 24h, 60m. This is the time window the objective is measured over.", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "query": { "description": "(Block List, Min: 1) Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported. (see below for nested schema)\nQuery describes the indicator that will be measured against the objective. Freeform Query types are currently supported.", "items": { "properties": { "freeform": { "description": "(Block List, Max: 1) (see below for nested schema)", "items": { "properties": { "query": { "description": "(Block List, Min: 1) Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported. (see below for nested schema)\nFreeform Query Field - valid promQl", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "grafanaQueries": { "description": "(Block List, Max: 1) Array for holding a set of grafana queries (see below for nested schema)\nArray for holding a set of grafana queries", "items": { "properties": { "grafanaQueries": { "description": "(Block List, Max: 1) Array for holding a set of grafana queries (see below for nested schema)\nQuery Object - Array of Grafana Query JSON objects", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "ratio": { "description": "(Block List, Max: 1) (see below for nested schema)", "items": { "properties": { "groupByLabels": { "description": "label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - \"^[a-zA-Z_][a-zA-Z0-9_]*$\"\nDefines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - \"^[a-zA-Z_][a-zA-Z0-9_]*$\"", "items": { "type": "string" }, "type": "array" }, "successMetric": { "description": "(String) Counter metric for success events (numerator)\nCounter metric for success events (numerator)", "type": "string" }, "totalMetric": { "description": "(String) Metric for total events (denominator)\nMetric for total events (denominator)", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "type": { "description": "(String) Query type must be one of: \"freeform\", \"query\", \"ratio\", \"grafana_queries\" or \"threshold\"\nQuery type must be one of: \"freeform\", \"query\", \"ratio\", \"grafana_queries\" or \"threshold\"", "type": "string" } }, "type": "object", "additionalProperties": false }, "type": "array" }, "searchExpression": { "description": "(String) The name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.\nThe name of a search expression in Grafana Asserts. This is used in the SLO UI to open the Asserts RCA workbench and in alerts to link to the RCA workbench.", "type": "string" }, "uuid": { "description": "(String) UUID for the SLO. Custom UUIDs can be set. If not provided, a random UUID will be generated by the API.\nUUID for the SLO. Custom UUIDs can be set. If not provided, a random UUID will be generated by the API.", "type": "string" } }, "type": "object", "additionalProperties": false }, "conditions": { "description": "Conditions of the resource.", "items": { "description": "A Condition that may apply to a resource.", "properties": { "lastTransitionTime": { "description": "LastTransitionTime is the last time this condition transitioned from one\nstatus to another.", "format": "date-time", "type": "string" }, "message": { "description": "A Message containing details about this condition's last transition from\none status to another, if any.", "type": "string" }, "observedGeneration": { "description": "ObservedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "type": "integer" }, "reason": { "description": "A Reason for this condition's last transition from one status to another.", "type": "string" }, "status": { "description": "Status of this condition; is it currently True, False, or Unknown?", "type": "string" }, "type": { "description": "Type of this condition. At most one of each condition type may apply to\na resource at any point in time.", "type": "string" } }, "required": [ "lastTransitionTime", "reason", "status", "type" ], "type": "object", "additionalProperties": false }, "type": "array", "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" }, "observedGeneration": { "description": "ObservedGeneration is the latest metadata.generation\nwhich resulted in either a ready state, or stalled due to error\nit can not recover from without human intervention.", "format": "int64", "type": "integer" } }, "type": "object", "additionalProperties": false } }, "required": [ "spec" ], "type": "object" }