support for transform start/stop

Author: Cristigeo

docs/resources/elasticsearch_transform.md

@@ -1,7 +1,7 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "elasticstack_elasticsearch_transform Resource - terraform-provider-elasticstack"
-subcategory: ""
+page_title: 'elasticstack_elasticsearch_transform Resource - terraform-provider-elasticstack'
+subcategory: ''
 description: |-
   Manages Elasticsearch transforms. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/transforms.html
 ---
@@ -59,11 +59,14 @@ resource "elasticstack_elasticsearch_transform" "transform_with_pivot" {
     }
   }
 
+  enabled = false
+
   defer_validation = false
 }
 ```
 
 <!-- schema generated by tfplugindocs -->
+
 ## Schema
 
 ### Required
@@ -77,20 +80,22 @@ resource "elasticstack_elasticsearch_transform" "transform_with_pivot" {
 - `defer_validation` (Boolean) When true, deferrable validations are not run upon creation, but rather when the transform is started. This behavior may be desired if the source index does not exist until after the transform is created.
 - `description` (String) Free text description of the transform.
 - `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) Controls wether the transform is started or stopped. Default is `false` (stopped).
 - `frequency` (String) The interval between checks for changes in the source indices when the transform is running continuously. Defaults to `1m`.
 - `latest` (String) The latest method transforms the data by finding the latest document for each unique key. JSON definition expected. Either 'pivot' or 'latest' must be present.
 - `metadata` (String) Defines optional transform metadata.
 - `pivot` (String) The pivot method transforms the data by aggregating and grouping it. JSON definition expected. Either 'pivot' or 'latest' must be present.
 - `retention_policy` (Block List, Max: 1) Defines a retention policy for the transform. (see [below for nested schema](#nestedblock--retention_policy))
 - `settings` (Block List, Max: 1) Defines optional transform settings. (see [below for nested schema](#nestedblock--settings))
 - `sync` (Block List, Max: 1) Defines the properties transforms require to run continuously. (see [below for nested schema](#nestedblock--sync))
-- `timeout` (String) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to `30s`.
+- `timeout` (String) Period to wait for a response from Elastisearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to `30s`.
 
 ### Read-Only
 
 - `id` (String) Internal identifier of the resource
 
 <a id="nestedblock--destination"></a>
+
 ### Nested Schema for `destination`
 
 Required:
@@ -101,8 +106,8 @@ Optional:
 
 - `pipeline` (String) The unique identifier for an ingest pipeline.
 
-
 <a id="nestedblock--source"></a>
+
 ### Nested Schema for `source`
 
 Required:
@@ -114,8 +119,8 @@ Optional:
 - `query` (String) A query clause that retrieves a subset of data from the source index.
 - `runtime_mappings` (String) Definitions of search-time runtime fields that can be used by the transform.
 
-
 <a id="nestedblock--elasticsearch_connection"></a>
+
 ### Nested Schema for `elasticsearch_connection`
 
 Optional:
@@ -132,25 +137,25 @@ Optional:
 - `password` (String, Sensitive) Password to use for API authentication to Elasticsearch.
 - `username` (String) Username to use for API authentication to Elasticsearch.
 
-
 <a id="nestedblock--retention_policy"></a>
+
 ### Nested Schema for `retention_policy`
 
 Required:
 
 - `time` (Block List, Min: 1, Max: 1) Specifies that the transform uses a time field to set the retention policy. (see [below for nested schema](#nestedblock--retention_policy--time))
 
 <a id="nestedblock--retention_policy--time"></a>
+
 ### Nested Schema for `retention_policy.time`
 
 Required:
 
 - `field` (String) The date field that is used to calculate the age of the document.
 - `max_age` (String) Specifies the maximum age of a document in the destination index.
 
-
-
 <a id="nestedblock--settings"></a>
+
 ### Nested Schema for `settings`
 
 Optional:
@@ -163,15 +168,16 @@ Optional:
 - `num_failure_retries` (Number) Defines the number of retries on a recoverable failure before the transform task is marked as failed. The default value is the cluster-level setting num_transform_failure_retries.
 - `unattended` (Boolean) In unattended mode, the transform retries indefinitely in case of an error which means the transform never fails. Defaults to false.
 
-
 <a id="nestedblock--sync"></a>
+
 ### Nested Schema for `sync`
 
 Required:
 
 - `time` (Block List, Min: 1, Max: 1) Specifies that the transform uses a time field to synchronize the source and destination indices. (see [below for nested schema](#nestedblock--sync--time))
 
 <a id="nestedblock--sync--time"></a>
+
 ### Nested Schema for `sync.time`
 
 Required:
@@ -181,5 +187,3 @@ Required:
 Optional:
 
 - `delay` (String) The time delay between the current time and the latest input data time. The default value is 60s.
-
-

examples/resources/elasticstack_elasticsearch_transform/resource.tf

@@ -44,5 +44,7 @@ resource "elasticstack_elasticsearch_transform" "transform_with_pivot" {
     }
   }
 
+  enabled = false
+
   defer_validation = false
-}
+}

internal/clients/elasticsearch/index.go

@@ -546,7 +546,7 @@ func DeleteIngestPipeline(ctx context.Context, apiClient *clients.ApiClient, nam
 }
 
 func PutTransform(ctx context.Context, apiClient *clients.ApiClient, transform *models.Transform, params *models.PutTransformParams) diag.Diagnostics {
-	fmt.Println("entering PutTransform")
+	fmt.Println("entering PutTransform for", transform.Name)
 	var diags diag.Diagnostics
 	transformBytes, err := json.Marshal(transform)
 	if err != nil {
@@ -576,11 +576,18 @@ func PutTransform(ctx context.Context, apiClient *clients.ApiClient, transform *
 		return diags
 	}
 
+	if params.Enabled {
+		_, err := esClient.TransformStartTransform(transform.Name)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+	}
+
 	return diags
 }
 
 func GetTransform(ctx context.Context, apiClient *clients.ApiClient, name *string) (*models.Transform, diag.Diagnostics) {
-	fmt.Println("entering GetTransform for ", *name)
+	fmt.Println("entering GetTransform for", *name)
 	var diags diag.Diagnostics
 	esClient, err := apiClient.GetESClient()
 	if err != nil {
@@ -615,7 +622,7 @@ func GetTransform(ctx context.Context, apiClient *clients.ApiClient, name *strin
 }
 
 func UpdateTransform(ctx context.Context, apiClient *clients.ApiClient, transform *models.Transform, params *models.UpdateTransformParams) diag.Diagnostics {
-	fmt.Println("entering UpdateTransform")
+	fmt.Println("entering UpdateTransform with Enabled", params.Enabled)
 	var diags diag.Diagnostics
 	transformBytes, err := json.Marshal(transform)
 	if err != nil {
@@ -645,24 +652,36 @@ func UpdateTransform(ctx context.Context, apiClient *clients.ApiClient, transfor
 		return diags
 	}
 
+	if params.Enabled {
+		_, err := esClient.TransformStartTransform(transform.Name)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+	} else {
+		_, err := esClient.TransformStopTransform(transform.Name)
+		if err != nil {
+			return diag.FromErr(err)
+		}
+	}
+
 	return diags
 }
 
-func DeleteTransform(ctx context.Context, apiClient *clients.ApiClient, name string) diag.Diagnostics {
-	fmt.Println("entering DeleteTransform for ", name)
+func DeleteTransform(ctx context.Context, apiClient *clients.ApiClient, name *string) diag.Diagnostics {
+	fmt.Println("entering DeleteTransform for", *name)
 	var diags diag.Diagnostics
 
 	esClient, err := apiClient.GetESClient()
 	if err != nil {
 		return diag.FromErr(err)
 	}
 
-	res, err := esClient.TransformDeleteTransform(name, esClient.TransformDeleteTransform.WithForce(true), esClient.TransformDeleteTransform.WithContext(ctx))
+	res, err := esClient.TransformDeleteTransform(*name, esClient.TransformDeleteTransform.WithForce(true), esClient.TransformDeleteTransform.WithContext(ctx))
 	if err != nil {
 		return diag.FromErr(err)
 	}
 	defer res.Body.Close()
-	if diags := utils.CheckError(res, fmt.Sprintf("Unable to delete the transform: %s", name)); diags.HasError() {
+	if diags := utils.CheckError(res, fmt.Sprintf("Unable to delete the transform: %s", *name)); diags.HasError() {
 		return diags
 	}
 

internal/elasticsearch/transform/transform.go

@@ -248,11 +248,17 @@ func ResourceTransform() *schema.Resource {
 		},
 		"timeout": {
 			Type:         schema.TypeString,
-			Description:  "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to `30s`.",
+			Description:  "Period to wait for a response from Elastisearch when performing any management operation. If no response is received before the timeout expires, the operation fails and returns an error. Defaults to `30s`.",
 			Optional:     true,
 			Default:      "30s",
 			ValidateFunc: utils.StringIsDuration,
 		},
+		"enabled": {
+			Type:        schema.TypeBool,
+			Description: "Controls wether the transform is started or stopped. Default is `false` (stopped).",
+			Optional:    true,
+			Default:     false,
+		},
 	}
 
 	utils.AddConnectionSchema(transformSchema)
@@ -269,7 +275,6 @@ func ResourceTransform() *schema.Resource {
 }
 
 func resourceTransformCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	fmt.Println("entering resourceTransformCreate")
 
 	client, diags := clients.NewApiClient(d, meta)
 	if diags.HasError() {
@@ -297,6 +302,8 @@ func resourceTransformCreate(ctx context.Context, d *schema.ResourceData, meta i
 	}
 	params.Timeout = timeout
 
+	params.Enabled = d.Get("enabled").(bool)
+
 	if diags := elasticsearch.PutTransform(ctx, client, transform, &params); diags.HasError() {
 		return diags
 	}
@@ -306,7 +313,7 @@ func resourceTransformCreate(ctx context.Context, d *schema.ResourceData, meta i
 }
 
 func resourceTransformRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	fmt.Println("entering resourceTransformRead")
+
 	client, diags := clients.NewApiClient(d, meta)
 	if diags.HasError() {
 		return diags
@@ -335,7 +342,6 @@ func resourceTransformRead(ctx context.Context, d *schema.ResourceData, meta int
 }
 
 func resourceTransformUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	fmt.Println("entering resourceTransformUpdate")
 
 	client, diags := clients.NewApiClient(d, meta)
 	if diags.HasError() {
@@ -366,6 +372,8 @@ func resourceTransformUpdate(ctx context.Context, d *schema.ResourceData, meta i
 	}
 	params.Timeout = timeout
 
+	params.Enabled = d.Get("enabled").(bool)
+
 	if diags := elasticsearch.UpdateTransform(ctx, client, updatedTransform, &params); diags.HasError() {
 		return diags
 	}
@@ -374,7 +382,7 @@ func resourceTransformUpdate(ctx context.Context, d *schema.ResourceData, meta i
 }
 
 func resourceTransformDelete(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	fmt.Println("entering resourceTransformDelete")
+
 	client, diags := clients.NewApiClient(d, meta)
 	if diags.HasError() {
 		return diags
@@ -386,7 +394,7 @@ func resourceTransformDelete(ctx context.Context, d *schema.ResourceData, meta i
 		return diags
 	}
 
-	if diags := elasticsearch.DeleteTransform(ctx, client, compId.ResourceId); diags.HasError() {
+	if diags := elasticsearch.DeleteTransform(ctx, client, &compId.ResourceId); diags.HasError() {
 		return diags
 	}
 

internal/elasticsearch/transform/transform_test.go

@@ -1,14 +1,11 @@
 package transform_test
 
 import (
-	//"context"
 	"fmt"
-	//"regexp"
 	"testing"
 
 	"github.com/elastic/terraform-provider-elasticstack/internal/acctest"
 	"github.com/elastic/terraform-provider-elasticstack/internal/clients"
-	//"github.com/elastic/terraform-provider-elasticstack/internal/elasticsearch/transform"
 	sdkacctest "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
@@ -128,6 +125,7 @@ resource "elasticstack_elasticsearch_transform" "test_pivot" {
     }
   })
   frequency = "5m"
+	enabled = false
 
 	defer_validation = true
 	timeout = "1m"
@@ -171,6 +169,7 @@ resource "elasticstack_elasticsearch_transform" "test_pivot" {
     }
   })
   frequency = "10m"
+	enabled = true
 
 	defer_validation = true
 	timeout = "1m"
@@ -201,6 +200,7 @@ resource "elasticstack_elasticsearch_transform" "test_latest" {
     "sort": "order_date"
   })
   frequency = "2m"
+	enabled = false
 
 	defer_validation = true
 	timeout = "1m"
@@ -270,6 +270,7 @@ resource "elasticstack_elasticsearch_transform" "test_pivot" {
     }
   })
   frequency = "5m"
+	enabled = false
 
 	defer_validation = false
 	timeout = "1m"

internal/models/transform.go

@@ -62,11 +62,13 @@ type TransformSettings struct {
 type PutTransformParams struct {
 	DeferValidation bool
 	Timeout         time.Duration
+	Enabled         bool
 }
 
 type UpdateTransformParams struct {
 	DeferValidation bool
 	Timeout         time.Duration
+	Enabled         bool
 }
 
 type GetTransformResponse struct {