Experiment/topologies map

.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

CHANGELOG.md

@@ -1,9 +1,33 @@
-# 0.6.0 (Unreleased)
+# 0.7.0 (Unreleased)
 
 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`
+
+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
+
+* The migration is based on 0.4.1, so all changes from 0.5.0 are omitted.
+
+* State upgrade is not yet 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.
+
 # 0.5.0 (Oct 12, 2022)
 
 FEATURES:

NOTICE

@@ -1,85 +1,83 @@
 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.
 
 =========================================================================
 
-github.com/davecgh/go-spew                         0BSD
-github.com/agext/levenshtein                       Apache-2.0
-github.com/apparentlymart/go-textseg/v13           Apache-2.0
-github.com/elastic/cloud-sdk-go                    Apache-2.0
-github.com/go-logr/logr                            Apache-2.0
-github.com/go-logr/stdr                            Apache-2.0
-github.com/go-openapi/analysis                     Apache-2.0
-github.com/go-openapi/errors                       Apache-2.0
-github.com/go-openapi/jsonpointer                  Apache-2.0
-github.com/go-openapi/jsonreference                Apache-2.0
-github.com/go-openapi/loads                        Apache-2.0
-github.com/go-openapi/runtime                      Apache-2.0
-github.com/go-openapi/spec                         Apache-2.0
-github.com/go-openapi/strfmt                       Apache-2.0
-github.com/go-openapi/swag                         Apache-2.0
-github.com/go-openapi/validate                     Apache-2.0
-github.com/oklog/run                               Apache-2.0
-github.com/oklog/ulid                              Apache-2.0
-github.com/opentracing/opentracing-go              Apache-2.0
-go.mongodb.org/mongo-driver                        Apache-2.0
-go.opentelemetry.io/otel/trace                     Apache-2.0
-go.opentelemetry.io/otel                           Apache-2.0
-google.golang.org/appengine                        Apache-2.0
-google.golang.org/genproto                         Apache-2.0
-google.golang.org/grpc                             Apache-2.0
-gopkg.in/yaml.v2                                   Apache-2.0
-gopkg.in/yaml.v3                                   Apache-2.0
-github.com/vmihailenco/msgpack/v4                  BSD-2-Clause
-github.com/vmihailenco/msgpack                     BSD-2-Clause
-github.com/vmihailenco/tagparser                   BSD-2-Clause
-github.com/puerkitobio/purell                      BSD-3-Clause
-github.com/puerkitobio/urlesc                      BSD-3-Clause
-github.com/golang/protobuf                         BSD-3-Clause
-github.com/google/go-cmp                           BSD-3-Clause
-github.com/pmezard/go-difflib                      BSD-3-Clause
-golang.org/x/crypto                                BSD-3-Clause
-golang.org/x/net                                   BSD-3-Clause
-golang.org/x/sys                                   BSD-3-Clause
-golang.org/x/text                                  BSD-3-Clause
-google.golang.org/protobuf                         BSD-3-Clause
-github.com/apparentlymart/go-cidr                  MIT
-github.com/asaskevich/govalidator                  MIT
-github.com/blang/semver/v4                         MIT
-github.com/fatih/color                             MIT
-github.com/hashicorp/go-cty                        MIT
-github.com/hashicorp/go-hclog                      MIT
-github.com/josharian/intern                        MIT
-github.com/mailru/easyjson                         MIT
-github.com/mattn/go-colorable                      MIT
-github.com/mattn/go-isatty                         MIT
-github.com/mitchellh/copystructure                 MIT
-github.com/mitchellh/go-testing-interface          MIT
-github.com/mitchellh/go-wordwrap                   MIT
-github.com/mitchellh/mapstructure                  MIT
-github.com/mitchellh/reflectwalk                   MIT
-github.com/stretchr/testify                        MIT
-github.com/zclconf/go-cty                          MIT
-github.com/hashicorp/go-checkpoint                 MPL-2.0
-github.com/hashicorp/go-cleanhttp                  MPL-2.0
-github.com/hashicorp/go-multierror                 MPL-2.0
-github.com/hashicorp/hc-install                    MPL-2.0
-github.com/hashicorp/hcl/v2                        MPL-2.0
-github.com/hashicorp/logutils                      MPL-2.0
-github.com/hashicorp/terraform-json                MPL-2.0
-github.com/hashicorp/terraform-plugin-log          MPL-2.0
-github.com/hashicorp/terraform-plugin-sdk/v2       MPL-2.0
-github.com/hashicorp/yamux                         MPL-2.0
-github.com/hashicorp/errwrap                       MPL-2.0-no-copyleft-exception
-github.com/hashicorp/go-plugin                     MPL-2.0-no-copyleft-exception
-github.com/hashicorp/go-uuid                       MPL-2.0-no-copyleft-exception
-github.com/hashicorp/go-version                    MPL-2.0-no-copyleft-exception
-github.com/hashicorp/terraform-exec                MPL-2.0-no-copyleft-exception
-github.com/hashicorp/terraform-plugin-go           MPL-2.0-no-copyleft-exception
-github.com/hashicorp/terraform-registry-address    MPL-2.0-no-copyleft-exception
-github.com/hashicorp/terraform-svchost             MPL-2.0-no-copyleft-exception
+github.com/davecgh/go-spew                                    0BSD
+github.com/agext/levenshtein                                  Apache-2.0
+github.com/apparentlymart/go-textseg/v13                      Apache-2.0
+github.com/elastic/cloud-sdk-go                               Apache-2.0
+github.com/go-openapi/analysis                                Apache-2.0
+github.com/go-openapi/errors                                  Apache-2.0
+github.com/go-openapi/jsonpointer                             Apache-2.0
+github.com/go-openapi/jsonreference                           Apache-2.0
+github.com/go-openapi/loads                                   Apache-2.0
+github.com/go-openapi/runtime                                 Apache-2.0
+github.com/go-openapi/spec                                    Apache-2.0
+github.com/go-openapi/strfmt                                  Apache-2.0
+github.com/go-openapi/swag                                    Apache-2.0
+github.com/go-openapi/validate                                Apache-2.0
+github.com/oklog/run                                          Apache-2.0
+github.com/oklog/ulid                                         Apache-2.0
+github.com/opentracing/opentracing-go                         Apache-2.0
+go.mongodb.org/mongo-driver                                   Apache-2.0
+google.golang.org/appengine                                   Apache-2.0
+google.golang.org/genproto                                    Apache-2.0
+google.golang.org/grpc                                        Apache-2.0
+gopkg.in/yaml.v2                                              Apache-2.0
+gopkg.in/yaml.v3                                              Apache-2.0
+github.com/vmihailenco/msgpack/v4                             BSD-2-Clause
+github.com/vmihailenco/msgpack                                BSD-2-Clause
+github.com/vmihailenco/tagparser                              BSD-2-Clause
+github.com/golang/protobuf                                    BSD-3-Clause
+github.com/google/go-cmp                                      BSD-3-Clause
+github.com/pmezard/go-difflib                                 BSD-3-Clause
+golang.org/x/crypto                                           BSD-3-Clause
+golang.org/x/exp                                              BSD-3-Clause
+golang.org/x/net                                              BSD-3-Clause
+golang.org/x/sys                                              BSD-3-Clause
+golang.org/x/text                                             BSD-3-Clause
+google.golang.org/protobuf                                    BSD-3-Clause
+github.com/apparentlymart/go-cidr                             MIT
+github.com/asaskevich/govalidator                             MIT
+github.com/blang/semver/v4                                    MIT
+github.com/blang/semver                                       MIT
+github.com/fatih/color                                        MIT
+github.com/hashicorp/go-cty                                   MIT
+github.com/hashicorp/go-hclog                                 MIT
+github.com/josharian/intern                                   MIT
+github.com/mailru/easyjson                                    MIT
+github.com/mattn/go-colorable                                 MIT
+github.com/mattn/go-isatty                                    MIT
+github.com/mitchellh/copystructure                            MIT
+github.com/mitchellh/go-testing-interface                     MIT
+github.com/mitchellh/go-wordwrap                              MIT
+github.com/mitchellh/mapstructure                             MIT
+github.com/mitchellh/reflectwalk                              MIT
+github.com/stretchr/testify                                   MIT
+github.com/zclconf/go-cty                                     MIT
+github.com/hashicorp/errwrap                                  MPL-2.0
+github.com/hashicorp/go-checkpoint                            MPL-2.0
+github.com/hashicorp/go-plugin                                MPL-2.0
+github.com/hashicorp/go-uuid                                  MPL-2.0
+github.com/hashicorp/hc-install                               MPL-2.0
+github.com/hashicorp/terraform-exec                           MPL-2.0
+github.com/hashicorp/terraform-json                           MPL-2.0
+github.com/hashicorp/terraform-plugin-framework-validators    MPL-2.0
+github.com/hashicorp/terraform-plugin-sdk/v2                  MPL-2.0
+github.com/hashicorp/terraform-svchost                        MPL-2.0
+github.com/hashicorp/go-cleanhttp                             MPL-2.0-no-copyleft-exception
+github.com/hashicorp/go-multierror                            MPL-2.0-no-copyleft-exception
+github.com/hashicorp/go-version                               MPL-2.0-no-copyleft-exception
+github.com/hashicorp/hcl/v2                                   MPL-2.0-no-copyleft-exception
+github.com/hashicorp/logutils                                 MPL-2.0-no-copyleft-exception
+github.com/hashicorp/terraform-plugin-framework               MPL-2.0-no-copyleft-exception
+github.com/hashicorp/terraform-plugin-go                      MPL-2.0-no-copyleft-exception
+github.com/hashicorp/terraform-plugin-log                     MPL-2.0-no-copyleft-exception
+github.com/hashicorp/terraform-registry-address               MPL-2.0-no-copyleft-exception
+github.com/hashicorp/yamux                                    MPL-2.0-no-copyleft-exception
 
 =========================================================================

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,123 @@ $ 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.
+
+#### Migration guide.
+
+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 user perspective
+
+Currently the state upgrade functionality is still in development 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.
+
+For the migrated version (0.6.0 or higher), `terraform plan` output can contain more changes comparing to the older versions of the provider (that use TF SDK). 
+This happens because TF Framework treats all `computed` attributes as `unknown` (known after apply) once configuration changes.
+`ec_deployment` schema contains quite a few of such attributes, so `terraform plan`'s output can be quite big for the resource due to the mentioned reason.
+However, it doesn't mean that all attributes that marked as `unknown` in the plan will get new values after apply.
+To mitigitate the problem, the provider uses plan modifiers that is a recommended way to reduce plan output. 
+However, currently plan modifiers don't cover all the `computed` attributes.
+
+Please make sure to update to the latest TF client version.

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.2.5
 VERSION_GOCHANGELOG:=v0.0.0-20201005170154-56335215ce3a
 VERSION_VERSIONBUMP:=v1.1.0

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)

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.