Merge pull request #38 from cisco-open/hh-internal-nat

Support internal and public NAT rules
cisco-open · Aug 8, 2024 · dd8214d · dd8214d
2 parents 63f24d4 + dd83e08
commit dd8214d
Show file tree

Hide file tree

Showing 42 changed files with 477 additions and 287 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -17,29 +17,24 @@ on:
 jobs:
   goreleaser:
     permissions:
-      contents: write 
+      contents: write
     runs-on: ubuntu-latest
     steps:
-      -
-        name: Checkout
+      - name: Checkout
         uses: actions/checkout@v3
-      -
-        name: Unshallow
+      - name: Unshallow
         run: git fetch --prune --unshallow
-      -
-        name: Set up Go
+      - name: Set up Go
         uses: actions/setup-go@v2
         with:
           go-version: 1.18
-      -
-        name: Import GPG key
+      - name: Import GPG key
         id: import_gpg
         uses: crazy-max/[email protected]
         with:
           gpg_private_key: ${{ secrets.TERRAFORM_GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.TERRAFORM_GPG_PASSPHRASE }}
-      -
-        name: Run GoReleaser
+      - name: Run GoReleaser
         uses: goreleaser/[email protected]
         with:
           version: latest

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -1,33 +1,33 @@
 {
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Acceptance Tests",
-            "type": "go",
-            "request": "launch",
-            "mode": "test",
-            // this assumes your workspace is the root of the repo
-            "program": "${fileDirname}",
-            "env": {
-                "TF_ACC": "1",
-            },
-            "args": [],
-        },
-        {
-            "name": "Debug - Attach External CLI",
-            "type": "go",
-            "request": "launch",
-            "mode": "debug",
-            // this assumes your workspace is the root of the repo
-            "program": "${workspaceFolder}",
-            "env": {},
-            "args": [
-                // pass the debug flag for reattaching
-                "-debug",
-            ],
-        }
-    ]
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Acceptance Tests",
+      "type": "go",
+      "request": "launch",
+      "mode": "test",
+      // this assumes your workspace is the root of the repo
+      "program": "${fileDirname}",
+      "env": {
+        "TF_ACC": "1"
+      },
+      "args": []
+    },
+    {
+      "name": "Debug - Attach External CLI",
+      "type": "go",
+      "request": "launch",
+      "mode": "debug",
+      // this assumes your workspace is the root of the repo
+      "program": "${workspaceFolder}",
+      "env": {},
+      "args": [
+        // pass the debug flag for reattaching
+        "-debug"
+      ]
+    }
+  ]
 }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,14 @@
 # How to Contribute
 
-Thank you for your interest in contributing to the dCloud Terraform Provider project! To ensure smooth collaboration and effective development, please review the following guidelines. By following these guidelines, you demonstrate respect for the time and efforts of the project's contributors. In return, they will reciprocate by addressing your issues, evaluating changes, and assisting with your pull requests. We strive to review incoming issues and pull requests within 10 days. Any lingering issues or pull requests inactive for 60 days will be closed.
+Thank you for your interest in contributing to the dCloud Terraform Provider project! To ensure smooth collaboration and
+effective development, please review the following guidelines. By following these guidelines, you demonstrate respect
+for the time and efforts of the project's contributors. In return, they will reciprocate by addressing your issues,
+evaluating changes, and assisting with your pull requests. We strive to review incoming issues and pull requests within
+10 days. Any lingering issues or pull requests inactive for 60 days will be closed.
 
-Please note that all interactions within the project are subject to our [Code of Conduct](/CODE_OF_CONDUCT.md). This applies to creating issues or pull requests, commenting on them, as well as any real-time discussions in platforms like Slack, Discord, etc.
+Please note that all interactions within the project are subject to our [Code of Conduct](/CODE_OF_CONDUCT.md). This
+applies to creating issues or pull requests, commenting on them, as well as any real-time discussions in platforms like
+Slack, Discord, etc.
 
 ## Table Of Contents
 
@@ -17,11 +23,15 @@ Please note that all interactions within the project are subject to our [Code of
 
 ## Reporting Issues
 
-Before reporting a new issue, please search our [issues list](https://github.com/cisco-open/terraform-provider-dcloud/issues) to ensure that it hasn't already been reported or fixed.
+Before reporting a new issue, please search
+our [issues list](https://github.com/cisco-open/terraform-provider-dcloud/issues) to ensure that it hasn't already been
+reported or fixed.
 
-When creating a new issue, include a clear title, a detailed description, relevant information, and if possible, a test case.
+When creating a new issue, include a clear title, a detailed description, relevant information, and if possible, a test
+case.
 
-**If you discover a security vulnerability, please refrain from reporting it through GitHub. Instead, follow the security procedures outlined in [SECURITY.md](/SECURITY.md).**
+**If you discover a security vulnerability, please refrain from reporting it through GitHub. Instead, follow the
+security procedures outlined in [SECURITY.md](/SECURITY.md).**
 
 ## Development
 
@@ -46,14 +56,17 @@ To run the example terraform definitions for the dCloud Terraform Provider, do t
 
 1. Navigate to each example directory under `/examples`
 2. Execute `terraform init`
-3. Create an environment variable to hold your Cisco Authentication Token (use a valid token) `export TB_AUTH_TOKEN=abc123`
+3. Create an environment variable to hold your Cisco Authentication Token (use a valid
+   token) `export TB_AUTH_TOKEN=abc123`
 4. Execute `terraform apply`
 
 ## Sending Pull Requests
 
-Before submitting a new pull request, please check existing pull requests and issues to ensure that your proposed changes or fixes haven't been discussed in the past or already implemented but not released.
+Before submitting a new pull request, please check existing pull requests and issues to ensure that your proposed
+changes or fixes haven't been discussed in the past or already implemented but not released.
 
-When submitting a pull request, include tests for any affected behavior. As we follow semantic versioning, breaking changes may be reserved for the next major version release.
+When submitting a pull request, include tests for any affected behavior. As we follow semantic versioning, breaking
+changes may be reserved for the next major version release.
 
 ## Other Ways to Contribute
 

diff --git a/docs/data-sources/external_dns.md b/docs/data-sources/external_dns.md
@@ -3,12 +3,13 @@
 page_title: "dcloud_external_dns Data Source - terraform-provider-dcloud"
 subcategory: ""
 description: |-
-  All the dns records currently in a given topology
+  All the External DNS rules in a given topology
 ---
 
 # dcloud_external_dns (Data Source)
 
-All the dns records currently in a given topology
+All the External DNS rules in a given topology
+
 
 
 <!-- schema generated by tfplugindocs -->
@@ -20,30 +21,29 @@ All the dns records currently in a given topology
 
 ### Read-Only
 
-- `id` (String) The ID of this resource.
 - `external_dns` (List of Object) (see [below for nested schema](#nestedatt--external_dns))
+- `id` (String) The ID of this resource.
 
 <a id="nestedatt--external_dns"></a>
 ### Nested Schema for `external_dns`
 
 Read-Only:
 
-- `uid` (String)
-- `topology_uid` (String)
+- `a_record` (String)
 - `hostname` (String)
 - `nat_rule_id` (String)
-- `a_record` (String)
 - `srv_records` (List of Object) (see [below for nested schema](#nestedobjatt--external_dns--srv_records))
-
+- `topology_uid` (String)
+- `uid` (String)
 
 <a id="nestedobjatt--external_dns--srv_records"></a>
 ### Nested Schema for `external_dns.srv_records`
 
 Read-Only:
 
+- `port` (Number)
 - `protocol` (String)
 - `service` (String)
-- `port` (Int)
 - `uid` (String)
 
 
diff --git a/docs/data-sources/inbound_proxy_rules.md b/docs/data-sources/inbound_proxy_rules.md
@@ -3,12 +3,13 @@
 page_title: "dcloud_inbound_proxy_rules Data Source - terraform-provider-dcloud"
 subcategory: ""
 description: |-
-  All the Inbound Proxy rules currently in a given topology
+  All the Inbound Proxy rules in a given topology
 ---
 
 # dcloud_inbound_proxy_rules (Data Source)
 
-All the Inbound Proxy rules currently in a given topology
+All the Inbound Proxy rules in a given topology
+
 
 
 <!-- schema generated by tfplugindocs -->
@@ -28,15 +29,15 @@ All the Inbound Proxy rules currently in a given topology
 
 Read-Only:
 
-- `nic_uid` (String)
+- `hyperlink` (String)
 - `nic_ip_address` (String)
+- `nic_uid` (String)
+- `show_hyperlink` (Boolean)
+- `ssl` (Boolean)
 - `target_vm_name` (String)
-- `show_hypperlink` (Bool)
-- `ssl` (Bool)
-- `url_path` (String)
-- `hyperlink` (String)
-- `tcp_port` (Integer)
+- `tcp_port` (Number)
 - `topology_uid` (String)
 - `uid` (String)
+- `url_path` (String)
 
 
diff --git a/docs/data-sources/inventory_dns_assets.md b/docs/data-sources/inventory_dns_assets.md
@@ -3,12 +3,12 @@
 page_title: "dcloud_inventory_dns_assets Data Source - terraform-provider-dcloud"
 subcategory: ""
 description: |-
-  All the inventory dns assets available to be used in a topology
+  All the Inventory DNS assets in a given topology
 ---
 
 # dcloud_inventory_dns_assets (Data Source)
 
-All the inventory dns assets available to be used in a topology
+All the Inventory DNS assets in a given topology
 
 
 

diff --git a/docs/data-sources/inventory_srv_protocols.md b/docs/data-sources/inventory_srv_protocols.md
@@ -3,19 +3,18 @@
 page_title: "dcloud_inventory_srv_protocols Data Source - terraform-provider-dcloud"
 subcategory: ""
 description: |-
-  All the inventory srv protocols available to be used in a topology
+  All the Inventory SRV protocols in a given topology
 ---
 
 # dcloud_inventory_srv_protocols (Data Source)
 
-All the inventory srv protocols available to be used in a topology
+All the Inventory SRV protocols in a given topology
 
 
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
-
 ### Read-Only
 
 - `id` (String) The ID of this resource.

diff --git a/docs/data-sources/inventory_telephony.md b/docs/data-sources/inventory_telephony.md
@@ -3,12 +3,12 @@
 page_title: "dcloud_inventory_telephony Data Source - terraform-provider-dcloud"
 subcategory: ""
 description: |-
-  All the inventory telephony available to be used in a topology
+  All the inventory Telephony Items available to be used in a topology
 ---
 
 # dcloud_inventory_telephony (Data Source)
 
-All the inventory telephony available to be used in a topology
+All the inventory Telephony Items available to be used in a topology
 
 
 
@@ -29,8 +29,8 @@ All the inventory telephony available to be used in a topology
 
 Read-Only:
 
+- `description` (String)
 - `id` (String)
 - `name` (String)
-- `description` (String)
 
 
diff --git a/docs/data-sources/ip_nat_rules.md b/docs/data-sources/ip_nat_rules.md
@@ -3,12 +3,13 @@
 page_title: "dcloud_ip_nat_rules Data Source - terraform-provider-dcloud"
 subcategory: ""
 description: |-
-  All the IP Nat rules currently in a given topology
+  All the IP Nat rules in a given topology
 ---
 
 # dcloud_ip_nat_rules (Data Source)
 
-All the IP Nat rules currently in a given topology
+All the IP Nat rules in a given topology
+
 
 
 <!-- schema generated by tfplugindocs -->
@@ -28,9 +29,10 @@ All the IP Nat rules currently in a given topology
 
 Read-Only:
 
+- `east_west` (Boolean)
+- `scope` (String)
 - `target_ip_address` (String)
 - `target_name` (String)
-- `east_west` (Bool)
 - `topology_uid` (String)
 - `uid` (String)
 

diff --git a/docs/data-sources/mail_servers.md b/docs/data-sources/mail_servers.md
@@ -3,12 +3,13 @@
 page_title: "dcloud_mail_servers Data Source - terraform-provider-dcloud"
 subcategory: ""
 description: |-
-  All the Mail servers currently in a given topology
+  All the Mail Servers in a given topology
 ---
 
 # dcloud_mail_servers (Data Source)
 
-All the Mail servers currently in a given topology
+All the Mail Servers in a given topology
+
 
 
 <!-- schema generated by tfplugindocs -->
@@ -21,16 +22,16 @@ All the Mail servers currently in a given topology
 ### Read-Only
 
 - `id` (String) The ID of this resource.
-- `mail-servers` (List of Object) (see [below for nested schema](#nestedatt--mail-servers))
+- `mail_servers` (List of Object) (see [below for nested schema](#nestedatt--mail_servers))
 
-<a id="nestedatt--mail-servers"></a>
-### Nested Schema for `mail-servers`
+<a id="nestedatt--mail_servers"></a>
+### Nested Schema for `mail_servers`
 
 Read-Only:
 
-- `nic_uid` (String)
 - `dns_asset_id` (String)
 - `dns_asset_name` (String)
+- `nic_uid` (String)
 - `topology_uid` (String)
 - `uid` (String)