add resource for datastream lifecycle

Author: aizerin

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## [Unreleased]
 
+- Add resource `elasticstack_elasticsearch_data_stream_lifecycle` ([838](https://github.com/elastic/terraform-provider-elasticstack/issues/838))
 - Support updating `elasticstack_elasticsearch_security_api_key` when supported by the backing cluster ([#843](https://github.com/elastic/terraform-provider-elasticstack/pull/843))
 - Fix validation of `throttle`, and `interval` attributes in `elasticstack_kibana_alerting_rule` allowing all Elastic duration values ([#846](https://github.com/elastic/terraform-provider-elasticstack/pull/846))
 - Fix boolean setting parsing for `elasticstack_elasticsearch_indices` data source. ([#842](https://github.com/elastic/terraform-provider-elasticstack/pull/842))

docs/resources/elasticsearch_data_stream_lifecycle.md

@@ -0,0 +1,131 @@
+---
+subcategory: "Index"
+layout: ""
+page_title: "Elasticstack: elasticstack_elasticsearch_data_stream_lifecycle Resource"
+description: |-
+  Manages Lifecycle for Elasticsearch Data Streams
+---
+
+# Resource: elasticstack_elasticsearch_data_stream
+
+Configures the data stream lifecycle for the targeted data streams, see: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-stream-apis.html
+
+## Example Usage
+
+```terraform
+provider "elasticstack" {
+  elasticsearch {}
+}
+
+
+// First we must have a index template created
+resource "elasticstack_elasticsearch_index_template" "my_data_stream_template" {
+  name = "my_data_stream"
+
+  index_patterns = ["my-stream*"]
+
+  data_stream {}
+}
+
+// and now we can create data stream based on the index template
+resource "elasticstack_elasticsearch_data_stream" "my_data_stream" {
+  name = "my-stream"
+
+  // make sure that template is created before the data stream
+  depends_on = [
+    elasticstack_elasticsearch_index_template.my_data_stream_template
+  ]
+}
+
+// finally we can manage lifecycle of data stream
+resource "elasticstack_elasticsearch_data_stream_lifecycle" "my_data_stream_lifecycle" {
+  name           = "my-stream"
+  data_retention = "3d"
+
+  depends_on = [
+    elasticstack_elasticsearch_data_stream.my_data_stream,
+  ]
+}
+
+// or you can use wildcards to manage multiple lifecycles at once
+resource "elasticstack_elasticsearch_data_stream_lifecycle" "my_data_stream_lifecycle_multiple" {
+  name           = "stream-*"
+  data_retention = "3d"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+
+## Schema
+
+### Required
+
+- `name` (String) Name of the data stream. Supports wildcards (_). To target all data streams use _ or \_all.
+
+### Optional
+
+- `data_retention` (String) If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely
+- `downsampling` (Block List) An optional array of downsampling configuration objects, each defining an after interval representing when the backing index is meant to be downsampled (the time frame is calculated since the index was rolled over, i.e. generation time) and a fixed_interval representing the downsampling interval (the minimum fixed_interval value is 5m). A maximum number of 10 downsampling rounds can be configured (see [below for nested schema](#nestedblock--downsampling))
+- `elasticsearch_connection` (Block List, Max: 1, Deprecated) Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead. (see [below for nested schema](#nestedblock--elasticsearch_connection))
+- `enabled` (Boolean) If defined, it turns data stream lifecycle on/off (true/false) for this data stream. A data stream lifecycle that is disabled (enabled: false) will have no effect on the data stream. Defaults to true.
+- `expand_wildcards` (String) Type of data stream that wildcard patterns can match. Supports comma-separated values, such as open,hidden. Valid values are:
+
+      	all, hidden - Match any data stream, including hidden ones.
+      	open, closed - Matches any non-hidden data stream. Data streams cannot be closed.
+      	none - Wildcard patterns are not accepted.
+
+      	Defaults to open.
+
+### Read-Only
+
+- `id` (String) Internal identifier of the resource
+- `lifecycles` (List of Object) (see [below for nested schema](#nestedatt--lifecycles))
+
+<a id="nestedblock--downsampling"></a>
+
+### Nested Schema for `downsampling`
+
+Required:
+
+- `after` (String) Interval representing when the backing index is meant to be downsampled
+- `fixed_interval` (String) The interval at which to aggregate the original time series index. For example, 60m produces a document for each 60 minute (hourly) interval. This follows standard time formatting syntax as used elsewhere in Elasticsearch.
+
+<a id="nestedblock--elasticsearch_connection"></a>
+
+### Nested Schema for `elasticsearch_connection`
+
+Optional:
+
+- `api_key` (String, Sensitive) API Key to use for authentication to Elasticsearch
+- `bearer_token` (String, Sensitive) Bearer Token to use for authentication to Elasticsearch
+- `ca_data` (String) PEM-encoded custom Certificate Authority certificate
+- `ca_file` (String) Path to a custom Certificate Authority certificate
+- `cert_data` (String) PEM encoded certificate for client auth
+- `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
+- `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
+- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the bearer token
+- `insecure` (Boolean) Disable TLS certificate validation
+- `key_data` (String, Sensitive) PEM encoded private key for client auth
+- `key_file` (String) Path to a file containing the PEM encoded private key for client auth
+- `password` (String, Sensitive) Password to use for API authentication to Elasticsearch.
+- `username` (String) Username to use for API authentication to Elasticsearch.
+
+<a id="nestedatt--lifecycles"></a>
+
+### Nested Schema for `lifecycles`
+
+Read-Only:
+
+- `data_retention` (String)
+- `downsampling` (List of Object) (see [below for nested schema](#nestedobjatt--lifecycles--downsampling))
+- `enabled` (Boolean)
+- `name` (String)
+
+<a id="nestedobjatt--lifecycles--downsampling"></a>
+
+### Nested Schema for `lifecycles.downsampling`
+
+Read-Only:
+
+- `after` (String)
+- `fixed_interval` (String)

examples/resources/elasticstack_elasticsearch_data_stream_lifecycle/resource.tf

@@ -0,0 +1,38 @@
+provider "elasticstack" {
+  elasticsearch {}
+}
+
+// First we must have a index template created
+resource "elasticstack_elasticsearch_index_template" "my_data_stream_template" {
+  name = "my_data_stream"
+
+  index_patterns = ["my-stream*"]
+
+  data_stream {}
+}
+
+// and now we can create data stream based on the index template
+resource "elasticstack_elasticsearch_data_stream" "my_data_stream" {
+  name = "my-stream"
+
+  // make sure that template is created before the data stream
+  depends_on = [
+    elasticstack_elasticsearch_index_template.my_data_stream_template
+  ]
+}
+
+// finally we can manage lifecycle of data stream
+resource "elasticstack_elasticsearch_data_stream_lifecycle" "my_data_stream_lifecycle" {
+  name           = "my-stream"
+  data_retention = "3d"
+
+  depends_on = [
+    elasticstack_elasticsearch_data_stream.my_data_stream,
+  ]
+}
+
+// or you can use wildcards to manage multiple lifecycles at once
+resource "elasticstack_elasticsearch_data_stream_lifecycle" "my_data_stream_lifecycle_multiple" {
+  name           = "stream-*"
+  data_retention = "3d"
+}

internal/clients/elasticsearch/index.go

@@ -499,6 +499,89 @@ func DeleteDataStream(ctx context.Context, apiClient *clients.ApiClient, dataStr
 	return diags
 }
 
+func PutDataStreamLifecycle(ctx context.Context, apiClient *clients.ApiClient, dataStreamName string, expand_wildcards string, lifecycle models.LifecycleSettings) diag.Diagnostics {
+	var diags diag.Diagnostics
+
+	esClient, err := apiClient.GetESClient()
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	lifecycleBytes, err := json.Marshal(lifecycle)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+
+	opts := []func(*esapi.IndicesPutDataLifecycleRequest){
+		esClient.Indices.PutDataLifecycle.WithBody(bytes.NewReader(lifecycleBytes)),
+		esClient.Indices.PutDataLifecycle.WithContext(ctx),
+		esClient.Indices.PutDataLifecycle.WithExpandWildcards(expand_wildcards),
+	}
+	res, err := esClient.Indices.PutDataLifecycle([]string{dataStreamName}, opts...)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	defer res.Body.Close()
+	if diags := utils.CheckError(res, fmt.Sprintf("Unable to create DataStreamLifecycle: %s", dataStreamName)); diags.HasError() {
+		return diags
+	}
+
+	return diags
+}
+
+func GetDataStreamLifecycle(ctx context.Context, apiClient *clients.ApiClient, dataStreamName string, expand_wildcards string) (*[]models.DataStreamLifecycle, diag.Diagnostics) {
+	var diags diag.Diagnostics
+	esClient, err := apiClient.GetESClient()
+	if err != nil {
+		return nil, diag.FromErr(err)
+	}
+	opts := []func(*esapi.IndicesGetDataLifecycleRequest){
+		esClient.Indices.GetDataLifecycle.WithContext(ctx),
+		esClient.Indices.GetDataLifecycle.WithExpandWildcards(expand_wildcards),
+	}
+	res, err := esClient.Indices.GetDataLifecycle([]string{dataStreamName}, opts...)
+	if err != nil {
+		return nil, diag.FromErr(err)
+	}
+	defer res.Body.Close()
+	if res.StatusCode == http.StatusNotFound {
+		return nil, nil
+	}
+	if diags := utils.CheckError(res, fmt.Sprintf("Unable to get requested DataStreamLifecycle: %s", dataStreamName)); diags.HasError() {
+		return nil, diags
+	}
+
+	dStreams := make(map[string][]models.DataStreamLifecycle)
+	if err := json.NewDecoder(res.Body).Decode(&dStreams); err != nil {
+		return nil, diag.FromErr(err)
+	}
+	ds := dStreams["data_streams"]
+	return &ds, diags
+}
+
+func DeleteDataStreamLifecycle(ctx context.Context, apiClient *clients.ApiClient, dataStreamName string, expand_wildcards string) diag.Diagnostics {
+	var diags diag.Diagnostics
+
+	esClient, err := apiClient.GetESClient()
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	opts := []func(*esapi.IndicesDeleteDataLifecycleRequest){
+		esClient.Indices.DeleteDataLifecycle.WithContext(ctx),
+		esClient.Indices.DeleteDataLifecycle.WithExpandWildcards(expand_wildcards),
+	}
+	res, err := esClient.Indices.DeleteDataLifecycle([]string{dataStreamName}, opts...)
+	if err != nil {
+		return diag.FromErr(err)
+	}
+	defer res.Body.Close()
+	if diags := utils.CheckError(res, fmt.Sprintf("Unable to delete DataStreamLifecycle: %s", dataStreamName)); diags.HasError() {
+		return diags
+	}
+
+	return diags
+}
+
 func PutIngestPipeline(ctx context.Context, apiClient *clients.ApiClient, pipeline *models.IngestPipeline) diag.Diagnostics {
 	var diags diag.Diagnostics
 	pipelineBytes, err := json.Marshal(pipeline)

internal/elasticsearch/cluster/slm.go

@@ -10,7 +10,6 @@ import (
 	"github.com/elastic/terraform-provider-elasticstack/internal/clients/elasticsearch"
 	"github.com/elastic/terraform-provider-elasticstack/internal/models"
 	"github.com/elastic/terraform-provider-elasticstack/internal/utils"
-	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -31,33 +30,11 @@ func ResourceSlm() *schema.Resource {
 			ForceNew:    true,
 		},
 		"expand_wildcards": {
-			Description: "Determines how wildcard patterns in the `indices` parameter match data streams and indices. Supports comma-separated values, such as `closed,hidden`.",
-			Type:        schema.TypeString,
-			Optional:    true,
-			Default:     "open,hidden",
-			ValidateDiagFunc: func(value interface{}, path cty.Path) diag.Diagnostics {
-				validValues := []string{"all", "open", "closed", "hidden", "none"}
-
-				var diags diag.Diagnostics
-				for _, pv := range strings.Split(value.(string), ",") {
-					found := false
-					for _, vv := range validValues {
-						if vv == strings.TrimSpace(pv) {
-							found = true
-							break
-						}
-					}
-					if !found {
-						diags = append(diags, diag.Diagnostic{
-							Severity: diag.Error,
-							Summary:  "Invalid value was provided.",
-							Detail:   fmt.Sprintf(`"%s" is not valid value for this field.`, pv),
-						})
-						return diags
-					}
-				}
-				return diags
-			},
+			Description:      "Determines how wildcard patterns in the `indices` parameter match data streams and indices. Supports comma-separated values, such as `closed,hidden`.",
+			Type:             schema.TypeString,
+			Optional:         true,
+			Default:          "open,hidden",
+			ValidateDiagFunc: utils.AllowedExpandWildcards,
 		},
 		"ignore_unavailable": {
 			Description: "If `false`, the snapshot fails if any data stream or index in indices is missing or closed. If `true`, the snapshot ignores missing or closed data streams and indices.",