Merge pull request #567 from linode/dev

Release v0.30.0

Makefile

@@ -62,26 +62,42 @@ gendocs:
 #	ansible-test integration $(TEST_ARGS) --tags never
 integration-test: create-integration-config create-e2e-firewall
 	@echo "Running Integration Test(s)..."
-	ansible-test integration $(TEST_ARGS)
-
-create-e2e-firewall:
+	{ \
+		ansible-test integration $(TEST_ARGS); \
+		TEST_EXIT_CODE=$$?; \
+		make delete-e2e-firewall; \
+		exit $$TEST_EXIT_CODE; \
+	}
+
+create-e2e-firewall: update-test-submodules
 	@echo "Running create e2e firewall playbook..."
-	@if ansible-playbook e2e_scripts/cloud_security_scripts/cloud_e2e_firewall/ansible_linode/create_e2e_cloud_firewall.yaml > /dev/null; then \
-		echo "Successfully created e2e firewall"; \
-	else \
-		echo "Failed to create e2e firewall. Please update the cloud firewall scripts using `git submodule update --init` if yaml file doesn't exist"; \
+	@OUTPUT=$$(ansible-playbook e2e_scripts/cloud_security_scripts/cloud_e2e_firewall/ansible_linode/create_e2e_cloud_firewall.yaml 2>&1); \
+	FAILED_COUNT=$$(echo "$$OUTPUT" | grep "failed=" | awk -F 'failed=' '{print $$2}' | awk '{print $$1}'); \
+	if [ "$$FAILED_COUNT" -gt 0 ]; then \
+		echo "Playbook execution failed:"; \
+		echo "$$OUTPUT"; \
 		exit 1; \
+	else \
+		echo "E2E Cloud firewall created successfully."; \
 	fi
 
-delete-e2e-firewall:
+
+delete-e2e-firewall: update-test-submodules
 	@echo "Running delete e2e firewall playbook..."
-	@if ansible-playbook e2e_scripts/cloud_security_scripts/cloud_e2e_firewall/ansible_linode/delete_e2e_cloud_firewall.yaml  > /dev/null; then \
-		echo "Successfully deleted e2e firewall"; \
+	@OUTPUT=$$(ansible-playbook e2e_scripts/cloud_security_scripts/cloud_e2e_firewall/ansible_linode/delete_e2e_cloud_firewall.yaml 2>&1); \
+	FAILED_COUNT=$$(echo "$$OUTPUT" | grep "failed=" | awk -F 'failed=' '{print $$2}' | awk '{print $$1}'); \
+	if [ "$$FAILED_COUNT" -gt 0 ]; then \
+		echo "Playbook execution failed:"; \
+		echo "$$OUTPUT"; \
+		exit 1; \
 	else \
-		echo "Failed to delete e2e firewall"; \
-    fi
+		echo "E2E Cloud firewall created successfully."; \
+	fi
+
+update-test-submodules:
+	@git submodule update --init
 
-test: integration-test delete-e2e-firewall
+test: integration-test
 
 testall:
 	./scripts/test_all.sh

README.md

@@ -37,7 +37,7 @@ Name | Description |
 [linode.cloud.lke_node_pool](./docs/modules/lke_node_pool.md)|Manage Linode LKE cluster node pools.|
 [linode.cloud.nodebalancer](./docs/modules/nodebalancer.md)|Manage a Linode NodeBalancer.|
 [linode.cloud.nodebalancer_node](./docs/modules/nodebalancer_node.md)|Manage Linode NodeBalancer Nodes.|
-[linode.cloud.nodebalancer_stats](./docs/modules/nodebalancer_stats.md)|View a Linode NodeBalancers Stats.|
+[linode.cloud.nodebalancer_stats](./docs/modules/nodebalancer_stats.md)|Get info about a Linode Node Balancer Stats.|
 [linode.cloud.object_keys](./docs/modules/object_keys.md)|Manage Linode Object Storage Keys.|
 [linode.cloud.placement_group](./docs/modules/placement_group.md)|Manage a Linode Placement Group.|
 [linode.cloud.placement_group_assign](./docs/modules/placement_group_assign.md)|Manages a single assignment between a Linode and a Placement Group.|
@@ -62,14 +62,14 @@ Name | Description |
 [linode.cloud.database_mysql_info](./docs/modules/database_mysql_info.md)|Get info about a Linode MySQL Managed Database.|
 [linode.cloud.database_postgresql_info](./docs/modules/database_postgresql_info.md)|Get info about a Linode PostgreSQL Managed Database.|
 [linode.cloud.domain_info](./docs/modules/domain_info.md)|Get info about a Linode Domain.|
-[linode.cloud.domain_record_info](./docs/modules/domain_record_info.md)|Get info about a Linode Domain Record.|
+[linode.cloud.domain_record_info](./docs/modules/domain_record_info.md)|Get info about a Linode Domain Records.|
 [linode.cloud.firewall_info](./docs/modules/firewall_info.md)|Get info about a Linode Firewall.|
 [linode.cloud.image_info](./docs/modules/image_info.md)|Get info about a Linode Image.|
 [linode.cloud.instance_info](./docs/modules/instance_info.md)|Get info about a Linode Instance.|
 [linode.cloud.ip_info](./docs/modules/ip_info.md)|Get info about a Linode IP.|
 [linode.cloud.ipv6_range_info](./docs/modules/ipv6_range_info.md)|Get info about a Linode IPv6 range.|
 [linode.cloud.lke_cluster_info](./docs/modules/lke_cluster_info.md)|Get info about a Linode LKE cluster.|
-[linode.cloud.nodebalancer_info](./docs/modules/nodebalancer_info.md)|Get info about a Linode NodeBalancer.|
+[linode.cloud.nodebalancer_info](./docs/modules/nodebalancer_info.md)|Get info about a Linode Node Balancer.|
 [linode.cloud.object_cluster_info](./docs/modules/object_cluster_info.md)|**NOTE: This module has been deprecated because it relies on deprecated API endpoints. Going forward, `region` will be the preferred way to designate where Object Storage resources should be created.**|
 [linode.cloud.placement_group_info](./docs/modules/placement_group_info.md)|Get info about a Linode Placement Group.|
 [linode.cloud.profile_info](./docs/modules/profile_info.md)|Get info about a Linode Profile.|
@@ -95,20 +95,20 @@ Name | Description |
 [linode.cloud.database_engine_list](./docs/modules/database_engine_list.md)|List and filter on Managed Database engine types.|
 [linode.cloud.database_list](./docs/modules/database_list.md)|List and filter on Linode Managed Databases.|
 [linode.cloud.domain_list](./docs/modules/domain_list.md)|List and filter on Domains.|
-[linode.cloud.event_list](./docs/modules/event_list.md)|List and filter on Linode events.|
+[linode.cloud.event_list](./docs/modules/event_list.md)|List and filter on Events.|
 [linode.cloud.firewall_list](./docs/modules/firewall_list.md)|List and filter on Firewalls.|
 [linode.cloud.image_list](./docs/modules/image_list.md)|List and filter on Images.|
-[linode.cloud.instance_list](./docs/modules/instance_list.md)|List and filter on Linode Instances.|
-[linode.cloud.instance_type_list](./docs/modules/instance_type_list.md)|List and filter on Linode Instance Types.|
+[linode.cloud.instance_list](./docs/modules/instance_list.md)|List and filter on Instances.|
+[linode.cloud.instance_type_list](./docs/modules/instance_type_list.md)|**NOTE: This module has been deprecated in favor of `type_list`.|
 [linode.cloud.lke_version_list](./docs/modules/lke_version_list.md)|List Kubernetes versions available for deployment to a Kubernetes cluster.|
-[linode.cloud.nodebalancer_list](./docs/modules/nodebalancer_list.md)|List and filter on Nodebalancers.|
+[linode.cloud.nodebalancer_list](./docs/modules/nodebalancer_list.md)|List and filter on Node Balancers.|
 [linode.cloud.object_cluster_list](./docs/modules/object_cluster_list.md)|**NOTE: This module has been deprecated because it relies on deprecated API endpoints. Going forward, `region` will be the preferred way to designate where Object Storage resources should be created.**|
 [linode.cloud.placement_group_list](./docs/modules/placement_group_list.md)|List and filter on Placement Groups.|
-[linode.cloud.region_list](./docs/modules/region_list.md)|List and filter on Linode Regions.|
+[linode.cloud.region_list](./docs/modules/region_list.md)|List and filter on Regions.|
 [linode.cloud.ssh_key_list](./docs/modules/ssh_key_list.md)|List and filter on SSH keys in the Linode profile.|
 [linode.cloud.stackscript_list](./docs/modules/stackscript_list.md)|List and filter on Linode stackscripts.|
 [linode.cloud.token_list](./docs/modules/token_list.md)|List and filter on Linode Account tokens.|
-[linode.cloud.type_list](./docs/modules/type_list.md)|List and filter on Linode Instance Types.|
+[linode.cloud.type_list](./docs/modules/type_list.md)|List and filter on Types.|
 [linode.cloud.user_list](./docs/modules/user_list.md)|List Users.|
 [linode.cloud.vlan_list](./docs/modules/vlan_list.md)|List and filter on Linode VLANs.|
 [linode.cloud.volume_list](./docs/modules/volume_list.md)|List and filter on Linode Volumes.|

docs/modules/account_availability_info.md

@@ -2,7 +2,7 @@
 
 Get info about a Linode Account Availability.
 
-**:warning: This module makes use of beta endpoints and requires the `api_version` field be explicitly set to `v4beta`.**
+WARNING! This module makes use of beta endpoints and requires the C(api_version) field be explicitly set to C(v4beta).
 
 - [Minimum Required Fields](#minimum-required-fields)
 - [Examples](#examples)
@@ -45,6 +45,6 @@ Get info about a Linode Account Availability.
         }
 
         ```
-    - See the [Linode API response documentation](TBD) for a list of returned fields
+    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-account-availability) for a list of returned fields
 
 

docs/modules/account_availability_list.md

@@ -2,7 +2,7 @@
 
 List and filter on Account Availabilities.
 
-**:warning: This module makes use of beta endpoints and requires the `api_version` field be explicitly set to `v4beta`.**
+WARNING! This module makes use of beta endpoints and requires the C(api_version) field be explicitly set to C(v4beta).
 
 - [Minimum Required Fields](#minimum-required-fields)
 - [Examples](#examples)
@@ -36,7 +36,7 @@ List and filter on Account Availabilities.
 
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
-| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](TBD).   |
+| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/get-account-availability).   |
 | `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.   |
 
 ## Return Values
@@ -58,6 +58,6 @@ List and filter on Account Availabilities.
             }
         ]
         ```
-    - See the [Linode API response documentation](TBD) for a list of returned fields
+    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-account-availability) for a list of returned fields
 
 

docs/modules/account_info.md

@@ -22,7 +22,7 @@ Get info about a Linode Account.
 
 ## Return Values
 
-- `account` - The account info in JSON serialized form.
+- `account` - The returned Account.
 
     - Sample Response:
         ```json

docs/modules/child_account_info.md

@@ -65,5 +65,6 @@ NOTE: Parent/Child related features may not be generally available.
             "zip": "19102-1234"
         }
         ```
+    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-child-account) for a list of returned fields
 
 

docs/modules/child_account_list.md

@@ -35,7 +35,7 @@ NOTE: Parent/Child related features may not be generally available.
 
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
-| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here]().   |
+| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/get-child-accounts).   |
 | `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.   |
 
 ## Return Values
@@ -74,5 +74,6 @@ NOTE: Parent/Child related features may not be generally available.
             "zip": "19102-1234"
         }
         ```
+    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-child-accounts) for a list of returned fields
 
 

docs/modules/domain.md

@@ -106,20 +106,18 @@ Manage Linode Domains.
 
     - Sample Response:
         ```json
-        [
-          {
-            "zone_file": [
-              "; example.com [123]",
-              "$TTL 864000",
-              "@  IN  SOA  ns1.linode.com. user.example.com. 2021000066 14400 14400 1209600 86400",
-              "@    NS  ns1.linode.com.",
-              "@    NS  ns2.linode.com.",
-              "@    NS  ns3.linode.com.",
-              "@    NS  ns4.linode.com.",
-              "@    NS  ns5.linode.com."
-            ]
-          }
-        ]
+        {
+          "zone_file": [
+            "; example.com [123]",
+            "$TTL 864000",
+            "@  IN  SOA  ns1.linode.com. user.example.com. 2021000066 14400 14400 1209600 86400",
+            "@    NS  ns1.linode.com.",
+            "@    NS  ns2.linode.com.",
+            "@    NS  ns3.linode.com.",
+            "@    NS  ns4.linode.com.",
+            "@    NS  ns5.linode.com."
+          ]
+        }
         ```
     - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain-zone) for a list of returned fields
 

docs/modules/domain_info.md

@@ -31,12 +31,12 @@ Get info about a Linode Domain.
 
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
-| `id` | <center>`int`</center> | <center>Optional</center> | The unique domain name of the Domain. Optional if `domain` is defined.  **(Conflicts With: `domain`)** |
-| `domain` | <center>`str`</center> | <center>Optional</center> | The unique id of the Domain. Optional if `id` is defined.  **(Conflicts With: `id`)** |
+| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the Domain to resolve.  **(Conflicts With: `domain`)** |
+| `domain` | <center>`str`</center> | <center>Optional</center> | The domain of the Domain to resolve.  **(Conflicts With: `id`)** |
 
 ## Return Values
 
-- `domain` - The domain in JSON serialized form.
+- `domain` - The returned Domain.
 
     - Sample Response:
         ```json
@@ -63,7 +63,7 @@ Get info about a Linode Domain.
     - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain) for a list of returned fields
 
 
-- `records` - The domain record in JSON serialized form.
+- `records` - The returned records.
 
     - Sample Response:
         ```json
@@ -85,27 +85,25 @@ Get info about a Linode Domain.
           }
         ]
         ```
-    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain-record) for a list of returned fields
+    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain-records) for a list of returned fields
 
 
-- `zone_file` - The zone file for the last rendered zone for the specified domain.
+- `zone_file` - The returned zone file.
 
     - Sample Response:
         ```json
-        [
-          {
-            "zone_file": [
-              "; example.com [123]",
-              "$TTL 864000",
-              "@  IN  SOA  ns1.linode.com. user.example.com. 2021000066 14400 14400 1209600 86400",
-              "@    NS  ns1.linode.com.",
-              "@    NS  ns2.linode.com.",
-              "@    NS  ns3.linode.com.",
-              "@    NS  ns4.linode.com.",
-              "@    NS  ns5.linode.com."
-            ]
-          }
-        ]
+        {
+          "zone_file": [
+            "; example.com [123]",
+            "$TTL 864000",
+            "@  IN  SOA  ns1.linode.com. user.example.com. 2021000066 14400 14400 1209600 86400",
+            "@    NS  ns1.linode.com.",
+            "@    NS  ns2.linode.com.",
+            "@    NS  ns3.linode.com.",
+            "@    NS  ns4.linode.com.",
+            "@    NS  ns5.linode.com."
+          ]
+        }
         ```
     - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-domain-zone) for a list of returned fields
 

docs/modules/domain_list.md

@@ -32,21 +32,21 @@ List and filter on Domains.
 
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
-| `order` | <center>`str`</center> | <center>Optional</center> | The order to list domains in.  **(Choices: `desc`, `asc`; Default: `asc`)** |
-| `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order domains by.   |
-| [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting domains.   |
-| `count` | <center>`int`</center> | <center>Optional</center> | The number of results to return. If undefined, all results will be returned.   |
+| `order` | <center>`str`</center> | <center>Optional</center> | The order to list Domains in.  **(Choices: `desc`, `asc`; Default: `asc`)** |
+| `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order Domains by.   |
+| [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting Domains.   |
+| `count` | <center>`int`</center> | <center>Optional</center> | The number of Domains to return. If undefined, all results will be returned.   |
 
 ### filters
 
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
-| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable attributes can be found here: https://techdocs.akamai.com/linode-api/reference/get-domains   |
+| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/get-domains).   |
 | `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.   |
 
 ## Return Values
 
-- `domains` - The returned domains.
+- `domains` - The returned Domains.
 
     - Sample Response:
         ```json