Prepare release 3.2.0 (#746)

SUMMARY
Prepare version 3.2.0
ISSUE TYPE

New Version Pull Request

ADDITIONAL INFORMATION
The current version of a major Ansible (Ansible 10) includes a collection version 3.1.0, meaning that the minor version (i.e. Ansible 10.1) will pick versions from the stable-3 branch. Hence, a recent documentation update will not be in Ansible and Ansible documentation site/kubernetes.core collection chapter until a new minor version released from stable-3 branch.
This PR also includes changes in README.md and Makefile that were missed in 3.1.0

Reviewed-by: Mike Graves <mgraves@redhat.com>

.ansible-lint-ignore

@@ -0,0 +1,2 @@
+# no-changed-when is not requried for examples
+plugins/connection/kubectl.py no-changed-when

.github/workflows/integration-tests-kubevirt.yaml

@@ -0,0 +1,127 @@
+name: Integration tests Kubevirt
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+    branches:
+      - main
+      - stable-*
+
+jobs:
+  splitter:
+    continue-on-error: true
+    env:
+      kubernetes: "./kubernetes"
+      kubevirt: "./kubevirt"
+      py_version: 3.9
+    runs-on: ubuntu-latest
+    outputs:
+      test_targets: ${{ steps.splitter.outputs.kubevirt_targets }}
+    steps:
+      - name: Checkout kubernetes.core repository
+        uses: actions/checkout@v3
+        with:
+          path: ${{ env.kubernetes }}
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Checkout the kubevirt.core collection
+        uses: actions/checkout@v3
+        with:
+          repository: kubevirt/kubevirt.core
+          path: ${{ env.kubevirt }}
+
+      - name: "Set up Python ${{ env.py_version }}"
+        uses: actions/setup-python@v4
+        with:
+          python-version: "${{ env.py_version }}"
+
+      - name: List targets from kubevirt.core collection
+        id: splitter
+        run: python ${{ env.kubernetes }}/tools/kubevirt_list_targets.py ${{ env.kubevirt }}
+        shell: bash
+
+  integration:
+    if: ${{ needs.splitter.outputs.test_targets != '' }}
+    name: "integration-kubevirt-${{ matrix.test-target }}"
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    needs:
+      - splitter
+    env:
+      kubernetes: "./kubernetes"
+      kubevirt: "./kubevirt"
+      ansible_version: milestone
+      python_version: 3.12
+    strategy:
+      fail-fast: false
+      matrix:
+        test-target: ${{ fromJson(needs.splitter.outputs.test_targets) }}
+    steps:
+      - name: Checkout kubernetes.core repository
+        uses: actions/checkout@v4
+        with:
+          path: ${{ env.kubernetes }}
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Checkout kubevirt.core repository
+        uses: actions/checkout@v4
+        with:
+          repository: kubevirt/kubevirt.core
+          path: ${{ env.kubevirt }}
+          ref: main
+
+      # Install ansible
+      - name: Install ansible-core (${{ env.ansible_version }})
+        run: >-
+          python3 -m pip install
+          https://github.com/ansible/ansible/archive/${{ env.ansible_version }}.tar.gz
+          --disable-pip-version-check
+        shell: bash
+
+      - name: Build and install kubevirt.core collection
+        id: install-kubevirt
+        uses: ansible-network/github_actions/.github/actions/build_install_collection@main
+        with:
+          install_python_dependencies: true
+          source_path: ${{ env.kubevirt }}
+
+      - name: Build and install kubernetes.core collection
+        id: install-kubernetes
+        uses: ansible-network/github_actions/.github/actions/build_install_collection@main
+        with:
+          install_python_dependencies: true
+          source_path: ${{ env.kubernetes }}
+
+      - name: Install kind / kubectl
+        uses: helm/kind-action@v1.9.0
+        with:
+          version: v0.22.0
+          install_only: true
+
+      - name: Deploy kubevirt
+        run: >-
+          ${{ env.kubevirt }}/hack/e2e-setup.sh \
+            -v \
+            --configure-inotify-limits \
+            --configure-secondary-network \
+            --deploy-kubevirt \
+            --deploy-kubevirt-cdi \
+            --deploy-kubevirt-common-instancetypes \
+            --deploy-cnao \
+            --create-cluster \
+            --create-nad
+        env:
+          KIND: kind
+          KUBECTL: kubectl
+
+      - name: Run integration tests
+        uses: ansible-network/github_actions/.github/actions/ansible_test_integration@main
+        with:
+          collection_path: ${{ steps.install-kubevirt.outputs.collection_path }}
+          python_version: ${{ env.python_version }}
+          ansible_version: ${{ env.ansible_version }}
+          ansible_test_targets: ${{ matrix.test-target }}
+        env:
+          ANSIBLE_COLLECTIONS_PATHS: /home/runner/collections

.github/workflows/linters.yaml

@@ -21,4 +21,4 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Run ansible-lint
-        uses: ansible/ansible-lint@v6.21.0
+        uses: ansible/ansible-lint@v24.2.3

CHANGELOG.rst

@@ -4,6 +4,39 @@ Kubernetes Collection Release Notes
 
 .. contents:: Topics
 
+v3.2.0
+======
+
+Release Summary
+---------------
+This release comes with documentation updates.
+
+Minor Changes
+-------------
+
+- inventory/k8s.py - Defer removal of k8s inventory plugin to version 6.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/734).
+- connection/kubectl.py - Added an example of using the kubectl connection plugin to the documentation (https://github.com/ansible-collections/kubernetes.core/pull/741).
+
+v3.1.0
+======
+
+Release Summary
+---------------
+
+This release comes with some bugfixes and documentation updates. It also adds new features to the kubectl connection plugin and the kustomize lookup plugin.
+
+Minor Changes
+-------------
+
+- kubectl - added support of local enviroment variable that will be used for kubectl and may be requried for establishing connections ifself (https://github.com/ansible-collections/kubernetes.core/pull/702)
+- kustomize - new parameter added to --enable-helm (https://github.com/ansible-collections/kubernetes.core/issues/568)
+
+Bugfixes
+--------
+
+- helm - expand kubeconfig path with user's home directory for consistency with k8s
+- k8s_json_patch - rename action symlink to ensure k8s action plugin is used (https://github.com/ansible-collections/kubernetes.core/pull/652).
+
 v3.0.1
 ======
 

Makefile

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

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: 3.0.0
+    version: 3.2.0
 ```
 
 ### Installing the Kubernetes Python Library

changelogs/changelog.yaml

@@ -833,3 +833,35 @@ releases:
     - 20240228-fix-helm-diff-with-reuse-values.yml
     - 3.0.1.yml
     release_date: '2024-03-01'
+  3.1.0:
+    changes:
+      bugfixes:
+      - helm - expand kubeconfig path with user's home directory for consistency with
+        k8s
+      - k8s_json_patch - rename action symlink to ensure k8s action plugin is used
+        (https://github.com/ansible-collections/kubernetes.core/pull/652).
+      minor_changes:
+      - kubectl - added support of local enviroment variable that will be used for
+        kubectl and may be requried for establishing connections ifself (https://github.com/ansible-collections/kubernetes.core/pull/702)
+      - kustomize - new parameter added to --enable-helm (https://github.com/ansible-collections/kubernetes.core/issues/568)
+      release_summary: This release comes with some bugfixes and documentation updates.
+        It also adds new features to the kubectl connection plugin and the kustomize
+        lookup plugin.
+    fragments:
+    - 20240426-add-support-of-kubectl-local-env-vars-for-connection-plugin.yml
+    - 3.1.0.yml
+    - 592-kustomize-helm-support.yml
+    - 652-fix-json-patch-action.yml
+    - 654-helm-expand-user.yml
+    release_date: '2024-05-16'
+  3.2.0:
+    changes:
+      minor_changes:
+      - inventory/k8s.py - Defer removal of k8s inventory plugin to version 6.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/734).
+      - connection/kubectl.py - Added an example of using the kubectl connection plugin to the documentation (https://github.com/ansible-collections/kubernetes.core/pull/741).
+      release_summary: This release comes with documentation updates.
+    fragments:
+    - 20240530-defer-removal-and-ansible-core-support-update.yaml
+    - 20240601-doc-example-of-using-kubectl.yaml
+    - 3.2.0.yml
+    release_date: '2024-06-14'

changelogs/fragments/20240530-ansible-core-support-update.yaml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - inventory/k8s.py - Defer removal of k8s inventory plugin to version 6.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/734).

changelogs/fragments/inventory-update_removal_date.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - inventory/k8s.py - Defer removal of k8s inventory plugin to version 5.0 (https://github.com/ansible-collections/kubernetes.core/pull/723).

docs/kubernetes.core.k8s_inventory.rst

@@ -17,7 +17,7 @@ DEPRECATED
 ----------
 :Removed in collection release after 
 :Why: As discussed in https://github.com/ansible-collections/kubernetes.core/issues/31, we decided to
-remove the k8s inventory plugin in release 4.0.0.
+remove the k8s inventory plugin in release 6.0.0.
 
 :Alternative: Use :ref:`kubernetes.core.k8s_info <kubernetes.core.k8s_info_module>` and :ref:`ansible.builtin.add_host <ansible.builtin.add_host_module>` instead.
 
@@ -357,7 +357,7 @@ Status
 ------
 
 
-- This inventory will be removed in version 4.0.0. *[deprecated]*
+- This inventory will be removed in version 6.0.0. *[deprecated]*
 - For more information see `DEPRECATED`_.
 
 

docs/kubernetes.core.k8s_module.rst

@@ -524,7 +524,7 @@ Parameters
                         <div>See <a href='https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment'>https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment</a></div>
                         <div>If more than one <code>merge_type</code> is given, the merge_types will be tried in order. This defaults to <code>[&#x27;strategic-merge&#x27;, &#x27;merge&#x27;]</code>, which is ideal for using the same parameters on resource kinds that combine Custom Resources and built-in resources.</div>
                         <div>mutually exclusive with <code>apply</code></div>
-                        <div><em>merge_type=json</em> is deprecated and will be removed in version 3.0.0. Please use <span class='module'>kubernetes.core.k8s_json_patch</span> instead.</div>
+                        <div><em>merge_type=json</em> is deprecated and will be removed in version 4.0.0. Please use <span class='module'>kubernetes.core.k8s_json_patch</span> instead.</div>
                 </td>
             </tr>
             <tr>

docs/kubernetes.core.kubectl_connection.rst

@@ -211,6 +211,27 @@ Parameters
                         <div>The configuration can be provided as dictionary. Added in version 2.4.0.</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>kubectl_local_env_vars</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">dictionary</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 3.1.0</div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">{}</div>
+                </td>
+                    <td>
+                                <div>var: ansible_kubectl_local_env_vars</div>
+                    </td>
+                <td>
+                        <div>Local enviromantal variable to be passed locally to the kubectl command line.</div>
+                        <div>Please be aware that this passes information directly on the command line and it could expose sensitive data.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -344,6 +365,82 @@ Parameters
 
 
 
+Examples
+--------
+
+.. code-block:: yaml
+
+    - name: Run a command in a pod using local kubectl with kubeconfig file ~/.kube/config
+      hosts: localhost
+      gather_facts: no
+      vars:
+        ansible_connection: kubernetes.core.kubectl
+        ansible_kubectl_namespace: my-namespace
+        ansible_kubectl_pod: my-pod
+        ansible_kubectl_container: my-container
+      tasks:
+        # be aware that the command is executed as the user that started the container
+        # and requires python to be installed in the image
+        - name: Run a command in a pod
+          ansible.builtin.command: echo "Hello, World!"
+
+    - name: Run a command in a pod using local kubectl with inventory variables
+      # Example inventory:
+      # k8s:
+      #   hosts:
+      #     foo.example.com:
+      #       ansible_connection: kubernetes.core.kubectl
+      #       ansible_kubectl_kubeconfig: /root/.kube/foo.example.com.config
+      #       ansible_kubectl_pod: my-foo-pod
+      #       ansible_kubectl_container: my-foo-container
+      #       ansible_kubectl_namespace: my-foo-namespace
+      #     bar.example.com:
+      #       ansible_connection: kubernetes.core.kubectl
+      #       ansible_kubectl_kubeconfig: /root/.kube/bar.example.com.config
+      #       ansible_kubectl_pod: my-bar-pod
+      #       ansible_kubectl_container: my-bar-container
+      #       ansible_kubectl_namespace: my-bar-namespace
+      hosts: k8s
+      gather_facts: no
+      tasks:
+        # be aware that the command is executed as the user that started the container
+        # and requires python to be installed in the image
+        - name: Run a command in a pod
+          ansible.builtin.command: echo "Hello, World!"
+
+    - name: Run a command in a pod using dynamic inventory
+      hosts: localhost
+      gather_facts: no
+      vars:
+        kubeconfig: /root/.kube/config
+        namespace: my-namespace
+        my_app: my-app
+      tasks:
+        - name: Get My App pod info based on label
+          kubernetes.core.k8s_info:
+            kubeconfig: "{{ kubeconfig }}"
+            namespace: "{{ namespace }}"
+            kind: Pod
+            label_selectors: app.kubernetes.io/name = "{{ my_app }}"
+          register: my_app_pod
+
+        - name: Get My App pod name
+          ansible.builtin.set_fact:
+            my_app_pod_name: "{{ my_app_pod.resources[0].metadata.name }}"
+
+        - name: Add My App pod to inventory
+          ansible.builtin.add_host:
+            name: "{{ my_app_pod_name }}"
+            ansible_connection: kubernetes.core.kubectl
+            ansible_kubectl_kubeconfig: "{{ kubeconfig }}"
+            ansible_kubectl_pod: "{{ my_app_pod_name }}"
+            ansible_kubectl_namespace: "{{ namespace }}"
+
+        - name: Run a command in My App pod
+          # be aware that the command is executed as the user that started the container
+          # and requires python to be installed in the image
+          ansible.builtin.command: echo "Hello, World!"
+          delegate_to: "{{ my_app_pod_name }}"
 
 
 

docs/kubernetes.core.kustomize_lookup.rst

@@ -77,6 +77,24 @@ Parameters
                         <div>If omitted, &#x27;.&#x27; is assumed.</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>enable_helm</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">-</span>
+                    </div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">"False"</div>
+                </td>
+                    <td>
+                    </td>
+                <td>
+                        <div>Enable the helm chart inflation generator</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -112,17 +130,21 @@ Examples
 .. code-block:: yaml
 
     - name: Run lookup using kustomize
-      set_fact:
+      ansible.builtin.set_fact:
         resources: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kustomize') }}"
 
     - name: Run lookup using kubectl kustomize
-      set_fact:
+      ansible.builtin.set_fact:
         resources: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kubectl') }}"
 
     - name: Create kubernetes resources for lookup output
-      k8s:
+      kubernetes.core.k8s:
         definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization') }}"
 
+    - name: Create kubernetes resources for lookup output with `--enable-helm` set
+      kubernetes.core.k8s:
+        definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization', enable_helm=True) }}"
+
 
 
 Return Values

galaxy.yml

@@ -25,7 +25,7 @@ tags:
   - openshift
   - okd
   - cluster
-version: 3.0.0
+version: 3.2.0
 build_ignore:
   - .DS_Store
   - "*.tar.gz"

meta/runtime.yml

@@ -22,10 +22,10 @@ plugin_routing:
       redirect: community.okd.openshift
     k8s:
       deprecation:
-        removal_version: 4.0.0
+        removal_version: 6.0.0
         warning_text: >-
           The k8s inventory plugin has been deprecated and
-          will be removed in release 4.0.0.
+          will be removed in release 6.0.0.
   modules:
     k8s_auth:
       redirect: community.okd.k8s_auth

plugins/connection/kubectl.py

@@ -72,6 +72,15 @@ DOCUMENTATION = r"""
           - name: ansible_kubectl_extra_args
         env:
           - name: K8S_AUTH_EXTRA_ARGS
+      kubectl_local_env_vars:
+        description:
+          - Local enviromantal variable to be passed locally to the kubectl command line.
+          - Please be aware that this passes information directly on the command line and it could expose sensitive data.
+        default: {}
+        type: dict
+        version_added: 3.1.0
+        vars:
+          - name: ansible_kubectl_local_env_vars
       kubectl_kubeconfig:
         description:
           - Path to a kubectl config file. Defaults to I(~/.kube/config)
@@ -172,6 +181,81 @@ DOCUMENTATION = r"""
         aliases: [ kubectl_verify_ssl ]
 """
 
+EXAMPLES = r"""
+
+- name: Run a command in a pod using local kubectl with kubeconfig file ~/.kube/config
+  hosts: localhost
+  gather_facts: no
+  vars:
+    ansible_connection: kubernetes.core.kubectl
+    ansible_kubectl_namespace: my-namespace
+    ansible_kubectl_pod: my-pod
+    ansible_kubectl_container: my-container
+  tasks:
+    # be aware that the command is executed as the user that started the container
+    # and requires python to be installed in the image
+    - name: Run a command in a pod
+      ansible.builtin.command: echo "Hello, World!"
+
+- name: Run a command in a pod using local kubectl with inventory variables
+  # Example inventory:
+  # k8s:
+  #   hosts:
+  #     foo.example.com:
+  #       ansible_connection: kubernetes.core.kubectl
+  #       ansible_kubectl_kubeconfig: /root/.kube/foo.example.com.config
+  #       ansible_kubectl_pod: my-foo-pod
+  #       ansible_kubectl_container: my-foo-container
+  #       ansible_kubectl_namespace: my-foo-namespace
+  #     bar.example.com:
+  #       ansible_connection: kubernetes.core.kubectl
+  #       ansible_kubectl_kubeconfig: /root/.kube/bar.example.com.config
+  #       ansible_kubectl_pod: my-bar-pod
+  #       ansible_kubectl_container: my-bar-container
+  #       ansible_kubectl_namespace: my-bar-namespace
+  hosts: k8s
+  gather_facts: no
+  tasks:
+    # be aware that the command is executed as the user that started the container
+    # and requires python to be installed in the image
+    - name: Run a command in a pod
+      ansible.builtin.command: echo "Hello, World!"
+
+- name: Run a command in a pod using dynamic inventory
+  hosts: localhost
+  gather_facts: no
+  vars:
+    kubeconfig: /root/.kube/config
+    namespace: my-namespace
+    my_app: my-app
+  tasks:
+    - name: Get My App pod info based on label
+      kubernetes.core.k8s_info:
+        kubeconfig: "{{ kubeconfig }}"
+        namespace: "{{ namespace }}"
+        kind: Pod
+        label_selectors: app.kubernetes.io/name = "{{ my_app }}"
+      register: my_app_pod
+
+    - name: Get My App pod name
+      ansible.builtin.set_fact:
+        my_app_pod_name: "{{ my_app_pod.resources[0].metadata.name }}"
+
+    - name: Add My App pod to inventory
+      ansible.builtin.add_host:
+        name: "{{ my_app_pod_name }}"
+        ansible_connection: kubernetes.core.kubectl
+        ansible_kubectl_kubeconfig: "{{ kubeconfig }}"
+        ansible_kubectl_pod: "{{ my_app_pod_name }}"
+        ansible_kubectl_namespace: "{{ namespace }}"
+
+    - name: Run a command in My App pod
+      # be aware that the command is executed as the user that started the container
+      # and requires python to be installed in the image
+      ansible.builtin.command: echo "Hello, World!"
+      delegate_to: "{{ my_app_pod_name }}"
+"""
+
 import json
 import os
 import os.path
@@ -301,6 +385,19 @@ class Connection(ConnectionBase):
 
         return local_cmd, censored_local_cmd
 
+    def _local_env(self):
+        """Return a dict of local environment variables to pass to the kubectl command"""
+        local_env = {}
+        local_local_env_vars_name = "{0}_local_env_vars".format(self.transport)
+        local_env_vars = self.get_option(local_local_env_vars_name)
+        if local_env_vars:
+            if isinstance(local_env_vars, dict):
+                local_env_vars = json.dumps(local_env_vars)
+            local_env = os.environ.copy()
+            local_env.update(json.loads(local_env_vars))
+            return local_env
+        return None
+
     def _connect(self, port=None):
         """Connect to the container. Nothing to do"""
         super(Connection, self)._connect()
@@ -329,6 +426,7 @@ class Connection(ConnectionBase):
             stdin=subprocess.PIPE,
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
+            env=self._local_env(),
         )
 
         stdout, stderr = p.communicate(in_data)
@@ -378,7 +476,11 @@ class Connection(ConnectionBase):
             args = [to_bytes(i, errors="surrogate_or_strict") for i in args]
             try:
                 p = subprocess.Popen(
-                    args, stdin=in_file, stdout=subprocess.PIPE, stderr=subprocess.PIPE
+                    args,
+                    stdin=in_file,
+                    stdout=subprocess.PIPE,
+                    stderr=subprocess.PIPE,
+                    env=self._local_env(),
                 )
             except OSError:
                 raise AnsibleError(
@@ -415,7 +517,11 @@ class Connection(ConnectionBase):
         ) as out_file:
             try:
                 p = subprocess.Popen(
-                    args, stdin=subprocess.PIPE, stdout=out_file, stderr=subprocess.PIPE
+                    args,
+                    stdin=subprocess.PIPE,
+                    stdout=out_file,
+                    stderr=subprocess.PIPE,
+                    env=self._local_env(),
                 )
             except OSError:
                 raise AnsibleError(

plugins/doc_fragments/helm_common_options.py

@@ -36,12 +36,12 @@ options:
     description:
     - Provide a URL for accessing the API. Can also be specified via C(K8S_AUTH_HOST) environment variable.
     type: str
-    version_added: "1.2.0"
+    version_added: 1.2.0
   api_key:
     description:
     - Token used to authenticate with the API. Can also be specified via C(K8S_AUTH_API_KEY) environment variable.
     type: str
-    version_added: "1.2.0"
+    version_added: 1.2.0
   validate_certs:
     description:
     - Whether or not to verify the API server's SSL certificates. Can also be specified via C(K8S_AUTH_VERIFY_SSL)
@@ -49,12 +49,12 @@ options:
     type: bool
     aliases: [ verify_ssl ]
     default: True
-    version_added: "1.2.0"
+    version_added: 1.2.0
   ca_cert:
     description:
     - Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to
       avoid certificate validation errors. Can also be specified via C(K8S_AUTH_SSL_CA_CERT) environment variable.
     type: path
     aliases: [ ssl_ca_cert ]
-    version_added: "1.2.0"
+    version_added: 1.2.0
 """

plugins/doc_fragments/k8s_delete_options.py

@@ -15,7 +15,7 @@ class ModuleDocFragment(object):
 options:
   delete_options:
     type: dict
-    version_added: '1.2.0'
+    version_added: 1.2.0
     description:
     - Configure behavior when deleting an object.
     - Only used when I(state=absent).

plugins/inventory/k8s.py

@@ -20,10 +20,10 @@ DOCUMENTATION = """
       - Uses k8s.(yml|yaml) YAML configuration file to set parameter values.
 
     deprecated:
-      removed_in: 4.0.0
+      removed_in: 6.0.0
       why: |
         As discussed in U(https://github.com/ansible-collections/kubernetes.core/issues/31), we decided to
-        remove the k8s inventory plugin in release 4.0.0.
+        remove the k8s inventory plugin in release 6.0.0.
       alternative: "Use M(kubernetes.core.k8s_info) and M(ansible.builtin.add_host) instead."
 
     options:
@@ -164,8 +164,8 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
         super(InventoryModule, self).parse(inventory, loader, path)
 
         self.display.deprecated(
-            "The 'k8s' inventory plugin has been deprecated and will be removed in release 4.0.0",
+            "The 'k8s' inventory plugin has been deprecated and will be removed in release 6.0.0",
-            version="4.0.0",
+            version="6.0.0",
             collection_name="kubernetes.core",
         )
         cache_key = self._get_cache_prefix(path)

plugins/lookup/kustomize.py

@@ -8,7 +8,7 @@ DOCUMENTATION = """
 
     short_description: Build a set of kubernetes resources using a 'kustomization.yaml' file.
 
-    version_added: "2.2.0"
+    version_added: 2.2.0
 
     author:
       - Aubin Bikouo (@abikouo)
@@ -30,6 +30,10 @@ DOCUMENTATION = """
       opt_dirs:
         description:
         - An optional list of directories to search for the executable in addition to PATH.
+      enable_helm:
+        description:
+        - Enable the helm chart inflation generator
+        default: "False"
 
     requirements:
       - "python >= 3.6"
@@ -37,16 +41,20 @@ DOCUMENTATION = """
 
 EXAMPLES = """
 - name: Run lookup using kustomize
-  set_fact:
+  ansible.builtin.set_fact:
     resources: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kustomize') }}"
 
 - name: Run lookup using kubectl kustomize
-  set_fact:
+  ansible.builtin.set_fact:
     resources: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kubectl') }}"
 
 - name: Create kubernetes resources for lookup output
-  k8s:
+  kubernetes.core.k8s:
     definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization') }}"
+
+- name: Create kubernetes resources for lookup output with `--enable-helm` set
+  kubernetes.core.k8s:
+    definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization', enable_helm=True) }}"
 """
 
 RETURN = """
@@ -91,7 +99,14 @@ def run_command(command):
 
 class LookupModule(LookupBase):
     def run(
-        self, terms, variables=None, dir=".", binary_path=None, opt_dirs=None, **kwargs
+        self,
+        terms,
+        variables=None,
+        dir=".",
+        binary_path=None,
+        opt_dirs=None,
+        enable_helm=False,
+        **kwargs
     ):
         executable_path = binary_path
         if executable_path is None:
@@ -122,6 +137,9 @@ class LookupModule(LookupBase):
                 )
             )
 
+        if enable_helm:
+            command += ["--enable-helm"]
+
         (out, err) = run_command(command)
         if err:
             raise AnsibleLookupError(

plugins/module_utils/helm.py

@@ -115,7 +115,7 @@ class AnsibleHelmModule(object):
         kubeconfig = self.params.get("kubeconfig")
         if kubeconfig:
             if isinstance(kubeconfig, string_types):
-                with open(kubeconfig) as fd:
+                with open(os.path.expanduser(kubeconfig)) as fd:
                     kubeconfig_content = yaml.safe_load(fd)
             elif isinstance(kubeconfig, dict):
                 kubeconfig_content = kubeconfig

plugins/modules/helm.py

@@ -14,7 +14,7 @@ module: helm
 
 short_description: Manages Kubernetes packages with the Helm package manager
 
-version_added: "0.11.0"
+version_added: 0.11.0
 
 author:
   - Lucas Boisserie (@LucasBoisserie)
@@ -61,7 +61,7 @@ options:
     default: false
     type: bool
     aliases: [ dep_up ]
-    version_added: "2.4.0"
+    version_added: 2.4.0
   release_name:
     description:
       - Release name to manage.
@@ -99,7 +99,7 @@ options:
     default: []
     type: list
     elements: str
-    version_added: '1.1.0'
+    version_added: 1.1.0
   update_repo_cache:
     description:
       - Run C(helm repo update) before the operation. Can be run as part of the package installation or as a separate step (see Examples).
@@ -129,7 +129,7 @@ options:
           - string
           - json
           - file
-    version_added: '2.4.0'
+    version_added: 2.4.0
   reuse_values:
     description:
       - When upgrading package, specifies wether to reuse the last release's values and merge in any overrides from parameters I(release_values),
@@ -137,14 +137,14 @@ options:
       - If I(reset_values) is set to C(True), this is ignored.
     type: bool
     required: false
-    version_added: '2.5.0'
+    version_added: 2.5.0
   reset_values:
     description:
       - When upgrading package, reset the values to the ones built into the chart.
     type: bool
     required: false
     default: True
-    version_added: '2.5.0'
+    version_added: 2.5.0
 
 #Helm options
   disable_hook:
@@ -181,7 +181,7 @@ options:
       - similar to C(wait_timeout) but does not required C(wait) to be activated.
       - Mutually exclusive with C(wait_timeout).
     type: str
-    version_added: "2.3.0"
+    version_added: 2.3.0
   atomic:
     description:
       - If set, the installation process deletes the installation on failure.
@@ -192,12 +192,12 @@ options:
       - Create the release namespace if not present.
     type: bool
     default: False
-    version_added: "0.11.1"
+    version_added: 0.11.1
   post_renderer:
     description:
       - Path to an executable to be used for post rendering.
     type: str
-    version_added: "2.4.0"
+    version_added: 2.4.0
   replace:
     description:
       - Reuse the given name, only if that name is a deleted release which remains in the history.
@@ -205,19 +205,19 @@ options:
       - mutually exclusive with with C(history_max).
     type: bool
     default: False
-    version_added: "1.11.0"
+    version_added: 1.11.0
   skip_crds:
     description:
       - Skip custom resource definitions when installing or upgrading.
     type: bool
     default: False
-    version_added: "1.2.0"
+    version_added: 1.2.0
   history_max:
     description:
       - Limit the maximum number of revisions saved per release.
       - mutually exclusive with with C(replace).
     type: int
-    version_added: "2.2.0"
+    version_added: 2.2.0
 extends_documentation_fragment:
   - kubernetes.core.helm_common_options
 """

plugins/modules/helm_info.py

@@ -14,7 +14,7 @@ module: helm_info
 
 short_description: Get information from Helm package deployed inside the cluster
 
-version_added: "0.11.0"
+version_added: 0.11.0
 
 author:
   - Lucas Boisserie (@LucasBoisserie)
@@ -53,7 +53,7 @@ options:
     type: list
     elements: str
     default: []
-    version_added: "2.3.0"
+    version_added: 2.3.0
   get_all_values:
     description:
       - Set to C(True) if you want to get all (computed) values of the release.
@@ -61,7 +61,7 @@ options:
     required: false
     default: false
     type: bool
-    version_added: "2.4.0"
+    version_added: 2.4.0
 extends_documentation_fragment:
   - kubernetes.core.helm_common_options
 """
@@ -123,18 +123,18 @@ status:
       elements: dict
       description: Hooks of the release
       returned: always
-      version_added: "2.4.0"
+      version_added: 2.4.0
     notes:
       type: str
       description: Notes of the release
       returned: always
-      version_added: "2.4.0"
+      version_added: 2.4.0
     manifest:
       type: list
       elements: dict
       description: Manifest of the release
       returned: always
-      version_added: "2.4.0"
+      version_added: 2.4.0
 """
 
 import copy

plugins/modules/helm_plugin.py

@@ -12,7 +12,7 @@ DOCUMENTATION = r"""
 ---
 module: helm_plugin
 short_description: Manage Helm plugins
-version_added: "1.0.0"
+version_added: 1.0.0
 author:
   - Abhijeet Kasurde (@Akasurde)
 requirements:
@@ -47,7 +47,7 @@ options:
       - Ignored when C(state=absent) or C(state=latest).
     required: false
     type: str
-    version_added: "2.3.0"
+    version_added: 2.3.0
 extends_documentation_fragment:
   - kubernetes.core.helm_common_options
 """

plugins/modules/helm_plugin_info.py

@@ -12,7 +12,7 @@ DOCUMENTATION = r"""
 ---
 module: helm_plugin_info
 short_description: Gather information about Helm plugins
-version_added: "1.0.0"
+version_added: 1.0.0
 author:
   - Abhijeet Kasurde (@Akasurde)
 requirements:

plugins/modules/helm_pull.py

@@ -12,7 +12,7 @@ DOCUMENTATION = r"""
 ---
 module: helm_pull
 short_description: download a chart from a repository and (optionally) unpack it in local directory.
-version_added: "2.4.0"
+version_added: 2.4.0
 author:
   - Aubin Bikouo (@abikouo)
 description:

plugins/modules/helm_repository.py

@@ -14,7 +14,7 @@ module: helm_repository
 
 short_description: Manage Helm repositories.
 
-version_added: "0.11.0"
+version_added: 0.11.0
 
 author:
   - Lucas Boisserie (@LucasBoisserie)
@@ -76,12 +76,12 @@ options:
     description:
     - Provide a URL for accessing the API. Can also be specified via C(K8S_AUTH_HOST) environment variable.
     type: str
-    version_added: "2.3.0"
+    version_added: 2.3.0
   api_key:
     description:
     - Token used to authenticate with the API. Can also be specified via C(K8S_AUTH_API_KEY) environment variable.
     type: str
-    version_added: "2.3.0"
+    version_added: 2.3.0
   validate_certs:
     description:
     - Whether or not to verify the API server's SSL certificates. Can also be specified via C(K8S_AUTH_VERIFY_SSL)
@@ -89,21 +89,21 @@ options:
     type: bool
     aliases: [ verify_ssl ]
     default: True
-    version_added: "2.3.0"
+    version_added: 2.3.0
   ca_cert:
     description:
     - Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to
       avoid certificate validation errors. Can also be specified via C(K8S_AUTH_SSL_CA_CERT) environment variable.
     type: path
     aliases: [ ssl_ca_cert ]
-    version_added: "2.3.0"
+    version_added: 2.3.0
   context:
     description:
       - Helm option to specify which kubeconfig context to use.
       - If the value is not specified in the task, the value of environment variable C(K8S_AUTH_CONTEXT) will be used instead.
     type: str
     aliases: [ kube_context ]
-    version_added: "2.4.0"
+    version_added: 2.4.0
   kubeconfig:
     description:
       - Helm option to specify kubeconfig path to use.
@@ -111,14 +111,14 @@ options:
       - The configuration can be provided as dictionary.
     type: raw
     aliases: [ kubeconfig_path ]
-    version_added: "2.4.0"
+    version_added: 2.4.0
   force_update:
     description:
     - Whether or not to replace (overwrite) the repo if it already exists.
     type: bool
     aliases: [ force ]
     default: False
-    version_added: "2.4.0"
+    version_added: 2.4.0
 """
 
 EXAMPLES = r"""

plugins/modules/helm_template.py

@@ -53,7 +53,7 @@ options:
     default: false
     type: bool
     aliases: [ dep_up ]
-    version_added: "2.4.0"
+    version_added: 2.4.0
   disable_hook:
     description:
       - Prevent hooks from running during install.
@@ -139,7 +139,7 @@ options:
           - string
           - json
           - file
-    version_added: '2.4.0'
+    version_added: 2.4.0
 """
 
 EXAMPLES = r"""

plugins/modules/k8s.py

@@ -63,7 +63,7 @@ options:
       C(['strategic-merge', 'merge']), which is ideal for using the same parameters on resource kinds that
       combine Custom Resources and built-in resources.
     - mutually exclusive with C(apply)
-    - I(merge_type=json) is deprecated and will be removed in version 3.0.0. Please use M(kubernetes.core.k8s_json_patch) instead.
+    - I(merge_type=json) is deprecated and will be removed in version 4.0.0. Please use M(kubernetes.core.k8s_json_patch) instead.
     choices:
     - json
     - merge

plugins/modules/k8s_cluster_info.py

@@ -11,7 +11,7 @@ __metaclass__ = type
 DOCUMENTATION = r"""
 module: k8s_cluster_info
 
-version_added: "0.11.1"
+version_added: 0.11.1
 
 short_description: Describe Kubernetes (K8s) cluster, APIs available and their respective versions
 

plugins/modules/k8s_cp.py

@@ -14,7 +14,7 @@ module: k8s_cp
 
 short_description: Copy files and directories to and from pod.
 
-version_added: "2.2.0"
+version_added: 2.2.0
 
 author:
     - Aubin Bikouo (@abikouo)

plugins/modules/k8s_drain.py

@@ -15,7 +15,7 @@ module: k8s_drain
 
 short_description: Drain, Cordon, or Uncordon node in k8s cluster
 
-version_added: "2.2.0"
+version_added: 2.2.0
 
 author: Aubin Bikouo (@abikouo)
 

plugins/modules/k8s_exec.py

@@ -15,7 +15,7 @@ module: k8s_exec
 
 short_description: Execute command in Pod
 
-version_added: "0.10.0"
+version_added: 0.10.0
 
 author: "Tristan de Cacqueray (@tristanC)"
 

plugins/modules/k8s_log.py

@@ -14,7 +14,7 @@ module: k8s_log
 
 short_description: Fetch logs from Kubernetes resources
 
-version_added: "0.10.0"
+version_added: 0.10.0
 
 author:
     - "Fabian von Feilitzsch (@fabianvf)"
@@ -61,26 +61,26 @@ options:
     - A relative time in seconds before the current time from which to show logs.
     required: no
     type: str
-    version_added: '2.2.0'
+    version_added: 2.2.0
   previous:
     description:
     - If C(true), print the logs for the previous instance of the container in a pod if it exists.
     required: no
     type: bool
     default: False
-    version_added: '2.4.0'
+    version_added: 2.4.0
   tail_lines:
     description:
     - A number of lines from the end of the logs to retrieve.
     required: no
     type: int
-    version_added: '2.4.0'
+    version_added: 2.4.0
   all_containers:
     description:
     - If set to C(true), retrieve all containers' logs in the pod(s).
     - mutually exclusive with C(container).
     type: bool
-    version_added: '2.4.0'
+    version_added: 2.4.0
 
 requirements:
   - "python >= 3.9"

plugins/modules/k8s_rollback.py

@@ -12,7 +12,7 @@ __metaclass__ = type
 DOCUMENTATION = r"""
 module: k8s_rollback
 short_description: Rollback Kubernetes (K8S) Deployments and DaemonSets
-version_added: "1.0.0"
+version_added: 1.0.0
 author:
     - "Julien Huon (@julienhuon)"
 description:

plugins/modules/k8s_taint.py

@@ -13,7 +13,7 @@ __metaclass__ = type
 DOCUMENTATION = r"""
 module: k8s_taint
 short_description: Taint a node in a Kubernetes/OpenShift cluster
-version_added: "2.3.0"
+version_added: 2.3.0
 author: Alina Buzachis (@alinabuzachis)
 description:
     - Taint allows a node to refuse Pod to be scheduled unless that Pod has a matching toleration.

tests/integration/targets/k8s_info/tasks/wait.yml

@@ -192,7 +192,7 @@
     - name: Check that module waited
       assert:
         that:
-          - "{{ lookup('pipe', 'date +%s') }} - {{ start }} > 30"
+          - ( lookup('pipe', 'date +%s')|int - start|int ) > 30
 
     - name: Create simple pod
       k8s:

tests/sanity/ignore-2.18.txt

@@ -0,0 +1,31 @@
+plugins/module_utils/client/discovery.py import-3.9!skip
+plugins/module_utils/client/discovery.py import-3.10!skip
+plugins/module_utils/client/discovery.py import-3.11!skip
+plugins/module_utils/client/discovery.py import-3.12!skip
+plugins/module_utils/client/resource.py import-3.9!skip
+plugins/module_utils/client/resource.py import-3.10!skip
+plugins/module_utils/client/resource.py import-3.11!skip
+plugins/module_utils/client/resource.py import-3.12!skip
+plugins/module_utils/k8sdynamicclient.py import-3.9!skip
+plugins/module_utils/k8sdynamicclient.py import-3.10!skip
+plugins/module_utils/k8sdynamicclient.py import-3.11!skip
+plugins/module_utils/k8sdynamicclient.py import-3.12!skip
+plugins/module_utils/version.py pylint!skip
+plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
+plugins/modules/k8s_scale.py validate-modules:parameter-type-not-in-doc
+plugins/modules/k8s_service.py validate-modules:parameter-type-not-in-doc
+tests/unit/module_utils/fixtures/definitions.yml yamllint!skip
+tests/unit/module_utils/fixtures/deployments.yml yamllint!skip
+tests/integration/targets/k8s_delete/files/deployments.yaml yamllint!skip
+tests/unit/module_utils/fixtures/pods.yml yamllint!skip
+tests/integration/targets/helm/files/appversionless-chart-v2/templates/configmap.yaml yamllint!skip
+tests/integration/targets/helm/files/appversionless-chart/templates/configmap.yaml yamllint!skip
+tests/integration/targets/helm/files/test-chart-v2/templates/configmap.yaml yamllint!skip
+tests/integration/targets/helm/files/test-chart/templates/configmap.yaml yamllint!skip
+tests/integration/targets/helm_diff/files/test-chart/templates/configmap.yaml yamllint!skip
+tests/integration/targets/k8s_scale/files/deployment.yaml yamllint!skip
+plugins/modules/k8s.py validate-modules:return-syntax-error
+plugins/modules/k8s_scale.py validate-modules:return-syntax-error
+plugins/modules/k8s_service.py validate-modules:return-syntax-error
+plugins/modules/k8s_taint.py validate-modules:return-syntax-error
+tests/integration/targets/helm_diff/files/test-chart-reuse-values/templates/configmap.yaml yamllint!skip

tools/kubevirt_list_targets.py

@@ -0,0 +1,22 @@
+import os
+import sys
+from pathlib import PosixPath
+
+
+def main():
+
+    src = sys.argv[1]
+    path = PosixPath(src) / PosixPath("tests/integration/targets/")
+
+    def _is_disable(path):
+        flags = ("unsupported", "disabled", "unstable", "hidden")
+        aliases_path = path / PosixPath("aliases")
+        return (aliases_path.exists() and any((d.startswith(flags) for d in aliases_path.read_text().split("\n"))))
+
+    targets = [i.stem for i in path.glob("*") if i.is_dir() and not _is_disable(i)]
+    with open(os.environ.get("GITHUB_OUTPUT"), "a", encoding="utf-8") as fw:
+        fw.write(f"kubevirt_targets={targets}\n")
+
+
+if __name__ == "__main__":
+    main()