feat!: migrate to Terraform Plugin Framework

Follow the provider scaffolding
https://github.com/hashicorp/terraform-provider-scaffolding-framework.

Author: tensor5

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @tensor5

.github/dependabot.yml

@@ -1,17 +1,12 @@
-# See GitHub's docs for more information on this file:
-# https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates
+# See GitHub's documentation for more information on this file:
+# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates
 version: 2
 updates:
-  # Maintain dependencies for GitHub Actions
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      # Check for updates to GitHub Actions every weekday
       interval: "daily"
-
-  # Maintain dependencies for Go modules
   - package-ecosystem: "gomod"
     directory: "/"
     schedule:
-      # Check for updates to Go modules every weekday
       interval: "daily"

.github/workflows/release.yml

@@ -1,14 +1,4 @@
-# This GitHub action can publish assets for release when a tag is created.
-# Currently its setup to run on any tag that matches the pattern "v*" (ie. v0.1.0).
-#
-# This uses an action (hashicorp/ghaction-import-gpg) that assumes you set your
-# private key in the `GPG_PRIVATE_KEY` secret and passphrase in the `PASSPHRASE`
-# secret. If you would rather own your own GPG handling, please fork this action
-# or use an alternative one for key handling.
-#
-# You will need to pass the `--batch` flag to `gpg` in your signing step
-# in `goreleaser` to indicate this is being used in a non-interactive mode.
-#
+# Terraform Provider release workflow.
 name: Release
 
 on:
@@ -37,27 +27,26 @@ jobs:
     needs: release-please
     runs-on: ubuntu-22.04
     steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Unshallow
-        run: git fetch --prune --unshallow
-      - name: Set up Go
-        uses: actions/setup-go@v3
+      - uses: actions/checkout@v3
         with:
+          # Allow goreleaser to access older tag information.
+          fetch-depth: 0
+      - uses: actions/setup-go@v3
+        with:
+          cache: true
           go-version-file: go.mod
       - name: Import GPG key
         uses: crazy-max/ghaction-import-gpg@v5
         id: import_gpg
         with:
+          fingerprint: ${{ secrets.GPG_FINGERPRINT }}
           gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.GPG_PASSPHRASE }}
-          fingerprint: ${{ secrets.GPG_FINGERPRINT }}
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v3.1.0
+        uses: goreleaser/goreleaser-action@v3
         with:
-          version: latest
           args: release --rm-dist
         env:
-          GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
-          # GitHub sets this automatically
+          # GitHub sets the GITHUB_TOKEN secret automatically.
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}

.github/workflows/test.yml

@@ -1,47 +1,52 @@
-# This GitHub action runs your tests for each commit push and/or PR. Optionally
-# you can turn it on using a cron schedule for regular testing.
-#
+# Terraform Provider testing workflow.
 name: Tests
+
+# This GitHub action runs your tests for each pull request and push.
+# Optionally, you can turn it on using a schedule for regular testing.
 on:
   pull_request:
     paths-ignore:
       - "README.md"
   push:
     paths-ignore:
       - "README.md"
-  # For systems with an upstream API that could drift unexpectedly (like most SaaS systems, etc.),
-  # we recommend testing at a regular interval not necessarily tied to code changes. This will
-  # ensure you are alerted to something breaking due to an API change, even if the code did not
-  # change.
-  # schedule:
-  #   - cron: '0 13 * * *'
+
+# Testing only needs permissions to read the repository contents.
+permissions:
+  contents: read
+
 jobs:
-  # ensure the code builds...
+  # Ensure project builds before running testing matrix
   build:
     name: Build
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v3
-
-      - name: Set up Go
-        uses: actions/setup-go@v3
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
         with:
-          go-version-file: go.mod
-        id: go
-
-      - name: Get dependencies
-        run: |
-          go mod download
+          go-version-file: "go.mod"
+          cache: true
+      - run: go mod download
+      - run: go build -v .
 
-      - name: Build
+  generate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
+        with:
+          go-version-file: "go.mod"
+          cache: true
+      - run: go generate ./...
+      - name: git diff
         run: |
-          go build -v .
+          git diff --compact-summary --exit-code || \
+            (echo; echo "Unexpected difference in directories after code generation. Run 'go generate ./...' command and commit."; exit 1)
 
-  # run acceptance tests in a matrix with Terraform core versions
+  # Run acceptance tests in a matrix with Terraform CLI versions
   test:
-    name: Matrix Test
+    name: Terraform Provider Acceptance Tests
     needs: build
     runs-on: ubuntu-latest
     timeout-minutes: 15
@@ -54,29 +59,17 @@ jobs:
           - "1.1.*"
           - "1.2.*"
     steps:
-      - name: Check out code into the Go module directory
-        uses: actions/checkout@v3
-
-      - name: Set up Go
-        uses: actions/setup-go@v3
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v3
         with:
-          go-version-file: go.mod
-        id: go
-
-      - name: Get dependencies
-        run: |
-          go mod download
-
-      - name: TF acceptance tests
-        timeout-minutes: 10
-        env:
+          go-version-file: "go.mod"
+          cache: true
+      - uses: hashicorp/setup-terraform@v2
+        with:
+          terraform_version: ${{ matrix.terraform }}
+          terraform_wrapper: false
+      - run: go mod download
+      - env:
           TF_ACC: "1"
-          TF_ACC_TERRAFORM_VERSION: ${{ matrix.terraform }}
-
-          # Set whatever additional acceptance test env vars here. You can
-          # optionally use data from your repository secrets using the
-          # following syntax:
-          # SOME_VAR: ${{ secrets.SOME_VAR }}
-
-        run: |
-          go test -v -cover ./internal/provider/
+        run: go test -v -cover ./internal/provider/
+        timeout-minutes: 10

.goreleaser.yml

@@ -16,6 +16,7 @@ builds:
     ldflags:
       - "-s -w -X main.version={{.Version}} -X main.commit={{.Commit}}"
     goos:
+      - freebsd
       - windows
       - linux
       - darwin
@@ -53,3 +54,7 @@ release:
   extra_files:
     - glob: "terraform-registry-manifest.json"
       name_template: "{{ .ProjectName }}_{{ .Version }}_manifest.json"
+  # If you want to manually examine the release before its live, uncomment this line:
+  # draft: true
+changelog:
+  skip: true

GNUmakefile

@@ -1,26 +1,5 @@
-
-GIT_VERSION ?= $(shell git describe --tags --always --dirty 2> /dev/null)
-VERSION = $(shell echo $(GIT_VERSION) | sed 's/^v//' | sed 's/-.*//')
-
-PROVIDER_HOSTNAME=github.com
-PROVIDER_NAMESPACE=tensor5
-PROVIDER_TYPE=talos
-PROVIDER_TARGET=$(shell go env GOOS)_$(shell go env GOARCH)
-PROVIDER_PATH=~/.terraform.d/plugins/$(PROVIDER_HOSTNAME)/$(PROVIDER_NAMESPACE)/$(PROVIDER_TYPE)/$(VERSION)/$(PROVIDER_TARGET)
-
 default: testacc
 
-build:
-	@mkdir -p $(PROVIDER_PATH)
-	go build \
-		-tags release \
-		-ldflags '-X $(MODULE)/internal/config.Version=$(GIT_VERSION)' \
-		-o $(PROVIDER_PATH)/terraform-provider-$(PROVIDER_TYPE)_v$(VERSION)
-
-.PHONY: docs
-docs:
-	go generate
-
 # Run acceptance tests
 .PHONY: testacc
 testacc:

docs/data-sources/kubeconfig.md

@@ -27,7 +27,6 @@ Download the kubeconfig information from a Talos node.
 - `client_certificate` (String) PEM-encoded client certificate for TLS authentication.
 - `client_key` (String) PEM-encoded client certificate key for TLS authentication.
 - `cluster_ca_certificate` (String) PEM-encoded root certificates bundle for TLS authentication.
-- `id` (String) The ID of this resource.
 - `raw` (String) Content of kubeconfig file.
 
 

docs/resources/bootstrap.md

@@ -27,7 +27,6 @@ Bootstrap a Talos cluster and download kubeconfig.
 - `client_certificate` (String) PEM-encoded client certificate for TLS authentication.
 - `client_key` (String) PEM-encoded client certificate key for TLS authentication.
 - `cluster_ca_certificate` (String) PEM-encoded root certificates bundle for TLS authentication.
-- `id` (String) The ID of this resource.
 - `raw` (String) Content of kubeconfig file.
 
 

docs/resources/gen_config.md

@@ -29,7 +29,7 @@ Generates a configuration for Talos cluster.
 - `dns_domain` (String) The dns domain to use for cluster.
 - `install_disk` (String) The disk to install to.
 - `install_image` (String) The image used to perform an installation.
-- `kubernetes_version` (String) Desired kubernetes version to run (default "1.24.3").
+- `kubernetes_version` (String) Desired kubernetes version to run (default "1.25.1").
 - `persist` (Boolean) The desired persist value for configs.
 - `registry_mirrors` (Map of String) List of registry mirrors to use in format: <registry host>=<mirror URL>.
 - `talos_version` (String) The desired Talos version to generate config for (backwards compatibility, e.g. v0.8).
@@ -38,9 +38,8 @@ Generates a configuration for Talos cluster.
 
 ### Read-Only
 
-- `control_plane_config` (String)
-- `id` (String) The ID of this resource.
-- `talos_config` (String)
-- `worker_config` (String)
+- `control_plane_config` (String, Sensitive)
+- `talos_config` (String, Sensitive)
+- `worker_config` (String, Sensitive)
 
 

examples/digitalocean/control-plane.tf

@@ -1,11 +1,11 @@
 resource "digitalocean_droplet" "control_plane" {
   count = var.control_plane_number
 
-  image              = digitalocean_custom_image.talos.id
-  name               = "talos-control-plane-${count.index}"
-  region             = var.region
-  size               = var.control_plane_size
-  ssh_keys           = [var.ssh_key_fingerprint]
-  tags               = [var.control_plane_tag]
-  user_data          = talos_gen_config.config.control_plane_config
+  image     = digitalocean_custom_image.talos.id
+  name      = "talos-control-plane-${count.index}"
+  region    = var.region
+  size      = var.control_plane_size
+  ssh_keys  = [var.ssh_key_fingerprint]
+  tags      = [var.control_plane_tag]
+  user_data = talos_gen_config.config.control_plane_config
 }