Merge pull request #661 from linode/dev

Release v0.37.0

Author: ezilber-akamai

.github/workflows/labeler.yml

@@ -21,7 +21,7 @@ jobs:
         uses: actions/checkout@v4
       -
         name: Run Labeler
-        uses: crazy-max/ghaction-github-labeler@31674a3852a9074f2086abcf1c53839d466a47e7
+        uses: crazy-max/ghaction-github-labeler@24d110aa46a59976b8a7f35518cb7f14f434c916
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           yaml-file: .github/labels.yml

.github/workflows/unit-tests.yml

@@ -7,10 +7,7 @@ name: Run Unit test
 
 jobs:
   run-tests:
-
-    # TODO:
-    # Upgrade back to ubuntu-latest when the permission issue fixed
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [ '3.9','3.10','3.11', '3.12' ]

README.md

@@ -72,6 +72,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.lke_version_info](./docs/modules/lke_version_info.md)|Get info about a Linode LKE Version.|
 [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.|

docs/modules/lke_cluster.md

@@ -61,12 +61,13 @@ Manage Linode LKE clusters.
 | `k8s_version` | <center>`str`</center> | <center>Optional</center> | The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>, and the latest supported patch version will be deployed. A version upgrade requires that you manually recycle the nodes in your cluster.  **(Updatable)** |
 | `region` | <center>`str`</center> | <center>Optional</center> | This Kubernetes cluster’s location.   |
 | `tags` | <center>`list`</center> | <center>Optional</center> | An array of tags applied to the Kubernetes cluster.   |
-| `high_availability` | <center>`bool`</center> | <center>Optional</center> | Defines whether High Availability is enabled for the Control Plane Components of the cluster.   **(Default: `False`; Updatable)** |
+| `high_availability` | <center>`bool`</center> | <center>Optional</center> | Defines whether High Availability is enabled for the Control Plane Components of the cluster.   **(Updatable)** |
 | [`acl` (sub-options)](#acl) | <center>`dict`</center> | <center>Optional</center> | The ACL configuration for this cluster's control plane.  **(Updatable)** |
 | [`node_pools` (sub-options)](#node_pools) | <center>`list`</center> | <center>Optional</center> | A list of node pools to configure the cluster with  **(Updatable)** |
 | `skip_polling` | <center>`bool`</center> | <center>Optional</center> | If true, the module will not wait for all nodes in the cluster to be ready.  **(Default: `False`)** |
 | `wait_timeout` | <center>`int`</center> | <center>Optional</center> | The period to wait for the cluster to be ready in seconds.  **(Default: `600`)** |
 | `apl_enabled` | <center>`bool`</center> | <center>Optional</center> | Whether this cluster should use APL. NOTE: This endpoint is in beta.  **(Default: `False`)** |
+| `tier` | <center>`str`</center> | <center>Optional</center> | The desired tier of the LKE Cluster. NOTE: LKE Enterprise may not currently be available to all users  and can only be used with v4beta.  **(Choices: `standard`, `enterprise`)** |
 
 ### acl
 

docs/modules/lke_node_pool.md

@@ -63,6 +63,8 @@ Manage Linode LKE cluster node pools.
 | `wait_timeout` | <center>`int`</center> | <center>Optional</center> | The period to wait for the node pool to be ready in seconds.  **(Default: `600`)** |
 | `labels` | <center>`dict`</center> | <center>Optional</center> | Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects.  **(Updatable)** |
 | [`taints` (sub-options)](#taints) | <center>`list`</center> | <center>Optional</center> | Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods.  **(Updatable)** |
+| `k8s_version` | <center>`str`</center> | <center>Optional</center> | The desired Kubernetes version for this Kubernetes  Node Pool in the format of <major>.<minor>, and the  latest supported patch version. NOTE: Only available for LKE Enterprise to support node pool upgrades.  This field may not currently be available to all users and is under v4beta.  **(Updatable)** |
+| `update_strategy` | <center>`str`</center> | <center>Optional</center> | Upgrade strategy describes the available upgrade strategies. NOTE: Only available for LKE Enterprise to support node pool upgrades.  This field may not currently be available to all users and is under v4beta.  **(Choices: `rolling_update`, `on_recycle`; Updatable)** |
 
 ### autoscaler
 

docs/modules/lke_version_info.md

@@ -0,0 +1,62 @@
+# lke_version_info
+
+Get info about a Linode LKE Version.
+
+- [Minimum Required Fields](#minimum-required-fields)
+- [Examples](#examples)
+- [Parameters](#parameters)
+- [Return Values](#return-values)
+
+## Minimum Required Fields
+| Field       | Type  | Required     | Description                                                                                                                                                                                                              |
+|-------------|-------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `api_token` | `str` | **Required** | The Linode account personal access token. It is necessary to run the module. <br/>It can be exposed by the environment variable `LINODE_API_TOKEN` instead. <br/>See details in [Usage](https://github.com/linode/ansible_linode?tab=readme-ov-file#usage). |
+
+## Examples
+
+```yaml
+    - name: Get info about an LKE version by ID
+      linode.cloud.lke_cluster_info:
+        id: '1.31'
+    
+```
+
+```yaml
+    - name: Get info about an LKE version by tier and ID
+      linode.cloud.lke_cluster_info:
+        tier: 'standard'
+        id: '1.31'
+    
+```
+
+
+## Parameters
+
+| Field     | Type | Required | Description                                                                  |
+|-----------|------|----------|------------------------------------------------------------------------------|
+| `id` | <center>`str`</center> | <center>**Required**</center> | The ID of the LKE Version to resolve.   |
+| `tier` | <center>`str`</center> | <center>Optional</center> | Specifies the service tier for retrieving LKE version details. NOTE: LKE Enterprise may not currently be available to all users and  can only be used with v4beta.  **(Choices: `standard`, `enterprise`)** |
+
+## Return Values
+
+- `lke_version` - The returned LKE Version.
+
+    - Sample Response:
+        ```json
+        
+            {
+              "id": "1.31"
+            }
+            
+        ```
+        ```json
+        
+            {
+              "id": "1.31",
+              "tier": "standard"
+            }
+            
+        ```
+    - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-lke-version) for a list of returned fields
+
+

docs/modules/lke_version_list.md

@@ -15,8 +15,16 @@ List and filter on LKE Versions.
 ## Examples
 
 ```yaml
-- name: List all Kubernetes versions available for deployment to a Kubernetes cluster
-  linode.cloud.lke_version_list: {}
+    - name: List all Kubernetes versions available for deployment to a Kubernetes cluster
+      linode.cloud.lke_version_list:
+    
+```
+
+```yaml
+    - name: List all enterprise-tier Kubernetes versions available for deployment to a Kubernetes cluster
+      linode.cloud.lke_version_list:
+        tier: "enterprise"
+    
 ```
 
 
@@ -28,6 +36,7 @@ List and filter on LKE Versions.
 | `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order LKE Versions by.   |
 | [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting LKE Versions.   |
 | `count` | <center>`int`</center> | <center>Optional</center> | The number of LKE Versions to return. If undefined, all results will be returned.   |
+| `tier` | <center>`str`</center> | <center>Optional</center> | Specifies the service tier for retrieving LKE version details. NOTE: LKE Enterprise may not currently be available to all users  and can only be used with v4beta.  **(Choices: `standard`, `enterprise`)** |
 
 ### filters
 
@@ -42,11 +51,29 @@ List and filter on LKE Versions.
 
     - Sample Response:
         ```json
-        [
-            {
-              "id": "1.25"
-            }
-        ]
+        
+            [
+                {
+                    "id": "1.32"
+                },
+                {
+                    "id": "1.31"
+                },
+                {
+                    "id": "1.30"
+                }
+            ]
+            
+        ```
+        ```json
+        
+            [
+                {
+                    "id": "v1.31.1+lke1",
+                    "tier": "enterprise"
+                }
+            ]
+            
         ```
     - See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-lke-versions) for a list of returned fields
 

e2e_scripts

@@ -0,0 +1,28 @@
+"""Documentation fragments for the lke_version_info module"""
+
+specdoc_examples = [
+    '''
+    - name: Get info about an LKE version by ID
+      linode.cloud.lke_cluster_info:
+        id: '1.31'
+    ''', '''
+    - name: Get info about an LKE version by tier and ID
+      linode.cloud.lke_cluster_info:
+        tier: 'standard'
+        id: '1.31'
+    '''
+]
+
+result_lke_version_samples = [
+    '''
+    {
+      "id": "1.31"
+    }
+    ''',
+    '''
+    {
+      "id": "1.31",
+      "tier": "standard"
+    }
+    '''
+]

plugins/module_utils/doc_fragments/lke_version_info.py

@@ -1,11 +1,36 @@
 """Documentation fragments for the lke_version_list module"""
 
-specdoc_examples = ['''
-- name: List all Kubernetes versions available for deployment to a Kubernetes cluster
-  linode.cloud.lke_version_list: {}''']
+specdoc_examples = [
+    '''
+    - name: List all Kubernetes versions available for deployment to a Kubernetes cluster
+      linode.cloud.lke_version_list:
+    ''', '''
+    - name: List all enterprise-tier Kubernetes versions available for deployment to a Kubernetes cluster
+      linode.cloud.lke_version_list:
+        tier: "enterprise"
+    '''
+]
 
-result_lke_versions_samples = ['''[
-    {
-      "id": "1.25"
-    }
-]''']
+result_lke_versions_samples = [
+    '''
+    [
+        {
+            "id": "1.32"
+        },
+        {
+            "id": "1.31"
+        },
+        {
+            "id": "1.30"
+        }
+    ]
+    ''',
+    '''
+    [
+        {
+            "id": "v1.31.1+lke1",
+            "tier": "enterprise"
+        }
+    ]
+    '''
+]