From 1447f709803838dfc2cb2b143392fa0b31280618 Mon Sep 17 00:00:00 2001 From: adcoelho Date: Mon, 10 Mar 2025 11:33:40 +0000 Subject: [PATCH 1/3] Update rule id description. --- internal/kibana/alerting.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/kibana/alerting.go b/internal/kibana/alerting.go index 96d9536eb..ab1b83960 100644 --- a/internal/kibana/alerting.go +++ b/internal/kibana/alerting.go @@ -33,7 +33,7 @@ func stringIsAlertingDuration() schema.SchemaValidateFunc { func ResourceAlertingRule() *schema.Resource { apikeySchema := map[string]*schema.Schema{ "rule_id": { - Description: "A UUID v1 or v4 to use instead of a randomly generated ID.", + Description: "The identifier for the rule. Until Kibana version 8.17.0 this should be a UUID v1 or v4, for later versions any format can be used. If it is omitted, an ID is randomly generated.", Type: schema.TypeString, Computed: true, Optional: true, From b852477b4963f515896a932a8364b141f59631b9 Mon Sep 17 00:00:00 2001 From: Boris Ilyushonak <57406418+biscout42@users.noreply.github.com> Date: Mon, 10 Mar 2025 12:56:27 +0100 Subject: [PATCH 2/3] update docs (#1048) --- docs/resources/kibana_alerting_rule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/kibana_alerting_rule.md b/docs/resources/kibana_alerting_rule.md index 8c25be398..80a622d19 100644 --- a/docs/resources/kibana_alerting_rule.md +++ b/docs/resources/kibana_alerting_rule.md @@ -64,7 +64,7 @@ Could not create API key - Unsupported scheme "ApiKey" for granting API Key - `alert_delay` (Number) A number that indicates how many consecutive runs need to meet the rule conditions for an alert to occur. - `enabled` (Boolean) Indicates if you want to run the rule on an interval basis. - `notify_when` (String) Required until v8.6.0. Deprecated in v8.13.0. Use the `notify_when` property in the action `frequency` object instead. Defines how often alerts generate actions. Valid values include: `onActionGroupChange`: Actions run when the alert status changes; `onActiveAlert`: Actions run when the alert becomes active and at each check interval while the rule conditions are met; `onThrottleInterval`: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: This is a rule level property; if you update the rule in Kibana, it is automatically changed to use action-specific `notify_when` values. -- `rule_id` (String) A UUID v1 or v4 to use instead of a randomly generated ID. +- `rule_id` (String) The identifier for the rule. Until Kibana version 8.17.0 this should be a UUID v1 or v4, for later versions any format can be used. If it is omitted, an ID is randomly generated. - `space_id` (String) An identifier for the space. If space_id is not provided, the default space is used. - `tags` (List of String) A list of tag names that are applied to the rule. - `throttle` (String) Deprecated in 8.13.0. Defines how often an alert generates repeated actions. This custom action interval must be specified in seconds, minutes, hours, or days. For example, 10m or 1h. This property is applicable only if `notify_when` is `onThrottleInterval`. NOTE: This is a rule level property; if you update the rule in Kibana, it is automatically changed to use action-specific `throttle` values. From 266920439df2497c261b1cd1ebcd6988bc9141a5 Mon Sep 17 00:00:00 2001 From: adcoelho Date: Mon, 10 Mar 2025 12:02:34 +0000 Subject: [PATCH 3/3] changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a7e5c7959..f9a841ba7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ - Add `max_primary_shard_docs` condition to ILM rollover ([#845](https://github.com/elastic/terraform-provider-elasticstack/pull/845)) - Add missing entries to `data_view.field_formats.params` ([#1001](https://github.com/elastic/terraform-provider-elasticstack/pull/1001)) - Fix namespaces inconsistency when creating elasticstack_kibana_data_view resources ([#1011](https://github.com/elastic/terraform-provider-elasticstack/pull/1011)) +- Update rule ID documentation. ([#1047](https://github.com/elastic/terraform-provider-elasticstack/pull/1047)) ## [0.11.13] - 2025-01-09