Prepare for release 3.0.0 (#662)

Prepare for release 3.0.0 SUMMARY Updated version to 3.0.0 Executed antsibull-changelog to generate changelog ISSUE TYPE Docs Pull Request COMPONENT NAME ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis Reviewed-by: Helen Bailey <[email protected]> Reviewed-by: GomathiselviS
ansible-collections · Nov 17, 2023 · e756ced · e756ced
1 parent 1a60121
commit e756ced
Show file tree

Hide file tree

Showing 45 changed files with 1,331 additions and 336 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,44 @@ Kubernetes Collection Release Notes
 .. contents:: Topics
 
 
+v3.0.0
+======
+
+Release Summary
+---------------
+
+This major release drops support for ansible-core versions lower than 2.14, Python versions lower than 3.9 and updates python kubernetes library to 24.2.0, helm/kind-action to 1.8.0, kubernetes >= 1.24, along with bug fixes and minor changes.
+
+Minor Changes
+-------------
+
+- helm - add ``reuse_values`` and ``reset_values`` support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/394).
+- k8s - add new option ``delete_all`` to support deletion of all resources when state is set to ``absent``. (https://github.com/ansible-collections/kubernetes.core/issues/504)
+- k8s, k8s_info - add a hidden_fields option to allow fields to be hidden in the results of k8s and k8s_info
+- k8s_drain - add ability to filter the list of pods to be drained by a pod label selector (https://github.com/ansible-collections/kubernetes.core/issues/474).
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- Remove support for ansible-core < 2.14
+- Update python kubernetes library to 24.2.0, helm/kind-action to 1.8.0, kubernetes >= 1.24.
+
+Deprecated Features
+-------------------
+
+- k8s - the ``k8s`` inventory plugin has been deprecated and will be removed in release 4.0.0 (https://github.com/ansible-collections/kubernetes.core/issues/31).
+
+Bugfixes
+--------
+
+- helm - Put the chart_ref into quotes when running ``helm show chart``, ``helm upgrade`` and ``helm dependency update`` commands (https://github.com/ansible-collections/kubernetes.core/issues/653).
+- helm - delete temporary file created when deploying chart with option ``release_values`` set (https://github.com/ansible-collections/kubernetes.core/issues/530).
+- helm - fix issue occurring when uninstalling chart with statues others than ``deployed`` (https://github.com/ansible-collections/kubernetes.core/issues/319).
+- helm - fix post_renderer argument breaking the helm deploy_command (https://github.com/ansible-collections/kubernetes.core/pull/586).
+- helm - use post_renderer when checking ``changed`` status for a helm release (https://github.com/ansible-collections/kubernetes.core/pull/588).
+- k8s_scale - clean handling of ResourceTimeout exception (https://github.com/ansible-collections/kubernetes.core/issues/583).
+- k8s_scale - fix issue when scaling StatefulSets with ``updateStrategy=OnDelete`` (https://github.com/ansible-collections/kubernetes.core/issues/579).
+
 v2.4.0
 ======
 
@@ -96,7 +134,7 @@ v2.3.1
 Bugfixes
 --------
 
-- Catch exception raised when the process is waiting for resources (https://github.com/ansible-collections/kubernetes.core/issues/407).
+- Catch expectation raised when the process is waiting for resources (https://github.com/ansible-collections/kubernetes.core/issues/407).
 - Remove `omit` placeholder when defining resource using template parameter (https://github.com/ansible-collections/kubernetes.core/issues/431).
 - k8s - fix the issue when trying to delete resources using label_selectors options (https://github.com/ansible-collections/kubernetes.core/issues/433).
 - k8s_cp - fix issue when using parameter local_path with file on managed node. (https://github.com/ansible-collections/kubernetes.core/issues/421).

diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 # Also needs to be updated in galaxy.yml
-VERSION = 2.4.0
+VERSION = 3.0.0
 
 TEST_ARGS ?= ""
 PYTHON_VERSION ?= `python -c 'import platform; print(".".join(platform.python_version_tuple()[0:2]))'`

diff --git a/README.md b/README.md
@@ -93,7 +93,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible
 ---
 collections:
   - name: kubernetes.core
-    version: 2.4.0
+    version: 3.0.0
 ```
 
 ### Installing the Kubernetes Python Library

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -762,3 +762,55 @@ releases:
       name: helm_pull
       namespace: ''
     release_date: '2023-01-24'
+  3.0.0:
+    changes:
+      breaking_changes:
+      - Remove support for ansible-core < 2.14
+      - Update python kubernetes library to 24.2.0, helm/kind-action to 1.8.0, kubernetes
+        >= 1.24.
+      bugfixes:
+      - helm - Put the chart_ref into quotes when running ``helm show chart``, ``helm
+        upgrade`` and ``helm dependency update`` commands (https://github.com/ansible-collections/kubernetes.core/issues/653).
+      - helm - delete temporary file created when deploying chart with option ``release_values``
+        set (https://github.com/ansible-collections/kubernetes.core/issues/530).
+      - helm - fix issue occurring when uninstalling chart with statues others than
+        ``deployed`` (https://github.com/ansible-collections/kubernetes.core/issues/319).
+      - helm - fix post_renderer argument breaking the helm deploy_command (https://github.com/ansible-collections/kubernetes.core/pull/586).
+      - helm - use post_renderer when checking ``changed`` status for a helm release
+        (https://github.com/ansible-collections/kubernetes.core/pull/588).
+      - k8s_scale - clean handling of ResourceTimeout exception (https://github.com/ansible-collections/kubernetes.core/issues/583).
+      - k8s_scale - fix issue when scaling StatefulSets with ``updateStrategy=OnDelete``
+        (https://github.com/ansible-collections/kubernetes.core/issues/579).
+      deprecated_features:
+      - k8s - the ``k8s`` inventory plugin has been deprecated and will be removed
+        in release 4.0.0 (https://github.com/ansible-collections/kubernetes.core/issues/31).
+      minor_changes:
+      - helm - add ``reuse_values`` and ``reset_values`` support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/394).
+      - k8s - add new option ``delete_all`` to support deletion of all resources when
+        state is set to ``absent``. (https://github.com/ansible-collections/kubernetes.core/issues/504)
+      - k8s, k8s_info - add a hidden_fields option to allow fields to be hidden in
+        the results of k8s and k8s_info
+      - k8s_drain - add ability to filter the list of pods to be drained by a pod
+        label selector (https://github.com/ansible-collections/kubernetes.core/issues/474).
+      release_summary: This major release drops support for ansible-core versions
+        lower than 2.14, Python versions lower than 3.9 and updates python kubernetes
+        library to 24.2.0, helm/kind-action to 1.8.0, kubernetes >= 1.24, along with
+        bug fixes and minor changes.
+    fragments:
+    - 20230206-deprecate-k8s-inventory.yml
+    - 20231110-helm-quote-ref.yaml
+    - 517-k8s-make-name-optional.yaml
+    - 575-helm-add-support-for-reuse_values-and-reset_values.yml
+    - 579-k8s_scale-fix-issue-with-scaling-statefulsets.yml
+    - 583-k8s_scale-clean-handling-of-ResourceTimeout-exception.yaml
+    - 586-helm-fix-post-renderer-arg.yml
+    - 588-helm-use-post-renderer-for-helmdiff.yml
+    - 589-helm-uninstall-chart-releases-with-statuses-different-than-deployed.yaml
+    - 606-k8s_drain-add-pod_selectors-parameter.yaml
+    - 612-fix-helm-tests.yaml
+    - 629-add-hidden-fields-option.yaml
+    - gha-sanity-fixes.yaml
+    - helm-delete-temporary-file-created-when-using-option-release_values.yaml
+    - remove_ansible_2_13.yaml
+    - update_supported_versions.yaml
+    release_date: '2023-11-17'
diff --git a/changelogs/fragments/20230206-deprecate-k8s-inventory.yml b/changelogs/fragments/20230206-deprecate-k8s-inventory.yml
diff --git a/changelogs/fragments/20231110-helm-quote-ref.yaml b/changelogs/fragments/20231110-helm-quote-ref.yaml
diff --git a/changelogs/fragments/517-k8s-make-name-optional.yaml b/changelogs/fragments/517-k8s-make-name-optional.yaml
diff --git a/changelogs/fragments/575-helm-add-support-for-reuse_values-and-reset_values.yml b/changelogs/fragments/575-helm-add-support-for-reuse_values-and-reset_values.yml
diff --git a/changelogs/fragments/579-k8s_scale-fix-issue-with-scaling-statefulsets.yml b/changelogs/fragments/579-k8s_scale-fix-issue-with-scaling-statefulsets.yml
diff --git a/changelogs/fragments/583-k8s_scale-clean-handling-of-ResourceTimeout-exception.yaml b/changelogs/fragments/583-k8s_scale-clean-handling-of-ResourceTimeout-exception.yaml
diff --git a/changelogs/fragments/586-helm-fix-post-renderer-arg.yml b/changelogs/fragments/586-helm-fix-post-renderer-arg.yml
diff --git a/changelogs/fragments/588-helm-use-post-renderer-for-helmdiff.yml b/changelogs/fragments/588-helm-use-post-renderer-for-helmdiff.yml
diff --git a/...gs/fragments/589-helm-uninstall-chart-releases-with-statuses-different-than-deployed.yaml b/...gs/fragments/589-helm-uninstall-chart-releases-with-statuses-different-than-deployed.yaml
diff --git a/changelogs/fragments/606-k8s_drain-add-pod_selectors-parameter.yaml b/changelogs/fragments/606-k8s_drain-add-pod_selectors-parameter.yaml
diff --git a/changelogs/fragments/612-fix-helm-tests.yaml b/changelogs/fragments/612-fix-helm-tests.yaml
diff --git a/changelogs/fragments/629-add-hidden-fields-option.yaml b/changelogs/fragments/629-add-hidden-fields-option.yaml
diff --git a/changelogs/fragments/gha-sanity-fixes.yaml b/changelogs/fragments/gha-sanity-fixes.yaml
diff --git a/...gelogs/fragments/helm-delete-temporary-file-created-when-using-option-release_values.yaml b/...gelogs/fragments/helm-delete-temporary-file-created-when-using-option-release_values.yaml
diff --git a/changelogs/fragments/remove_ansible_2_13.yaml b/changelogs/fragments/remove_ansible_2_13.yaml
diff --git a/changelogs/fragments/update_supported_versions.yaml b/changelogs/fragments/update_supported_versions.yaml
diff --git a/docs/kubernetes.core.helm_info_module.rst b/docs/kubernetes.core.helm_info_module.rst
@@ -105,6 +105,27 @@ Parameters
                         <div style="font-size: small; color: darkgreen"><br/>aliases: kube_context</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>get_all_values</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">boolean</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 2.4.0</div>
+                </td>
+                <td>
+                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
+                                    <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
+                                    <li>yes</li>
+                        </ul>
+                </td>
+                <td>
+                        <div>Set to <code>True</code> if you want to get all (computed) values of the release.</div>
+                        <div>When <code>False</code> (default), only user supplied values are returned.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -127,14 +148,15 @@ Parameters
                     <b>kubeconfig</b>
                     <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
                     <div style="font-size: small">
-                        <span style="color: purple">path</span>
+                        <span style="color: purple">raw</span>
                     </div>
                 </td>
                 <td>
                 </td>
                 <td>
                         <div>Helm option to specify kubeconfig path to use.</div>
                         <div>If the value is not specified in the task, the value of environment variable <code>K8S_AUTH_KUBECONFIG</code> will be used instead.</div>
+                        <div>The configuration can be provided as dictionary. Added in version 2.4.0.</div>
                         <div style="font-size: small; color: darkgreen"><br/>aliases: kubeconfig_path</div>
                 </td>
             </tr>
@@ -172,6 +194,32 @@ Parameters
                         <div style="font-size: small; color: darkgreen"><br/>aliases: namespace</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>release_state</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">list</span>
+                         / <span style="color: purple">elements=string</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 2.3.0</div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">[]</div>
+                </td>
+                <td>
+                        <div>Show releases as per their states.</div>
+                        <div>Default value is <code>deployed</code> and <code>failed</code>.</div>
+                        <div>If set to <code>all</code>, show all releases without any filter applied.</div>
+                        <div>If set to <code>deployed</code>, show deployed releases.</div>
+                        <div>If set to <code>failed</code>, show failed releases.</div>
+                        <div>If set to <code>pending</code>, show pending releases.</div>
+                        <div>If set to <code>superseded</code>, show superseded releases.</div>
+                        <div>If set to <code>uninstalled</code>, show uninstalled releases, if <code>helm uninstall --keep-history</code> was used.</div>
+                        <div>If set to <code>uninstalling</code>, show releases that are currently being uninstalled.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -204,11 +252,18 @@ Examples
 
 .. code-block:: yaml
 
-    - name: Deploy latest version of Grafana chart inside monitoring namespace
+    - name: Gather information of Grafana chart inside monitoring namespace
       kubernetes.core.helm_info:
         name: test
         release_namespace: monitoring
 
+    - name: Gather information about test-chart with pending state
+      kubernetes.core.helm_info:
+        name: test-chart
+        release_namespace: testenv
+        release_state:
+        - pending
+
 
 
 Return Values
@@ -270,6 +325,42 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                     <br/>
                 </td>
             </tr>
+            <tr>
+                    <td class="elbow-placeholder">&nbsp;</td>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>hooks</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">list</span>
+                       / <span style="color: purple">elements=dictionary</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 2.4.0</div>
+                </td>
+                <td>always</td>
+                <td>
+                            <div>Hooks of the release</div>
+                    <br/>
+                </td>
+            </tr>
+            <tr>
+                    <td class="elbow-placeholder">&nbsp;</td>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>manifest</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">list</span>
+                       / <span style="color: purple">elements=dictionary</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 2.4.0</div>
+                </td>
+                <td>always</td>
+                <td>
+                            <div>Manifest of the release</div>
+                    <br/>
+                </td>
+            </tr>
             <tr>
                     <td class="elbow-placeholder">&nbsp;</td>
                 <td colspan="1">
@@ -302,6 +393,23 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                     <br/>
                 </td>
             </tr>
+            <tr>
+                    <td class="elbow-placeholder">&nbsp;</td>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>notes</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">string</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 2.4.0</div>
+                </td>
+                <td>always</td>
+                <td>
+                            <div>Notes of the release</div>
+                    <br/>
+                </td>
+            </tr>
             <tr>
                     <td class="elbow-placeholder">&nbsp;</td>
                 <td colspan="1">