Update changelog, documentation and release workflow

.github/workflows/release.yaml

@@ -1,47 +1,35 @@
-# This GitHub action can publish assets for release when a tag is created.
+name: Create release
-# Currently its setup to run on any tag that matches the pattern "v*" (ie. v0.1.0).
-#
-# This uses an action (paultyng/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.
-#
-name: release
 on:
   push:
     tags:
       - 'v*'
 jobs:
   goreleaser:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       -
-        name: Checkout
+        name: Checkout the repository
         uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
       -
-        name: Unshallow
+        name: Set up the required version of Go
-        run: git fetch --prune --unshallow
-      -
-        name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.14
+          go-version: 1.15
       -
-        name: Import GPG key
+        name: Import the GPG signing key
-        id: import_gpg
-        uses: paultyng/ghaction-import-gpg@v2.1.0
         env:
-          GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
+          GPG_KEY: ${{ secrets.GPG_KEY }}
-          PASSPHRASE: ${{ secrets.PASSPHRASE }}
+        run: |
+          echo "$GPG_KEY" | base64 -d | gpg --batch --allow-secret-key-import --import
+          gpg --keyid-format LONG --list-secret-keys
       -
-        name: Run GoReleaser
+        name: Create release
         uses: goreleaser/goreleaser-action@v2
         with:
           version: latest
           args: release --rm-dist
         env:
-          GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GPG_FINGERPRINT: ${{ secrets.GPG_FINGERPRINT }}

.goreleaser.yml

@@ -1,14 +1,8 @@
-# Visit https://goreleaser.com for documentation on how to customize this
-# behavior.
 before:
   hooks:
-    # this is just an example and not a requirement for provider building/publishing
     - go mod tidy
 builds:
 - env:
-    # goreleaser does not work with CGO, it could also complicate
-    # usage by users in CI/CD systems like Terraform Cloud where
-    # they are unable to install libraries.
     - CGO_ENABLED=0
   mod_timestamp: '{{ .CommitTimestamp }}'
   flags:
@@ -38,17 +32,14 @@ checksum:
 signs:
   - artifacts: checksum
     args:
-      # if you are using this is a GitHub action or some other automated pipeline, you 
-      # need to pass the batch flag to indicate its not interactive.
       - "--batch"
       - "--local-user"
-      - "{{ .Env.GPG_FINGERPRINT }}" # set this environment variable for your signing key
+      - "{{ .Env.GPG_FINGERPRINT }}"
       - "--output"
       - "${signature}"
       - "--detach-sign"
       - "${artifact}"
 release:
-  # If you want to manually examine the release before its live, uncomment this line:
+  draft: false
-  # draft: true
 changelog:
   skip: true

.travis.yml

@@ -8,7 +8,7 @@ cache:
     - $HOME/gopath/pkg/mod
 
 go:
-  - 1.13.x
+  - 1.15.x
 
 git:
   depth: 1

CHANGELOG.md

@@ -1,4 +1,4 @@
-## 0.4.0 (UNRELEASED)
+## v0.4.0
 
 FEATURES:
 
@@ -7,7 +7,7 @@ FEATURES:
 
 BREAKING CHANGES:
 
-* `interface` is now required to create disks
+* resource/virtual_environment_vm: `interface` is now required to create disks
 
 ```
   disk {
@@ -29,12 +29,12 @@ ENHANCEMENTS:
 BUG FIXES:
 
 * library/virtual_environment_nodes: Fix node IP address format
+* library/virtual_environment_nodes: Fix WaitForNodeTask now detects errors correctly
+* library/virtual_environment_vm: Fix CloneVM now waits for the task to be finished and detect errors.
 * resource/virtual_environment_container: Fix VM ID collision when `vm_id` is not specified
 * resource/virtual_environment_vm: Fix VM ID collision when `vm_id` is not specified
 * resource/virtual_environment_vm: Fix disk import issue when importing from directory-based datastores
 * resource/virtual/environment/vm: Fix handling of storage name - correct handling of `-`
-* library/virtual_environment_nodes: Fix WaitForNodeTask now detects errors correctly
-* library/virtual_environment_vm: Fix CloneVM now waits for the task to be finished and detect errors.
 
 WORKAROUNDS:
 

docs/data-sources/alias.md

@@ -4,6 +4,7 @@ title: Alias
 permalink: /data-sources/alias
 nav_order: 1
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Alias
@@ -18,11 +19,11 @@ data "proxmox_virtual_environment_cluster_alias" "local_network" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `name` - (Required) Alias name.
 
-## Attributes Reference
+## Attribute Reference
 
 * `cidr` - (Required) Network/IP specification in CIDR format.
 * `comment` - (Optional) Alias comment.

docs/data-sources/aliases.md

@@ -4,6 +4,7 @@ title: Aliases
 permalink: /data-sources/aliases
 nav_order: 2
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Aliases
@@ -16,10 +17,10 @@ Retrieves the identifiers for all the available aliases.
 data "proxmox_virtual_environment_cluster_aliases" "available_aliases" {}
 ```
 
-## Arguments Reference
+## Argument Reference
 
 There are no arguments available for this data source.
 
-## Attributes Reference
+## Attribute Reference
 
 * `alias_ids` - The pool identifiers.

docs/data-sources/datastores.md

@@ -4,6 +4,7 @@ title: Datastores
 permalink: /data-sources/datastores
 nav_order: 3
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Datastores
@@ -18,11 +19,11 @@ data "proxmox_virtual_environment_datastores" "first_node" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `node_name` - (Required) A node name.
 
-## Attributes Reference
+## Attribute Reference
 
 * `active` - Whether the datastore is active.
 * `content_types` - The allowed content types.

docs/data-sources/dns.md

@@ -4,6 +4,7 @@ title: DNS
 permalink: /data-sources/dns
 nav_order: 4
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: DNS
@@ -18,11 +19,11 @@ data "proxmox_virtual_environment_dns" "first_node" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `node_name` - (Required) A node name.
 
-## Attributes Reference
+## Attribute Reference
 
 * `domain` - The DNS search domain.
 * `servers` - The DNS servers.

docs/data-sources/group.md

@@ -4,6 +4,7 @@ title: Group
 permalink: /data-sources/group
 nav_order: 5
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Group
@@ -18,11 +19,11 @@ data "proxmox_virtual_environment_group" "operations_team" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `group_id` - (Required) The group identifier.
 
-## Attributes Reference
+## Attribute Reference
 
 * `acl` - The access control list.
     * `path` - The path.

docs/data-sources/groups.md

@@ -4,6 +4,7 @@ title: Groups
 permalink: /data-sources/groups
 nav_order: 6
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Groups
@@ -16,11 +17,11 @@ Retrieves basic information about all available user groups.
 data "proxmox_virtual_environment_groups" "available_groups" {}
 ```
 
-## Arguments Reference
+## Argument Reference
 
 There are no arguments available for this data source.
 
-## Attributes Reference
+## Attribute Reference
 
 * `comments` - The group comments.
 * `group_ids` - The group identifiers.

docs/data-sources/hosts.md

@@ -4,6 +4,7 @@ title: Hosts
 permalink: /data-sources/hosts
 nav_order: 7
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Hosts
@@ -18,11 +19,11 @@ data "proxmox_virtual_environment_hosts" "first_node_host_entries" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `node_name` - (Required) A node name.
 
-## Attributes Reference
+## Attribute Reference
 
 * `addresses` - The IP addresses.
 * `digest` - The SHA1 digest.

docs/data-sources/nodes.md

@@ -4,6 +4,7 @@ title: Nodes
 permalink: /data-sources/nodes
 nav_order: 8
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Nodes
@@ -16,11 +17,11 @@ Retrieves information about all available nodes.
 data "proxmox_virtual_environment_nodes" "available_nodes" {}
 ```
 
-## Arguments Reference
+## Argument Reference
 
 There are no arguments available for this data source.
 
-## Attributes Reference
+## Attribute Reference
 
 * `cpu_count` - The CPU count for each node.
 * `cpu_utilization` - The CPU utilization on each node.

docs/data-sources/pool.md

@@ -4,6 +4,7 @@ title: Pool
 permalink: /data-sources/pool
 nav_order: 9
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Pool
@@ -18,11 +19,11 @@ data "proxmox_virtual_environment_pool" "operations_pool" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `pool_id` - (Required) The pool identifier.
 
-## Attributes Reference
+## Attribute Reference
 
 * `comment` - The pool comment.
 * `members` - The pool members.

docs/data-sources/pools.md

@@ -4,6 +4,7 @@ title: Pools
 permalink: /data-sources/pools
 nav_order: 10
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Pools
@@ -16,10 +17,10 @@ Retrieves the identifiers for all the available resource pools.
 data "proxmox_virtual_environment_pools" "available_pools" {}
 ```
 
-## Arguments Reference
+## Argument Reference
 
 There are no arguments available for this data source.
 
-## Attributes Reference
+## Attribute Reference
 
 * `pool_ids` - The pool identifiers.

docs/data-sources/role.md

@@ -4,6 +4,7 @@ title: Role
 permalink: /data-sources/role
 nav_order: 11
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Role
@@ -18,10 +19,10 @@ data "proxmox_virtual_environment_role" "operations_role" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `role_id` - (Required) The role identifier.
 
-## Attributes Reference
+## Attribute Reference
 
 * `privileges` - The role privileges

docs/data-sources/roles.md

@@ -4,6 +4,7 @@ title: Roles
 permalink: /data-sources/roles
 nav_order: 12
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Roles
@@ -16,11 +17,11 @@ Retrieves information about all the available roles.
 data "proxmox_virtual_environment_roles" "available_roles" {}
 ```
 
-## Arguments Reference
+## Argument Reference
 
 There are no arguments available for this data source.
 
-## Attributes Reference
+## Attribute Reference
 
 * `privileges` - The role privileges.
 * `role_ids` - The role identifiers.

docs/data-sources/time.md

@@ -4,6 +4,7 @@ title: Time
 permalink: /data-sources/time
 nav_order: 13
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Time
@@ -18,11 +19,11 @@ data "proxmox_virtual_environment_time" "first_node_time" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `node_name` - (Required) A node name.
 
-## Attributes Reference
+## Attribute Reference
 
 * `local_time` - The node's local time.
 * `time_zone` - The node's time zone.

docs/data-sources/user.md

@@ -4,6 +4,7 @@ title: User
 permalink: /data-sources/user
 nav_order: 14
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: User
@@ -18,11 +19,11 @@ data "proxmox_virtual_environment_user" "operations_user" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `user_id` - (Required) The user identifier.
 
-## Attributes Reference
+## Attribute Reference
 
 * `acl` - The access control list.
     * `path` - The path.

docs/data-sources/users.md

@@ -4,6 +4,7 @@ title: Users
 permalink: /data-sources/users
 nav_order: 15
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Users
@@ -16,11 +17,11 @@ Retrieves information about all the available users.
 data "proxmox_virtual_environment_users" "available_users" {}
 ```
 
-## Arguments Reference
+## Argument Reference
 
 There are no arguments available for this data source.
 
-## Attributes Reference
+## Attribute Reference
 
 * `comments` - The user comments.
 * `emails` - The users' email addresses.

docs/data-sources/version.md

@@ -4,6 +4,7 @@ title: Version
 permalink: /data-sources/version
 nav_order: 16
 parent: Data Sources
+subcategory: Virtual Environment
 ---
 
 # Data Source: Version
@@ -16,11 +17,11 @@ Retrieves the version information from the API endpoint.
 data "proxmox_virtual_environment_version" "current_version" {}
 ```
 
-## Arguments Reference
+## Argument Reference
 
 There are no arguments available for this data source.
 
-## Attributes Reference
+## Attribute Reference
 
 * `keyboard_layout` - The keyboard layout.
 * `release` - The release number.

docs/index.md

@@ -64,7 +64,7 @@ $ export PROXMOX_VE_PASSWORD="a-strong-password"
 $ terraform plan
 ```
 
-## Arguments Reference
+## Argument Reference
 
 In addition to [generic provider arguments](https://www.terraform.io/docs/configuration/providers.html) (e.g. `alias` and `version`), the following arguments are supported in the Proxmox `provider` block:
 

docs/resources/alias.md

@@ -4,6 +4,7 @@ title: Alias
 permalink: /ressources/alias
 nav_order: 1
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: Alias
@@ -27,12 +28,12 @@ resource "proxmox_virtual_environment_cluster_alias" "ubuntu_vm" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `name` - (Required) Alias name.
 * `cidr` - (Required) Network/IP specification in CIDR format.
 * `comment` - (Optional) Alias comment.
 
-## Attributes Reference
+## Attribute Reference
 
 There are no attribute references available for this resource.

docs/resources/certificate.md

@@ -4,6 +4,7 @@ title: Certificate
 permalink: /resources/certificate
 nav_order: 2
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: Certificate
@@ -43,14 +44,14 @@ resource "tls_self_signed_cert" "proxmox_virtual_environment_certificate" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `certificate` - (Required) The PEM encoded certificate.
 * `certificate_chain` - (Optional) The PEM encoded certificate chain.
 * `node_name` - (Required) A node name.
 * `private_key` - (Required) The PEM encoded private key.
 
-## Attributes Reference
+## Attribute Reference
 
 * `expiration_date` - The expiration date (RFC 3339).
 * `file_name` - The file name.

docs/resources/container.md

@@ -4,6 +4,7 @@ title: Container
 permalink: /resources/container
 nav_order: 3
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: Container
@@ -80,7 +81,7 @@ output "ubuntu_container_public_key" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `clone` - (Optional) The cloning configuration.
     * `datastore_id` - (Optional) The identifier for the target datastore.
@@ -147,6 +148,6 @@ output "ubuntu_container_public_key" {
 * `template` - (Optional) Whether to create a template (defaults to `false`).
 * `vm_id` - (Optional) The virtual machine identifier
 
-## Attributes Reference
+## Attribute Reference
 
 There are no additional attributes available for this resource.

docs/resources/dns.md

@@ -4,6 +4,7 @@ title: DNS
 permalink: /resources/dns
 nav_order: 4
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: DNS
@@ -28,13 +29,13 @@ data "proxmox_virtual_environment_dns" "first_node_dns_configuration" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `domain` - (Required) The DNS search domain.
 * `node_name` - (Required) A node name.
 * `servers` - (Optional) The DNS servers.
 
-## Attributes Reference
+## Attribute Reference
 
 There are no additional attributes available for this resource.
 

docs/resources/file.md

@@ -4,6 +4,7 @@ title: File
 permalink: /resources/file
 nav_order: 5
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: File
@@ -24,7 +25,7 @@ resource "proxmox_virtual_environment_file" "ubuntu_container_template" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `content_type` - (Optional) The content type.
     * `backup`
@@ -43,7 +44,7 @@ resource "proxmox_virtual_environment_file" "ubuntu_container_template" {
     * `file_name` - (Required) The file name.
     * `resize` - (Optional) The number of bytes to resize the file to.
 
-## Attributes Reference
+## Attribute Reference
 
 * `file_modification_date` - The file modification date (RFC 3339).
 * `file_name` - The file name.

docs/resources/group.md

@@ -4,6 +4,7 @@ title: Group
 permalink: /resources/group
 nav_order: 6
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: Group
@@ -19,7 +20,7 @@ resource "proxmox_virtual_environment_group" "operations_team" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `acl` - (Optional) The access control list (multiple blocks supported).
     * `path` - The path.
@@ -28,6 +29,6 @@ resource "proxmox_virtual_environment_group" "operations_team" {
 * `comment` - (Optional) The group comment.
 * `group_id` - (Required) The group identifier.
 
-## Attributes Reference
+## Attribute Reference
 
 * `members` - The group members as a list of `username@realm` entries

docs/resources/hosts.md

@@ -4,6 +4,7 @@ title: Hosts
 permalink: /resources/hosts
 nav_order: 7
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: Hosts
@@ -27,14 +28,14 @@ resource "proxmox_virtual_environment_hosts" "first_node_host_entries" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `node_name` - (Required) A node name.
 * `entry` - (Required) A host entry (multiple blocks supported).
     * `address` - (Required) The IP address.
     * `hostnames` - (Required) The hostnames.
 
-## Attributes Reference
+## Attribute Reference
 
 * `addresses` - The IP addresses.
 * `digest` - The SHA1 digest.

docs/resources/ipset.md

@@ -4,6 +4,7 @@ title: IPSet
 permalink: /ressources/ipset
 nav_order: 8
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: IPSet
@@ -35,7 +36,7 @@ resource "proxmox_virtual_environment_cluster_ipset" "ipset" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `name` - (Required) Alias name.
 * `comment` - (Optional) Alias comment.
@@ -44,6 +45,6 @@ resource "proxmox_virtual_environment_cluster_ipset" "ipset" {
     * `comment` - (Optional) Arbitrary string annotation.
     * `nomatch` -  (Optional) Entries marked as `nomatch` are skipped as if those were not added to the set.
 
-## Attributes Reference
+## Attribute Reference
 
 There are no attribute references available for this resource.

docs/resources/pool.md

@@ -4,6 +4,7 @@ title: Pool
 permalink: /resources/pool
 nav_order: 9
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: Pool
@@ -19,12 +20,12 @@ resource "proxmox_virtual_environment_pool" "operations_pool" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `comment` - (Optional) The pool comment.
 * `pool_id` - (Required) The pool identifier.
 
-## Attributes Reference
+## Attribute Reference
 
 * `members` - The pool members.
     * `datastore_id` - The datastore identifier.

docs/resources/role.md

@@ -4,6 +4,7 @@ title: Role
 permalink: /resources/role
 nav_order: 10
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: Role
@@ -22,11 +23,11 @@ resource "proxmox_virtual_environment_role" "operations_monitoring" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `privileges` - (Required) The role privileges.
 * `role_id` - (Required) The role identifier.
 
-## Attributes Reference
+## Attribute Reference
 
 There are no additional attributes available for this resource.

docs/resources/time.md

@@ -4,6 +4,7 @@ title: Time
 permalink: /resources/time
 nav_order: 11
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: Time
@@ -19,12 +20,12 @@ resource "proxmox_virtual_environment_time" "first_node_time" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `node_name` - (Required) A node name.
 * `time_zone` - (Required) The node's time zone.
 
-## Attributes Reference
+## Attribute Reference
 
 * `local_time` - The node's local time.
 * `utc_time` - The node's local time formatted as UTC.

docs/resources/user.md

@@ -4,6 +4,7 @@ title: User
 permalink: /resources/user
 nav_order: 12
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: User
@@ -34,7 +35,7 @@ resource "proxmox_virtual_environment_role" "operations_monitoring" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `acl` - (Optional) The access control list (multiple blocks supported).
     * `path` - The path.
@@ -51,6 +52,6 @@ resource "proxmox_virtual_environment_role" "operations_monitoring" {
 * `password` - (Required) The user's password.
 * `user_id` - (Required) The user identifier.
 
-## Attributes Reference
+## Attribute Reference
 
 There are no additional attributes available for this resource.

docs/resources/vm.md

@@ -4,6 +4,7 @@ title: VM
 permalink: /resources/vm
 nav_order: 13
 parent: Resources
+subcategory: Virtual Environment
 ---
 
 # Resource: VM
@@ -91,7 +92,7 @@ output "ubuntu_vm_public_key" {
 }
 ```
 
-## Arguments Reference
+## Argument Reference
 
 * `acpi` - (Optional) Whether to enable ACPI (defaults to `true`).
 * `agent` - (Optional) The QEMU agent configuration.
@@ -295,7 +296,7 @@ output "ubuntu_vm_public_key" {
         * `vmware` - VMware Compatible.
 * `vm_id` - (Optional) The VM identifier.
 
-## Attributes Reference
+## Attribute Reference
 
 * `ipv4_addresses` - The IPv4 addresses per network interface published by the QEMU agent (empty list when `agent.enabled` is `false`)
 * `ipv6_addresses` - The IPv6 addresses per network interface published by the QEMU agent (empty list when `agent.enabled` is `false`)