Merge pull request #35 from umich-vci/update

Update

.github/workflows/release.yml

@@ -1,7 +1,7 @@
 # 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 (paultyng/ghaction-import-gpg) that assumes you set your 
+# 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.
@@ -20,28 +20,27 @@ jobs:
     steps:
       -
         name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       -
         name: Unshallow
         run: git fetch --prune --unshallow
       -
         name: Set up Go
-        uses: actions/setup-go@v2
+        uses: actions/setup-go@v3
         with:
-          go-version: 1.16
+          go-version-file: 'go.mod'
+          cache: true
       -
         name: Import GPG key
         id: import_gpg
-        # TODO: move this to HashiCorp namespace or find alternative that is just simple gpg commands
-        # see https://github.com/hashicorp/terraform-provider-scaffolding/issues/22
-        uses: paultyng/[email protected]
+        uses: hashicorp/[email protected]
         env:
           # These secrets will need to be configured for the repository:
           GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
           PASSPHRASE: ${{ secrets.PASSPHRASE }}
       -
         name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v2
+        uses: goreleaser/goreleaser-action@v3.0.0
         with:
           version: latest
           args: release --rm-dist

.github/workflows/test.yml

@@ -23,15 +23,16 @@ jobs:
     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@v2.1.3
+      uses: actions/setup-go@v3
       with:
-        go-version: '1.16'
+        go-version-file: 'go.mod'
+        cache: true
       id: go
 
-    - name: Check out code into the Go module directory
-      uses: actions/[email protected]
-
     - name: Get dependencies
       run: |
         go mod download
@@ -40,6 +41,20 @@ jobs:
       run: |
         go build -v .
 
+  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: |
+          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
   test:
     name: Matrix Test
@@ -51,19 +66,24 @@ jobs:
       matrix:
         # list whatever Terraform versions here you would like to support
         terraform:
-          - '0.12.29'
-          - '0.13.4'
-          - '0.14.0-beta2'
+          - '1.0.*'
+          - '1.1.*'
     steps:
 
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v3
+
     - name: Set up Go
-      uses: actions/setup-go@v2.1.3
+      uses: actions/setup-go@v3
       with:
-        go-version: '1.16'
+        go-version-file: 'go.mod'
+        cache: true
       id: go
 
-    - name: Check out code into the Go module directory
-      uses: actions/[email protected]
+    - uses: hashicorp/setup-terraform@v2
+      with:
+        terraform_version: ${{ matrix.terraform }}
+        terraform_wrapper: false
 
     - name: Get dependencies
       run: |
@@ -73,7 +93,6 @@ jobs:
       timeout-minutes: 10
       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

docs/data-sources/entity.md

@@ -28,16 +28,16 @@ output "bluecat_config_id" {
 
 ### Required
 
-- **name** (String) The name of the entity to find.
-- **type** (String) The type of the entity you want to retrieve.
+- `name` (String) The name of the entity to find.
+- `type` (String) The type of the entity you want to retrieve.
 
 ### Optional
 
-- **id** (String) The ID of this resource.
-- **parent_id** (String) The object ID of the parent object that contains the entity. Configurations are stored in ID `0`. Defaults to `0`.
+- `parent_id` (String) The object ID of the parent object that contains the entity. Configurations are stored in ID `0`. Defaults to `0`.
 
 ### Read-Only
 
-- **properties** (String) The properties of the entity as returned by the API (pipe delimited).
+- `id` (String) The ID of this resource.
+- `properties` (String) The properties of the entity as returned by the API (pipe delimited).
 
 

docs/data-sources/host_record.md

@@ -27,25 +27,25 @@ output "bluecat_host_addresses" {
 
 ### Required
 
-- **absolute_name** (String) The absolute name/fqdn of the host record.
+- `absolute_name` (String) The absolute name/fqdn of the host record.
 
 ### Optional
 
-- **id** (String) The ID of this resource.
-- **result_count** (Number) The number of results the API should return. This must be between 1 and 10.  You most likely want to leave this alone. Defaults to `10`.
-- **start** (Number) The start index of the search results the API should return. You most likely want to leave this alone. Defaults to `0`.
+- `result_count` (Number) The number of results the API should return. This must be between 1 and 10.  You most likely want to leave this alone. Defaults to `10`.
+- `start` (Number) The start index of the search results the API should return. You most likely want to leave this alone. Defaults to `0`.
 
 ### Read-Only
 
-- **address_ids** (Set of String) A set of all address ids associated with the host record.
-- **addresses** (Set of String) A set of all addresses associated with the host record.
-- **custom_properties** (Map of String) A map of all custom properties associated with the host record.
-- **name** (String) The short name of the host record.
-- **parent_id** (String) The ID of the parent of the host record.
-- **parent_type** (String) The type of the parent of the host record.
-- **properties** (String) The properties of the host record as returned by the API (pipe delimited).
-- **reverse_record** (Boolean) A boolean that represents if the host record should set reverse records.
-- **ttl** (Number) The TTL of the host record.
-- **type** (String) The type of the resource.
+- `address_ids` (Set of String) A set of all address ids associated with the host record.
+- `addresses` (Set of String) A set of all addresses associated with the host record.
+- `custom_properties` (Map of String) A map of all custom properties associated with the host record.
+- `id` (String) The ID of this resource.
+- `name` (String) The short name of the host record.
+- `parent_id` (String) The ID of the parent of the host record.
+- `parent_type` (String) The type of the parent of the host record.
+- `properties` (String) The properties of the host record as returned by the API (pipe delimited).
+- `reverse_record` (Boolean) A boolean that represents if the host record should set reverse records.
+- `ttl` (Number) The TTL of the host record.
+- `type` (String) The type of the resource.
 
 

docs/data-sources/ip4_address.md

@@ -28,20 +28,17 @@ output "bluecat_address_mac" {
 
 ### Required
 
-- **address** (String) The IPv4 address to get data for.
-- **container_id** (String) The object ID of the container that has the specified `address`.  This can be a Configuration, IPv4 Block, IPv4 Network, or DHCP range.
-
-### Optional
-
-- **id** (String) The ID of this resource.
+- `address` (String) The IPv4 address to get data for.
+- `container_id` (String) The object ID of the container that has the specified `address`.  This can be a Configuration, IPv4 Block, IPv4 Network, or DHCP range.
 
 ### Read-Only
 
-- **custom_properties** (Map of String) A map of all custom properties associated with the IPv4 address.
-- **mac_address** (String) The MAC address associated with the IPv4 address.
-- **name** (String) The name assigned to the IPv4 address.  This is not related to DNS.
-- **properties** (String) The properties of the IPv4 address as returned by the API (pipe delimited).
-- **state** (String) The state of the IPv4 address.
-- **type** (String) The type of the resource.
+- `custom_properties` (Map of String) A map of all custom properties associated with the IPv4 address.
+- `id` (String) The ID of this resource.
+- `mac_address` (String) The MAC address associated with the IPv4 address.
+- `name` (String) The name assigned to the IPv4 address.  This is not related to DNS.
+- `properties` (String) The properties of the IPv4 address as returned by the API (pipe delimited).
+- `state` (String) The state of the IPv4 address.
+- `type` (String) The type of the resource.
 
 

docs/data-sources/ip4_network-block-range.md

@@ -29,35 +29,32 @@ output "bluecat_network_name" {
 
 ### Required
 
-- **address** (String) IP address to find the IPv4 network, IPv4 Block, or DHCPv4 Range of.
-- **container_id** (String) The object ID of a container that contains the specified IPv4 network, block, or range.
-- **type** (String) Must be "IP4Block", "IP4Network", "DHCP4Range", or "". "" will find the most specific container.
-
-### Optional
-
-- **id** (String) The ID of this resource.
+- `address` (String) IP address to find the IPv4 network, IPv4 Block, or DHCPv4 Range of.
+- `container_id` (String) The object ID of a container that contains the specified IPv4 network, block, or range.
+- `type` (String) Must be "IP4Block", "IP4Network", "DHCP4Range", or "". "" will find the most specific container.
 
 ### Read-Only
 
-- **addresses_free** (Number) The number of addresses unallocated/free on the network.
-- **addresses_in_use** (Number) The number of addresses allocated/in use on the network.
-- **allow_duplicate_host** (String) Duplicate host names check.
-- **cidr** (String) The CIDR address of the IPv4 network.
-- **custom_properties** (Map of String) A map of all custom properties associated with the IPv4 network.
-- **default_domains** (Set of String) TODO
-- **default_view** (String) The object id of the default DNS View for the network.
-- **dns_restrictions** (Set of String) TODO
-- **gateway** (String) The gateway of the IPv4 network.
-- **inherit_allow_duplicate_host** (Boolean) Duplicate host names check is inherited.
-- **inherit_default_domains** (Boolean) Default domains are inherited.
-- **inherit_default_view** (Boolean) The default DNS View is inherited.
-- **inherit_dns_restrictions** (Boolean) DNS restrictions are inherited.
-- **inherit_ping_before_assign** (Boolean) The network pings an address before assignment is inherited.
-- **location_code** (String) TODO
-- **location_inherited** (Boolean) TODO
-- **name** (String) The name assigned the resource.
-- **ping_before_assign** (String) The network pings an address before assignment.
-- **properties** (String) The properties of the resource as returned by the API (pipe delimited).
-- **template** (String) TODO
+- `addresses_free` (Number) The number of addresses unallocated/free on the network.
+- `addresses_in_use` (Number) The number of addresses allocated/in use on the network.
+- `allow_duplicate_host` (String) Duplicate host names check.
+- `cidr` (String) The CIDR address of the IPv4 network.
+- `custom_properties` (Map of String) A map of all custom properties associated with the IPv4 network.
+- `default_domains` (Set of String) TODO
+- `default_view` (String) The object id of the default DNS View for the network.
+- `dns_restrictions` (Set of String) TODO
+- `gateway` (String) The gateway of the IPv4 network.
+- `id` (String) The ID of this resource.
+- `inherit_allow_duplicate_host` (Boolean) Duplicate host names check is inherited.
+- `inherit_default_domains` (Boolean) Default domains are inherited.
+- `inherit_default_view` (Boolean) The default DNS View is inherited.
+- `inherit_dns_restrictions` (Boolean) DNS restrictions are inherited.
+- `inherit_ping_before_assign` (Boolean) The network pings an address before assignment is inherited.
+- `location_code` (String) TODO
+- `location_inherited` (Boolean) TODO
+- `name` (String) The name assigned the resource.
+- `ping_before_assign` (String) The network pings an address before assignment.
+- `properties` (String) The properties of the resource as returned by the API (pipe delimited).
+- `template` (String) TODO
 
 

docs/data-sources/ip4_network.md

@@ -17,35 +17,32 @@ Data source to access the attributes of an IPv4 network from a hint based search
 
 ### Required
 
-- **container_id** (String) The object ID of a container that contains the specified IPv4 network.
-- **hint** (String) Hint to find the IP4Network
-
-### Optional
-
-- **id** (String) The ID of this resource.
+- `container_id` (String) The object ID of a container that contains the specified IPv4 network.
+- `hint` (String) Hint to find the IP4Network
 
 ### Read-Only
 
-- **addresses_free** (Number) The number of addresses unallocated/free on the network.
-- **addresses_in_use** (Number) The number of addresses allocated/in use on the network.
-- **allow_duplicate_host** (String) Duplicate host names check.
-- **cidr** (String) The CIDR address of the IPv4 network.
-- **custom_properties** (Map of String) A map of all custom properties associated with the IPv4 network.
-- **default_domains** (Set of String) TODO
-- **default_view** (String) The object id of the default DNS View for the network.
-- **dns_restrictions** (Set of String) TODO
-- **gateway** (String) The gateway of the IPv4 network.
-- **inherit_allow_duplicate_host** (Boolean) Duplicate host names check is inherited.
-- **inherit_default_domains** (Boolean) Default domains are inherited.
-- **inherit_default_view** (Boolean) The default DNS View is inherited.
-- **inherit_dns_restrictions** (Boolean) DNS restrictions are inherited.
-- **inherit_ping_before_assign** (Boolean) The network pings an address before assignment is inherited.
-- **location_code** (String) TODO
-- **location_inherited** (Boolean) TODO
-- **name** (String) The name assigned the resource.
-- **ping_before_assign** (String) The network pings an address before assignment.
-- **properties** (String) The properties of the resource as returned by the API (pipe delimited).
-- **template** (String) TODO
-- **type** (String) The type of the IP4Network
+- `addresses_free` (Number) The number of addresses unallocated/free on the network.
+- `addresses_in_use` (Number) The number of addresses allocated/in use on the network.
+- `allow_duplicate_host` (String) Duplicate host names check.
+- `cidr` (String) The CIDR address of the IPv4 network.
+- `custom_properties` (Map of String) A map of all custom properties associated with the IPv4 network.
+- `default_domains` (Set of String) TODO
+- `default_view` (String) The object id of the default DNS View for the network.
+- `dns_restrictions` (Set of String) TODO
+- `gateway` (String) The gateway of the IPv4 network.
+- `id` (String) The ID of this resource.
+- `inherit_allow_duplicate_host` (Boolean) Duplicate host names check is inherited.
+- `inherit_default_domains` (Boolean) Default domains are inherited.
+- `inherit_default_view` (Boolean) The default DNS View is inherited.
+- `inherit_dns_restrictions` (Boolean) DNS restrictions are inherited.
+- `inherit_ping_before_assign` (Boolean) The network pings an address before assignment is inherited.
+- `location_code` (String) TODO
+- `location_inherited` (Boolean) TODO
+- `name` (String) The name assigned the resource.
+- `ping_before_assign` (String) The network pings an address before assignment.
+- `properties` (String) The properties of the resource as returned by the API (pipe delimited).
+- `template` (String) TODO
+- `type` (String) The type of the IP4Network
 
 

docs/index.md

@@ -31,10 +31,10 @@ data "bluecat_entity" "config" {
 
 ### Required
 
-- **bluecat_endpoint** (String) The BlueCat Address Manager endpoint hostname. Can also use the environment variable `BLUECAT_ENDPOINT`
-- **password** (String, Sensitive) The BlueCat Address Manager password. Can also use the environment variable `BLUECAT_PASSWORD`
-- **username** (String) A BlueCat Address Manager username. Can also use the environment variable `BLUECAT_USERNAME`
+- `bluecat_endpoint` (String) The BlueCat Address Manager endpoint hostname. Can also use the environment variable `BLUECAT_ENDPOINT`
+- `password` (String, Sensitive) The BlueCat Address Manager password. Can also use the environment variable `BLUECAT_PASSWORD`
+- `username` (String) A BlueCat Address Manager username. Can also use the environment variable `BLUECAT_USERNAME`
 
 ### Optional
 
-- **ssl_verify** (Boolean) Verify the SSL certificate of the BlueCat Address Manager endpoint? Defaults to `true`.
+- `ssl_verify` (Boolean) Verify the SSL certificate of the BlueCat Address Manager endpoint? Defaults to `true`.

docs/resources/host_record.md

@@ -30,23 +30,23 @@ output "bluecat_hostname_fqdn" {
 
 ### Required
 
-- **addresses** (Set of String) The address(es) to be associated with the host record.
-- **dns_zone** (String) The DNS zone to create the host record in. Combined with `name` to make the fqdn.  If changed, forces a new resource.
-- **name** (String) The name of the host record to be created. Combined with `dns_zone` to make the fqdn.
-- **view_id** (String) The object ID of the View that host record should be created in. If changed, forces a new resource.
+- `addresses` (Set of String) The address(es) to be associated with the host record.
+- `dns_zone` (String) The DNS zone to create the host record in. Combined with `name` to make the fqdn.  If changed, forces a new resource.
+- `name` (String) The name of the host record to be created. Combined with `dns_zone` to make the fqdn.
+- `view_id` (String) The object ID of the View that host record should be created in. If changed, forces a new resource.
 
 ### Optional
 
-- **comments** (String) Comments to be associated with the host record. Defaults to ``.
-- **custom_properties** (Map of String) A map of all custom properties associated with the host record.
-- **id** (String) The ID of this resource.
-- **reverse_record** (Boolean) If a reverse record should be created for addresses. Defaults to `true`.
-- **ttl** (Number) The TTL for the host record.  When set to -1, ignores the TTL. Defaults to `-1`.
+- `comments` (String) Comments to be associated with the host record. Defaults to ``.
+- `custom_properties` (Map of String) A map of all custom properties associated with the host record.
+- `reverse_record` (Boolean) If a reverse record should be created for addresses. Defaults to `true`.
+- `ttl` (Number) The TTL for the host record.  When set to -1, ignores the TTL. Defaults to `-1`.
 
 ### Read-Only
 
-- **absolute_name** (String) The absolute name (fqdn) of the host record.
-- **properties** (String) The properties of the host record as returned by the API (pipe delimited).
-- **type** (String) The type of the resource.
+- `absolute_name` (String) The absolute name (fqdn) of the host record.
+- `id` (String) The ID of this resource.
+- `properties` (String) The properties of the host record as returned by the API (pipe delimited).
+- `type` (String) The type of the resource.