docs: Generate with tfplugindocs

.github/workflows/check.yml

@@ -0,0 +1,69 @@
+name: Check
+
+on:
+  push: {}
+  pull_request: {}
+
+jobs:
+
+  go:
+    name: Go
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v2
+        with:
+          go-version: ^1.13
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - name: Get dependencies
+        run: |
+          go get -v -t -d ./...
+          if [ -f Gopkg.toml ]; then
+              curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
+              dep ensure
+          fi
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Test
+        run: go test -v ./...
+
+      - name: Format check
+        run: |
+          fmtdiff="$(gofmt -s -e -d .)"
+          if [ -n "$fmtdiff" ]; then
+            >&2 echo "$fmtdiff"
+            exit 1
+          fi
+
+  terraform:
+    name: Terraform
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Terraform
+        uses: hashicorp/setup-terraform@v1
+
+      - name: Terraformat
+        run: terraform fmt -recursive examples
+
+      - name: Check docs updated
+        run: |
+          curl -L https://github.com/hashicorp/terraform-plugin-docs/releases/download/v0.4.0/tfplugindocs_0.4.0_linux_amd64.zip --output tfplugindocs.zip
+          unzip tfplugindocs.zip tfplugindocs
+          ./tfplugindocs
+          change="$(git diff)"
+          if [ -n "$change" ]; then
+            >&2 echo "$change"
+            exit 1
+          fi

.gitignore

@@ -1 +1,2 @@
-/dist/
+/terraform-provider-wireguard
+*.tfstate

docs/index.md

@@ -0,0 +1,20 @@
+---
+layout: ""
+page_title: "Provider: Mullvad"
+description: |-
+  The WireGuard provider is used to handle WireGuard metadata.
+---
+
+# WireGuard Provider
+
+The WireGuard provider is used to handle WireGuard metadata.
+
+## Example Usage
+
+```terraform
+provider "wireguard" {
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema

docs/resources/asymmetric_key.md

@@ -0,0 +1,44 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "wireguard_asymmetric_key Resource - terraform-provider-wireguard"
+subcategory: ""
+description: |-
+  Provides a WireGuard asymmetric key resource. This can be used to create, read, and delete WireGuard keys in terraform state.
+---
+
+# wireguard_asymmetric_key (Resource)
+
+Provides a WireGuard asymmetric key resource. This can be used to create, read, and delete WireGuard keys in terraform state.
+
+## Example Usage
+
+```terraform
+resource "wireguard_asymmetric_key" "example" {
+}
+
+output "wg_public_key" {
+  description = "Example's public WireGuard key"
+  value       = wireguard_asymmetric_key.example.public_key
+}
+
+output "wg_private_key" {
+  description = "Example's private WireGuard key"
+  value       = wireguard_asymmetric_key.example.private_key
+  sensitive   = true
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- **bind** (String) A string to tie the lifecycle to, e.g. the terraform ID of another resource.
+- **id** (String) The ID of this resource.
+- **private_key** (String, Sensitive) A supplied WireGuard private key. By default one is generated.
+
+### Read-Only
+
+- **public_key** (String) The public key corresponding to the (given or generated) private key.
+
+

examples/provider/provider.tf

@@ -0,0 +1,2 @@
+provider "wireguard" {
+}

examples/asymmetric_key/outputs.tf → examples/resources/wireguard_asymmetric_key/resource.tf

@@ -1,3 +1,6 @@
+resource "wireguard_asymmetric_key" "example" {
+}
+
 output "wg_public_key" {
   description = "Example's public WireGuard key"
   value       = wireguard_asymmetric_key.example.public_key

examples/asymmetric_key/versions.tf → examples/resources/wireguard_asymmetric_key/versions.tf

@@ -4,5 +4,4 @@ terraform {
       source = "OJFord/wireguard"
     }
   }
-  required_version = ">= 0.13"
 }

go.mod

@@ -3,6 +3,6 @@ module github.com/OJFord/terraform-provider-wireguard
 go 1.12
 
 require (
-	github.com/hashicorp/terraform-plugin-sdk v1.7.0
+	github.com/hashicorp/terraform-plugin-sdk/v2 v2.4.4
 	golang.zx2c4.com/wireguard/wgctrl v0.0.0-20200205215550-e35592f146e4
 )

main.go

@@ -1,15 +1,15 @@
 package main
 
 import (
-	"github.com/OJFord/terraform-provider-wireguard/wireguard"
-	"github.com/hashicorp/terraform-plugin-sdk/plugin"
-	"github.com/hashicorp/terraform-plugin-sdk/terraform"
+	"github.com/OJFord/terraform-provider-wireguard/provider"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/plugin"
 )
 
 func main() {
 	plugin.Serve(&plugin.ServeOpts{
-		ProviderFunc: func() terraform.ResourceProvider {
-			return wireguard.Provider()
+		ProviderFunc: func() *schema.Provider {
+			return provider.Provider()
 		},
 	})
 }

wireguard/provider.go → provider/provider.go

@@ -1,7 +1,7 @@
-package wireguard
+package provider
 
 import (
-	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
 func Provider() *schema.Provider {

wireguard/resource_wireguard_asymmetric_key.go → provider/resource_wireguard_asymmetric_key.go

@@ -1,33 +1,38 @@
-package wireguard
+package provider
 
 import (
-	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"golang.zx2c4.com/wireguard/wgctrl/wgtypes"
 )
 
 func resourceWireguardAsymmetricKey() *schema.Resource {
 	return &schema.Resource{
+		Description: "Provides a WireGuard asymmetric key resource. This can be used to create, read, and delete WireGuard keys in terraform state.",
+
 		Create: resourceWireguardAsymmetricKeyCreate,
 		Read:   resourceWireguardAsymmetricKeyRead,
 		Delete: resourceWireguardAsymmetricKeyDelete,
 
 		Schema: map[string]*schema.Schema{
-			"bind": &schema.Schema{
-				Default:  "",
-				ForceNew: true,
-				Optional: true,
-				Type:     schema.TypeString,
+			"bind": {
+				Description: "A string to tie the lifecycle to, e.g. the terraform ID of another resource.",
+				Default:     "",
+				ForceNew:    true,
+				Optional:    true,
+				Type:        schema.TypeString,
 			},
-			"private_key": &schema.Schema{
-				Computed:  true,
-				ForceNew:  true,
-				Optional:  true,
-				Sensitive: true,
-				Type:      schema.TypeString,
+			"private_key": {
+				Description: "A supplied WireGuard private key. By default one is generated.",
+				Computed:    true,
+				ForceNew:    true,
+				Optional:    true,
+				Sensitive:   true,
+				Type:        schema.TypeString,
 			},
-			"public_key": &schema.Schema{
-				Computed: true,
-				Type:     schema.TypeString,
+			"public_key": {
+				Description: "The public key corresponding to the (given or generated) private key.",
+				Computed:    true,
+				Type:        schema.TypeString,
 			},
 		},
 	}

templates/index.md.tmpl

@@ -0,0 +1,16 @@
+---
+layout: ""
+page_title: "Provider: Mullvad"
+description: |-
+  The WireGuard provider is used to handle WireGuard metadata.
+---
+
+# WireGuard Provider
+
+The WireGuard provider is used to handle WireGuard metadata.
+
+## Example Usage
+
+{{ tffile "examples/provider/provider.tf" }}
+
+{{ .SchemaMarkdown | trimspace }}