Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-grafana.Go to Latest
grafana/provider-grafana@v0.13.2
RuleGroup
alerting.grafana.crossplane.io
RuleGroup
grafana/provider-grafana@v0.13.2alerting.grafana.crossplane.io

RuleGroup is the Schema for the RuleGroups API. Manages Grafana Alerting rule groups. Official documentation https://grafana.com/docs/grafana/latest/alerting/alerting-rules/HTTP API https://grafana.com/docs/grafana/latest/developers/http_api/alerting_provisioning/#alert-rules This resource requires Grafana 9.1.0 or later.

Type

CRD

Group

alerting.grafana.crossplane.io

Version

v1alpha1

apiVersion: alerting.grafana.crossplane.io/v1alpha1

kind: RuleGroup

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

RuleGroupSpec defines the desired state of RuleGroup

forProvider
requiredobject
requiredobject

No description provided.

folderRef
object
object

Reference to a Folder in oss to populate folderUid.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Folder in oss to populate folderUid.

policy
object
object

Policies for selection.

resolve
string
folderUid
string
name
string
orgId
string
object

Reference to a Organization in oss to populate orgId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Organization in oss to populate orgId.

policy
object
object

Policies for selection.

resolve
string
rule
array
array

(Block List, Min: 1) The rules within the group. (see below for nested schema) The rules within the group.

condition
string
data
array
array

(Block List, Min: 1) A sequence of stages that describe the contents of the rule. (see below for nested schema) A sequence of stages that describe the contents of the rule.

model
string
queryType
string
refId
string
array

(Block List, Min: 1, Max: 1) The time range, relative to when the query is executed, across which to query. (see below for nested schema) The time range, relative to when the query is executed, across which to query.

from
number
to
number
for
string
isPaused
boolean
labels
object
name
string
array

(Block List, Max: 1) Notification settings for the rule. If specified, it overrides the notification policies. Available since Grafana 10.4, requires feature flag 'alertingSimplifiedRouting' enabled. (see below for nested schema) Notification settings for the rule. If specified, it overrides the notification policies. Available since Grafana 10.4, requires feature flag 'alertingSimplifiedRouting' enabled.

groupBy
array
array

(List of String) A list of alert labels to group alerts into notifications by. Use the special label ... to group alerts by all labels, effectively disabling grouping. If empty, no grouping is used. If specified, requires labels 'alertname' and 'grafana_folder' to be included. A list of alert labels to group alerts into notifications by. Use the special label ... to group alerts by all labels, effectively disabling grouping. If empty, no grouping is used. If specified, requires labels 'alertname' and 'grafana_folder' to be included.

groupWait
string
array

(List of String) A list of mute timing names to apply to alerts that match this policy. A list of mute timing names to apply to alerts that match this policy.

object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

folderRef
object
object

Reference to a Folder in oss to populate folderUid.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Folder in oss to populate folderUid.

policy
object
object

Policies for selection.

resolve
string
folderUid
string
name
string
orgId
string
object

Reference to a Organization in oss to populate orgId.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Organization in oss to populate orgId.

policy
object
object

Policies for selection.

resolve
string
rule
array
array

(Block List, Min: 1) The rules within the group. (see below for nested schema) The rules within the group.

condition
string
data
array
array

(Block List, Min: 1) A sequence of stages that describe the contents of the rule. (see below for nested schema) A sequence of stages that describe the contents of the rule.

model
string
queryType
string
refId
string
array

(Block List, Min: 1, Max: 1) The time range, relative to when the query is executed, across which to query. (see below for nested schema) The time range, relative to when the query is executed, across which to query.

from
number
to
number
for
string
isPaused
boolean
labels
object
name
string
array

(Block List, Max: 1) Notification settings for the rule. If specified, it overrides the notification policies. Available since Grafana 10.4, requires feature flag 'alertingSimplifiedRouting' enabled. (see below for nested schema) Notification settings for the rule. If specified, it overrides the notification policies. Available since Grafana 10.4, requires feature flag 'alertingSimplifiedRouting' enabled.

groupBy
array
array

(List of String) A list of alert labels to group alerts into notifications by. Use the special label ... to group alerts by all labels, effectively disabling grouping. If empty, no grouping is used. If specified, requires labels 'alertname' and 'grafana_folder' to be included. A list of alert labels to group alerts into notifications by. Use the special label ... to group alerts by all labels, effectively disabling grouping. If empty, no grouping is used. If specified, requires labels 'alertname' and 'grafana_folder' to be included.

groupWait
string
array

(List of String) A list of mute timing names to apply to alerts that match this policy. A list of mute timing names to apply to alerts that match this policy.

array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

RuleGroupStatus defines the observed state of RuleGroup.

object

No description provided.

folderUid
string
id
string
name
string
orgId
string
rule
array
array

(Block List, Min: 1) The rules within the group. (see below for nested schema) The rules within the group.

condition
string
data
array
array

(Block List, Min: 1) A sequence of stages that describe the contents of the rule. (see below for nested schema) A sequence of stages that describe the contents of the rule.

model
string
queryType
string
refId
string
array

(Block List, Min: 1, Max: 1) The time range, relative to when the query is executed, across which to query. (see below for nested schema) The time range, relative to when the query is executed, across which to query.

from
number
to
number
for
string
isPaused
boolean
labels
object
name
string
array

(Block List, Max: 1) Notification settings for the rule. If specified, it overrides the notification policies. Available since Grafana 10.4, requires feature flag 'alertingSimplifiedRouting' enabled. (see below for nested schema) Notification settings for the rule. If specified, it overrides the notification policies. Available since Grafana 10.4, requires feature flag 'alertingSimplifiedRouting' enabled.

groupBy
array
array

(List of String) A list of alert labels to group alerts into notifications by. Use the special label ... to group alerts by all labels, effectively disabling grouping. If empty, no grouping is used. If specified, requires labels 'alertname' and 'grafana_folder' to be included. A list of alert labels to group alerts into notifications by. Use the special label ... to group alerts by all labels, effectively disabling grouping. If empty, no grouping is used. If specified, requires labels 'alertname' and 'grafana_folder' to be included.

groupWait
string
array

(List of String) A list of mute timing names to apply to alerts that match this policy. A list of mute timing names to apply to alerts that match this policy.

uid
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.