diff --git a/config/kustomization.yaml b/config/kustomization.yaml index 7c019c3b5..18603b5c3 100644 --- a/config/kustomization.yaml +++ b/config/kustomization.yaml @@ -6,4 +6,5 @@ resources: - grafana.integreatly.org_grafanadashboards.yaml - grafana.integreatly.org_grafanadatasources.yaml - grafana.integreatly.org_grafanafolders.yaml + - grafana.integreatly.org_grafanaalertrulegroups.yaml #+kubebuilder:scaffold:crdkustomizeresource diff --git a/deploy/kustomize/base/crds.yaml b/deploy/kustomize/base/crds.yaml index 1cb82ef1e..c70fb10ea 100644 --- a/deploy/kustomize/base/crds.yaml +++ b/deploy/kustomize/base/crds.yaml @@ -1,5 +1,280 @@ apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.12.0 + name: grafanaalertrulegroups.grafana.integreatly.org +spec: + group: grafana.integreatly.org + names: + kind: GrafanaAlertRuleGroup + listKind: GrafanaAlertRuleGroupList + plural: grafanaalertrulegroups + singular: grafanaalertrulegroup + scope: Namespaced + versions: + - name: v1beta1 + schema: + openAPIV3Schema: + description: GrafanaAlertRuleGroup is the Schema for the grafanaalertrulegroups + API + properties: + apiVersion: + description: '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' + type: string + kind: + description: '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' + type: string + metadata: + type: object + spec: + description: GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup + properties: + allowCrossNamespaceImport: + type: boolean + folderRef: + description: Match GrafanaFolders CRs to infer the uid + type: string + folderUID: + description: UID of the folder containing this rule group Overrides + the FolderSelector + type: string + instanceSelector: + description: selects Grafanas for import + properties: + matchExpressions: + description: matchExpressions is a list of label selector requirements. + The requirements are ANDed. + items: + description: A label selector requirement is a selector that + contains values, a key, and an operator that relates the key + and values. + properties: + key: + description: key is the label key that the selector applies + to. + type: string + operator: + description: operator represents a key's relationship to + a set of values. Valid operators are In, NotIn, Exists + and DoesNotExist. + type: string + values: + description: values is an array of string values. If the + operator is In or NotIn, the values array must be non-empty. + If the operator is Exists or DoesNotExist, the values + array must be empty. This array is replaced during a strategic + merge patch. + items: + type: string + type: array + required: + - key + - operator + type: object + type: array + matchLabels: + additionalProperties: + type: string + description: matchLabels is a map of {key,value} pairs. A single + {key,value} in the matchLabels map is equivalent to an element + of matchExpressions, whose key field is "key", the operator + is "In", and the values array contains only "value". The requirements + are ANDed. + type: object + type: object + x-kubernetes-map-type: atomic + interval: + format: duration + pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$ + type: string + resyncPeriod: + default: 10m + format: duration + pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$ + type: string + rules: + items: + description: AlertRule defines a specific rule to be evaluated. + It is based on the upstream model with some k8s specific type + mappings + properties: + annotations: + additionalProperties: + type: string + type: object + condition: + type: string + data: + items: + properties: + datasourceUid: + description: Grafana data source unique identifier; it + should be '__expr__' for a Server Side Expression operation. + type: string + model: + description: JSON is the raw JSON query and includes the + above properties as well as custom properties. + x-kubernetes-preserve-unknown-fields: true + queryType: + description: QueryType is an optional identifier for the + type of query. It can be used to distinguish different + types of queries. + type: string + refId: + description: RefID is the unique identifier of the query, + set by the frontend call. + type: string + relativeTimeRange: + description: relative time range + properties: + from: + description: from + format: int64 + type: integer + to: + description: to + format: int64 + type: integer + type: object + type: object + type: array + execErrState: + enum: + - OK + - Alerting + - Error + type: string + for: + format: duration + pattern: ^([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$ + type: string + isPaused: + type: boolean + labels: + additionalProperties: + type: string + type: object + noDataState: + enum: + - Alerting + - NoData + - OK + type: string + title: + example: Always firing + maxLength: 190 + minLength: 1 + type: string + uid: + pattern: ^[a-zA-Z0-9-_]+$ + type: string + required: + - condition + - data + - execErrState + - for + - noDataState + - title + - uid + type: object + type: array + required: + - instanceSelector + - interval + - rules + type: object + x-kubernetes-validations: + - message: Only one of FolderUID or FolderRef can be set + rule: (has(self.folderUID) && !(has(self.folderRef))) || (has(self.folderRef) + && !(has(self.folderUID))) + status: + description: GrafanaAlertRuleGroupStatus defines the observed state of + GrafanaAlertRuleGroup + properties: + conditions: + items: + description: "Condition contains details for one aspect of the current + state of this API Resource. --- This struct is intended for direct + use as an array at the field path .status.conditions. For example, + \n type FooStatus struct{ // Represents the observations of a + foo's current state. // Known .status.conditions.type are: \"Available\", + \"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge + // +listType=map // +listMapKey=type Conditions []metav1.Condition + `json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\" + protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }" + properties: + lastTransitionTime: + description: 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. + format: date-time + type: string + message: + description: message is a human readable message indicating + details about the transition. This may be an empty string. + maxLength: 32768 + type: string + observedGeneration: + description: 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. + format: int64 + minimum: 0 + type: integer + reason: + description: 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. + maxLength: 1024 + minLength: 1 + pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$ + type: string + status: + description: status of the condition, one of True, False, Unknown. + enum: + - "True" + - "False" + - Unknown + type: string + type: + description: type of condition in CamelCase or in foo.example.com/CamelCase. + --- Many .condition.type values are consistent across resources + like Available, but because arbitrary conditions can be useful + (see .node.status.conditions), the ability to deconflict is + important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) + maxLength: 316 + pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$ + type: string + required: + - lastTransitionTime + - message + - reason + - status + - type + type: object + type: array + required: + - conditions + type: object + type: object + served: true + storage: true + subresources: + status: {} +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: v0.12.0 diff --git a/docs/docs/api.md b/docs/docs/api.md index 9e47b16ba..e4ecfe94a 100644 --- a/docs/docs/api.md +++ b/docs/docs/api.md @@ -11,6 +11,8 @@ Packages: Resource Types: +- [GrafanaAlertRuleGroup](#grafanaalertrulegroup) + - [GrafanaDashboard](#grafanadashboard) - [GrafanaDatasource](#grafanadatasource) @@ -22,6 +24,497 @@ Resource Types: +## GrafanaAlertRuleGroup +[↩ Parent](#grafanaintegreatlyorgv1beta1 ) + + + + + + +GrafanaAlertRuleGroup is the Schema for the grafanaalertrulegroups API + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringgrafana.integreatly.org/v1beta1true
kindstringGrafanaAlertRuleGrouptrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject + GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup
+
+ Validations:
  • (has(self.folderUID) && !(has(self.folderRef))) || (has(self.folderRef) && !(has(self.folderUID))): Only one of FolderUID or FolderRef can be set
  • +
    false
    statusobject + GrafanaAlertRuleGroupStatus defines the observed state of GrafanaAlertRuleGroup
    +
    false
    + + +### GrafanaAlertRuleGroup.spec +[↩ Parent](#grafanaalertrulegroup) + + + +GrafanaAlertRuleGroupSpec defines the desired state of GrafanaAlertRuleGroup + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescriptionRequired
    instanceSelectorobject + selects Grafanas for import
    +
    true
    intervalstring +
    +
    + Format: duration
    +
    true
    rules[]object +
    +
    true
    allowCrossNamespaceImportboolean +
    +
    false
    folderRefstring + Match GrafanaFolders CRs to infer the uid
    +
    false
    folderUIDstring + UID of the folder containing this rule group Overrides the FolderSelector
    +
    false
    resyncPeriodstring +
    +
    + Format: duration
    + Default: 10m
    +
    false
    + + +### GrafanaAlertRuleGroup.spec.instanceSelector +[↩ Parent](#grafanaalertrulegroupspec) + + + +selects Grafanas for import + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescriptionRequired
    matchExpressions[]object + matchExpressions is a list of label selector requirements. The requirements are ANDed.
    +
    false
    matchLabelsmap[string]string + matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    +
    false
    + + +### GrafanaAlertRuleGroup.spec.instanceSelector.matchExpressions[index] +[↩ Parent](#grafanaalertrulegroupspecinstanceselector) + + + +A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescriptionRequired
    keystring + key is the label key that the selector applies to.
    +
    true
    operatorstring + operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
    +
    true
    values[]string + values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
    +
    false
    + + +### GrafanaAlertRuleGroup.spec.rules[index] +[↩ Parent](#grafanaalertrulegroupspec) + + + +AlertRule defines a specific rule to be evaluated. It is based on the upstream model with some k8s specific type mappings + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescriptionRequired
    conditionstring +
    +
    true
    data[]object +
    +
    true
    execErrStateenum +
    +
    + Enum: OK, Alerting, Error
    +
    true
    forstring +
    +
    + Format: duration
    +
    true
    noDataStateenum +
    +
    + Enum: Alerting, NoData, OK
    +
    true
    titlestring +
    +
    true
    uidstring +
    +
    true
    annotationsmap[string]string +
    +
    false
    isPausedboolean +
    +
    false
    labelsmap[string]string +
    +
    false
    + + +### GrafanaAlertRuleGroup.spec.rules[index].data[index] +[↩ Parent](#grafanaalertrulegroupspecrulesindex) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescriptionRequired
    datasourceUidstring + Grafana data source unique identifier; it should be '__expr__' for a Server Side Expression operation.
    +
    false
    modelJSON + JSON is the raw JSON query and includes the above properties as well as custom properties.
    +
    false
    queryTypestring + QueryType is an optional identifier for the type of query. It can be used to distinguish different types of queries.
    +
    false
    refIdstring + RefID is the unique identifier of the query, set by the frontend call.
    +
    false
    relativeTimeRangeobject + relative time range
    +
    false
    + + +### GrafanaAlertRuleGroup.spec.rules[index].data[index].relativeTimeRange +[↩ Parent](#grafanaalertrulegroupspecrulesindexdataindex) + + + +relative time range + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescriptionRequired
    frominteger + from
    +
    + Format: int64
    +
    false
    tointeger + to
    +
    + Format: int64
    +
    false
    + + +### GrafanaAlertRuleGroup.status +[↩ Parent](#grafanaalertrulegroup) + + + +GrafanaAlertRuleGroupStatus defines the observed state of GrafanaAlertRuleGroup + + + + + + + + + + + + + + + + +
    NameTypeDescriptionRequired
    conditions[]object +
    +
    true
    + + +### GrafanaAlertRuleGroup.status.conditions[index] +[↩ Parent](#grafanaalertrulegroupstatus) + + + +Condition contains details for one aspect of the current state of this API Resource. --- This struct is intended for direct use as an array at the field path .status.conditions. For example, + type FooStatus struct{ // Represents the observations of a foo's current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` + // other fields } + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDescriptionRequired
    lastTransitionTimestring + 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.
    +
    + Format: date-time
    +
    true
    messagestring + message is a human readable message indicating details about the transition. This may be an empty string.
    +
    true
    reasonstring + 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.
    +
    true
    statusenum + status of the condition, one of True, False, Unknown.
    +
    + Enum: True, False, Unknown
    +
    true
    typestring + type of condition in CamelCase or in foo.example.com/CamelCase. --- Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
    +
    true
    observedGenerationinteger + 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.
    +
    + Format: int64
    + Minimum: 0
    +
    false
    + ## GrafanaDashboard [↩ Parent](#grafanaintegreatlyorgv1beta1 )