Migrated nb info and list modules (#566)

linode · Aug 20, 2024 · 6af0104 · 6af0104
1 parent 0a16ba0
commit 6af0104
Show file tree

Hide file tree

Showing 10 changed files with 254 additions and 413 deletions.
diff --git a/README.md b/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.|
@@ -69,7 +69,7 @@ Name | Description |
 [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.|
@@ -101,7 +101,7 @@ Name | Description |
 [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 Regions.|

diff --git a/docs/modules/nodebalancer_info.md b/docs/modules/nodebalancer_info.md
@@ -1,6 +1,6 @@
 # nodebalancer_info
 
-Get info about a Linode NodeBalancer.
+Get info about a Linode Node Balancer.
 
 - [Minimum Required Fields](#minimum-required-fields)
 - [Examples](#examples)
@@ -31,12 +31,12 @@ Get info about a Linode NodeBalancer.
 
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
-| `id` | <center>`int`</center> | <center>Optional</center> | The ID of this NodeBalancer. Optional if `label` is defined.  **(Conflicts With: `label`)** |
-| `label` | <center>`str`</center> | <center>Optional</center> | The label of this NodeBalancer. Optional if `id` is defined.  **(Conflicts With: `id`)** |
+| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Node Balancer to resolve.  **(Conflicts With: `id`)** |
+| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the Node Balancer to resolve.  **(Conflicts With: `label`)** |
 
 ## Return Values
 
-- `node_balancer` - The NodeBalancer in JSON serialized form.
+- `node_balancer` - The returned Node Balancer.
 
     - Sample Response:
         ```json
@@ -64,7 +64,7 @@ Get info about a Linode NodeBalancer.
     - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-node-balancer) for a list of returned fields
 
 
-- `configs` - A list of configs applied to the NodeBalancer.
+- `configs` - The returned configs.
 
     - Sample Response:
         ```json
@@ -96,10 +96,10 @@ Get info about a Linode NodeBalancer.
           }
         ]
         ```
-    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-config) for a list of returned fields
+    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-configs) for a list of returned fields
 
 
-- `nodes` - A list of configs applied to the NodeBalancer.
+- `nodes` - The returned nodes.
 
     - Sample Response:
         ```json
@@ -116,10 +116,10 @@ Get info about a Linode NodeBalancer.
           }
         ]
         ```
-    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-node) for a list of returned fields
+    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-config-nodes) for a list of returned fields
 
 
-- `firewalls` - A list IDs for firewalls attached to this NodeBalancer.
+- `firewalls` - The returned firewalls.
 
     - Sample Response:
         ```json
@@ -131,3 +131,37 @@ Get info about a Linode NodeBalancer.
     - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-firewalls) for a list of returned fields
 
 
+- `firewalls_data` - The returned firewalls_data.
+
+    - Sample Response:
+        ```json
+        [
+          {
+            "created": "2020-04-10T13:34:00",
+            "entities": [
+              {
+                "id": 1234,
+                "label": "example-label",
+                "type": "nodebalancer",
+                "url": "/v4/nodebalancers/1234"
+              }
+            ],
+            "id": 45678,
+            "label": "very-cool-label",
+            "rules": {
+              "fingerprint": "abcdefg",
+              "inbound": [],
+              "inbound_policy": "DROP",
+              "outbound": [],
+              "outbound_policy": "DROP",
+              "version": 1
+            },
+              "status": "enabled",
+              "tags": [],
+              "updated": "2020-04-10T13:34:01"
+          }
+        ]
+        ```
+    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-firewalls) for a list of returned fields
+
+
diff --git a/docs/modules/nodebalancer_list.md b/docs/modules/nodebalancer_list.md
@@ -1,6 +1,6 @@
 # nodebalancer_list
 
-List and filter on Nodebalancers.
+List and filter on Node Balancers.
 
 - [Minimum Required Fields](#minimum-required-fields)
 - [Examples](#examples)
@@ -32,21 +32,21 @@ List and filter on Nodebalancers.
 
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
-| `order` | <center>`str`</center> | <center>Optional</center> | The order to list nodebalancers in.  **(Choices: `desc`, `asc`; Default: `asc`)** |
-| `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order nodebalancers by.   |
-| [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting nodebalancers.   |
-| `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 Node Balancers in.  **(Choices: `desc`, `asc`; Default: `asc`)** |
+| `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order Node Balancers by.   |
+| [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting Node Balancers.   |
+| `count` | <center>`int`</center> | <center>Optional</center> | The number of Node Balancers 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-node-balancers   |
+| `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-node-balancers).   |
 | `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
 
-- `nodebalancers` - The returned nodebalancers.
+- `nodebalancers` - The returned Node Balancers.
 
     - Sample Response:
         ```json

diff --git a/docs/modules/nodebalancer_stats.md b/docs/modules/nodebalancer_stats.md
@@ -1,6 +1,6 @@
 # nodebalancer_stats
 
-View a Linode NodeBalancers Stats.
+Get info about a Linode Node Balancer Stats.
 
 - [Minimum Required Fields](#minimum-required-fields)
 - [Examples](#examples)
@@ -28,12 +28,12 @@ View a Linode NodeBalancers Stats.
 
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
-| `id` | <center>`int`</center> | <center>Optional</center> | The id of the nodebalancer for which the statistics apply to.  **(Conflicts With: `label`)** |
-| `label` | <center>`str`</center> | <center>Optional</center> | The label of the nodebalancer for which the statistics apply to.  **(Conflicts With: `id`)** |
+| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Node Balancer Stats to resolve.  **(Conflicts With: `id`)** |
+| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the Node Balancer Stats to resolve.  **(Conflicts With: `label`)** |
 
 ## Return Values
 
-- `node_balancer_stats` - The NodeBalancer Stats in JSON serialized form.
+- `node_balancer_stats` - The returned Node Balancer Stats.
 
     - Sample Response:
         ```json

diff --git a/plugins/module_utils/doc_fragments/nodebalancer.py b/plugins/module_utils/doc_fragments/nodebalancer.py
@@ -86,3 +86,30 @@
   1234,
   5678
 ]''']
+
+result_firewalls_data_samples = ['''[
+  {
+    "created": "2020-04-10T13:34:00",
+    "entities": [
+      {
+        "id": 1234,
+        "label": "example-label",
+        "type": "nodebalancer",
+        "url": "/v4/nodebalancers/1234"
+      }
+    ],
+    "id": 45678,
+    "label": "very-cool-label",
+    "rules": {
+      "fingerprint": "abcdefg",
+      "inbound": [],
+      "inbound_policy": "DROP",
+      "outbound": [],
+      "outbound_policy": "DROP",
+      "version": 1
+    },
+      "status": "enabled",
+      "tags": [],
+      "updated": "2020-04-10T13:34:01"
+  }
+]''']