Feature/530/migrate to plugin framework (#567)

Migration to TF Framework. A breaking schema change. Please see relevant NOTES in CHANGELOG for v0.6.0 and README for more info. State upgrade is not supported, please use import instead. --------- Co-authored-by: Pascal Hofmann <[email protected]> Co-authored-by: Pascal Hofmann <[email protected]> Co-authored-by: Toby Brain <[email protected]>
elastic · Feb 27, 2023 · 269648d · 269648d
1 parent b9c45c5
commit 269648d
Show file tree

Hide file tree

Showing 388 changed files with 31,735 additions and 23,074 deletions.
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -21,7 +21,8 @@ jobs:
     - name: Install terraform
       uses: hashicorp/setup-terraform@v2
       with:
-        terraform_version: "0.14.x"
+        terraform_version: "1.x.x"
+        terraform_wrapper: false
 
     - name: Cache Go Modules
       uses: actions/cache@v3

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,11 +1,37 @@
-# 0.6.0 (Unreleased)
+# 0.7.0 (Unreleased)
 
 # 0.5.1 (Feb 15, 2023)
 
 FEATURES:
 
 * resource/deployment: Utilise the template migration API to build the base update request when changing `deployment_template_id`. This results in more reliable changes between deployment templates. ([#547](https://github.com/elastic/terraform-provider-ec/issues/547))
 
+# 0.6.0 (Unreleased)
+
+FEATURES:
+
+Migration to [TF Plugin Framework](https://developer.hashicorp.com/terraform/plugin/framework)
+
+**BREAKING CHANGES**:
+
+New schema for `ec_deployment`. Existing resources should be imported. Please see NOTES below and README for more details.
+
+BUG FIXES:
+
+[#336](https://github.com/elastic/terraform-provider-ec/issues/336)
+[#467](https://github.com/elastic/terraform-provider-ec/issues/467)
+[#445](https://github.com/elastic/terraform-provider-ec/issues/445)
+
+NOTES
+
+* Older versions of terraform CLI can report errors with the provider 0.6.0 and higher. Please make sure to update Terraform CLI to the latest version.
+* State upgrade is not implemented for `ec_deployment`.
+  The recommended way to proceed with existing TF resources is [state import](https://developer.hashicorp.com/terraform/cli/import#state-only).
+  However, this doesn't import user passwords and secret tokens.
+* After import, the next plan command can output more elements that the actual configuration defines, e.g. plan command can output `cold` Elasticsearch tier with 0 size or empty `config` block for configuration that doesn't specify `cold` tier and `config` for `elasticsearch`.
+  It should not be a problem. You can eigher execute the plan (the only result should be updated Terraform state while the deployment should stay the same) or add empty `cold` tier and `confg` to the configuration.
+* The migration is based on 0.4.1, so all changes from 0.5.0 are omitted.
+
 # 0.5.0 (Oct 12, 2022)
 
 FEATURES:

diff --git a/NOTICE b/NOTICE
@@ -1,5 +1,5 @@
 terraform-provider-ec
-Copyright 2023 Elasticsearch B.V.
+Copyright 2022-2023 Elasticsearch B.V.
 
 This product includes software developed at Elasticsearch B.V. and
 third-party software developed by the licenses listed below.

diff --git a/README.md b/README.md
@@ -72,9 +72,15 @@ resource "ec_deployment" "example_minimal" {
   deployment_template_id = "aws-io-optimized-v2"
 
   # Use the deployment template defaults
-  elasticsearch {}
+  elasticsearch = {
+    hot = {
+      autoscaling = {}
+    }
+  }
 
-  kibana {}
+  kibana = {
+    topology = {}
+  }
 }
 ```
 
@@ -114,3 +120,125 @@ $ export EC_API_KEY="<apikey value>"
 ```
 
 After doing so, you can navigate to any of our examples in `./examples` and try one.
+
+### Moving to TF Framework and schema change for `ec_deployment` resource.
+
+v0.6.0 contains migration to [TF Plugin Framework](https://developer.hashicorp.com/terraform/plugin/framework) and intoduces new schema for `ec_deployment` resource:
+
+- switching to attributes syntax instead of blocks for almost all definitions that used to be blocks. It means that, for example, a definition like `elasticsearch {...}` has to be changed to `elasticsearch = {...}`, e.g.
+
+```hcl
+resource "ec_deployment" "defaults" {
+  name                   = "example"
+  region                 = "us-east-1"
+  version                = data.ec_stack.latest.version
+  deployment_template_id = "aws-io-optimized-v2"
+
+  elasticsearch = {
+    hot = {
+      autoscaling = {}
+    }
+  }
+
+  kibana = {
+    topology = {}
+  }
+
+  enterprise_search = {
+    zone_count = 1
+  }
+}
+```
+
+- `topology` attribute of `elasticsearch` is replaced with a number of dedicated attributes, one per tier, e.g. 
+
+```
+  elasticsearch {
+    topology {
+      id         = "hot_content"
+      size       = "1g"
+      autoscaling {
+        max_size = "8g"
+      }
+    }
+    topology {
+      id         = "warm"
+      size       = "2g"
+      autoscaling {
+        max_size = "15g"
+      }
+    }
+  }
+```
+
+has to be converted to 
+
+```
+  elasticsearch = {
+    hot = {
+      size = "1g"
+      autoscaling = {
+        max_size = "8g"
+      }
+    }
+
+    warm = {
+      size = "2g"
+      autoscaling = {
+        max_size = "15g"
+      }
+    }
+  }
+
+```
+
+- due to some existing limitations of TF, nested attributes that are nested inside other nested attributes cannot be `Computed`. It means that all such attributes have to be mentioned in configurations even if they are empty. E.g., a definition of `elasticsearch` has to include all topology elements (tiers) that have non-zero size or can be scaled up (if autoscaling is enabled) in the corresponding template. For example, the simplest definition of `elasticsearch` for `aws-io-optimized-v2` template is 
+
+```hcl
+resource "ec_deployment" "defaults" {
+  name                   = "example"
+  region                 = "us-east-1"
+  version                = data.ec_stack.latest.version
+  deployment_template_id = "aws-io-optimized-v2"
+
+  elasticsearch = {
+    hot = {
+      autoscaling = {}
+    }
+  }
+}
+```
+
+Please note that the snippet explicitly mentions `hot` tier with `autoscaling` attribute even despite the fact that they are empty.
+
+- a lot of attributes that used to be collections (e.g. lists and sets) are converted to sigletons, e.g. `elasticsearch`, `apm`, `kibana`, `enterprise_search`, `observability`, `topology`, `autoscaling`, etc. Please note that, generally, users are not expected to make any change to their existing configuration to address this particular change (besides moving from block to attribute syntax). All these components used to exist in single instances, so the change is mostly syntactical, taking into account the switch to attributes instead of blocks (otherwise if we kept list for configs,  `config {}` had to be rewritten in `config = [{}]` with the move to the attribute syntax). However this change is a breaking one from the schema perspective and requires state upgrade for existing resources that is performed by TF (by calling the provider's API).
+
+- [`strategy` attribute](https://registry.terraform.io/providers/elastic/ec/latest/docs/resources/ec_deployment#strategy) is converted to string with the same set of values that was used for its `type` attribute previously;
+
+- switching to TF protocol 6. From user perspective it should not require any change in their existing configurations.
+
+#### Moving to the provider v0.6.0.
+
+The schema modifications means that a current TF state cannot work as is with the provider version 0.6.0 and higher.
+
+There are 2 ways to tackle this
+
+- import existing resource using deployment ID, e.g `terraform import 'ec_deployment.test' <deployment_id>`
+- state upgrade that is performed by TF by calling the provider's API so no action is required from users
+
+Currently the state upgrade functionality is not implemented so importing existing resources is the recommended way to deal with existing TF states.
+Please mind the fact that state import doesn't import user passwords and secret tokens that can be the case if your TF modules make use of them.
+State upgrade doesn't have this limitation.
+
+#### Known issues of moving to the provider v0.6.0
+
+- Older versions of terraform CLI can report errors with the provider 0.6.0 and higher. Please make sure to update Terraform CLI to the latest version.
+
+- Starting from the provider v0.6.0, `terraform plan` output can contain more changes comparing to the older versions of the provider (that use TF SDK v2).
+  This happens because TF Framework treats all `computed` attributes as `unknown` (known after apply) once configuration changes.
+  However, it doesn't mean that all attributes that marked as `unknown` in the plan will get new values after apply.
+
+- After import, the next plan command can output more elements that the actual configuration defines, e.g. plan command can output `cold` Elasticsearch tier with 0 size or empty `config` block for configuration that doesn't specify `cold` tier and `config` for `elasticsearch`.
+  It should not be a problem. You can eigher execute the plan (the only result should be updated Terraform state while the deployment should stay the same) or add empty `cold` tier and `confg` to the configuration.
+
+- The migration is based on 0.4.1, so all changes from 0.5.0 are omitted.
diff --git a/build/Makefile.deps b/build/Makefile.deps
@@ -5,7 +5,7 @@ ARCH_GORELEASER:=$(shell $(PWD)/scripts/uname_arch_goreleaser.sh)
 VERSION_DIR:=$(GOBIN)/versions
 
 VERSION_GOLICENSER:=v0.3.0
-VERSION_GOLANGCILINT:=v1.49.0
+VERSION_GOLANGCILINT:=v1.50.0
 VERSION_GORELEASER:=v1.15.2
 VERSION_GOCHANGELOG:=v0.0.0-20201005170154-56335215ce3a
 VERSION_VERSIONBUMP:=v1.1.0

diff --git a/build/Makefile.test b/build/Makefile.test
@@ -3,7 +3,7 @@ SWEEP_DIR ?= $(TEST_ACC)
 SWEEP_CI_RUN_FILTER ?= ec_deployments
 TEST ?= ./...
 TEST_COUNT ?= 1
-TESTUNITARGS ?= -timeout 10s -p 4 -race -cover -coverprofile=reports/c.out
+TESTUNITARGS ?= -timeout 10m -race -cover -coverprofile=reports/c.out
 TEST_ACC ?= github.com/elastic/terraform-provider-ec/ec/acc
 TEST_NAME ?= TestAcc
 TEST_ACC_PARALLEL = 6
@@ -26,7 +26,7 @@ unit: _report_path
 tests: unit
 
 .PHONY: testacc
-## Runs the Terraform acceptance tests. Use TEST_NAME, TESTARGS, TEST_COUNT and TEST_ACC_PARALLEL to control execution.
+## Runs the Terraform acceptance tests. Use TEST_NAME, TESTARGS, TEST_COUNT to control execution.
 testacc:
 	@ echo "-> Running terraform acceptance tests..."
 	@ TF_ACC=1 go test $(TEST_ACC) -v -count $(TEST_COUNT) -parallel $(TEST_ACC_PARALLEL) $(TESTARGS) -timeout 120m -run $(TEST_NAME)

diff --git a/docs/data-sources/ec_stack.md b/docs/data-sources/ec_stack.md
@@ -4,7 +4,7 @@ description: |-
   Retrieves information about an Elastic Cloud stack.
 ---
 
-# Data Source: ec_deployment
+# Data Source: ec_stack
 
 Use this data source to retrieve information about an existing Elastic Cloud stack.
 

diff --git a/docs/guides/configuring-sso-ec-deployment.md b/docs/guides/configuring-sso-ec-deployment.md
@@ -31,27 +31,27 @@ resource "ec_deployment" "elastic-sso" {
   version                = "7.17.5"
   deployment_template_id = "aws-compute-optimized-v3"
 
-  elasticsearch {
-    topology {
-      id         = "hot_content"
+  elasticsearch = {
+    hot = {
       size       = "8g"
       zone_count = 2
     }
 
-    topology {
-      id         = "warm"
+    warm = {
       size       = "8g"
       zone_count = 2
     }
 
-    config {
+    config = {
       # The URL domain suffix that is used in this example is often different for other Elasticsearch Service regions. Please check the appropriate domain suffix for your used region.
       user_settings_yaml = templatefile("./es.yml", { kibana_url = format("https://%s-%s.kb.us-east-1.aws.found.io:9243", var.name, substr("${random_uuid.uuid.result}", 0, 6)) })
     }
   }
 
-  kibana {
-    config {
+  kibana = {
+    topology = {}
+
+    config = {
       user_settings_yaml = file("./kb.yml")
     }
   }
@@ -71,7 +71,7 @@ You will configure the deployment alias field to be the same, so if the deployme
 Then, by using a variable in the `es.yml` file and a terraform templating mechanism, you can generate your own `es.yml` file. Your variable is named kibana_url, as seen in the ec_deployment resource:
 
 ```hcl
-config {
+config = {
   user_settings_yaml = templatefile("./es.yml", { kibana_url = format("https://%s-%s.kb.us-east-1.aws.found.io:9243", var.name, substr("${random_uuid.uuid.result}", 0, 6)) })
 }
 ```