mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-05-12 04:22:02 +00:00
Compare commits
54 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
dcbe52e722 | ||
|
|
1e711d4da8 | ||
|
|
4b2dc4f974 | ||
|
|
eb0aeeb318 | ||
|
|
f3d3696093 | ||
|
|
e3da2f28fd | ||
|
|
bb599542e8 | ||
|
|
6560fb1c53 | ||
|
|
20084d119e | ||
|
|
c47343d7b6 | ||
|
|
c213b51741 | ||
|
|
60b53b9dc9 | ||
|
|
d531368d64 | ||
|
|
c3bf5cc47f | ||
|
|
349534b85b | ||
|
|
92e3f98a20 | ||
|
|
d2dcb9e55f | ||
|
|
0eff03dd19 | ||
|
|
81fb8662da | ||
|
|
f74ee14d71 | ||
|
|
6f75d86954 | ||
|
|
c93a7e2459 | ||
|
|
2d68a37a52 | ||
|
|
c5f5398e9e | ||
|
|
05aea7727d | ||
|
|
d3f6dd186c | ||
|
|
8cee9fddbe | ||
|
|
05a942e41e | ||
|
|
fcd47ca995 | ||
|
|
f1729ce186 | ||
|
|
c37dc5b566 | ||
|
|
410855cd36 | ||
|
|
e1f52ddbee | ||
|
|
5d038db848 | ||
|
|
9d3195641e | ||
|
|
dac1448b9c | ||
|
|
4bdff5d672 | ||
|
|
19a71c82ba | ||
|
|
c73f3e3f75 | ||
|
|
2cdcc195e6 | ||
|
|
e98605eb16 | ||
|
|
e13a7fd0c6 | ||
|
|
2098dfea5e | ||
|
|
10a9b9e811 | ||
|
|
67868442f3 | ||
|
|
5eefa9c308 | ||
|
|
4ed9105797 | ||
|
|
46f8e4adfb | ||
|
|
5761205513 | ||
|
|
7b0190f8d5 | ||
|
|
c47e691101 | ||
|
|
8ae6469696 | ||
|
|
1174fee5c9 | ||
|
|
f22ffcab18 |
14
.github/workflows/integration-tests.yaml
vendored
14
.github/workflows/integration-tests.yaml
vendored
@@ -26,7 +26,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
path: ${{ env.source_dir }}
|
path: ${{ env.source_dir }}
|
||||||
fetch-depth: "0"
|
fetch-depth: "0"
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
|
||||||
|
|
||||||
- name: list changes for pull request
|
- name: list changes for pull request
|
||||||
id: splitter
|
id: splitter
|
||||||
@@ -55,14 +54,13 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
# Ref must match a branch/tag on github.com/ansible/ansible (e.g. stable-2.18, not 2.18).
|
ansible-version:
|
||||||
ansible-version: ["stable-2.18", "milestone"]
|
- milestone
|
||||||
enable-turbo-mode: [true, false]
|
|
||||||
exclude:
|
|
||||||
- ansible-version: "milestone"
|
|
||||||
enable-turbo-mode: true
|
|
||||||
python-version:
|
python-version:
|
||||||
- "3.12"
|
- "3.12"
|
||||||
|
enable-turbo-mode:
|
||||||
|
- true
|
||||||
|
- false
|
||||||
workflow-id: ${{ fromJson(needs.splitter.outputs.test_jobs) }}
|
workflow-id: ${{ fromJson(needs.splitter.outputs.test_jobs) }}
|
||||||
name: "integration-py${{ matrix.python-version }}-${{ matrix.ansible-version }}-${{ matrix.workflow-id }}-enable_turbo=${{ matrix.enable-turbo-mode }}"
|
name: "integration-py${{ matrix.python-version }}-${{ matrix.ansible-version }}-${{ matrix.workflow-id }}-enable_turbo=${{ matrix.enable-turbo-mode }}"
|
||||||
steps:
|
steps:
|
||||||
@@ -108,7 +106,6 @@ jobs:
|
|||||||
source_path: ${{ env.source }}
|
source_path: ${{ env.source }}
|
||||||
|
|
||||||
- name: checkout ansible-collections/cloud.common
|
- name: checkout ansible-collections/cloud.common
|
||||||
if: ${{ matrix.enable-turbo-mode == true }}
|
|
||||||
uses: ansible-network/github_actions/.github/actions/checkout_dependency@main
|
uses: ansible-network/github_actions/.github/actions/checkout_dependency@main
|
||||||
with:
|
with:
|
||||||
repository: ansible-collections/cloud.common
|
repository: ansible-collections/cloud.common
|
||||||
@@ -130,7 +127,6 @@ jobs:
|
|||||||
ref: main
|
ref: main
|
||||||
|
|
||||||
- name: install cloud.common collection
|
- name: install cloud.common collection
|
||||||
if: ${{ matrix.enable-turbo-mode == true }}
|
|
||||||
uses: ansible-network/github_actions/.github/actions/build_install_collection@main
|
uses: ansible-network/github_actions/.github/actions/build_install_collection@main
|
||||||
with:
|
with:
|
||||||
install_python_dependencies: true
|
install_python_dependencies: true
|
||||||
|
|||||||
28
.github/workflows/label-new-prs.yaml
vendored
28
.github/workflows/label-new-prs.yaml
vendored
@@ -1,28 +0,0 @@
|
|||||||
---
|
|
||||||
name: label new prs
|
|
||||||
on:
|
|
||||||
pull_request_target:
|
|
||||||
types:
|
|
||||||
- opened
|
|
||||||
- reopened
|
|
||||||
- converted_to_draft
|
|
||||||
- ready_for_review
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
add_label:
|
|
||||||
if: github.actor != 'patchback[bot]'
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
pull-requests: write
|
|
||||||
steps:
|
|
||||||
- name: Add 'needs_triage' label if the pr is not a draft
|
|
||||||
uses: actions-ecosystem/action-add-labels@v1
|
|
||||||
if: github.event.pull_request.draft == false
|
|
||||||
with:
|
|
||||||
labels: needs_triage
|
|
||||||
|
|
||||||
- name: Remove 'needs_triage' label if the pr is a draft
|
|
||||||
uses: actions-ecosystem/action-remove-labels@v1
|
|
||||||
if: github.event.pull_request.draft == true
|
|
||||||
with:
|
|
||||||
labels: needs_triage
|
|
||||||
4
.gitignore
vendored
4
.gitignore
vendored
@@ -17,11 +17,7 @@ tests/integration/cloud-config-*
|
|||||||
|
|
||||||
# Helm charts
|
# Helm charts
|
||||||
tests/integration/*-chart-*.tgz
|
tests/integration/*-chart-*.tgz
|
||||||
tests/integration/targets/*/*.tgz
|
|
||||||
|
|
||||||
# ansible-test generated file
|
# ansible-test generated file
|
||||||
tests/integration/inventory
|
tests/integration/inventory
|
||||||
tests/integration/*-*.yml
|
tests/integration/*-*.yml
|
||||||
|
|
||||||
# VS Code settings
|
|
||||||
.vscode/
|
|
||||||
|
|||||||
139
CHANGELOG.rst
139
CHANGELOG.rst
@@ -4,135 +4,6 @@ Kubernetes Collection Release Notes
|
|||||||
|
|
||||||
.. contents:: Topics
|
.. contents:: Topics
|
||||||
|
|
||||||
v6.4.0
|
|
||||||
======
|
|
||||||
|
|
||||||
Release Summary
|
|
||||||
---------------
|
|
||||||
|
|
||||||
This release adds Helm v4 compatibility across the Helm modules and improves ``k8s_drain`` with check mode. When you explicitly allow evicting unmanaged pods, pods with local storage, or pods managed by a ``DaemonSet``, those cases are reported as informational output instead of module warnings.
|
|
||||||
|
|
||||||
Minor Changes
|
|
||||||
-------------
|
|
||||||
|
|
||||||
- helm_info - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- helm_plugin - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- helm_plugin_info - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- helm_pull - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- helm_registry_auth - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- helm_registry_auth - add new option plain_http to allow insecure http connection when running ``helm registry login`` (https://github.com/ansible-collections/kubernetes.core/pull/1090).
|
|
||||||
- helm_repository - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- k8s_drain - Add support for ``check_mode`` (https://github.com/ansible-collections/kubernetes.core/pull/1086).
|
|
||||||
- k8s_drain - Convert module warnings into informational displays when users explicitly request the deletion of unmanaged pods, pods with local storage, or those managed by a `DaemonSet` (https://github.com/ansible-collections/kubernetes.core/issues/1037).
|
|
||||||
|
|
||||||
Bugfixes
|
|
||||||
--------
|
|
||||||
|
|
||||||
- Helm - Allow taking ownership of existing Kubernetes resources on the first installation of a Helm release. Previously, the ``take_ownership`` parameter was always disabled during the initial install, preventing resource adoption (https://github.com/ansible-collections/kubernetes.core/pull/1034).
|
|
||||||
|
|
||||||
v6.3.0
|
|
||||||
======
|
|
||||||
|
|
||||||
Release Summary
|
|
||||||
---------------
|
|
||||||
|
|
||||||
This release includes bugfixes such as implementing idempotency for the ``helm_pull`` module as well as a security update for selectively redacting sensitive information from kubeconfig.
|
|
||||||
|
|
||||||
Minor Changes
|
|
||||||
-------------
|
|
||||||
|
|
||||||
- Remove deprecated import from ``ansible.module_utils._text`` (https://github.com/ansible-collections/kubernetes.core/pull/1053).
|
|
||||||
- helm - add ``release_values`` key to ``status`` return value that can be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- helm_info - add ``release_values`` key to ``status`` return value that can be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
|
|
||||||
Deprecated Features
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
- helm - the ``status.values`` return value has been deprecated and will be removed in a release after 2027-01-08. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- helm_info - the ``status.values`` return value has been deprecated and will be removed in a release after 2027-01-08. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
|
|
||||||
Security Fixes
|
|
||||||
--------------
|
|
||||||
|
|
||||||
- Selectively redact sensitive info from kubeconfig instead of applying blanket ``no_log=True`` (https://github.com/ansible-collections/kubernetes.core/pull/1014).
|
|
||||||
|
|
||||||
Bugfixes
|
|
||||||
--------
|
|
||||||
|
|
||||||
- Add idempotency for ``helm_pull`` module (https://github.com/ansible-collections/kubernetes.core/pull/1055).
|
|
||||||
- Fixed a bug where setting ``K8S_AUTH_VERIFY_SSL=true`` (or any string value) caused the value to be treated as a separate ``kubectl`` command argument. (https://github.com/ansible-collections/kubernetes.core/pull/1049).
|
|
||||||
- Limit supported versions of Helm to <4.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/1039).
|
|
||||||
- Replace passing ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` in the ``k8s_drain``, ``k8s_rollback.py`` and ``k8s_scale.py`` modules as it deprecated in ``ansible-core>=2.19.0`` and will be removed in ``ansible-core>=2.23.0`` (https://github.com/ansible-collections/kubernetes.core/pull/1033).
|
|
||||||
- k8s - Fix return block from the module documentation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- meta - Add ``k8s_cluster_info``, ``k8s_json_patch`` and ``k8s_rollback`` to k8s action group (https://github.com/ansible-collections/kubernetes.core/pull/992).
|
|
||||||
|
|
||||||
v6.2.0
|
|
||||||
======
|
|
||||||
|
|
||||||
Release Summary
|
|
||||||
---------------
|
|
||||||
|
|
||||||
This release adds minor changes and bugfixes, including support of skip-schema-validation in ``helm`` module and removing deprecated ``ansible.module_utils.six`` imports.
|
|
||||||
|
|
||||||
Minor Changes
|
|
||||||
-------------
|
|
||||||
|
|
||||||
- Add support of skip-schema-validation in ``helm`` module (https://github.com/ansible-collections/kubernetes.core/pull/995)
|
|
||||||
- kustomize - Add support of local environ (https://github.com/ansible-collections/kubernetes.core/pull/786).
|
|
||||||
|
|
||||||
Bugfixes
|
|
||||||
--------
|
|
||||||
|
|
||||||
- Remove ``ansible.module_utils.six`` imports to avoid warnings (https://github.com/ansible-collections/kubernetes.core/pull/998).
|
|
||||||
- Update the ``k8s_cp`` module to also work for init containers (https://github.com/ansible-collections/kubernetes.core/pull/971).
|
|
||||||
|
|
||||||
v6.1.0
|
|
||||||
======
|
|
||||||
|
|
||||||
Release Summary
|
|
||||||
---------------
|
|
||||||
|
|
||||||
This release adds ``plain_http`` and ``take_ownership`` parameters for helm modules, support for ``hidden_fields`` in ``k8s_json_patch``, documented lack of idempotency support in ``helm_registry_auth`` with ``helm ≥ 3.18.0``, and improved ``k8s_rollback`` test coverage.
|
|
||||||
|
|
||||||
Minor Changes
|
|
||||||
-------------
|
|
||||||
|
|
||||||
- Module helm_registry_auth do not support idempotency with `helm >= 3.18.0` (https://github.com/ansible-collections/kubernetes.core/pull/946)
|
|
||||||
- Module k8s_json_patch - Add support for `hidden_fields` (https://github.com/ansible-collections/kubernetes.core/pull/964).
|
|
||||||
- helm - Parameter plain_http added for working with insecure OCI registries (https://github.com/ansible-collections/kubernetes.core/pull/934).
|
|
||||||
- helm - Parameter take_ownership added (https://github.com/ansible-collections/kubernetes.core/pull/957).
|
|
||||||
- helm_pull - Parameter plain_http added for working with insecure OCI registries (https://github.com/ansible-collections/kubernetes.core/pull/934).
|
|
||||||
- helm_template - Parameter plain_http added for working with insecure OCI registries (https://github.com/ansible-collections/kubernetes.core/pull/934).
|
|
||||||
|
|
||||||
Bugfixes
|
|
||||||
--------
|
|
||||||
|
|
||||||
- module_utils/k8s/service - hide fields first before creating diffs (https://github.com/ansible-collections/kubernetes.core/pull/915).
|
|
||||||
|
|
||||||
v6.0.0
|
|
||||||
======
|
|
||||||
|
|
||||||
Breaking Changes / Porting Guide
|
|
||||||
--------------------------------
|
|
||||||
|
|
||||||
- Remove deprecated ``k8s`` invetory plugin (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
|
||||||
- Remove support for ``ansible-core<2.16`` (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
|
||||||
|
|
||||||
v5.4.1
|
|
||||||
======
|
|
||||||
|
|
||||||
Release Summary
|
|
||||||
---------------
|
|
||||||
|
|
||||||
This release includes bugfixes for k8s service field handling, k8s_cp init containers support, and removes deprecated ansible.module_utils.six imports.
|
|
||||||
|
|
||||||
Bugfixes
|
|
||||||
--------
|
|
||||||
|
|
||||||
- Remove ``ansible.module_utils.six`` imports to avoid warnings (https://github.com/ansible-collections/kubernetes.core/pull/998).
|
|
||||||
- Update the `k8s_cp` module to also work for init containers (https://github.com/ansible-collections/kubernetes.core/pull/971).
|
|
||||||
- module_utils/k8s/service - hide fields first before creating diffs (https://github.com/ansible-collections/kubernetes.core/pull/915).
|
|
||||||
|
|
||||||
v5.4.0
|
v5.4.0
|
||||||
======
|
======
|
||||||
|
|
||||||
@@ -144,7 +15,7 @@ This release updates the ``helm_registry_auth`` module to match the behavior of
|
|||||||
Minor Changes
|
Minor Changes
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
- Module ``helm_registry_auth`` does not support idempotency with ``helm >= 3.18.0`` (https://github.com/ansible-collections/kubernetes.core/pull/946).
|
- Module ``helm_registry_auth`` does not support idempotency with ``helm >= 3.18.0`` (https://github.com/ansible-collections/kubernetes.core/pull/946)
|
||||||
|
|
||||||
v5.3.0
|
v5.3.0
|
||||||
======
|
======
|
||||||
@@ -157,15 +28,15 @@ This release includes minor changes, bug fixes and also bumps ``ansible-lint`` v
|
|||||||
Minor Changes
|
Minor Changes
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
- Bump version of ``ansible-lint`` to 25.1.2 (https://github.com/ansible-collections/kubernetes.core/pull/919).
|
- kubernetes.core - Bump version of ``ansible-lint`` to ``25.1.2`` (https://github.com/ansible-collections/kubernetes.core/pull/919).
|
||||||
- action/k8s_info - update templating mechanism with changes from ``ansible-core 2.19`` (https://github.com/ansible-collections/kubernetes.core/pull/888).
|
- action/k8s_info - update templating mechanism with changes from ``ansible-core 2.19`` (https://github.com/ansible-collections/kubernetes.core/pull/888).
|
||||||
- helm - add ``reset_then_reuse_values`` support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/803).
|
- helm - add ``reset_then_reuse_values`` support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/803).
|
||||||
- helm - add support for ``insecure_skip_tls_verify`` option to helm and helm_repository(https://github.com/ansible-collections/kubernetes.core/issues/694).
|
- helm - add support for ``insecure_skip_tls_verify`` option to helm and ``helm_repository`` (https://github.com/ansible-collections/kubernetes.core/issues/694).
|
||||||
|
|
||||||
Bugfixes
|
Bugfixes
|
||||||
--------
|
--------
|
||||||
|
|
||||||
- module_utils/k8s/service - fix issue when trying to delete resource using ``delete_options`` and ``check_mode=true`` (https://github.com/ansible-collections/kubernetes.core/issues/892).
|
- module_utils/k8s/service - Fix issue when trying to delete resource using ``delete_options`` and ``check_mode=true`` (https://github.com/ansible-collections/kubernetes.core/issues/892).
|
||||||
|
|
||||||
v5.2.0
|
v5.2.0
|
||||||
======
|
======
|
||||||
@@ -193,7 +64,7 @@ This release came with new module ``helm_registry_auth``, improvements to the er
|
|||||||
Minor Changes
|
Minor Changes
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
- Bump version of ``ansible-lint`` to minimum 24.7.0 (https://github.com/ansible-collections/kubernetes.core/pull/765).
|
- Bump version of ansible-lint to minimum 24.7.0 (https://github.com/ansible-collections/kubernetes.core/pull/765).
|
||||||
- Parameter insecure_registry added to helm_template as equivalent of insecure-skip-tls-verify (https://github.com/ansible-collections/kubernetes.core/pull/805).
|
- Parameter insecure_registry added to helm_template as equivalent of insecure-skip-tls-verify (https://github.com/ansible-collections/kubernetes.core/pull/805).
|
||||||
- k8s_drain - Improve error message for pod disruption budget when draining a node (https://github.com/ansible-collections/kubernetes.core/issues/797).
|
- k8s_drain - Improve error message for pod disruption budget when draining a node (https://github.com/ansible-collections/kubernetes.core/issues/797).
|
||||||
|
|
||||||
|
|||||||
2
Makefile
2
Makefile
@@ -1,5 +1,5 @@
|
|||||||
# Also needs to be updated in galaxy.yml
|
# Also needs to be updated in galaxy.yml
|
||||||
VERSION = 6.4.0
|
VERSION = 5.4.0
|
||||||
|
|
||||||
TEST_ARGS ?= ""
|
TEST_ARGS ?= ""
|
||||||
PYTHON_VERSION ?= `python -c 'import platform; print(".".join(platform.python_version_tuple()[0:2]))'`
|
PYTHON_VERSION ?= `python -c 'import platform; print(".".join(platform.python_version_tuple()[0:2]))'`
|
||||||
|
|||||||
31
README.md
31
README.md
@@ -21,19 +21,17 @@ For more information about communication, see the [Ansible communication guide](
|
|||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
<!--start requires_ansible-->
|
<!--start requires_ansible-->
|
||||||
## Ansible version compatibility
|
## Ansible Version Compatibility
|
||||||
|
|
||||||
This collection has been tested against the following Ansible versions: **>=2.16.0**.
|
This collection has been tested against following Ansible versions: **>=2.15.0**.
|
||||||
|
|
||||||
|
For collections that support Ansible 2.9, please ensure you update your `network_os` to use the
|
||||||
|
fully qualified collection name (for example, `cisco.ios.ios`).
|
||||||
Plugins and modules within a collection may be tested with only specific Ansible versions.
|
Plugins and modules within a collection may be tested with only specific Ansible versions.
|
||||||
A collection may contain metadata that identifies these versions.
|
A collection may contain metadata that identifies these versions.
|
||||||
PEP440 is the schema used to describe the versions of Ansible.
|
PEP440 is the schema used to describe the versions of Ansible.
|
||||||
<!--end requires_ansible-->
|
<!--end requires_ansible-->
|
||||||
|
|
||||||
### Helm Version Compatibility
|
|
||||||
|
|
||||||
This collection supports Helm v3.x and newer. Please note that specific modules or certain parameters may have additional version requirements.
|
|
||||||
|
|
||||||
### Python Support
|
### Python Support
|
||||||
|
|
||||||
* Collection supports 3.9+
|
* Collection supports 3.9+
|
||||||
@@ -49,17 +47,22 @@ This collection supports Kubernetes versions >= 1.24.
|
|||||||
Click on the name of a plugin or module to view that content's documentation:
|
Click on the name of a plugin or module to view that content's documentation:
|
||||||
|
|
||||||
<!--start collection content-->
|
<!--start collection content-->
|
||||||
### Connection plugins
|
### Connection Plugins
|
||||||
Name | Description
|
Name | Description
|
||||||
--- | ---
|
--- | ---
|
||||||
[kubernetes.core.kubectl](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kubectl_connection.rst)|Execute tasks in pods running on Kubernetes.
|
[kubernetes.core.kubectl](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kubectl_connection.rst)|Execute tasks in pods running on Kubernetes.
|
||||||
|
|
||||||
### K8s filter plugins
|
### K8s filter Plugins
|
||||||
Name | Description
|
Name | Description
|
||||||
--- | ---
|
--- | ---
|
||||||
kubernetes.core.k8s_config_resource_name|Generate resource name for the given resource of type ConfigMap, Secret
|
kubernetes.core.k8s_config_resource_name|Generate resource name for the given resource of type ConfigMap, Secret
|
||||||
|
|
||||||
### Lookup plugins
|
### Inventory Plugins
|
||||||
|
Name | Description
|
||||||
|
--- | ---
|
||||||
|
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_inventory.rst)|Kubernetes (K8s) inventory source
|
||||||
|
|
||||||
|
### Lookup Plugins
|
||||||
Name | Description
|
Name | Description
|
||||||
--- | ---
|
--- | ---
|
||||||
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API
|
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API
|
||||||
@@ -103,7 +106,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible
|
|||||||
---
|
---
|
||||||
collections:
|
collections:
|
||||||
- name: kubernetes.core
|
- name: kubernetes.core
|
||||||
version: 6.4.0
|
version: 5.4.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### Installing the Kubernetes Python Library
|
### Installing the Kubernetes Python Library
|
||||||
@@ -182,6 +185,7 @@ For documentation on how to use individual modules and other content included in
|
|||||||
|
|
||||||
## Ansible Turbo Mode Tech Preview
|
## Ansible Turbo Mode Tech Preview
|
||||||
|
|
||||||
|
|
||||||
The ``kubernetes.core`` collection supports Ansible Turbo mode as a tech preview via the ``cloud.common`` collection. By default, this feature is disabled. To enable Turbo mode for modules, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. For example:
|
The ``kubernetes.core`` collection supports Ansible Turbo mode as a tech preview via the ``cloud.common`` collection. By default, this feature is disabled. To enable Turbo mode for modules, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. For example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
@@ -220,7 +224,7 @@ You can run the collection's test suites with the commands:
|
|||||||
|
|
||||||
### Testing with `molecule`
|
### Testing with `molecule`
|
||||||
|
|
||||||
There are also integration tests in the `molecule` directory which are meant to be run against a local Kubernetes cluster, e.g. using [KinD](https://kind.sigs.k8s.io) or [Minikube](https://minikube.sigs.k8s.io). To set up a local cluster using KinD and run Molecule:
|
There are also integration tests in the `molecule` directory which are meant to be run against a local Kubernetes cluster, e.g. using [KinD](https://kind.sigs.k8s.io) or [Minikube](https://minikube.sigs.k8s.io). To setup a local cluster using KinD and run Molecule:
|
||||||
|
|
||||||
kind create cluster
|
kind create cluster
|
||||||
make test-molecule
|
make test-molecule
|
||||||
@@ -259,7 +263,7 @@ For more information about communication, refer to the [Ansible Communication gu
|
|||||||
For the latest supported versions, refer to the release notes below.
|
For the latest supported versions, refer to the release notes below.
|
||||||
|
|
||||||
If you encounter issues or have questions, you can submit a support request through the following channels:
|
If you encounter issues or have questions, you can submit a support request through the following channels:
|
||||||
- GitHub Issues: Report bugs, request features, or ask questions by opening an issue in the [GitHub repository](https://github.com/ansible-collections/kubernetes.core/).
|
- GitHub Issues: Report bugs, request features, or ask questions by opening an issue in the [GitHub repository]((https://github.com/ansible-collections/kubernetes.core/).
|
||||||
|
|
||||||
## Release Notes
|
## Release Notes
|
||||||
|
|
||||||
@@ -271,8 +275,9 @@ We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/c
|
|||||||
|
|
||||||
If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint.
|
If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint.
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
GNU General Public License v3.0 or later
|
GNU General Public License v3.0 or later
|
||||||
|
|
||||||
See LICENSE to see the full text.
|
See LICENCE to see the full text.
|
||||||
|
|||||||
@@ -977,7 +977,7 @@ releases:
|
|||||||
- kustomize - kustomize plugin fails with deprecation warnings (https://github.com/ansible-collections/kubernetes.core/issues/639).
|
- kustomize - kustomize plugin fails with deprecation warnings (https://github.com/ansible-collections/kubernetes.core/issues/639).
|
||||||
- waiter - Fix waiting for daemonset when desired number of pods is 0. (https://github.com/ansible-collections/kubernetes.core/pull/756).
|
- waiter - Fix waiting for daemonset when desired number of pods is 0. (https://github.com/ansible-collections/kubernetes.core/pull/756).
|
||||||
minor_changes:
|
minor_changes:
|
||||||
- Bump version of ``ansible-lint`` to minimum 24.7.0 (https://github.com/ansible-collections/kubernetes.core/pull/765).
|
- Bump version of ansible-lint to minimum 24.7.0 (https://github.com/ansible-collections/kubernetes.core/pull/765).
|
||||||
- Parameter insecure_registry added to helm_template as equivalent of insecure-skip-tls-verify
|
- Parameter insecure_registry added to helm_template as equivalent of insecure-skip-tls-verify
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/805).
|
(https://github.com/ansible-collections/kubernetes.core/pull/805).
|
||||||
- k8s_drain - Improve error message for pod disruption budget when draining
|
- k8s_drain - Improve error message for pod disruption budget when draining
|
||||||
@@ -1027,13 +1027,13 @@ releases:
|
|||||||
changes:
|
changes:
|
||||||
bugfixes:
|
bugfixes:
|
||||||
- module_utils/k8s/service - fix issue when trying to delete resource using
|
- module_utils/k8s/service - fix issue when trying to delete resource using
|
||||||
``delete_options`` and ``check_mode=true`` (https://github.com/ansible-collections/kubernetes.core/issues/892).
|
`delete_options` and `check_mode=true` (https://github.com/ansible-collections/kubernetes.core/issues/892).
|
||||||
minor_changes:
|
minor_changes:
|
||||||
- Bump version of ``ansible-lint`` to 25.1.2 (https://github.com/ansible-collections/kubernetes.core/pull/919).
|
- kubernetes.core - Bump version of ``ansible-lint`` to ``25.1.2`` (https://github.com/ansible-collections/kubernetes.core/pull/919).
|
||||||
- action/k8s_info - update templating mechanism with changes from ``ansible-core
|
- action/k8s_info - update templating mechanism with changes from ``ansible-core
|
||||||
2.19`` (https://github.com/ansible-collections/kubernetes.core/pull/888).
|
2.19`` (https://github.com/ansible-collections/kubernetes.core/pull/888).
|
||||||
- helm - add ``reset_then_reuse_values`` support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/803).
|
- helm - add ``reset_then_reuse_values`` support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/803).
|
||||||
- helm - add support for ``insecure_skip_tls_verify`` option to helm and helm_repository(https://github.com/ansible-collections/kubernetes.core/issues/694).
|
- helm - add support for ``insecure_skip_tls_verify`` option to helm and ``helm_repository`` (https://github.com/ansible-collections/kubernetes.core/issues/694).
|
||||||
release_summary: This release includes minor changes, bug fixes and also bumps
|
release_summary: This release includes minor changes, bug fixes and also bumps
|
||||||
``ansible-lint`` version to ``25.1.2``.
|
``ansible-lint`` version to ``25.1.2``.
|
||||||
fragments:
|
fragments:
|
||||||
@@ -1047,159 +1047,12 @@ releases:
|
|||||||
5.4.0:
|
5.4.0:
|
||||||
changes:
|
changes:
|
||||||
minor_changes:
|
minor_changes:
|
||||||
- Module ``helm_registry_auth`` does not support idempotency with ``helm >=
|
- Module ``helm_registry_auth`` does not support idempotency with ``helm >= 3.18.0``
|
||||||
3.18.0`` (https://github.com/ansible-collections/kubernetes.core/pull/946).
|
(https://github.com/ansible-collections/kubernetes.core/pull/946).
|
||||||
release_summary: This release updates the ``helm_registry_auth`` module to match
|
release_summary: This release updates the ``helm_registry_auth`` module to match the behavior of ``helm >= 3.18.0`` which reports a successful logout regardless of the current state (i.e., no idempotency).
|
||||||
the behavior of ``helm >= 3.18.0`` which reports a successful logout regardless
|
|
||||||
of the current state (i.e., no idempotency).
|
|
||||||
fragments:
|
fragments:
|
||||||
- 20250411-kubeconfig-no_log-revert.yaml
|
- 20250411-kubeconfig-no_log-revert.yaml
|
||||||
- 20250503-fix-unit-tests.yml
|
- 20250503-fix-unit-tests.yml
|
||||||
- 20250605-fix-helm_registry_auth-integration_test.yaml
|
- 20250605-fix-helm_registry_auth-integration_test.yaml
|
||||||
- 5.4.0.yml
|
- 5.4.0.yml
|
||||||
release_date: '2025-08-12'
|
release_date: '2025-08-12'
|
||||||
5.4.1:
|
|
||||||
changes:
|
|
||||||
bugfixes:
|
|
||||||
- Remove ``ansible.module_utils.six`` imports to avoid warnings (https://github.com/ansible-collections/kubernetes.core/pull/998).
|
|
||||||
- Update the ``k8s_cp`` module to also work for init containers (https://github.com/ansible-collections/kubernetes.core/pull/971).
|
|
||||||
- module_utils/k8s/service - hide fields first before creating diffs (https://github.com/ansible-collections/kubernetes.core/pull/915).
|
|
||||||
release_summary: This release includes bugfixes for k8s service field handling,
|
|
||||||
k8s_cp init containers support, and removes deprecated ansible.module_utils.six
|
|
||||||
imports.
|
|
||||||
fragments:
|
|
||||||
- 20250428-k8s-service-hide-fields-first.yaml
|
|
||||||
- 20250731-fix-k8s_cp-initcontainers.yaml
|
|
||||||
- 20250922-remove-ansible-six-imports.yaml
|
|
||||||
- 5.4.1.yml
|
|
||||||
release_date: '2025-10-07'
|
|
||||||
6.0.0:
|
|
||||||
changes:
|
|
||||||
breaking_changes:
|
|
||||||
- Remove deprecated ``k8s`` invetory plugin (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
|
||||||
- Remove support for ``ansible-core<2.16`` (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
|
||||||
fragments:
|
|
||||||
- 20250121-breaking-changes-6.0.0.yml
|
|
||||||
release_date: '2025-05-19'
|
|
||||||
6.1.0:
|
|
||||||
changes:
|
|
||||||
bugfixes:
|
|
||||||
- module_utils/k8s/service - hide fields first before creating diffs (https://github.com/ansible-collections/kubernetes.core/pull/915).
|
|
||||||
minor_changes:
|
|
||||||
- Module ``helm_registry_auth`` does not support idempotency with `helm >= 3.18.0`
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/946).
|
|
||||||
- Module k8s_json_patch - Add support for ``hidden_fields`` (https://github.com/ansible-collections/kubernetes.core/pull/964).
|
|
||||||
- helm - Parameter plain_http added for working with insecure OCI registries
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/934).
|
|
||||||
- helm - Parameter take_ownership added (https://github.com/ansible-collections/kubernetes.core/pull/957).
|
|
||||||
- helm_pull - Parameter plain_http added for working with insecure OCI registries
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/934).
|
|
||||||
- helm_template - Parameter plain_http added for working with insecure OCI registries
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/934).
|
|
||||||
release_summary: "This release adds ``plain_http`` and ``take_ownership`` parameters
|
|
||||||
for helm modules, support for ``hidden_fields`` in ``k8s_json_patch``, documented
|
|
||||||
lack of idempotency support in ``helm_registry_auth`` with ``helm \u2265 3.18.0``,
|
|
||||||
and improved ``k8s_rollback`` test coverage."
|
|
||||||
fragments:
|
|
||||||
- 20250411-kubeconfig-no_log-revert.yaml
|
|
||||||
- 20250428-k8s-service-hide-fields-first.yaml
|
|
||||||
- 20250522-add-plain-http-for-oci-registries.yaml
|
|
||||||
- 20250605-fix-helm_registry_auth-integration_test.yaml
|
|
||||||
- 20250704-k8s-rollback-integration-test-coverage.yaml
|
|
||||||
- 20250720-k8s-patch-add-hidden-fields.yaml
|
|
||||||
- 20250911-add-support-helm-take-ownership.yaml
|
|
||||||
- release_summary.yml
|
|
||||||
release_date: '2025-08-12'
|
|
||||||
6.2.0:
|
|
||||||
changes:
|
|
||||||
bugfixes:
|
|
||||||
- Remove ``ansible.module_utils.six`` imports to avoid warnings (https://github.com/ansible-collections/kubernetes.core/pull/998).
|
|
||||||
- Update the `k8s_cp` module to also work for init containers (https://github.com/ansible-collections/kubernetes.core/pull/971).
|
|
||||||
minor_changes:
|
|
||||||
- Add support of skip-schema-validation in ``helm`` module (https://github.com/ansible-collections/kubernetes.core/pull/995)
|
|
||||||
- kustomize - Add support of local environ (https://github.com/ansible-collections/kubernetes.core/pull/786).
|
|
||||||
release_summary: This release adds minor changes and bugfixes, including support
|
|
||||||
of skip-schema-validation in ``helm`` module and removing deprecated ``ansible.module_utils.six``
|
|
||||||
imports.
|
|
||||||
fragments:
|
|
||||||
- 20241030-support-of-evrion-for-kustomize-lookup-plugin.yaml
|
|
||||||
- 20250731-fix-k8s_cp-initcontainers.yaml
|
|
||||||
- 20250916-skip-schema-validation.yaml
|
|
||||||
- 20250922-remove-ansible-six-imports.yaml
|
|
||||||
- 6_2_0.yml
|
|
||||||
release_date: '2025-10-07'
|
|
||||||
6.3.0:
|
|
||||||
changes:
|
|
||||||
bugfixes:
|
|
||||||
- Add idempotency for ``helm_pull`` module (https://github.com/ansible-collections/kubernetes.core/pull/1055).
|
|
||||||
- Fixed a bug where setting ``K8S_AUTH_VERIFY_SSL=true`` (or any string value)
|
|
||||||
caused the value to be treated as a separate ``kubectl`` command argument.
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/1049).
|
|
||||||
- Limit supported versions of Helm to <4.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/1039).
|
|
||||||
- Replace passing ``warnings`` to ``exit_json`` with ``AnsibleModule.warn``
|
|
||||||
in the ``k8s_drain``, ``k8s_rollback.py`` and ``k8s_scale.py`` modules as
|
|
||||||
it deprecated in ``ansible-core>=2.19.0`` and will be removed in ``ansible-core>=2.23.0``
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/1033).
|
|
||||||
- k8s - Fix return block from the module documentation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- meta - Add ``k8s_cluster_info``, ``k8s_json_patch`` and ``k8s_rollback`` to
|
|
||||||
k8s action group (https://github.com/ansible-collections/kubernetes.core/pull/992).
|
|
||||||
deprecated_features:
|
|
||||||
- helm - the ``status.values`` return value has been deprecated and will be
|
|
||||||
removed in a release after 2027-01-08. Use ``status.release_values`` instead
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- helm_info - the ``status.values`` return value has been deprecated and will
|
|
||||||
be removed in a release after 2027-01-08. Use ``status.release_values`` instead
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
minor_changes:
|
|
||||||
- Remove deprecated import from ``ansible.module_utils._text`` (https://github.com/ansible-collections/kubernetes.core/pull/1053).
|
|
||||||
- helm - add ``release_values`` key to ``status`` return value that can be accessed
|
|
||||||
using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- helm_info - add ``release_values`` key to ``status`` return value that can
|
|
||||||
be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
release_summary: This release includes bugfixes such as implementing idempotency
|
|
||||||
for the ``helm_pull`` module as well as a security update for selectively
|
|
||||||
redacting sensitive information from kubeconfig.
|
|
||||||
security_fixes:
|
|
||||||
- Selectively redact sensitive info from kubeconfig instead of applying blanket
|
|
||||||
``no_log=True`` (https://github.com/ansible-collections/kubernetes.core/pull/1014).
|
|
||||||
fragments:
|
|
||||||
- 1033-warnings-deprecations.yaml
|
|
||||||
- 20251002-fix-k8s-actiongroup.yaml
|
|
||||||
- 20251007-selective-kubeconfig-redaction.yaml
|
|
||||||
- 20251115-limit-versions-of-helm.yaml
|
|
||||||
- 20251220-fix-K8S_AUTH_VERIFY_SSL-in-kubectl-connecton-plugion.yaml
|
|
||||||
- 20251228-1053-remove-deprecated-import.yaml
|
|
||||||
- 20260107-add-idempodency-for-helm-pull.yaml
|
|
||||||
- 20260108-fix-sanity-failures.yml
|
|
||||||
- 6-3-0.yaml
|
|
||||||
release_date: '2026-02-03'
|
|
||||||
6.4.0:
|
|
||||||
changes:
|
|
||||||
bugfixes:
|
|
||||||
- Helm - Allow taking ownership of existing Kubernetes resources on the first
|
|
||||||
installation of a Helm release. Previously, the ``take_ownership`` parameter
|
|
||||||
was always disabled during the initial install, preventing resource adoption
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/1034).
|
|
||||||
minor_changes:
|
|
||||||
- helm_info - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- helm_plugin - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- helm_plugin_info - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- helm_pull - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- helm_registry_auth - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- helm_registry_auth - add new option plain_http to allow insecure http connection
|
|
||||||
when running ``helm registry login`` (https://github.com/ansible-collections/kubernetes.core/pull/1090).
|
|
||||||
- helm_repository - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
|
||||||
- k8s_drain - Add support for ``check_mode`` (https://github.com/ansible-collections/kubernetes.core/pull/1086).
|
|
||||||
- k8s_drain - Convert module warnings into informational displays when users
|
|
||||||
explicitly request the deletion of unmanaged pods, pods with local storage,
|
|
||||||
or those managed by a ``DaemonSet`` (https://github.com/ansible-collections/kubernetes.core/issues/1037).
|
|
||||||
release_summary: This release adds Helm v4 compatibility across the Helm modules
|
|
||||||
and improves ``k8s_drain`` with check mode. When you explicitly allow evicting
|
|
||||||
unmanaged pods, pods with local storage, or pods managed by a ``DaemonSet``,
|
|
||||||
those cases are reported as informational output instead of module warnings.
|
|
||||||
fragments:
|
|
||||||
- 20251224-take-ownership-helm-initialization.yaml
|
|
||||||
- 20260203-k8s_drain-warning-fixes.yaml
|
|
||||||
- 20260213-support-helm-v4-for-helm-plugin-modules.yaml
|
|
||||||
- release-6-4-0.yml
|
|
||||||
release_date: '2026-04-22'
|
|
||||||
|
|||||||
147
docs/ansible_turbo_mode.rst
Normal file
147
docs/ansible_turbo_mode.rst
Normal file
@@ -0,0 +1,147 @@
|
|||||||
|
.. _ansible_turbo_mode:
|
||||||
|
|
||||||
|
|
||||||
|
******************
|
||||||
|
Ansible Turbo mode
|
||||||
|
******************
|
||||||
|
|
||||||
|
Following document provides overview of Ansible Turbo mode in ``kubernetes.core`` collection.
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
:local:
|
||||||
|
:depth: 1
|
||||||
|
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
--------
|
||||||
|
- A brief introduction about Ansible Turbo mode in ``kuberentes.core`` collection.
|
||||||
|
- Ansible Turbo mode is an optional performance optimization. It can be enabled by installing the cloud.common collection and setting the ``ENABLE_TURBO_MODE`` environment variable.
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
|
||||||
|
The following requirement is needed on the host that executes this module.
|
||||||
|
|
||||||
|
- The ``cloud.common`` collection (https://github.com/ansible-collections/cloud.common)
|
||||||
|
|
||||||
|
You will also need to set the environment variable ``ENABLE_TURBO_MODE=1`` on the managed host. This can be done in the same ways you would usually do so, for example::
|
||||||
|
|
||||||
|
---
|
||||||
|
- hosts: remote
|
||||||
|
environment:
|
||||||
|
ENABLE_TURBO_MODE: 1
|
||||||
|
tasks:
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
You can install ``cloud.common`` collection using following command::
|
||||||
|
|
||||||
|
# ansible-galaxy collection install cloud.common
|
||||||
|
|
||||||
|
|
||||||
|
Current situation without Ansible Turbo mode
|
||||||
|
============================================
|
||||||
|
|
||||||
|
The traditional execution flow of an Ansible module includes the following steps:
|
||||||
|
|
||||||
|
- Upload of a ZIP archive with the module and its dependencies
|
||||||
|
- Execution of the module
|
||||||
|
- Ansible collects the results once the script is finished
|
||||||
|
|
||||||
|
These steps happen for each task of a playbook, and on every host.
|
||||||
|
|
||||||
|
Most of the time, the execution of a module is fast enough for
|
||||||
|
the user. However, sometime the module requires significant amount of time,
|
||||||
|
just to initialize itself. This is a common situation with the API based modules.
|
||||||
|
|
||||||
|
A classic initialization involves the following steps:
|
||||||
|
|
||||||
|
- Load a Python library to access the remote resource (via SDK)
|
||||||
|
- Open a client
|
||||||
|
- Load a bunch of Python modules.
|
||||||
|
- Request a new TCP connection.
|
||||||
|
- Create a session.
|
||||||
|
- Authenticate the client.
|
||||||
|
|
||||||
|
All these steps are time consuming and the same operations will be running again and again.
|
||||||
|
|
||||||
|
For instance, here:
|
||||||
|
|
||||||
|
- ``import openstack``: takes 0.569s
|
||||||
|
- ``client = openstack.connect()``: takes 0.065s
|
||||||
|
- ``client.authorize()``: takes 1.360s,
|
||||||
|
|
||||||
|
These numbers are from test running against VexxHost public cloud.
|
||||||
|
|
||||||
|
In this case, it's a 2s-ish overhead per task. If the playbook
|
||||||
|
comes with 10 tasks, the execution time cannot go below 20s.
|
||||||
|
|
||||||
|
How Ansible Turbo Module improve the situation
|
||||||
|
==============================================
|
||||||
|
|
||||||
|
``AnsibleTurboModule`` is actually a class that inherites from
|
||||||
|
the standard ``AnsibleModule`` class that your modules probably
|
||||||
|
already use.
|
||||||
|
The big difference is that when a module starts, it also spawns
|
||||||
|
a little Python daemon. If a daemon already exists, it will just
|
||||||
|
reuse it.
|
||||||
|
All the module logic is run inside this Python daemon. This means:
|
||||||
|
|
||||||
|
- Python modules are actually loaded one time
|
||||||
|
- Ansible module can reuse an existing authenticated session.
|
||||||
|
|
||||||
|
The background service
|
||||||
|
======================
|
||||||
|
|
||||||
|
The daemon kills itself after 15s, and communication are done
|
||||||
|
through an Unix socket.
|
||||||
|
It runs in one single process and uses ``asyncio`` internally.
|
||||||
|
Consequently you can use the ``async`` keyword in your Ansible module.
|
||||||
|
This will be handy if you interact with a lot of remote systems
|
||||||
|
at the same time.
|
||||||
|
|
||||||
|
Security impact
|
||||||
|
===============
|
||||||
|
|
||||||
|
``ansible_module.turbo`` open an Unix socket to interact with the background service.
|
||||||
|
We use this service to open the connection toward the different target systems.
|
||||||
|
|
||||||
|
This is similar to what SSH does with the sockets.
|
||||||
|
|
||||||
|
Keep in mind that:
|
||||||
|
|
||||||
|
- All the modules can access the same cache. Soon an isolation will be done at the collection level (https://github.com/ansible-collections/cloud.common/pull/17)
|
||||||
|
- A task can load a different version of a library and impact the next tasks.
|
||||||
|
- If the same user runs two ``ansible-playbook`` at the same time, they will have access to the same cache.
|
||||||
|
|
||||||
|
When a module stores a session in a cache, it's a good idea to use a hash of the authentication information to identify the session.
|
||||||
|
|
||||||
|
Error management
|
||||||
|
================
|
||||||
|
|
||||||
|
``ansible_module.turbo`` uses exceptions to communicate a result back to the module.
|
||||||
|
|
||||||
|
- ``EmbeddedModuleFailure`` is raised when ``json_fail()`` is called.
|
||||||
|
- ``EmbeddedModuleSuccess`` is raised in case of success and returns the result to the origin module process.
|
||||||
|
|
||||||
|
These exceptions are defined in ``ansible_collections.cloud.common.plugins.module_utils.turbo.exceptions``.
|
||||||
|
You can raise ``EmbeddedModuleFailure`` exception yourself, for instance from a module in ``module_utils``.
|
||||||
|
|
||||||
|
.. note:: Be careful with the ``except Exception:`` blocks.
|
||||||
|
Not only they are bad practice, but also may interface with this
|
||||||
|
mechanism.
|
||||||
|
|
||||||
|
|
||||||
|
Troubleshooting
|
||||||
|
===============
|
||||||
|
|
||||||
|
You may want to manually start the server. This can be done with the following command:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
|
||||||
|
PYTHONPATH=$HOME/.ansible/collections python -m ansible_collections.cloud.common.plugins.module_utils.turbo.server --socket-path $HOME/.ansible/tmp/turbo_mode.kubernetes.core.socket
|
||||||
|
|
||||||
|
You can use the ``--help`` argument to get a list of the optional parameters.
|
||||||
@@ -17,7 +17,7 @@ Requirements
|
|||||||
|
|
||||||
To use the modules, you'll need the following:
|
To use the modules, you'll need the following:
|
||||||
|
|
||||||
- Ansible 2.16.0 or latest installed
|
- Ansible 2.9.17 or latest installed
|
||||||
- `Kubernetes Python client <https://pypi.org/project/kubernetes/>`_ installed on the host that will execute the modules.
|
- `Kubernetes Python client <https://pypi.org/project/kubernetes/>`_ installed on the host that will execute the modules.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
88
docs/docsite/rst/kubernetes_scenarios/k8s_inventory.rst
Normal file
88
docs/docsite/rst/kubernetes_scenarios/k8s_inventory.rst
Normal file
@@ -0,0 +1,88 @@
|
|||||||
|
.. _ansible_collections.kubernetes.core.docsite.k8s_ansible_inventory:
|
||||||
|
|
||||||
|
*****************************************
|
||||||
|
Using Kubernetes dynamic inventory plugin
|
||||||
|
*****************************************
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
:local:
|
||||||
|
|
||||||
|
Kubernetes dynamic inventory plugin
|
||||||
|
===================================
|
||||||
|
|
||||||
|
|
||||||
|
The best way to interact with your Pods is to use the Kubernetes dynamic inventory plugin, which queries Kubernetes APIs using ``kubectl`` command line available on controller node and tells Ansible what Pods can be managed.
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
|
||||||
|
To use the Kubernetes dynamic inventory plugins, you must install `Kubernetes Python client <https://github.com/kubernetes-client/python>`_, `kubectl <https://github.com/kubernetes/kubectl>`_ on your control node (the host running Ansible).
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
$ pip install kubernetes
|
||||||
|
|
||||||
|
Please refer to Kubernetes official documentation for `installing kubectl <https://kubernetes.io/docs/tasks/tools/install-kubectl/>`_ on the given operating systems.
|
||||||
|
|
||||||
|
To use this Kubernetes dynamic inventory plugin, you need to enable it first by specifying the following in the ``ansible.cfg`` file:
|
||||||
|
|
||||||
|
.. code-block:: ini
|
||||||
|
|
||||||
|
[inventory]
|
||||||
|
enable_plugins = kubernetes.core.k8s
|
||||||
|
|
||||||
|
Then, create a file that ends in ``.k8s.yml`` or ``.k8s.yaml`` in your working directory.
|
||||||
|
|
||||||
|
The ``kubernetes.core.k8s`` inventory plugin takes in the same authentication information as any other Kubernetes modules.
|
||||||
|
|
||||||
|
Here's an example of a valid inventory file:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
plugin: kubernetes.core.k8s
|
||||||
|
|
||||||
|
Executing ``ansible-inventory --list -i <filename>.k8s.yml`` will create a list of Pods that are ready to be configured using Ansible.
|
||||||
|
|
||||||
|
You can also provide the namespace to gather information about specific pods from the given namespace. For example, to gather information about Pods under the ``test`` namespace you will specify the ``namespaces`` parameter:
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
plugin: kubernetes.core.k8s
|
||||||
|
connections:
|
||||||
|
- namespaces:
|
||||||
|
- test
|
||||||
|
|
||||||
|
Using vaulted configuration files
|
||||||
|
=================================
|
||||||
|
|
||||||
|
Since the inventory configuration file contains Kubernetes related sensitive information in plain text, a security risk, you may want to
|
||||||
|
encrypt your entire inventory configuration file.
|
||||||
|
|
||||||
|
You can encrypt a valid inventory configuration file as follows:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
$ ansible-vault encrypt <filename>.k8s.yml
|
||||||
|
New Vault password:
|
||||||
|
Confirm New Vault password:
|
||||||
|
Encryption successful
|
||||||
|
|
||||||
|
$ echo "MySuperSecretPassw0rd!" > /path/to/vault_password_file
|
||||||
|
|
||||||
|
And you can use this vaulted inventory configuration file using:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
$ ansible-inventory -i <filename>.k8s.yml --list --vault-password-file=/path/to/vault_password_file
|
||||||
|
|
||||||
|
|
||||||
|
.. seealso::
|
||||||
|
|
||||||
|
`Kubernetes Python client - Issue Tracker <https://github.com/kubernetes-client/python/issues>`_
|
||||||
|
The issue tracker for Kubernetes Python client
|
||||||
|
`Kubectl installation <https://kubernetes.io/docs/tasks/tools/install-kubectl/>`_
|
||||||
|
Installation guide for installing Kubectl
|
||||||
|
:ref:`working_with_playbooks`
|
||||||
|
An introduction to playbooks
|
||||||
|
:ref:`playbooks_vault`
|
||||||
|
Using Vault in playbooks
|
||||||
@@ -13,5 +13,6 @@ To get started, please select one of the following topics.
|
|||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
kubernetes_scenarios/k8s_intro
|
kubernetes_scenarios/k8s_intro
|
||||||
|
kubernetes_scenarios/k8s_inventory
|
||||||
kubernetes_scenarios/k8s_scenarios
|
kubernetes_scenarios/k8s_scenarios
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
- helm (https://github.com/helm/helm/releases)
|
||||||
- yaml (https://pypi.org/project/PyYAML/)
|
- yaml (https://pypi.org/project/PyYAML/)
|
||||||
|
|
||||||
|
|
||||||
@@ -268,7 +268,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
||||||
|
|
||||||
.. raw:: html
|
.. raw:: html
|
||||||
|
|
||||||
@@ -410,23 +410,6 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
|
|||||||
<br/>
|
<br/>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="elbow-placeholder"> </td>
|
|
||||||
<td colspan="1">
|
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
|
||||||
<b>release_values</b>
|
|
||||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></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 6.3.0</div>
|
|
||||||
</td>
|
|
||||||
<td>always</td>
|
|
||||||
<td>
|
|
||||||
<div>Dict of Values used to deploy.</div>
|
|
||||||
<br/>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<td class="elbow-placeholder"> </td>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
@@ -482,13 +465,12 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
|
|||||||
<b>values</b>
|
<b>values</b>
|
||||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
<div style="font-size: small">
|
<div style="font-size: small">
|
||||||
<span style="color: purple">dictionary</span>
|
<span style="color: purple">string</span>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>always</td>
|
<td>always</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Dict of Values used to deploy</div>
|
<div>Dict of Values used to deploy</div>
|
||||||
<div>This return value has been deprecated and will be removed in a release after 2027-01-08. Use RV(status.release_values) instead.</div>
|
|
||||||
<br/>
|
<br/>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
- helm (https://github.com/helm/helm/releases)
|
||||||
- yaml (https://pypi.org/project/PyYAML/)
|
- yaml (https://pypi.org/project/PyYAML/)
|
||||||
|
|
||||||
|
|
||||||
@@ -330,27 +330,6 @@ Parameters
|
|||||||
<div style="font-size: small; color: darkgreen"><br/>aliases: kubeconfig_path</div>
|
<div style="font-size: small; color: darkgreen"><br/>aliases: kubeconfig_path</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td colspan="2">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
||||||
<b>plain_http</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 6.1.0</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
||||||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
|
||||||
<li>yes</li>
|
|
||||||
</ul>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div>Use HTTP instead of HTTPS when working with OCI registries</div>
|
|
||||||
<div>Requires Helm >= 3.13.0</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -622,48 +601,6 @@ Parameters
|
|||||||
<div>Skip custom resource definitions when installing or upgrading.</div>
|
<div>Skip custom resource definitions when installing or upgrading.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td colspan="2">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
||||||
<b>skip_schema_validation</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 6.2.0</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
||||||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
|
||||||
<li>yes</li>
|
|
||||||
</ul>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div>Disables JSON schema validation for Chart and values.</div>
|
|
||||||
<div>This feature requires helm >= 3.16.0</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td colspan="2">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
||||||
<b>take_ownership</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 6.1.0</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
||||||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
|
||||||
<li>yes</li>
|
|
||||||
</ul>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div>Helm will ignore the check for helm annotations and take ownership of the existing resources</div>
|
|
||||||
<div>This feature requires helm >= 3.17.0</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -873,12 +810,6 @@ Examples
|
|||||||
chart_ref: "https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz"
|
chart_ref: "https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz"
|
||||||
release_namespace: monitoring
|
release_namespace: monitoring
|
||||||
|
|
||||||
- name: Deploy Bitnami's MongoDB latest chart from OCI registry
|
|
||||||
kubernetes.core.helm:
|
|
||||||
name: test
|
|
||||||
chart_ref: "oci://registry-1.docker.io/bitnamicharts/mongodb"
|
|
||||||
release_namespace: database
|
|
||||||
|
|
||||||
# Using complex Values
|
# Using complex Values
|
||||||
- name: Deploy new-relic client chart
|
- name: Deploy new-relic client chart
|
||||||
kubernetes.core.helm:
|
kubernetes.core.helm:
|
||||||
@@ -920,7 +851,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
||||||
|
|
||||||
.. raw:: html
|
.. raw:: html
|
||||||
|
|
||||||
@@ -1026,23 +957,6 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
|
|||||||
<br/>
|
<br/>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td class="elbow-placeholder"> </td>
|
|
||||||
<td colspan="1">
|
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
|
||||||
<b>release_values</b>
|
|
||||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></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 6.3.0</div>
|
|
||||||
</td>
|
|
||||||
<td>always</td>
|
|
||||||
<td>
|
|
||||||
<div>Dict of Values used to deploy.</div>
|
|
||||||
<br/>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<td class="elbow-placeholder"> </td>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
@@ -1098,13 +1012,12 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
|
|||||||
<b>values</b>
|
<b>values</b>
|
||||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
<div style="font-size: small">
|
<div style="font-size: small">
|
||||||
<span style="color: purple">dictionary</span>
|
<span style="color: purple">string</span>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>always</td>
|
<td>always</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Dict of Values used to deploy.</div>
|
<div>Dict of Values used to deploy</div>
|
||||||
<div>This return value has been deprecated and will be removed in a release after 2027-01-08. Use RV(status.release_values) instead.</div>
|
|
||||||
<br/>
|
<br/>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
- helm (https://github.com/helm/helm/releases)
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
@@ -196,7 +196,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
||||||
|
|
||||||
.. raw:: html
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
- helm (https://github.com/helm/helm/releases)
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
@@ -231,28 +231,6 @@ Parameters
|
|||||||
<div style="font-size: small; color: darkgreen"><br/>aliases: verify_ssl</div>
|
<div style="font-size: small; color: darkgreen"><br/>aliases: verify_ssl</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td colspan="1">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
||||||
<b>verify</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 6.4.0</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
||||||
<li>no</li>
|
|
||||||
<li><div style="color: blue"><b>yes</b> ←</div></li>
|
|
||||||
</ul>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div>Verify the plugin signature before installing.</div>
|
|
||||||
<div>This option requires helm version >= 4.0.0</div>
|
|
||||||
<div>Used with <em>state=present</em>.</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
</table>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
@@ -294,7 +272,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
||||||
|
|
||||||
.. raw:: html
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
- helm >= 3.0 (https://github.com/helm/helm/releases)
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
@@ -174,28 +174,6 @@ Parameters
|
|||||||
<div>location to write the chart.</div>
|
<div>location to write the chart.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td colspan="1">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
||||||
<b>force</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 6.3.0</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
||||||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
|
||||||
<li>yes</li>
|
|
||||||
</ul>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div>Force download of the chart even if it already exists in the destination directory.</div>
|
|
||||||
<div>By default, the module will skip downloading if the chart with the same version already exists for idempotency.</div>
|
|
||||||
<div>When used with O(untar_chart=true), will remove any existing chart directory before extracting.</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -215,27 +193,6 @@ Parameters
|
|||||||
<div>Pass credentials to all domains.</div>
|
<div>Pass credentials to all domains.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td colspan="1">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
||||||
<b>plain_http</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 6.1.0</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
||||||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
|
||||||
<li>yes</li>
|
|
||||||
</ul>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div>Use HTTP instead of HTTPS when working with OCI registries</div>
|
|
||||||
<div>Requires Helm >= 3.13.0</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -419,28 +376,11 @@ Examples
|
|||||||
username: myuser
|
username: myuser
|
||||||
password: mypassword123
|
password: mypassword123
|
||||||
|
|
||||||
- name: Download Chart (force re-download even if exists)
|
|
||||||
kubernetes.core.helm_pull:
|
|
||||||
chart_ref: redis
|
|
||||||
repo_url: https://charts.bitnami.com/bitnami
|
|
||||||
chart_version: '17.0.0'
|
|
||||||
destination: /path/to/chart
|
|
||||||
force: yes
|
|
||||||
|
|
||||||
- name: Download and untar chart (force re-extraction even if directory exists)
|
|
||||||
kubernetes.core.helm_pull:
|
|
||||||
chart_ref: redis
|
|
||||||
repo_url: https://charts.bitnami.com/bitnami
|
|
||||||
chart_version: '17.0.0'
|
|
||||||
destination: /path/to/chart
|
|
||||||
untar_chart: yes
|
|
||||||
force: yes
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
||||||
|
|
||||||
.. raw:: html
|
.. raw:: html
|
||||||
|
|
||||||
@@ -467,23 +407,6 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
|
|||||||
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">helm pull --repo test ...</div>
|
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">helm pull --repo test ...</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td colspan="1">
|
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
|
||||||
<b>msg</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>
|
|
||||||
</td>
|
|
||||||
<td>when chart already exists</td>
|
|
||||||
<td>
|
|
||||||
<div>A message indicating the result of the operation.</div>
|
|
||||||
<br/>
|
|
||||||
<div style="font-size: smaller"><b>Sample:</b></div>
|
|
||||||
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">Chart redis version 17.0.0 already exists in destination directory</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm (https://github.com/helm/helm/releases) >= 3.8.0
|
- helm (https://github.com/helm/helm/releases) => 3.8.0
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
@@ -151,27 +151,6 @@ Parameters
|
|||||||
<div style="font-size: small; color: darkgreen"><br/>aliases: repo_password</div>
|
<div style="font-size: small; color: darkgreen"><br/>aliases: repo_password</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td colspan="1">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
||||||
<b>plain_http</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 6.4.0</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
||||||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
|
||||||
<li>yes</li>
|
|
||||||
</ul>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div>Use insecure HTTP connections for <code>helm registry login</code>.</div>
|
|
||||||
<div>Requires Helm >= 3.18.0</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -236,7 +215,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
||||||
|
|
||||||
.. raw:: html
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
- helm (https://github.com/helm/helm/releases)
|
||||||
- yaml (https://pypi.org/project/PyYAML/)
|
- yaml (https://pypi.org/project/PyYAML/)
|
||||||
|
|
||||||
|
|
||||||
@@ -336,7 +336,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
||||||
|
|
||||||
.. raw:: html
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -20,13 +20,6 @@ Synopsis
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
Requirements
|
|
||||||
------------
|
|
||||||
The below requirements are needed on the host that executes this module.
|
|
||||||
|
|
||||||
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
|
||||||
- yaml (https://pypi.org/project/PyYAML/)
|
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
@@ -201,27 +194,6 @@ Parameters
|
|||||||
<div>If the directory already exists, it will be overwritten.</div>
|
<div>If the directory already exists, it will be overwritten.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td colspan="2">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
||||||
<b>plain_http</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 6.1.0</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
|
||||||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
|
||||||
<li>yes</li>
|
|
||||||
</ul>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div>Use HTTP instead of HTTPS when working with OCI registries</div>
|
|
||||||
<div>Requires Helm >= 3.13.0</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -437,7 +409,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
||||||
|
|
||||||
.. raw:: html
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -512,7 +512,6 @@ Notes
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
- the tar binary is required on the container when copying from local filesystem to pod.
|
- the tar binary is required on the container when copying from local filesystem to pod.
|
||||||
- the (init) container has to be started before you copy files or directories to it.
|
|
||||||
- To avoid SSL certificate validation errors when ``validate_certs`` is *True*, the full certificate chain for the API server must be provided via ``ca_cert`` or in the kubeconfig file.
|
- To avoid SSL certificate validation errors when ``validate_certs`` is *True*, the full certificate chain for the API server must be provided via ``ca_cert`` or in the kubeconfig file.
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
372
docs/kubernetes.core.k8s_inventory.rst
Normal file
372
docs/kubernetes.core.k8s_inventory.rst
Normal file
@@ -0,0 +1,372 @@
|
|||||||
|
.. _kubernetes.core.k8s_inventory:
|
||||||
|
|
||||||
|
|
||||||
|
*******************
|
||||||
|
kubernetes.core.k8s
|
||||||
|
*******************
|
||||||
|
|
||||||
|
**Kubernetes (K8s) inventory source**
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
:local:
|
||||||
|
:depth: 1
|
||||||
|
|
||||||
|
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 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.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
--------
|
||||||
|
- Fetch containers and services for one or more clusters.
|
||||||
|
- Groups by cluster name, namespace, namespace_services, namespace_pods, and labels.
|
||||||
|
- Uses the kubectl connection plugin to access the Kubernetes cluster.
|
||||||
|
- Uses k8s.(yml|yaml) YAML configuration file to set parameter values.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
The below requirements are needed on the local Ansible controller node that executes this inventory.
|
||||||
|
|
||||||
|
- python >= 3.9
|
||||||
|
- kubernetes >= 24.2.0
|
||||||
|
- PyYAML >= 3.11
|
||||||
|
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table border=0 cellpadding=0 class="documentation-table">
|
||||||
|
<tr>
|
||||||
|
<th colspan="2">Parameter</th>
|
||||||
|
<th>Choices/<font color="blue">Defaults</font></th>
|
||||||
|
<th>Configuration</th>
|
||||||
|
<th width="100%">Comments</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>connections</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Optional list of cluster connection settings. If no connections are provided, the default <em>~/.kube/config</em> and active context will be used, and objects will be returned for all namespaces the active user is authorized to access.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>api_key</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>ca_cert</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: ssl_ca_cert</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>client_cert</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: cert_file</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>client_key</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: key_file</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>context</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>host</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>kubeconfig</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>name</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Optional name to assign to the cluster. If not provided, a name is constructed from the server and port.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>namespaces</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized to access.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>password</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>username</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>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>validate_certs</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li>no</li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: verify_ssl</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>plugin</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
/ <span style="color: red">required</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li>kubernetes.core.k8s</li>
|
||||||
|
<li>k8s</li>
|
||||||
|
<li>community.kubernetes.k8s</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>token that ensures this is a source file for the 'k8s' plugin.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Examples
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
# File must be named k8s.yaml or k8s.yml
|
||||||
|
|
||||||
|
- name: Authenticate with token, and return all pods and services for all namespaces
|
||||||
|
plugin: kubernetes.core.k8s
|
||||||
|
connections:
|
||||||
|
- host: https://192.168.64.4:8443
|
||||||
|
api_key: xxxxxxxxxxxxxxxx
|
||||||
|
validate_certs: false
|
||||||
|
|
||||||
|
- name: Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
|
||||||
|
plugin: kubernetes.core.k8s
|
||||||
|
connections:
|
||||||
|
- namespaces:
|
||||||
|
- testing
|
||||||
|
|
||||||
|
- name: Use a custom config file, and a specific context.
|
||||||
|
plugin: kubernetes.core.k8s
|
||||||
|
connections:
|
||||||
|
- kubeconfig: /path/to/config
|
||||||
|
context: 'awx/192-168-64-4:8443/developer'
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Status
|
||||||
|
------
|
||||||
|
|
||||||
|
|
||||||
|
- This inventory will be removed in version 6.0.0. *[deprecated]*
|
||||||
|
- For more information see `DEPRECATED`_.
|
||||||
|
|
||||||
|
|
||||||
|
Authors
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
- Chris Houseknecht (@chouseknecht)
|
||||||
|
- Fabian von Feilitzsch (@fabianvf)
|
||||||
|
|
||||||
|
|
||||||
|
.. hint::
|
||||||
|
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
|
||||||
@@ -140,25 +140,6 @@ Parameters
|
|||||||
<div>The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.</div>
|
<div>The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td colspan="2">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
||||||
<b>hidden_fields</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 6.1.0</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<b>Default:</b><br/><div style="color: blue">[]</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div>List of fields to hide from the diff output.</div>
|
|
||||||
<div>This is useful for fields that are not relevant to the patch operation, such as `metadata.managedFields`.</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
|||||||
@@ -95,26 +95,6 @@ Parameters
|
|||||||
<div>Enable the helm chart inflation generator</div>
|
<div>Enable the helm chart inflation generator</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
|
||||||
<td colspan="1">
|
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
|
||||||
<b>environment</b>
|
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
|
||||||
<div style="font-size: small">
|
|
||||||
<span style="color: purple">raw</span>
|
|
||||||
</div>
|
|
||||||
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.2.0</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<b>Default:</b><br/><div style="color: blue">{}</div>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
</td>
|
|
||||||
<td>
|
|
||||||
<div>The environment variables to pass to the kustomize or kubectl command.</div>
|
|
||||||
<div>This can be a dictionary or a string in the format key=value, multiple pairs separated by space.</div>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -165,14 +145,6 @@ Examples
|
|||||||
kubernetes.core.k8s:
|
kubernetes.core.k8s:
|
||||||
definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization', enable_helm=True) }}"
|
definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization', enable_helm=True) }}"
|
||||||
|
|
||||||
- name: Create kubernetes resources for lookup output with environment variables in string format
|
|
||||||
kubernetes.core.k8s:
|
|
||||||
definition: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kubectl', environment='HTTP_PROXY=http://proxy.example.com:3128') }}"
|
|
||||||
|
|
||||||
- name: Create kubernetes resources for lookup output with environment variables in dict format
|
|
||||||
kubernetes.core.k8s:
|
|
||||||
definition: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kubectl', environment={'HTTP_PROXY': 'http://proxy.example.com:3128'}) }}"
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ tags:
|
|||||||
- openshift
|
- openshift
|
||||||
- okd
|
- okd
|
||||||
- cluster
|
- cluster
|
||||||
version: 6.4.0
|
version: 5.4.0
|
||||||
build_ignore:
|
build_ignore:
|
||||||
- .DS_Store
|
- .DS_Store
|
||||||
- "*.tar.gz"
|
- "*.tar.gz"
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
---
|
---
|
||||||
requires_ansible: '>=2.16.0'
|
requires_ansible: '>=2.15.0'
|
||||||
|
|
||||||
action_groups:
|
action_groups:
|
||||||
helm:
|
helm:
|
||||||
@@ -8,26 +8,24 @@ action_groups:
|
|||||||
- helm_repository
|
- helm_repository
|
||||||
k8s:
|
k8s:
|
||||||
- k8s
|
- k8s
|
||||||
- k8s_cluster_info
|
|
||||||
- k8s_cp
|
|
||||||
- k8s_drain
|
|
||||||
- k8s_exec
|
- k8s_exec
|
||||||
- k8s_info
|
- k8s_info
|
||||||
- k8s_json_patch
|
|
||||||
- k8s_log
|
- k8s_log
|
||||||
- k8s_rollback
|
|
||||||
- k8s_scale
|
- k8s_scale
|
||||||
- k8s_service
|
- k8s_service
|
||||||
|
- k8s_cp
|
||||||
|
- k8s_drain
|
||||||
|
|
||||||
plugin_routing:
|
plugin_routing:
|
||||||
inventory:
|
inventory:
|
||||||
openshift:
|
openshift:
|
||||||
redirect: community.okd.openshift
|
redirect: community.okd.openshift
|
||||||
k8s:
|
k8s:
|
||||||
tombstone:
|
deprecation:
|
||||||
removal_version: 6.0.0
|
removal_version: 6.0.0
|
||||||
warning_text: >-
|
warning_text: >-
|
||||||
The k8s inventory plugin was slated for deprecation in 3.3.0 and has been removed in release 6.0.0. Use kubernetes.core.k8s_info and ansible.builtin.add_host instead.
|
The k8s inventory plugin has been deprecated and
|
||||||
|
will be removed in release 6.0.0.
|
||||||
modules:
|
modules:
|
||||||
k8s_auth:
|
k8s_auth:
|
||||||
redirect: community.okd.k8s_auth
|
redirect: community.okd.k8s_auth
|
||||||
|
|||||||
@@ -20,8 +20,9 @@ from ansible.errors import (
|
|||||||
AnsibleError,
|
AnsibleError,
|
||||||
AnsibleFileNotFound,
|
AnsibleFileNotFound,
|
||||||
)
|
)
|
||||||
from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
|
from ansible.module_utils._text import to_bytes, to_native, to_text
|
||||||
from ansible.module_utils.parsing.convert_bool import boolean
|
from ansible.module_utils.parsing.convert_bool import boolean
|
||||||
|
from ansible.module_utils.six import iteritems, string_types
|
||||||
from ansible.plugins.action import ActionBase
|
from ansible.plugins.action import ActionBase
|
||||||
|
|
||||||
try:
|
try:
|
||||||
@@ -99,7 +100,7 @@ class ActionModule(ActionBase):
|
|||||||
"trim_blocks": True,
|
"trim_blocks": True,
|
||||||
"lstrip_blocks": False,
|
"lstrip_blocks": False,
|
||||||
}
|
}
|
||||||
if isinstance(template, str):
|
if isinstance(template, string_types):
|
||||||
# treat this as raw_params
|
# treat this as raw_params
|
||||||
template_param["path"] = template
|
template_param["path"] = template
|
||||||
elif isinstance(template, dict):
|
elif isinstance(template, dict):
|
||||||
@@ -119,7 +120,7 @@ class ActionModule(ActionBase):
|
|||||||
):
|
):
|
||||||
if s_type in template_args:
|
if s_type in template_args:
|
||||||
value = ensure_type(template_args[s_type], "string")
|
value = ensure_type(template_args[s_type], "string")
|
||||||
if value is not None and not isinstance(value, str):
|
if value is not None and not isinstance(value, string_types):
|
||||||
raise AnsibleActionFail(
|
raise AnsibleActionFail(
|
||||||
"%s is expected to be a string, but got %s instead"
|
"%s is expected to be a string, but got %s instead"
|
||||||
% (s_type, type(value))
|
% (s_type, type(value))
|
||||||
@@ -195,7 +196,7 @@ class ActionModule(ActionBase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
template_params = []
|
template_params = []
|
||||||
if isinstance(template, str) or isinstance(template, dict):
|
if isinstance(template, string_types) or isinstance(template, dict):
|
||||||
template_params.append(self.get_template_args(template))
|
template_params.append(self.get_template_args(template))
|
||||||
elif isinstance(template, list):
|
elif isinstance(template, list):
|
||||||
for element in template:
|
for element in template:
|
||||||
@@ -245,7 +246,7 @@ class ActionModule(ActionBase):
|
|||||||
# add ansible 'template' vars
|
# add ansible 'template' vars
|
||||||
temp_vars = copy.deepcopy(task_vars)
|
temp_vars = copy.deepcopy(task_vars)
|
||||||
overrides = {}
|
overrides = {}
|
||||||
for key, value in template_item.items():
|
for key, value in iteritems(template_item):
|
||||||
if hasattr(self._templar.environment, key):
|
if hasattr(self._templar.environment, key):
|
||||||
if value is not None:
|
if value is not None:
|
||||||
overrides[key] = value
|
overrides[key] = value
|
||||||
@@ -302,7 +303,7 @@ class ActionModule(ActionBase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def get_kubeconfig(self, kubeconfig, remote_transport, new_module_args):
|
def get_kubeconfig(self, kubeconfig, remote_transport, new_module_args):
|
||||||
if isinstance(kubeconfig, str):
|
if isinstance(kubeconfig, string_types):
|
||||||
# find the kubeconfig in the expected search path
|
# find the kubeconfig in the expected search path
|
||||||
if not remote_transport:
|
if not remote_transport:
|
||||||
# kubeconfig is local
|
# kubeconfig is local
|
||||||
|
|||||||
@@ -264,8 +264,7 @@ import subprocess
|
|||||||
import tempfile
|
import tempfile
|
||||||
|
|
||||||
from ansible.errors import AnsibleError, AnsibleFileNotFound
|
from ansible.errors import AnsibleError, AnsibleFileNotFound
|
||||||
from ansible.module_utils.common.text.converters import to_bytes
|
from ansible.module_utils._text import to_bytes
|
||||||
from ansible.module_utils.parsing.convert_bool import boolean
|
|
||||||
from ansible.module_utils.six.moves import shlex_quote
|
from ansible.module_utils.six.moves import shlex_quote
|
||||||
from ansible.parsing.yaml.loader import AnsibleLoader
|
from ansible.parsing.yaml.loader import AnsibleLoader
|
||||||
from ansible.plugins.connection import BUFSIZE, ConnectionBase
|
from ansible.plugins.connection import BUFSIZE, ConnectionBase
|
||||||
@@ -325,12 +324,9 @@ class Connection(ConnectionBase):
|
|||||||
# Build command options based on doc string
|
# Build command options based on doc string
|
||||||
doc_yaml = AnsibleLoader(self.documentation).get_single_data()
|
doc_yaml = AnsibleLoader(self.documentation).get_single_data()
|
||||||
for key in doc_yaml.get("options"):
|
for key in doc_yaml.get("options"):
|
||||||
if key == "validate_certs" and self.get_option(key) != "":
|
if key.endswith("verify_ssl") and self.get_option(key) != "":
|
||||||
# Translate validate_certs to --insecure-skip-tls-verify flag
|
# Translate verify_ssl to skip_verify_ssl, and output as string
|
||||||
# validate_certs=True means verify certs (don't skip verification)
|
skip_verify_ssl = not self.get_option(key)
|
||||||
# validate_certs=False means don't verify certs (skip verification)
|
|
||||||
validate_certs_value = boolean(self.get_option(key), strict=False)
|
|
||||||
skip_verify_ssl = not validate_certs_value
|
|
||||||
local_cmd.append(
|
local_cmd.append(
|
||||||
"{0}={1}".format(
|
"{0}={1}".format(
|
||||||
self.connection_options[key], str(skip_verify_ssl).lower()
|
self.connection_options[key], str(skip_verify_ssl).lower()
|
||||||
|
|||||||
476
plugins/inventory/k8s.py
Normal file
476
plugins/inventory/k8s.py
Normal file
@@ -0,0 +1,476 @@
|
|||||||
|
# Copyright (c) 2018 Ansible Project
|
||||||
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
from __future__ import absolute_import, division, print_function
|
||||||
|
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
DOCUMENTATION = """
|
||||||
|
name: k8s
|
||||||
|
author:
|
||||||
|
- Chris Houseknecht (@chouseknecht)
|
||||||
|
- Fabian von Feilitzsch (@fabianvf)
|
||||||
|
|
||||||
|
short_description: Kubernetes (K8s) inventory source
|
||||||
|
|
||||||
|
description:
|
||||||
|
- Fetch containers and services for one or more clusters.
|
||||||
|
- Groups by cluster name, namespace, namespace_services, namespace_pods, and labels.
|
||||||
|
- Uses the kubectl connection plugin to access the Kubernetes cluster.
|
||||||
|
- Uses k8s.(yml|yaml) YAML configuration file to set parameter values.
|
||||||
|
|
||||||
|
deprecated:
|
||||||
|
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 6.0.0.
|
||||||
|
alternative: "Use M(kubernetes.core.k8s_info) and M(ansible.builtin.add_host) instead."
|
||||||
|
|
||||||
|
options:
|
||||||
|
plugin:
|
||||||
|
description: token that ensures this is a source file for the 'k8s' plugin.
|
||||||
|
required: True
|
||||||
|
choices: ['kubernetes.core.k8s', 'k8s', 'community.kubernetes.k8s']
|
||||||
|
connections:
|
||||||
|
description:
|
||||||
|
- Optional list of cluster connection settings. If no connections are provided, the default
|
||||||
|
I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces
|
||||||
|
the active user is authorized to access.
|
||||||
|
suboptions:
|
||||||
|
name:
|
||||||
|
description:
|
||||||
|
- Optional name to assign to the cluster. If not provided, a name is constructed from the server
|
||||||
|
and port.
|
||||||
|
kubeconfig:
|
||||||
|
description:
|
||||||
|
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||||
|
options are provided, the Kubernetes client will attempt to load the default
|
||||||
|
configuration file from I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG
|
||||||
|
environment variable.
|
||||||
|
context:
|
||||||
|
description:
|
||||||
|
- The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment
|
||||||
|
variable.
|
||||||
|
host:
|
||||||
|
description:
|
||||||
|
- Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
||||||
|
api_key:
|
||||||
|
description:
|
||||||
|
- Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment
|
||||||
|
variable.
|
||||||
|
username:
|
||||||
|
description:
|
||||||
|
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME
|
||||||
|
environment variable.
|
||||||
|
password:
|
||||||
|
description:
|
||||||
|
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD
|
||||||
|
environment variable.
|
||||||
|
client_cert:
|
||||||
|
description:
|
||||||
|
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE
|
||||||
|
environment variable.
|
||||||
|
aliases: [ cert_file ]
|
||||||
|
client_key:
|
||||||
|
description:
|
||||||
|
- Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE
|
||||||
|
environment variable.
|
||||||
|
aliases: [ key_file ]
|
||||||
|
ca_cert:
|
||||||
|
description:
|
||||||
|
- Path to a CA certificate used to authenticate with the API. Can also be specified via
|
||||||
|
K8S_AUTH_SSL_CA_CERT environment variable.
|
||||||
|
aliases: [ ssl_ca_cert ]
|
||||||
|
validate_certs:
|
||||||
|
description:
|
||||||
|
- "Whether or not to verify the API server's SSL certificates. Can also be specified via
|
||||||
|
K8S_AUTH_VERIFY_SSL environment variable."
|
||||||
|
type: bool
|
||||||
|
aliases: [ verify_ssl ]
|
||||||
|
namespaces:
|
||||||
|
description:
|
||||||
|
- List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized
|
||||||
|
to access.
|
||||||
|
|
||||||
|
requirements:
|
||||||
|
- "python >= 3.9"
|
||||||
|
- "kubernetes >= 24.2.0"
|
||||||
|
- "PyYAML >= 3.11"
|
||||||
|
"""
|
||||||
|
|
||||||
|
EXAMPLES = r"""
|
||||||
|
# File must be named k8s.yaml or k8s.yml
|
||||||
|
|
||||||
|
- name: Authenticate with token, and return all pods and services for all namespaces
|
||||||
|
plugin: kubernetes.core.k8s
|
||||||
|
connections:
|
||||||
|
- host: https://192.168.64.4:8443
|
||||||
|
api_key: xxxxxxxxxxxxxxxx
|
||||||
|
validate_certs: false
|
||||||
|
|
||||||
|
- name: Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
|
||||||
|
plugin: kubernetes.core.k8s
|
||||||
|
connections:
|
||||||
|
- namespaces:
|
||||||
|
- testing
|
||||||
|
|
||||||
|
- name: Use a custom config file, and a specific context.
|
||||||
|
plugin: kubernetes.core.k8s
|
||||||
|
connections:
|
||||||
|
- kubeconfig: /path/to/config
|
||||||
|
context: 'awx/192-168-64-4:8443/developer'
|
||||||
|
"""
|
||||||
|
|
||||||
|
import json
|
||||||
|
|
||||||
|
from ansible.errors import AnsibleError
|
||||||
|
from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, Constructable
|
||||||
|
|
||||||
|
try:
|
||||||
|
from kubernetes.dynamic.exceptions import DynamicApiError
|
||||||
|
|
||||||
|
HAS_K8S_MODULE_HELPER = True
|
||||||
|
k8s_import_exception = None
|
||||||
|
except ImportError as e:
|
||||||
|
HAS_K8S_MODULE_HELPER = False
|
||||||
|
k8s_import_exception = e
|
||||||
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
||||||
|
get_api_client,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def format_dynamic_api_exc(exc):
|
||||||
|
if exc.body:
|
||||||
|
if exc.headers and exc.headers.get("Content-Type") == "application/json":
|
||||||
|
message = json.loads(exc.body).get("message")
|
||||||
|
if message:
|
||||||
|
return message
|
||||||
|
return exc.body
|
||||||
|
else:
|
||||||
|
return "%s Reason: %s" % (exc.status, exc.reason)
|
||||||
|
|
||||||
|
|
||||||
|
class K8sInventoryException(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
|
||||||
|
NAME = "kubernetes.core.k8s"
|
||||||
|
|
||||||
|
connection_plugin = "kubernetes.core.kubectl"
|
||||||
|
transport = "kubectl"
|
||||||
|
|
||||||
|
def parse(self, inventory, loader, path, cache=True):
|
||||||
|
super(InventoryModule, self).parse(inventory, loader, path)
|
||||||
|
|
||||||
|
self.display.deprecated(
|
||||||
|
"The 'k8s' inventory plugin has been deprecated and will be removed in release 6.0.0",
|
||||||
|
version="6.0.0",
|
||||||
|
collection_name="kubernetes.core",
|
||||||
|
)
|
||||||
|
cache_key = self._get_cache_prefix(path)
|
||||||
|
config_data = self._read_config_data(path)
|
||||||
|
self.setup(config_data, cache, cache_key)
|
||||||
|
|
||||||
|
def setup(self, config_data, cache, cache_key):
|
||||||
|
connections = config_data.get("connections")
|
||||||
|
|
||||||
|
if not HAS_K8S_MODULE_HELPER:
|
||||||
|
raise K8sInventoryException(
|
||||||
|
"This module requires the Kubernetes Python client. Try `pip install kubernetes`. Detail: {0}".format(
|
||||||
|
k8s_import_exception
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
source_data = None
|
||||||
|
if cache and cache_key in self._cache:
|
||||||
|
try:
|
||||||
|
source_data = self._cache[cache_key]
|
||||||
|
except KeyError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
if not source_data:
|
||||||
|
self.fetch_objects(connections)
|
||||||
|
|
||||||
|
def fetch_objects(self, connections):
|
||||||
|
if connections:
|
||||||
|
if not isinstance(connections, list):
|
||||||
|
raise K8sInventoryException("Expecting connections to be a list.")
|
||||||
|
|
||||||
|
for connection in connections:
|
||||||
|
if not isinstance(connection, dict):
|
||||||
|
raise K8sInventoryException(
|
||||||
|
"Expecting connection to be a dictionary."
|
||||||
|
)
|
||||||
|
client = get_api_client(**connection)
|
||||||
|
name = connection.get(
|
||||||
|
"name", self.get_default_host_name(client.configuration.host)
|
||||||
|
)
|
||||||
|
if connection.get("namespaces"):
|
||||||
|
namespaces = connection["namespaces"]
|
||||||
|
else:
|
||||||
|
namespaces = self.get_available_namespaces(client)
|
||||||
|
for namespace in namespaces:
|
||||||
|
self.get_pods_for_namespace(client, name, namespace)
|
||||||
|
self.get_services_for_namespace(client, name, namespace)
|
||||||
|
else:
|
||||||
|
client = get_api_client()
|
||||||
|
name = self.get_default_host_name(client.configuration.host)
|
||||||
|
namespaces = self.get_available_namespaces(client)
|
||||||
|
for namespace in namespaces:
|
||||||
|
self.get_pods_for_namespace(client, name, namespace)
|
||||||
|
self.get_services_for_namespace(client, name, namespace)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def get_default_host_name(host):
|
||||||
|
return (
|
||||||
|
host.replace("https://", "")
|
||||||
|
.replace("http://", "")
|
||||||
|
.replace(".", "-")
|
||||||
|
.replace(":", "_")
|
||||||
|
)
|
||||||
|
|
||||||
|
def get_available_namespaces(self, client):
|
||||||
|
v1_namespace = client.resources.get(api_version="v1", kind="Namespace")
|
||||||
|
try:
|
||||||
|
obj = v1_namespace.get()
|
||||||
|
except DynamicApiError as exc:
|
||||||
|
self.display.debug(exc)
|
||||||
|
raise K8sInventoryException(
|
||||||
|
"Error fetching Namespace list: %s" % format_dynamic_api_exc(exc)
|
||||||
|
)
|
||||||
|
return [namespace.metadata.name for namespace in obj.items]
|
||||||
|
|
||||||
|
def get_pods_for_namespace(self, client, name, namespace):
|
||||||
|
v1_pod = client.resources.get(api_version="v1", kind="Pod")
|
||||||
|
try:
|
||||||
|
obj = v1_pod.get(namespace=namespace)
|
||||||
|
except DynamicApiError as exc:
|
||||||
|
self.display.debug(exc)
|
||||||
|
raise K8sInventoryException(
|
||||||
|
"Error fetching Pod list: %s" % format_dynamic_api_exc(exc)
|
||||||
|
)
|
||||||
|
|
||||||
|
namespace_group = "namespace_{0}".format(namespace)
|
||||||
|
namespace_pods_group = "{0}_pods".format(namespace_group)
|
||||||
|
|
||||||
|
self.inventory.add_group(name)
|
||||||
|
self.inventory.add_group(namespace_group)
|
||||||
|
self.inventory.add_child(name, namespace_group)
|
||||||
|
self.inventory.add_group(namespace_pods_group)
|
||||||
|
self.inventory.add_child(namespace_group, namespace_pods_group)
|
||||||
|
|
||||||
|
for pod in obj.items:
|
||||||
|
pod_name = pod.metadata.name
|
||||||
|
pod_groups = []
|
||||||
|
pod_annotations = (
|
||||||
|
{} if not pod.metadata.annotations else dict(pod.metadata.annotations)
|
||||||
|
)
|
||||||
|
|
||||||
|
if pod.metadata.labels:
|
||||||
|
# create a group for each label_value
|
||||||
|
for key, value in pod.metadata.labels:
|
||||||
|
group_name = "label_{0}_{1}".format(key, value)
|
||||||
|
if group_name not in pod_groups:
|
||||||
|
pod_groups.append(group_name)
|
||||||
|
self.inventory.add_group(group_name)
|
||||||
|
pod_labels = dict(pod.metadata.labels)
|
||||||
|
else:
|
||||||
|
pod_labels = {}
|
||||||
|
|
||||||
|
if not pod.status.containerStatuses:
|
||||||
|
continue
|
||||||
|
|
||||||
|
for container in pod.status.containerStatuses:
|
||||||
|
# add each pod_container to the namespace group, and to each label_value group
|
||||||
|
container_name = "{0}_{1}".format(pod.metadata.name, container.name)
|
||||||
|
self.inventory.add_host(container_name)
|
||||||
|
self.inventory.add_child(namespace_pods_group, container_name)
|
||||||
|
if pod_groups:
|
||||||
|
for group in pod_groups:
|
||||||
|
self.inventory.add_child(group, container_name)
|
||||||
|
|
||||||
|
# Add hostvars
|
||||||
|
self.inventory.set_variable(container_name, "object_type", "pod")
|
||||||
|
self.inventory.set_variable(container_name, "labels", pod_labels)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "annotations", pod_annotations
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "cluster_name", pod.metadata.clusterName
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "pod_node_name", pod.spec.nodeName
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(container_name, "pod_name", pod.spec.name)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "pod_host_ip", pod.status.hostIP
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "pod_phase", pod.status.phase
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(container_name, "pod_ip", pod.status.podIP)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "pod_self_link", pod.metadata.selfLink
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "pod_resource_version", pod.metadata.resourceVersion
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(container_name, "pod_uid", pod.metadata.uid)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "container_name", container.image
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "container_image", container.image
|
||||||
|
)
|
||||||
|
if container.state.running:
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "container_state", "Running"
|
||||||
|
)
|
||||||
|
if container.state.terminated:
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "container_state", "Terminated"
|
||||||
|
)
|
||||||
|
if container.state.waiting:
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "container_state", "Waiting"
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "container_ready", container.ready
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "ansible_remote_tmp", "/tmp/"
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "ansible_connection", self.connection_plugin
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name, "ansible_{0}_pod".format(self.transport), pod_name
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name,
|
||||||
|
"ansible_{0}_container".format(self.transport),
|
||||||
|
container.name,
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
container_name,
|
||||||
|
"ansible_{0}_namespace".format(self.transport),
|
||||||
|
namespace,
|
||||||
|
)
|
||||||
|
|
||||||
|
def get_services_for_namespace(self, client, name, namespace):
|
||||||
|
v1_service = client.resources.get(api_version="v1", kind="Service")
|
||||||
|
try:
|
||||||
|
obj = v1_service.get(namespace=namespace)
|
||||||
|
except DynamicApiError as exc:
|
||||||
|
self.display.debug(exc)
|
||||||
|
raise K8sInventoryException(
|
||||||
|
"Error fetching Service list: %s" % format_dynamic_api_exc(exc)
|
||||||
|
)
|
||||||
|
|
||||||
|
namespace_group = "namespace_{0}".format(namespace)
|
||||||
|
namespace_services_group = "{0}_services".format(namespace_group)
|
||||||
|
|
||||||
|
self.inventory.add_group(name)
|
||||||
|
self.inventory.add_group(namespace_group)
|
||||||
|
self.inventory.add_child(name, namespace_group)
|
||||||
|
self.inventory.add_group(namespace_services_group)
|
||||||
|
self.inventory.add_child(namespace_group, namespace_services_group)
|
||||||
|
|
||||||
|
for service in obj.items:
|
||||||
|
service_name = service.metadata.name
|
||||||
|
service_labels = (
|
||||||
|
{} if not service.metadata.labels else dict(service.metadata.labels)
|
||||||
|
)
|
||||||
|
service_annotations = (
|
||||||
|
{}
|
||||||
|
if not service.metadata.annotations
|
||||||
|
else dict(service.metadata.annotations)
|
||||||
|
)
|
||||||
|
|
||||||
|
self.inventory.add_host(service_name)
|
||||||
|
|
||||||
|
if service.metadata.labels:
|
||||||
|
# create a group for each label_value
|
||||||
|
for key, value in service.metadata.labels:
|
||||||
|
group_name = "label_{0}_{1}".format(key, value)
|
||||||
|
self.inventory.add_group(group_name)
|
||||||
|
self.inventory.add_child(group_name, service_name)
|
||||||
|
|
||||||
|
try:
|
||||||
|
self.inventory.add_child(namespace_services_group, service_name)
|
||||||
|
except AnsibleError:
|
||||||
|
raise
|
||||||
|
|
||||||
|
ports = [
|
||||||
|
{
|
||||||
|
"name": port.name,
|
||||||
|
"port": port.port,
|
||||||
|
"protocol": port.protocol,
|
||||||
|
"targetPort": port.targetPort,
|
||||||
|
"nodePort": port.nodePort,
|
||||||
|
}
|
||||||
|
for port in service.spec.ports or []
|
||||||
|
]
|
||||||
|
|
||||||
|
# add hostvars
|
||||||
|
self.inventory.set_variable(service_name, "object_type", "service")
|
||||||
|
self.inventory.set_variable(service_name, "labels", service_labels)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name, "annotations", service_annotations
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name, "cluster_name", service.metadata.clusterName
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(service_name, "ports", ports)
|
||||||
|
self.inventory.set_variable(service_name, "type", service.spec.type)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name, "self_link", service.metadata.selfLink
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name, "resource_version", service.metadata.resourceVersion
|
||||||
|
)
|
||||||
|
self.inventory.set_variable(service_name, "uid", service.metadata.uid)
|
||||||
|
|
||||||
|
if service.spec.externalTrafficPolicy:
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name,
|
||||||
|
"external_traffic_policy",
|
||||||
|
service.spec.externalTrafficPolicy,
|
||||||
|
)
|
||||||
|
if service.spec.externalIPs:
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name, "external_ips", service.spec.externalIPs
|
||||||
|
)
|
||||||
|
|
||||||
|
if service.spec.externalName:
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name, "external_name", service.spec.externalName
|
||||||
|
)
|
||||||
|
|
||||||
|
if service.spec.healthCheckNodePort:
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name,
|
||||||
|
"health_check_node_port",
|
||||||
|
service.spec.healthCheckNodePort,
|
||||||
|
)
|
||||||
|
if service.spec.loadBalancerIP:
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name, "load_balancer_ip", service.spec.loadBalancerIP
|
||||||
|
)
|
||||||
|
if service.spec.selector:
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name, "selector", dict(service.spec.selector)
|
||||||
|
)
|
||||||
|
|
||||||
|
if (
|
||||||
|
hasattr(service.status.loadBalancer, "ingress")
|
||||||
|
and service.status.loadBalancer.ingress
|
||||||
|
):
|
||||||
|
load_balancer = [
|
||||||
|
{"hostname": ingress.hostname, "ip": ingress.ip}
|
||||||
|
for ingress in service.status.loadBalancer.ingress
|
||||||
|
]
|
||||||
|
self.inventory.set_variable(
|
||||||
|
service_name, "load_balancer", load_balancer
|
||||||
|
)
|
||||||
@@ -86,48 +86,14 @@ DOCUMENTATION = """
|
|||||||
description:
|
description:
|
||||||
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment
|
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment
|
||||||
variable.
|
variable.
|
||||||
no_proxy:
|
|
||||||
description:
|
|
||||||
- The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy.
|
|
||||||
Can also be specified via K8S_AUTH_NO_PROXY environment variable.
|
|
||||||
- Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
|
|
||||||
- This feature requires kubernetes>=19.15.0.
|
|
||||||
When kubernetes library is less than 19.15.0, it fails even if no_proxy is set correctly.
|
|
||||||
type: str
|
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment
|
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment
|
||||||
variable.
|
variable.
|
||||||
proxy:
|
|
||||||
description:
|
|
||||||
- The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable.
|
|
||||||
- Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
|
|
||||||
type: str
|
|
||||||
proxy_headers:
|
|
||||||
description:
|
|
||||||
- The Header used for the HTTP proxy.
|
|
||||||
- Documentation can be found here
|
|
||||||
U(https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers).
|
|
||||||
type: dict
|
|
||||||
suboptions:
|
|
||||||
proxy_basic_auth:
|
|
||||||
type: str
|
|
||||||
description:
|
|
||||||
- Colon-separated username:password for proxy basic authentication header.
|
|
||||||
- Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
|
|
||||||
basic_auth:
|
|
||||||
type: str
|
|
||||||
description:
|
|
||||||
- Colon-separated username:password for basic authentication header.
|
|
||||||
- Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
|
|
||||||
user_agent:
|
|
||||||
type: str
|
|
||||||
description:
|
|
||||||
- String representing the user-agent you want, such as foo/1.0.
|
|
||||||
- Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
|
|
||||||
client_cert:
|
client_cert:
|
||||||
description:
|
description:
|
||||||
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment
|
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE
|
||||||
|
environment
|
||||||
variable.
|
variable.
|
||||||
aliases: [ cert_file ]
|
aliases: [ cert_file ]
|
||||||
client_key:
|
client_key:
|
||||||
|
|||||||
@@ -34,13 +34,6 @@ DOCUMENTATION = """
|
|||||||
description:
|
description:
|
||||||
- Enable the helm chart inflation generator
|
- Enable the helm chart inflation generator
|
||||||
default: "False"
|
default: "False"
|
||||||
environment:
|
|
||||||
description:
|
|
||||||
- The environment variables to pass to the kustomize or kubectl command.
|
|
||||||
- This can be a dictionary or a string in the format key=value, multiple pairs separated by space.
|
|
||||||
type: raw
|
|
||||||
default: {}
|
|
||||||
version_added: 6.2.0
|
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 3.6"
|
- "python >= 3.6"
|
||||||
@@ -62,14 +55,6 @@ EXAMPLES = """
|
|||||||
- name: Create kubernetes resources for lookup output with `--enable-helm` set
|
- name: Create kubernetes resources for lookup output with `--enable-helm` set
|
||||||
kubernetes.core.k8s:
|
kubernetes.core.k8s:
|
||||||
definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization', enable_helm=True) }}"
|
definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization', enable_helm=True) }}"
|
||||||
|
|
||||||
- name: Create kubernetes resources for lookup output with environment variables in string format
|
|
||||||
kubernetes.core.k8s:
|
|
||||||
definition: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kubectl', environment='HTTP_PROXY=http://proxy.example.com:3128') }}"
|
|
||||||
|
|
||||||
- name: Create kubernetes resources for lookup output with environment variables in dict format
|
|
||||||
kubernetes.core.k8s:
|
|
||||||
definition: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kubectl', environment={'HTTP_PROXY': 'http://proxy.example.com:3128'}) }}"
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
RETURN = """
|
RETURN = """
|
||||||
@@ -87,7 +72,6 @@ RETURN = """
|
|||||||
key1: val1
|
key1: val1
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
from ansible.errors import AnsibleLookupError
|
from ansible.errors import AnsibleLookupError
|
||||||
@@ -108,10 +92,8 @@ def get_binary_from_path(name, opt_dirs=None):
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
def run_command(command, environ=None):
|
def run_command(command):
|
||||||
cmd = subprocess.Popen(
|
cmd = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||||||
command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=environ
|
|
||||||
)
|
|
||||||
stdout, stderr = cmd.communicate()
|
stdout, stderr = cmd.communicate()
|
||||||
return cmd.returncode, stdout, stderr
|
return cmd.returncode, stdout, stderr
|
||||||
|
|
||||||
@@ -125,7 +107,6 @@ class LookupModule(LookupBase):
|
|||||||
binary_path=None,
|
binary_path=None,
|
||||||
opt_dirs=None,
|
opt_dirs=None,
|
||||||
enable_helm=False,
|
enable_helm=False,
|
||||||
environment=None,
|
|
||||||
**kwargs
|
**kwargs
|
||||||
):
|
):
|
||||||
executable_path = binary_path
|
executable_path = binary_path
|
||||||
@@ -160,21 +141,7 @@ class LookupModule(LookupBase):
|
|||||||
if enable_helm:
|
if enable_helm:
|
||||||
command += ["--enable-helm"]
|
command += ["--enable-helm"]
|
||||||
|
|
||||||
environ = None
|
(ret, out, err) = run_command(command)
|
||||||
if environment:
|
|
||||||
environ = os.environ.copy()
|
|
||||||
if isinstance(environment, str):
|
|
||||||
if not all(env.count("=") == 1 for env in environment.split(" ")):
|
|
||||||
raise AnsibleLookupError(
|
|
||||||
"environment should be dict or string in the format key=value, multiple pairs separated by space"
|
|
||||||
)
|
|
||||||
for env in environment.split(" "):
|
|
||||||
key, value = env.split("=")
|
|
||||||
environ[key] = value
|
|
||||||
if isinstance(environment, dict):
|
|
||||||
environ.update(environment)
|
|
||||||
|
|
||||||
(ret, out, err) = run_command(command, environ=environ)
|
|
||||||
if ret != 0:
|
if ret != 0:
|
||||||
if err:
|
if err:
|
||||||
raise AnsibleLookupError(
|
raise AnsibleLookupError(
|
||||||
|
|||||||
@@ -1,64 +1,16 @@
|
|||||||
from __future__ import absolute_import, division, print_function
|
from __future__ import absolute_import, division, print_function
|
||||||
|
|
||||||
|
from ansible.module_utils.six import string_types
|
||||||
|
|
||||||
__metaclass__ = type
|
__metaclass__ = type
|
||||||
|
|
||||||
import warnings
|
|
||||||
|
|
||||||
|
|
||||||
def list_dict_str(value):
|
def list_dict_str(value):
|
||||||
if isinstance(value, (list, dict, str)):
|
if isinstance(value, (list, dict, string_types)):
|
||||||
return value
|
return value
|
||||||
raise TypeError
|
raise TypeError
|
||||||
|
|
||||||
|
|
||||||
def extract_sensitive_values_from_kubeconfig(kubeconfig_data):
|
|
||||||
"""
|
|
||||||
Extract only sensitive string values from kubeconfig data for no_log_values.
|
|
||||||
|
|
||||||
:arg kubeconfig_data: Dictionary containing kubeconfig data
|
|
||||||
:returns: Set of sensitive string values to be added to no_log_values
|
|
||||||
"""
|
|
||||||
values = set()
|
|
||||||
sensitive_fields = {
|
|
||||||
"token",
|
|
||||||
"password",
|
|
||||||
"secret",
|
|
||||||
"client-key-data",
|
|
||||||
"client-certificate-data",
|
|
||||||
"certificate-authority-data",
|
|
||||||
"api_key",
|
|
||||||
"access-token",
|
|
||||||
"refresh-token",
|
|
||||||
}
|
|
||||||
|
|
||||||
# Check API version and warn if not v1
|
|
||||||
if isinstance(kubeconfig_data, dict):
|
|
||||||
api_version = kubeconfig_data.get("apiVersion", "v1")
|
|
||||||
if api_version != "v1":
|
|
||||||
warnings.warn(
|
|
||||||
f"Kubeconfig API version '{api_version}' is not 'v1'. "
|
|
||||||
f"Sensitive field redaction is only guaranteed for API version 'v1'. "
|
|
||||||
f"Some sensitive data may not be properly redacted from the logs.",
|
|
||||||
UserWarning,
|
|
||||||
)
|
|
||||||
|
|
||||||
def _extract_recursive(data, current_path=""):
|
|
||||||
if isinstance(data, dict):
|
|
||||||
for key, value in data.items():
|
|
||||||
path = f"{current_path}.{key}" if current_path else key
|
|
||||||
if key in sensitive_fields:
|
|
||||||
if isinstance(value, str):
|
|
||||||
values.add(value)
|
|
||||||
else:
|
|
||||||
_extract_recursive(value, path)
|
|
||||||
elif isinstance(data, list):
|
|
||||||
for i, item in enumerate(data):
|
|
||||||
_extract_recursive(item, f"{current_path}[{i}]")
|
|
||||||
|
|
||||||
_extract_recursive(kubeconfig_data)
|
|
||||||
return values
|
|
||||||
|
|
||||||
|
|
||||||
AUTH_PROXY_HEADERS_SPEC = dict(
|
AUTH_PROXY_HEADERS_SPEC = dict(
|
||||||
proxy_basic_auth=dict(type="str", no_log=True),
|
proxy_basic_auth=dict(type="str", no_log=True),
|
||||||
basic_auth=dict(type="str", no_log=True),
|
basic_auth=dict(type="str", no_log=True),
|
||||||
@@ -66,7 +18,7 @@ AUTH_PROXY_HEADERS_SPEC = dict(
|
|||||||
)
|
)
|
||||||
|
|
||||||
AUTH_ARG_SPEC = {
|
AUTH_ARG_SPEC = {
|
||||||
"kubeconfig": {"type": "raw"},
|
"kubeconfig": {"type": "raw", "no_log": True},
|
||||||
"context": {},
|
"context": {},
|
||||||
"host": {},
|
"host": {},
|
||||||
"api_key": {"no_log": True},
|
"api_key": {"no_log": True},
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ import base64
|
|||||||
import os
|
import os
|
||||||
from tempfile import NamedTemporaryFile
|
from tempfile import NamedTemporaryFile
|
||||||
|
|
||||||
from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
|
from ansible.module_utils._text import to_bytes, to_native, to_text
|
||||||
from ansible.module_utils.urls import Request
|
from ansible.module_utils.urls import Request
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ from abc import ABCMeta, abstractmethod
|
|||||||
from select import select
|
from select import select
|
||||||
from tempfile import NamedTemporaryFile, TemporaryFile
|
from tempfile import NamedTemporaryFile, TemporaryFile
|
||||||
|
|
||||||
from ansible.module_utils.common.text.converters import to_native
|
from ansible.module_utils._text import to_native
|
||||||
|
|
||||||
# from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import AnsibleModule
|
# from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import AnsibleModule
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
|
||||||
@@ -96,7 +96,7 @@ class K8SCopy(metaclass=ABCMeta):
|
|||||||
return error, stdout, stderr
|
return error, stdout, stderr
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
self.module.fail_json(
|
self.module.fail_json(
|
||||||
msg="Error while running/parsing from pod {0}/{1} command='{2}' : {3}".format(
|
msg="Error while running/parsing from pod {1}/{2} command='{0}' : {3}".format(
|
||||||
self.namespace, self.name, cmd, to_native(e)
|
self.namespace, self.name, cmd, to_native(e)
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
@@ -278,15 +278,11 @@ class K8SCopyFromPod(K8SCopy):
|
|||||||
def run(self):
|
def run(self):
|
||||||
self.files_to_copy = self.list_remote_files()
|
self.files_to_copy = self.list_remote_files()
|
||||||
if self.files_to_copy == []:
|
if self.files_to_copy == []:
|
||||||
# Using warn method instead of passing warnings to exit_json as it is
|
|
||||||
# deprecated in ansible-core>=2.19.0
|
|
||||||
self._module.warn(
|
|
||||||
"No file found from directory '{0}' into remote Pod.".format(
|
|
||||||
self.remote_path
|
|
||||||
)
|
|
||||||
)
|
|
||||||
self.module.exit_json(
|
self.module.exit_json(
|
||||||
changed=False,
|
changed=False,
|
||||||
|
warning="No file found from directory '{0}' into remote Pod.".format(
|
||||||
|
self.remote_path
|
||||||
|
),
|
||||||
)
|
)
|
||||||
self.copy()
|
self.copy()
|
||||||
|
|
||||||
@@ -439,21 +435,11 @@ def check_pod(svc):
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
result = svc.client.get(resource, name=name, namespace=namespace)
|
result = svc.client.get(resource, name=name, namespace=namespace)
|
||||||
containers = dict(
|
containers = [
|
||||||
{
|
c["name"] for c in result.to_dict()["status"]["containerStatuses"]
|
||||||
c["name"]: c
|
]
|
||||||
for cl in ["initContainerStatuses", "containerStatuses"]
|
if container and container not in containers:
|
||||||
for c in result.to_dict()["status"].get(cl, [])
|
|
||||||
}
|
|
||||||
)
|
|
||||||
if container and container not in containers.keys():
|
|
||||||
module.fail_json(msg="Pod has no container {0}".format(container))
|
module.fail_json(msg="Pod has no container {0}".format(container))
|
||||||
if (
|
return containers
|
||||||
container
|
|
||||||
and container in containers
|
|
||||||
and not bool(containers[container].get("started", False))
|
|
||||||
):
|
|
||||||
module.fail_json(msg="Pod container {0} is not started".format(container))
|
|
||||||
return containers.keys()
|
|
||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
_fail(exc)
|
_fail(exc)
|
||||||
|
|||||||
@@ -15,9 +15,7 @@ import tempfile
|
|||||||
import traceback
|
import traceback
|
||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
from ansible.module_utils.six import string_types
|
||||||
extract_sensitive_values_from_kubeconfig,
|
|
||||||
)
|
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
||||||
LooseVersion,
|
LooseVersion,
|
||||||
)
|
)
|
||||||
@@ -40,20 +38,16 @@ def parse_helm_plugin_list(output=None):
|
|||||||
if not output:
|
if not output:
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
parsing_grammar = None
|
|
||||||
for line in output:
|
for line in output:
|
||||||
if line.startswith("NAME"):
|
if line.startswith("NAME"):
|
||||||
parsing_grammar = [s.strip().lower() for s in line.split("\t")]
|
|
||||||
continue
|
continue
|
||||||
if parsing_grammar is None:
|
name, version, description = line.split("\t", 3)
|
||||||
|
name = name.strip()
|
||||||
|
version = version.strip()
|
||||||
|
description = description.strip()
|
||||||
|
if name == "":
|
||||||
continue
|
continue
|
||||||
plugin = {
|
ret.append((name, version, description))
|
||||||
parsing_grammar[i]: v.strip()
|
|
||||||
for i, v in enumerate(line.split("\t", len(parsing_grammar)))
|
|
||||||
}
|
|
||||||
if plugin["name"] == "":
|
|
||||||
continue
|
|
||||||
ret.append(plugin)
|
|
||||||
|
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
@@ -119,19 +113,12 @@ class AnsibleHelmModule(object):
|
|||||||
kubeconfig_content = None
|
kubeconfig_content = None
|
||||||
kubeconfig = self.params.get("kubeconfig")
|
kubeconfig = self.params.get("kubeconfig")
|
||||||
if kubeconfig:
|
if kubeconfig:
|
||||||
if isinstance(kubeconfig, str):
|
if isinstance(kubeconfig, string_types):
|
||||||
with open(os.path.expanduser(kubeconfig)) as fd:
|
with open(os.path.expanduser(kubeconfig)) as fd:
|
||||||
kubeconfig_content = yaml.safe_load(fd)
|
kubeconfig_content = yaml.safe_load(fd)
|
||||||
elif isinstance(kubeconfig, dict):
|
elif isinstance(kubeconfig, dict):
|
||||||
kubeconfig_content = kubeconfig
|
kubeconfig_content = kubeconfig
|
||||||
|
|
||||||
# Redact sensitive fields from kubeconfig for logging purposes
|
|
||||||
if kubeconfig_content:
|
|
||||||
# Add original sensitive values to no_log_values to prevent them from appearing in logs
|
|
||||||
self._module.no_log_values.update(
|
|
||||||
extract_sensitive_values_from_kubeconfig(kubeconfig_content)
|
|
||||||
)
|
|
||||||
|
|
||||||
if self.params.get("ca_cert"):
|
if self.params.get("ca_cert"):
|
||||||
ca_cert = self.params.get("ca_cert")
|
ca_cert = self.params.get("ca_cert")
|
||||||
if LooseVersion(self.get_helm_version()) < LooseVersion("3.5.0"):
|
if LooseVersion(self.get_helm_version()) < LooseVersion("3.5.0"):
|
||||||
@@ -206,38 +193,6 @@ class AnsibleHelmModule(object):
|
|||||||
return m.group(1)
|
return m.group(1)
|
||||||
return None
|
return None
|
||||||
|
|
||||||
def is_helm_v4(self):
|
|
||||||
helm_version = self.get_helm_version()
|
|
||||||
if helm_version is None:
|
|
||||||
return False
|
|
||||||
return LooseVersion(helm_version) >= LooseVersion("4.0.0")
|
|
||||||
|
|
||||||
def is_helm_version_compatible_with_helm_diff(self, helm_diff_version):
|
|
||||||
"""
|
|
||||||
Return true if the helm version is compatible with the helm diff version
|
|
||||||
Helm v4 requires helm diff v3.14.0
|
|
||||||
"""
|
|
||||||
if not helm_diff_version:
|
|
||||||
return False
|
|
||||||
if self.is_helm_v4():
|
|
||||||
return LooseVersion(helm_diff_version) >= LooseVersion("3.14.0")
|
|
||||||
return True
|
|
||||||
|
|
||||||
def validate_helm_version(self, version="3.0.0"):
|
|
||||||
"""
|
|
||||||
Validate that Helm version is >= version (default version=3.0.0).
|
|
||||||
"""
|
|
||||||
helm_version = self.get_helm_version()
|
|
||||||
if helm_version is None:
|
|
||||||
self.fail_json(msg="Unable to determine Helm version")
|
|
||||||
|
|
||||||
if LooseVersion(helm_version) < LooseVersion(version):
|
|
||||||
self.fail_json(
|
|
||||||
msg="Helm version must be >= {0}, current version is {1}".format(
|
|
||||||
version, helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
def get_values(self, release_name, get_all=False):
|
def get_values(self, release_name, get_all=False):
|
||||||
"""
|
"""
|
||||||
Get Values from deployed release
|
Get Values from deployed release
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ HELM_AUTH_ARG_SPEC = dict(
|
|||||||
type="raw",
|
type="raw",
|
||||||
aliases=["kubeconfig_path"],
|
aliases=["kubeconfig_path"],
|
||||||
fallback=(env_fallback, ["K8S_AUTH_KUBECONFIG"]),
|
fallback=(env_fallback, ["K8S_AUTH_KUBECONFIG"]),
|
||||||
|
no_log=True,
|
||||||
),
|
),
|
||||||
host=dict(type="str", fallback=(env_fallback, ["K8S_AUTH_HOST"])),
|
host=dict(type="str", fallback=(env_fallback, ["K8S_AUTH_HOST"])),
|
||||||
ca_cert=dict(
|
ca_cert=dict(
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import hashlib
|
|||||||
import os
|
import os
|
||||||
from typing import Any, Dict, List, Optional
|
from typing import Any, Dict, List, Optional
|
||||||
|
|
||||||
|
from ansible.module_utils.six import iteritems, string_types
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||||
AUTH_ARG_MAP,
|
AUTH_ARG_MAP,
|
||||||
AUTH_ARG_SPEC,
|
AUTH_ARG_SPEC,
|
||||||
@@ -114,7 +115,7 @@ def _load_config(auth: Dict) -> None:
|
|||||||
"persist_config": auth.get("persist_config"),
|
"persist_config": auth.get("persist_config"),
|
||||||
}
|
}
|
||||||
if kubeconfig:
|
if kubeconfig:
|
||||||
if isinstance(kubeconfig, str):
|
if isinstance(kubeconfig, string_types):
|
||||||
kubernetes.config.load_kube_config(config_file=kubeconfig, **optional_arg)
|
kubernetes.config.load_kube_config(config_file=kubeconfig, **optional_arg)
|
||||||
elif isinstance(kubeconfig, dict):
|
elif isinstance(kubeconfig, dict):
|
||||||
kubernetes.config.load_kube_config_from_dict(
|
kubernetes.config.load_kube_config_from_dict(
|
||||||
@@ -162,7 +163,7 @@ def _create_configuration(auth: Dict):
|
|||||||
except AttributeError:
|
except AttributeError:
|
||||||
configuration = kubernetes.client.Configuration()
|
configuration = kubernetes.client.Configuration()
|
||||||
|
|
||||||
for key, value in auth.items():
|
for key, value in iteritems(auth):
|
||||||
if key in AUTH_ARG_MAP.keys() and value is not None:
|
if key in AUTH_ARG_MAP.keys() and value is not None:
|
||||||
if key == "api_key":
|
if key == "api_key":
|
||||||
setattr(
|
setattr(
|
||||||
|
|||||||
@@ -3,9 +3,6 @@ from typing import Optional
|
|||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
||||||
from ansible.module_utils.common.text.converters import to_text
|
from ansible.module_utils.common.text.converters import to_text
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
|
||||||
extract_sensitive_values_from_kubeconfig,
|
|
||||||
)
|
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
||||||
LooseVersion,
|
LooseVersion,
|
||||||
)
|
)
|
||||||
@@ -36,15 +33,6 @@ class AnsibleK8SModule:
|
|||||||
|
|
||||||
self._module = self.settings["module_class"](**kwargs)
|
self._module = self.settings["module_class"](**kwargs)
|
||||||
|
|
||||||
# Apply kubeconfig redaction for logging purposes
|
|
||||||
if hasattr(self._module, "params") and hasattr(self._module, "no_log_values"):
|
|
||||||
kubeconfig = self._module.params.get("kubeconfig")
|
|
||||||
if kubeconfig and isinstance(kubeconfig, dict):
|
|
||||||
# Add sensitive values to no_log_values to prevent them from appearing in logs
|
|
||||||
self._module.no_log_values.update(
|
|
||||||
extract_sensitive_values_from_kubeconfig(kubeconfig)
|
|
||||||
)
|
|
||||||
|
|
||||||
if self.settings["check_k8s"]:
|
if self.settings["check_k8s"]:
|
||||||
self.requires("kubernetes")
|
self.requires("kubernetes")
|
||||||
self.has_at_least("kubernetes", "24.2.0", warn=True)
|
self.has_at_least("kubernetes", "24.2.0", warn=True)
|
||||||
|
|||||||
@@ -4,6 +4,7 @@
|
|||||||
import os
|
import os
|
||||||
from typing import Dict, Iterable, List, Optional, Union, cast
|
from typing import Dict, Iterable, List, Optional, Union, cast
|
||||||
|
|
||||||
|
from ansible.module_utils.six import string_types
|
||||||
from ansible.module_utils.urls import Request
|
from ansible.module_utils.urls import Request
|
||||||
|
|
||||||
try:
|
try:
|
||||||
@@ -77,11 +78,11 @@ def create_definitions(params: Dict) -> List[ResourceDefinition]:
|
|||||||
def from_yaml(definition: Union[str, List, Dict]) -> Iterable[Dict]:
|
def from_yaml(definition: Union[str, List, Dict]) -> Iterable[Dict]:
|
||||||
"""Load resource definitions from a yaml definition."""
|
"""Load resource definitions from a yaml definition."""
|
||||||
definitions: List[Dict] = []
|
definitions: List[Dict] = []
|
||||||
if isinstance(definition, str):
|
if isinstance(definition, string_types):
|
||||||
definitions += yaml.safe_load_all(definition)
|
definitions += yaml.safe_load_all(definition)
|
||||||
elif isinstance(definition, list):
|
elif isinstance(definition, list):
|
||||||
for item in definition:
|
for item in definition:
|
||||||
if isinstance(item, str):
|
if isinstance(item, string_types):
|
||||||
definitions += yaml.safe_load_all(item)
|
definitions += yaml.safe_load_all(item)
|
||||||
else:
|
else:
|
||||||
definitions.append(item)
|
definitions.append(item)
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
from typing import Dict
|
from typing import Dict
|
||||||
|
|
||||||
from ansible.module_utils.common.text.converters import to_native
|
from ansible.module_utils._text import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
||||||
get_api_client,
|
get_api_client,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -498,8 +498,8 @@ def diff_objects(
|
|||||||
if not diff:
|
if not diff:
|
||||||
return True, result
|
return True, result
|
||||||
|
|
||||||
result["before"] = hide_fields(diff[0], hidden_fields)
|
result["before"] = diff[0]
|
||||||
result["after"] = hide_fields(diff[1], hidden_fields)
|
result["after"] = diff[1]
|
||||||
|
|
||||||
if list(result["after"].keys()) == ["metadata"] and list(
|
if list(result["after"].keys()) == ["metadata"] and list(
|
||||||
result["before"].keys()
|
result["before"].keys()
|
||||||
@@ -512,6 +512,9 @@ def diff_objects(
|
|||||||
).issubset(ignored_keys):
|
).issubset(ignored_keys):
|
||||||
return True, result
|
return True, result
|
||||||
|
|
||||||
|
result["before"] = hide_fields(result["before"], hidden_fields)
|
||||||
|
result["after"] = hide_fields(result["after"], hidden_fields)
|
||||||
|
|
||||||
return False, result
|
return False, result
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ author:
|
|||||||
- Matthieu Diehr (@d-matt)
|
- Matthieu Diehr (@d-matt)
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
- "helm (https://github.com/helm/helm/releases)"
|
||||||
- "yaml (https://pypi.org/project/PyYAML/)"
|
- "yaml (https://pypi.org/project/PyYAML/)"
|
||||||
|
|
||||||
description:
|
description:
|
||||||
@@ -237,27 +237,6 @@ options:
|
|||||||
default: False
|
default: False
|
||||||
aliases: [ skip_tls_certs_check ]
|
aliases: [ skip_tls_certs_check ]
|
||||||
version_added: 5.3.0
|
version_added: 5.3.0
|
||||||
plain_http:
|
|
||||||
description:
|
|
||||||
- Use HTTP instead of HTTPS when working with OCI registries
|
|
||||||
- Requires Helm >= 3.13.0
|
|
||||||
type: bool
|
|
||||||
default: False
|
|
||||||
version_added: 6.1.0
|
|
||||||
take_ownership:
|
|
||||||
description:
|
|
||||||
- Helm will ignore the check for helm annotations and take ownership of the existing resources
|
|
||||||
- This feature requires helm >= 3.17.0
|
|
||||||
type: bool
|
|
||||||
default: False
|
|
||||||
version_added: 6.1.0
|
|
||||||
skip_schema_validation:
|
|
||||||
description:
|
|
||||||
- Disables JSON schema validation for Chart and values.
|
|
||||||
- This feature requires helm >= 3.16.0
|
|
||||||
type: bool
|
|
||||||
default: False
|
|
||||||
version_added: 6.2.0
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- kubernetes.core.helm_common_options
|
- kubernetes.core.helm_common_options
|
||||||
"""
|
"""
|
||||||
@@ -340,12 +319,6 @@ EXAMPLES = r"""
|
|||||||
chart_ref: "https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz"
|
chart_ref: "https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz"
|
||||||
release_namespace: monitoring
|
release_namespace: monitoring
|
||||||
|
|
||||||
- name: Deploy Bitnami's MongoDB latest chart from OCI registry
|
|
||||||
kubernetes.core.helm:
|
|
||||||
name: test
|
|
||||||
chart_ref: "oci://registry-1.docker.io/bitnamicharts/mongodb"
|
|
||||||
release_namespace: database
|
|
||||||
|
|
||||||
# Using complex Values
|
# Using complex Values
|
||||||
- name: Deploy new-relic client chart
|
- name: Deploy new-relic client chart
|
||||||
kubernetes.core.helm:
|
kubernetes.core.helm:
|
||||||
@@ -419,18 +392,9 @@ status:
|
|||||||
returned: always
|
returned: always
|
||||||
description: The Date of last update
|
description: The Date of last update
|
||||||
values:
|
values:
|
||||||
type: dict
|
type: str
|
||||||
returned: always
|
returned: always
|
||||||
description:
|
description: Dict of Values used to deploy
|
||||||
- Dict of Values used to deploy.
|
|
||||||
- This return value has been deprecated and will be removed in a release after
|
|
||||||
2027-01-08. Use RV(status.release_values) instead.
|
|
||||||
release_values:
|
|
||||||
type: dict
|
|
||||||
returned: always
|
|
||||||
description:
|
|
||||||
- Dict of Values used to deploy.
|
|
||||||
version_added: 6.3.0
|
|
||||||
stdout:
|
stdout:
|
||||||
type: str
|
type: str
|
||||||
description: Full `helm` command stdout, in case you want to display it or examine the event log
|
description: Full `helm` command stdout, in case you want to display it or examine the event log
|
||||||
@@ -500,13 +464,9 @@ def get_release_status(module, release_name, all_status=False):
|
|||||||
"--filter",
|
"--filter",
|
||||||
release_name,
|
release_name,
|
||||||
]
|
]
|
||||||
if all_status and not module.is_helm_v4():
|
if all_status:
|
||||||
# --all has been removed from `helm list` command on helm v4
|
|
||||||
list_command.append("--all")
|
list_command.append("--all")
|
||||||
elif not all_status:
|
|
||||||
# The default behavior to display only deployed releases has been removed from
|
|
||||||
# Helm v4
|
|
||||||
list_command.append("--deployed")
|
|
||||||
rc, out, err = module.run_helm_command(list_command)
|
rc, out, err = module.run_helm_command(list_command)
|
||||||
|
|
||||||
release = get_release(yaml.safe_load(out), release_name)
|
release = get_release(yaml.safe_load(out), release_name)
|
||||||
@@ -514,8 +474,7 @@ def get_release_status(module, release_name, all_status=False):
|
|||||||
if release is None: # not install
|
if release is None: # not install
|
||||||
return None
|
return None
|
||||||
|
|
||||||
release["release_values"] = module.get_values(release_name)
|
release["values"] = module.get_values(release_name)
|
||||||
release["values"] = release["release_values"]
|
|
||||||
|
|
||||||
return release
|
return release
|
||||||
|
|
||||||
@@ -536,9 +495,7 @@ def run_dep_update(module, chart_ref):
|
|||||||
rc, out, err = module.run_helm_command(dep_update)
|
rc, out, err = module.run_helm_command(dep_update)
|
||||||
|
|
||||||
|
|
||||||
def fetch_chart_info(
|
def fetch_chart_info(module, command, chart_ref, insecure_skip_tls_verify=False):
|
||||||
module, command, chart_ref, insecure_skip_tls_verify=False, plain_http=False
|
|
||||||
):
|
|
||||||
"""
|
"""
|
||||||
Get chart info
|
Get chart info
|
||||||
"""
|
"""
|
||||||
@@ -547,17 +504,6 @@ def fetch_chart_info(
|
|||||||
if insecure_skip_tls_verify:
|
if insecure_skip_tls_verify:
|
||||||
inspect_command += " --insecure-skip-tls-verify"
|
inspect_command += " --insecure-skip-tls-verify"
|
||||||
|
|
||||||
if plain_http:
|
|
||||||
helm_version = module.get_helm_version()
|
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.13.0"):
|
|
||||||
module.fail_json(
|
|
||||||
msg="plain_http requires helm >= 3.13.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
inspect_command += " --plain-http"
|
|
||||||
|
|
||||||
rc, out, err = module.run_helm_command(inspect_command)
|
rc, out, err = module.run_helm_command(inspect_command)
|
||||||
|
|
||||||
return yaml.safe_load(out)
|
return yaml.safe_load(out)
|
||||||
@@ -587,9 +533,6 @@ def deploy(
|
|||||||
reset_values=True,
|
reset_values=True,
|
||||||
reset_then_reuse_values=False,
|
reset_then_reuse_values=False,
|
||||||
insecure_skip_tls_verify=False,
|
insecure_skip_tls_verify=False,
|
||||||
plain_http=False,
|
|
||||||
take_ownership=False,
|
|
||||||
skip_schema_validation=False,
|
|
||||||
):
|
):
|
||||||
"""
|
"""
|
||||||
Install/upgrade/rollback release chart
|
Install/upgrade/rollback release chart
|
||||||
@@ -603,8 +546,6 @@ def deploy(
|
|||||||
deploy_command = command + " upgrade -i" # install/upgrade
|
deploy_command = command + " upgrade -i" # install/upgrade
|
||||||
if reset_values:
|
if reset_values:
|
||||||
deploy_command += " --reset-values"
|
deploy_command += " --reset-values"
|
||||||
if take_ownership:
|
|
||||||
deploy_command += " --take-ownership"
|
|
||||||
|
|
||||||
if reuse_values is not None:
|
if reuse_values is not None:
|
||||||
deploy_command += " --reuse-values=" + str(reuse_values)
|
deploy_command += " --reuse-values=" + str(reuse_values)
|
||||||
@@ -654,9 +595,6 @@ def deploy(
|
|||||||
else:
|
else:
|
||||||
deploy_command += " --insecure-skip-tls-verify"
|
deploy_command += " --insecure-skip-tls-verify"
|
||||||
|
|
||||||
if plain_http:
|
|
||||||
deploy_command += " --plain-http"
|
|
||||||
|
|
||||||
if values_files:
|
if values_files:
|
||||||
for value_file in values_files:
|
for value_file in values_files:
|
||||||
deploy_command += " --values=" + value_file
|
deploy_command += " --values=" + value_file
|
||||||
@@ -680,17 +618,6 @@ def deploy(
|
|||||||
if set_value_args:
|
if set_value_args:
|
||||||
deploy_command += " " + set_value_args
|
deploy_command += " " + set_value_args
|
||||||
|
|
||||||
if skip_schema_validation:
|
|
||||||
helm_version = module.get_helm_version()
|
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.16.0"):
|
|
||||||
module.fail_json(
|
|
||||||
msg="skip_schema_validation requires helm >= 3.16.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
deploy_command += " --skip-schema-validation"
|
|
||||||
|
|
||||||
deploy_command += " " + release_name + f" '{chart_name}'"
|
deploy_command += " " + release_name + f" '{chart_name}'"
|
||||||
return deploy_command
|
return deploy_command
|
||||||
|
|
||||||
@@ -743,8 +670,8 @@ def get_plugin_version(plugin):
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
for line in out:
|
for line in out:
|
||||||
if line["name"] == plugin:
|
if line[0] == plugin:
|
||||||
return line["version"]
|
return line[1]
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
@@ -763,8 +690,6 @@ def helmdiff_check(
|
|||||||
reset_values=True,
|
reset_values=True,
|
||||||
reset_then_reuse_values=False,
|
reset_then_reuse_values=False,
|
||||||
insecure_skip_tls_verify=False,
|
insecure_skip_tls_verify=False,
|
||||||
plain_http=False,
|
|
||||||
skip_schema_validation=False,
|
|
||||||
):
|
):
|
||||||
"""
|
"""
|
||||||
Use helm diff to determine if a release would change by upgrading a chart.
|
Use helm diff to determine if a release would change by upgrading a chart.
|
||||||
@@ -820,28 +745,6 @@ def helmdiff_check(
|
|||||||
if insecure_skip_tls_verify:
|
if insecure_skip_tls_verify:
|
||||||
cmd += " --insecure-skip-tls-verify"
|
cmd += " --insecure-skip-tls-verify"
|
||||||
|
|
||||||
if skip_schema_validation:
|
|
||||||
helm_version = module.get_helm_version()
|
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.16.0"):
|
|
||||||
module.fail_json(
|
|
||||||
msg="skip_schema_validation requires helm >= 3.16.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
cmd += " --skip-schema-validation"
|
|
||||||
|
|
||||||
if plain_http:
|
|
||||||
helm_version = module.get_helm_version()
|
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.13.0"):
|
|
||||||
module.fail_json(
|
|
||||||
msg="plain_http requires helm >= 3.13.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
cmd += " --plain-http"
|
|
||||||
|
|
||||||
rc, out, err = module.run_helm_command(cmd)
|
rc, out, err = module.run_helm_command(cmd)
|
||||||
return (len(out.strip()) > 0, out.strip())
|
return (len(out.strip()) > 0, out.strip())
|
||||||
|
|
||||||
@@ -905,9 +808,6 @@ def argument_spec():
|
|||||||
insecure_skip_tls_verify=dict(
|
insecure_skip_tls_verify=dict(
|
||||||
type="bool", default=False, aliases=["skip_tls_certs_check"]
|
type="bool", default=False, aliases=["skip_tls_certs_check"]
|
||||||
),
|
),
|
||||||
plain_http=dict(type="bool", default=False),
|
|
||||||
take_ownership=dict(type="bool", default=False),
|
|
||||||
skip_schema_validation=dict(type="bool", default=False),
|
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
return arg_spec
|
return arg_spec
|
||||||
@@ -932,9 +832,6 @@ def main():
|
|||||||
if not IMP_YAML:
|
if not IMP_YAML:
|
||||||
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
||||||
|
|
||||||
# Validate Helm version >=3.0.0
|
|
||||||
module.validate_helm_version()
|
|
||||||
|
|
||||||
changed = False
|
changed = False
|
||||||
|
|
||||||
chart_ref = module.params.get("chart_ref")
|
chart_ref = module.params.get("chart_ref")
|
||||||
@@ -965,9 +862,6 @@ def main():
|
|||||||
reset_values = module.params.get("reset_values")
|
reset_values = module.params.get("reset_values")
|
||||||
reset_then_reuse_values = module.params.get("reset_then_reuse_values")
|
reset_then_reuse_values = module.params.get("reset_then_reuse_values")
|
||||||
insecure_skip_tls_verify = module.params.get("insecure_skip_tls_verify")
|
insecure_skip_tls_verify = module.params.get("insecure_skip_tls_verify")
|
||||||
plain_http = module.params.get("plain_http")
|
|
||||||
take_ownership = module.params.get("take_ownership")
|
|
||||||
skip_schema_validation = module.params.get("skip_schema_validation")
|
|
||||||
|
|
||||||
if update_repo_cache:
|
if update_repo_cache:
|
||||||
run_repo_update(module)
|
run_repo_update(module)
|
||||||
@@ -977,33 +871,6 @@ def main():
|
|||||||
release_status = get_release_status(module, release_name, all_status=all_status)
|
release_status = get_release_status(module, release_name, all_status=all_status)
|
||||||
|
|
||||||
helm_cmd = module.get_helm_binary()
|
helm_cmd = module.get_helm_binary()
|
||||||
|
|
||||||
if plain_http:
|
|
||||||
helm_version = module.get_helm_version()
|
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.13.0"):
|
|
||||||
module.fail_json(
|
|
||||||
msg="plain_http requires helm >= 3.13.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
if take_ownership:
|
|
||||||
helm_version = module.get_helm_version()
|
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.17.0"):
|
|
||||||
module.fail_json(
|
|
||||||
msg="take_ownership requires helm >= 3.17.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
if skip_schema_validation:
|
|
||||||
helm_version = module.get_helm_version()
|
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.16.0"):
|
|
||||||
module.fail_json(
|
|
||||||
msg="skip_schema_validation requires helm >= 3.16.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
opt_result = {}
|
opt_result = {}
|
||||||
if release_state == "absent" and release_status is not None:
|
if release_state == "absent" and release_status is not None:
|
||||||
# skip release statuses 'uninstalled' and 'uninstalling'
|
# skip release statuses 'uninstalled' and 'uninstalling'
|
||||||
@@ -1014,7 +881,8 @@ def main():
|
|||||||
if wait:
|
if wait:
|
||||||
helm_version = module.get_helm_version()
|
helm_version = module.get_helm_version()
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.7.0"):
|
if LooseVersion(helm_version) < LooseVersion("3.7.0"):
|
||||||
module.warn(
|
opt_result["warnings"] = []
|
||||||
|
opt_result["warnings"].append(
|
||||||
"helm uninstall support option --wait for helm release >= 3.7.0"
|
"helm uninstall support option --wait for helm release >= 3.7.0"
|
||||||
)
|
)
|
||||||
wait = False
|
wait = False
|
||||||
@@ -1032,7 +900,7 @@ def main():
|
|||||||
|
|
||||||
# Fetch chart info to have real version and real name for chart_ref from archive, folder or url
|
# Fetch chart info to have real version and real name for chart_ref from archive, folder or url
|
||||||
chart_info = fetch_chart_info(
|
chart_info = fetch_chart_info(
|
||||||
module, helm_cmd, chart_ref, insecure_skip_tls_verify, plain_http
|
module, helm_cmd, chart_ref, insecure_skip_tls_verify
|
||||||
)
|
)
|
||||||
|
|
||||||
if dependency_update:
|
if dependency_update:
|
||||||
@@ -1094,29 +962,19 @@ def main():
|
|||||||
reset_values=reset_values,
|
reset_values=reset_values,
|
||||||
reset_then_reuse_values=reset_then_reuse_values,
|
reset_then_reuse_values=reset_then_reuse_values,
|
||||||
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
||||||
plain_http=plain_http,
|
|
||||||
take_ownership=take_ownership,
|
|
||||||
skip_schema_validation=skip_schema_validation,
|
|
||||||
)
|
)
|
||||||
changed = True
|
changed = True
|
||||||
|
|
||||||
else:
|
else:
|
||||||
helm_diff_version = get_plugin_version("diff")
|
helm_diff_version = get_plugin_version("diff")
|
||||||
helm_version_compatible = module.is_helm_version_compatible_with_helm_diff(
|
if helm_diff_version and (
|
||||||
helm_diff_version
|
not chart_repo_url
|
||||||
)
|
or (
|
||||||
if (
|
chart_repo_url
|
||||||
helm_diff_version
|
and LooseVersion(helm_diff_version) >= LooseVersion("3.4.1")
|
||||||
and helm_version_compatible
|
|
||||||
and (
|
|
||||||
not chart_repo_url
|
|
||||||
or (
|
|
||||||
chart_repo_url
|
|
||||||
and LooseVersion(helm_diff_version) >= LooseVersion("3.4.1")
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
):
|
):
|
||||||
would_change, prepared = helmdiff_check(
|
(would_change, prepared) = helmdiff_check(
|
||||||
module,
|
module,
|
||||||
release_name,
|
release_name,
|
||||||
chart_ref,
|
chart_ref,
|
||||||
@@ -1131,24 +989,14 @@ def main():
|
|||||||
reset_values=reset_values,
|
reset_values=reset_values,
|
||||||
reset_then_reuse_values=reset_then_reuse_values,
|
reset_then_reuse_values=reset_then_reuse_values,
|
||||||
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
||||||
plain_http=plain_http,
|
|
||||||
skip_schema_validation=skip_schema_validation,
|
|
||||||
)
|
)
|
||||||
if would_change and module._diff:
|
if would_change and module._diff:
|
||||||
opt_result["diff"] = {"prepared": prepared}
|
opt_result["diff"] = {"prepared": prepared}
|
||||||
else:
|
else:
|
||||||
if helm_diff_version and not helm_version_compatible:
|
module.warn(
|
||||||
module.warn(
|
"The default idempotency check can fail to report changes in certain cases. "
|
||||||
"Idempotency checks are currently disabled due to a version mismatch."
|
"Install helm diff >= 3.4.1 for better results."
|
||||||
f" Helm version {module.get_helm_version()} requires helm-diff >= 3.14.0,"
|
)
|
||||||
f" but the environment is currently running {helm_diff_version}."
|
|
||||||
" Please align the plugin versions to restore standard behavior."
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
module.warn(
|
|
||||||
"The default idempotency check can fail to report changes in certain cases. "
|
|
||||||
"Install helm diff >= 3.4.1 for better results."
|
|
||||||
)
|
|
||||||
would_change = default_check(
|
would_change = default_check(
|
||||||
release_status, chart_info, release_values, values_files
|
release_status, chart_info, release_values, values_files
|
||||||
)
|
)
|
||||||
@@ -1178,22 +1026,14 @@ def main():
|
|||||||
reset_values=reset_values,
|
reset_values=reset_values,
|
||||||
reset_then_reuse_values=reset_then_reuse_values,
|
reset_then_reuse_values=reset_then_reuse_values,
|
||||||
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
||||||
plain_http=plain_http,
|
|
||||||
take_ownership=take_ownership,
|
|
||||||
skip_schema_validation=skip_schema_validation,
|
|
||||||
)
|
)
|
||||||
changed = True
|
changed = True
|
||||||
|
|
||||||
if module.check_mode:
|
if module.check_mode:
|
||||||
check_status = {
|
check_status = {"values": {"current": {}, "declared": {}}}
|
||||||
"values": {"current": {}, "declared": {}},
|
|
||||||
"release_values": {"current": {}, "declared": {}},
|
|
||||||
}
|
|
||||||
if release_status:
|
if release_status:
|
||||||
check_status["values"]["current"] = release_status["release_values"]
|
check_status["values"]["current"] = release_status["values"]
|
||||||
check_status["values"]["declared"] = release_status
|
check_status["values"]["declared"] = release_status
|
||||||
check_status["release_values"]["current"] = release_status["release_values"]
|
|
||||||
check_status["release_values"]["declared"] = release_status
|
|
||||||
|
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
changed=changed,
|
changed=changed,
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ author:
|
|||||||
- Lucas Boisserie (@LucasBoisserie)
|
- Lucas Boisserie (@LucasBoisserie)
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
- "helm (https://github.com/helm/helm/releases)"
|
||||||
- "yaml (https://pypi.org/project/PyYAML/)"
|
- "yaml (https://pypi.org/project/PyYAML/)"
|
||||||
|
|
||||||
description:
|
description:
|
||||||
@@ -115,18 +115,9 @@ status:
|
|||||||
returned: always
|
returned: always
|
||||||
description: The Date of last update
|
description: The Date of last update
|
||||||
values:
|
values:
|
||||||
type: dict
|
type: str
|
||||||
returned: always
|
returned: always
|
||||||
description:
|
description: Dict of Values used to deploy
|
||||||
- Dict of Values used to deploy
|
|
||||||
- This return value has been deprecated and will be removed in a release after
|
|
||||||
2027-01-08. Use RV(status.release_values) instead.
|
|
||||||
release_values:
|
|
||||||
type: dict
|
|
||||||
returned: always
|
|
||||||
description:
|
|
||||||
- Dict of Values used to deploy.
|
|
||||||
version_added: 6.3.0
|
|
||||||
hooks:
|
hooks:
|
||||||
type: list
|
type: list
|
||||||
elements: dict
|
elements: dict
|
||||||
@@ -211,8 +202,7 @@ def get_release_status(module, release_name, release_state, get_all_values=False
|
|||||||
if release is None: # not install
|
if release is None: # not install
|
||||||
return None
|
return None
|
||||||
|
|
||||||
release["release_values"] = module.get_values(release_name, get_all_values)
|
release["values"] = module.get_values(release_name, get_all_values)
|
||||||
release["values"] = release["release_values"]
|
|
||||||
release["manifest"] = module.get_manifest(release_name)
|
release["manifest"] = module.get_manifest(release_name)
|
||||||
release["notes"] = module.get_notes(release_name)
|
release["notes"] = module.get_notes(release_name)
|
||||||
release["hooks"] = module.get_hooks(release_name)
|
release["hooks"] = module.get_hooks(release_name)
|
||||||
@@ -245,9 +235,6 @@ def main():
|
|||||||
if not IMP_YAML:
|
if not IMP_YAML:
|
||||||
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
||||||
|
|
||||||
# Validate Helm version >=3.0.0
|
|
||||||
module.validate_helm_version()
|
|
||||||
|
|
||||||
release_name = module.params.get("release_name")
|
release_name = module.params.get("release_name")
|
||||||
release_state = module.params.get("release_state")
|
release_state = module.params.get("release_state")
|
||||||
get_all_values = module.params.get("get_all_values")
|
get_all_values = module.params.get("get_all_values")
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ version_added: 1.0.0
|
|||||||
author:
|
author:
|
||||||
- Abhijeet Kasurde (@Akasurde)
|
- Abhijeet Kasurde (@Akasurde)
|
||||||
requirements:
|
requirements:
|
||||||
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
- "helm (https://github.com/helm/helm/releases)"
|
||||||
description:
|
description:
|
||||||
- Manages Helm plugins.
|
- Manages Helm plugins.
|
||||||
options:
|
options:
|
||||||
@@ -48,14 +48,6 @@ options:
|
|||||||
required: false
|
required: false
|
||||||
type: str
|
type: str
|
||||||
version_added: 2.3.0
|
version_added: 2.3.0
|
||||||
verify:
|
|
||||||
description:
|
|
||||||
- Verify the plugin signature before installing.
|
|
||||||
- This option requires helm version >= 4.0.0
|
|
||||||
- Used with I(state=present).
|
|
||||||
type: bool
|
|
||||||
default: true
|
|
||||||
version_added: 6.4.0
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- kubernetes.core.helm_common_options
|
- kubernetes.core.helm_common_options
|
||||||
"""
|
"""
|
||||||
@@ -126,9 +118,6 @@ from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common i
|
|||||||
HELM_AUTH_ARG_SPEC,
|
HELM_AUTH_ARG_SPEC,
|
||||||
HELM_AUTH_MUTUALLY_EXCLUSIVE,
|
HELM_AUTH_MUTUALLY_EXCLUSIVE,
|
||||||
)
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
|
||||||
LooseVersion,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def argument_spec():
|
def argument_spec():
|
||||||
@@ -149,10 +138,6 @@ def argument_spec():
|
|||||||
default="present",
|
default="present",
|
||||||
choices=["present", "absent", "latest"],
|
choices=["present", "absent", "latest"],
|
||||||
),
|
),
|
||||||
verify=dict(
|
|
||||||
type="bool",
|
|
||||||
default=True,
|
|
||||||
),
|
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
return arg_spec
|
return arg_spec
|
||||||
@@ -176,9 +161,6 @@ def main():
|
|||||||
mutually_exclusive=mutually_exclusive(),
|
mutually_exclusive=mutually_exclusive(),
|
||||||
)
|
)
|
||||||
|
|
||||||
# Validate helm version >= 3.0.0
|
|
||||||
module.validate_helm_version()
|
|
||||||
|
|
||||||
state = module.params.get("state")
|
state = module.params.get("state")
|
||||||
|
|
||||||
helm_cmd_common = module.get_helm_binary() + " plugin"
|
helm_cmd_common = module.get_helm_binary() + " plugin"
|
||||||
@@ -186,19 +168,8 @@ def main():
|
|||||||
if state == "present":
|
if state == "present":
|
||||||
helm_cmd_common += " install %s" % module.params.get("plugin_path")
|
helm_cmd_common += " install %s" % module.params.get("plugin_path")
|
||||||
plugin_version = module.params.get("plugin_version")
|
plugin_version = module.params.get("plugin_version")
|
||||||
verify = module.params.get("verify")
|
|
||||||
if plugin_version is not None:
|
if plugin_version is not None:
|
||||||
helm_cmd_common += " --version=%s" % plugin_version
|
helm_cmd_common += " --version=%s" % plugin_version
|
||||||
if not verify:
|
|
||||||
helm_version = module.get_helm_version()
|
|
||||||
if LooseVersion(helm_version) < LooseVersion("4.0.0"):
|
|
||||||
module.warn(
|
|
||||||
"verify parameter requires helm >= 4.0.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
helm_cmd_common += " --verify=false"
|
|
||||||
if not module.check_mode:
|
if not module.check_mode:
|
||||||
rc, out, err = module.run_helm_command(
|
rc, out, err = module.run_helm_command(
|
||||||
helm_cmd_common, fails_on_error=False
|
helm_cmd_common, fails_on_error=False
|
||||||
@@ -237,9 +208,9 @@ def main():
|
|||||||
elif state == "absent":
|
elif state == "absent":
|
||||||
plugin_name = module.params.get("plugin_name")
|
plugin_name = module.params.get("plugin_name")
|
||||||
rc, output, err, command = module.get_helm_plugin_list()
|
rc, output, err, command = module.get_helm_plugin_list()
|
||||||
plugins = parse_helm_plugin_list(output=output.splitlines())
|
out = parse_helm_plugin_list(output=output.splitlines())
|
||||||
|
|
||||||
if not plugins:
|
if not out:
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
failed=False,
|
failed=False,
|
||||||
changed=False,
|
changed=False,
|
||||||
@@ -250,7 +221,12 @@ def main():
|
|||||||
rc=rc,
|
rc=rc,
|
||||||
)
|
)
|
||||||
|
|
||||||
if all(plugin["name"] != plugin_name for plugin in plugins):
|
found = False
|
||||||
|
for line in out:
|
||||||
|
if line[0] == plugin_name:
|
||||||
|
found = True
|
||||||
|
break
|
||||||
|
if not found:
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
failed=False,
|
failed=False,
|
||||||
changed=False,
|
changed=False,
|
||||||
@@ -288,9 +264,9 @@ def main():
|
|||||||
elif state == "latest":
|
elif state == "latest":
|
||||||
plugin_name = module.params.get("plugin_name")
|
plugin_name = module.params.get("plugin_name")
|
||||||
rc, output, err, command = module.get_helm_plugin_list()
|
rc, output, err, command = module.get_helm_plugin_list()
|
||||||
plugins = parse_helm_plugin_list(output=output.splitlines())
|
out = parse_helm_plugin_list(output=output.splitlines())
|
||||||
|
|
||||||
if not plugins:
|
if not out:
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
failed=False,
|
failed=False,
|
||||||
changed=False,
|
changed=False,
|
||||||
@@ -301,7 +277,12 @@ def main():
|
|||||||
rc=rc,
|
rc=rc,
|
||||||
)
|
)
|
||||||
|
|
||||||
if all(plugin["name"] != plugin_name for plugin in plugins):
|
found = False
|
||||||
|
for line in out:
|
||||||
|
if line[0] == plugin_name:
|
||||||
|
found = True
|
||||||
|
break
|
||||||
|
if not found:
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
failed=False,
|
failed=False,
|
||||||
changed=False,
|
changed=False,
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ version_added: 1.0.0
|
|||||||
author:
|
author:
|
||||||
- Abhijeet Kasurde (@Akasurde)
|
- Abhijeet Kasurde (@Akasurde)
|
||||||
requirements:
|
requirements:
|
||||||
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
- "helm (https://github.com/helm/helm/releases)"
|
||||||
description:
|
description:
|
||||||
- Gather information about Helm plugins installed in namespace.
|
- Gather information about Helm plugins installed in namespace.
|
||||||
options:
|
options:
|
||||||
@@ -98,16 +98,26 @@ def main():
|
|||||||
supports_check_mode=True,
|
supports_check_mode=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Validate helm version >= 3.0.0
|
|
||||||
module.validate_helm_version()
|
|
||||||
|
|
||||||
plugin_name = module.params.get("plugin_name")
|
plugin_name = module.params.get("plugin_name")
|
||||||
|
|
||||||
|
plugin_list = []
|
||||||
|
|
||||||
rc, output, err, command = module.get_helm_plugin_list()
|
rc, output, err, command = module.get_helm_plugin_list()
|
||||||
|
|
||||||
plugins = parse_helm_plugin_list(output=output.splitlines())
|
out = parse_helm_plugin_list(output=output.splitlines())
|
||||||
if plugin_name is not None:
|
|
||||||
plugins = [plugin for plugin in plugins if plugin.get("name") == plugin_name]
|
for line in out:
|
||||||
|
if plugin_name is None:
|
||||||
|
plugin_list.append(
|
||||||
|
{"name": line[0], "version": line[1], "description": line[2]}
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
|
||||||
|
if plugin_name == line[0]:
|
||||||
|
plugin_list.append(
|
||||||
|
{"name": line[0], "version": line[1], "description": line[2]}
|
||||||
|
)
|
||||||
|
break
|
||||||
|
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
changed=True,
|
changed=True,
|
||||||
@@ -115,7 +125,7 @@ def main():
|
|||||||
stdout=output,
|
stdout=output,
|
||||||
stderr=err,
|
stderr=err,
|
||||||
rc=rc,
|
rc=rc,
|
||||||
plugin_list=plugins,
|
plugin_list=plugin_list,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ description:
|
|||||||
- There are options for unpacking the chart after download.
|
- There are options for unpacking the chart after download.
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
- "helm >= 3.0 (https://github.com/helm/helm/releases)"
|
||||||
|
|
||||||
options:
|
options:
|
||||||
chart_ref:
|
chart_ref:
|
||||||
@@ -89,14 +89,6 @@ options:
|
|||||||
- if set to true, will untar the chart after downloading it.
|
- if set to true, will untar the chart after downloading it.
|
||||||
type: bool
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
force:
|
|
||||||
description:
|
|
||||||
- Force download of the chart even if it already exists in the destination directory.
|
|
||||||
- By default, the module will skip downloading if the chart with the same version already exists for idempotency.
|
|
||||||
- When used with O(untar_chart=true), will remove any existing chart directory before extracting.
|
|
||||||
type: bool
|
|
||||||
default: False
|
|
||||||
version_added: 6.3.0
|
|
||||||
destination:
|
destination:
|
||||||
description:
|
description:
|
||||||
- location to write the chart.
|
- location to write the chart.
|
||||||
@@ -122,13 +114,6 @@ options:
|
|||||||
- The path of a helm binary to use.
|
- The path of a helm binary to use.
|
||||||
required: false
|
required: false
|
||||||
type: path
|
type: path
|
||||||
plain_http:
|
|
||||||
description:
|
|
||||||
- Use HTTP instead of HTTPS when working with OCI registries
|
|
||||||
- Requires Helm >= 3.13.0
|
|
||||||
type: bool
|
|
||||||
default: False
|
|
||||||
version_added: 6.1.0
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = r"""
|
EXAMPLES = r"""
|
||||||
@@ -160,23 +145,6 @@ EXAMPLES = r"""
|
|||||||
destination: /path/to/chart
|
destination: /path/to/chart
|
||||||
username: myuser
|
username: myuser
|
||||||
password: mypassword123
|
password: mypassword123
|
||||||
|
|
||||||
- name: Download Chart (force re-download even if exists)
|
|
||||||
kubernetes.core.helm_pull:
|
|
||||||
chart_ref: redis
|
|
||||||
repo_url: https://charts.bitnami.com/bitnami
|
|
||||||
chart_version: '17.0.0'
|
|
||||||
destination: /path/to/chart
|
|
||||||
force: yes
|
|
||||||
|
|
||||||
- name: Download and untar chart (force re-extraction even if directory exists)
|
|
||||||
kubernetes.core.helm_pull:
|
|
||||||
chart_ref: redis
|
|
||||||
repo_url: https://charts.bitnami.com/bitnami
|
|
||||||
chart_version: '17.0.0'
|
|
||||||
destination: /path/to/chart
|
|
||||||
untar_chart: yes
|
|
||||||
force: yes
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
RETURN = r"""
|
RETURN = r"""
|
||||||
@@ -195,11 +163,6 @@ command:
|
|||||||
description: Full `helm pull` command built by this module, in case you want to re-run the command outside the module or debug a problem.
|
description: Full `helm pull` command built by this module, in case you want to re-run the command outside the module or debug a problem.
|
||||||
returned: always
|
returned: always
|
||||||
sample: helm pull --repo test ...
|
sample: helm pull --repo test ...
|
||||||
msg:
|
|
||||||
type: str
|
|
||||||
description: A message indicating the result of the operation.
|
|
||||||
returned: when chart already exists
|
|
||||||
sample: Chart redis version 17.0.0 already exists in destination directory
|
|
||||||
rc:
|
rc:
|
||||||
type: int
|
type: int
|
||||||
description: Helm pull command return code
|
description: Helm pull command return code
|
||||||
@@ -207,18 +170,6 @@ rc:
|
|||||||
sample: 1
|
sample: 1
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
|
||||||
import shutil
|
|
||||||
import tarfile
|
|
||||||
import uuid
|
|
||||||
|
|
||||||
try:
|
|
||||||
import yaml
|
|
||||||
|
|
||||||
HAS_YAML = True
|
|
||||||
except ImportError:
|
|
||||||
HAS_YAML = False
|
|
||||||
|
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
||||||
AnsibleHelmModule,
|
AnsibleHelmModule,
|
||||||
)
|
)
|
||||||
@@ -227,115 +178,6 @@ from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def extract_chart_name(chart_ref):
|
|
||||||
"""
|
|
||||||
Extract chart name from chart reference.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
chart_ref (str): Chart reference (name, URL, or OCI reference)
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
str: Extracted chart name
|
|
||||||
"""
|
|
||||||
chart_name = chart_ref.split("/")[-1]
|
|
||||||
# Remove any query parameters or fragments from URL-based refs
|
|
||||||
if "?" in chart_name:
|
|
||||||
chart_name = chart_name.split("?")[0]
|
|
||||||
if "#" in chart_name:
|
|
||||||
chart_name = chart_name.split("#")[0]
|
|
||||||
# Remove .tgz extension if present
|
|
||||||
if chart_name.endswith(".tgz"):
|
|
||||||
chart_name = chart_name[:-4]
|
|
||||||
return chart_name
|
|
||||||
|
|
||||||
|
|
||||||
def chart_exists(destination, chart_ref, chart_version, untar_chart):
|
|
||||||
"""
|
|
||||||
Check if the chart already exists in the destination directory.
|
|
||||||
|
|
||||||
For untarred charts: check if directory exists with Chart.yaml matching version
|
|
||||||
For tarred charts: check if .tgz file exists and contains matching version
|
|
||||||
|
|
||||||
Args:
|
|
||||||
destination (str): Destination directory path
|
|
||||||
chart_ref (str): Chart reference (name or URL)
|
|
||||||
chart_version (str): Chart version to check for
|
|
||||||
untar_chart (bool): Whether to check for untarred or tarred chart
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
bool: True if chart with matching version exists, False otherwise
|
|
||||||
"""
|
|
||||||
# YAML is required for version checking
|
|
||||||
if not HAS_YAML:
|
|
||||||
return False
|
|
||||||
|
|
||||||
# Without version, we can't reliably check
|
|
||||||
if not chart_version:
|
|
||||||
return False
|
|
||||||
|
|
||||||
# Extract chart name from chart_ref using shared helper
|
|
||||||
chart_name = extract_chart_name(chart_ref)
|
|
||||||
|
|
||||||
if untar_chart:
|
|
||||||
# Check for extracted directory
|
|
||||||
chart_dir = os.path.join(destination, chart_name)
|
|
||||||
chart_yaml_path = os.path.join(chart_dir, "Chart.yaml")
|
|
||||||
|
|
||||||
if os.path.isdir(chart_dir) and os.path.isfile(chart_yaml_path):
|
|
||||||
try:
|
|
||||||
with open(chart_yaml_path, "r", encoding="utf-8") as chart_file:
|
|
||||||
chart_metadata = yaml.safe_load(chart_file)
|
|
||||||
# Ensure chart_metadata is a dict and has a version that matches
|
|
||||||
if (
|
|
||||||
chart_metadata
|
|
||||||
and isinstance(chart_metadata, dict)
|
|
||||||
and chart_metadata.get("version") == chart_version
|
|
||||||
and chart_metadata.get("name") == chart_name
|
|
||||||
):
|
|
||||||
return True
|
|
||||||
except (yaml.YAMLError, IOError, OSError, TypeError):
|
|
||||||
# If we can't read or parse the file, treat as non-existent
|
|
||||||
pass
|
|
||||||
else:
|
|
||||||
# Check for .tgz file
|
|
||||||
chart_file = os.path.join(destination, f"{chart_name}-{chart_version}.tgz")
|
|
||||||
|
|
||||||
if os.path.isfile(chart_file):
|
|
||||||
try:
|
|
||||||
# Verify it's a valid tarball with matching version
|
|
||||||
with tarfile.open(chart_file, "r:gz") as tar:
|
|
||||||
# Try to extract Chart.yaml to verify version
|
|
||||||
# Look for Chart.yaml at the expected path: <chart-name>/Chart.yaml
|
|
||||||
expected_chart_yaml = f"{chart_name}/Chart.yaml"
|
|
||||||
try:
|
|
||||||
member = tar.getmember(expected_chart_yaml)
|
|
||||||
chart_yaml_file = tar.extractfile(member)
|
|
||||||
if chart_yaml_file:
|
|
||||||
try:
|
|
||||||
chart_metadata = yaml.safe_load(chart_yaml_file)
|
|
||||||
# Ensure chart_metadata is a dict and has a version that matches
|
|
||||||
if (
|
|
||||||
chart_metadata
|
|
||||||
and isinstance(chart_metadata, dict)
|
|
||||||
and chart_metadata.get("version") == chart_version
|
|
||||||
and chart_metadata.get("name") == chart_name
|
|
||||||
):
|
|
||||||
return True
|
|
||||||
except (yaml.YAMLError, TypeError):
|
|
||||||
# If we can't parse the YAML, treat as non-existent
|
|
||||||
pass
|
|
||||||
finally:
|
|
||||||
chart_yaml_file.close()
|
|
||||||
except KeyError:
|
|
||||||
# Chart.yaml not found at expected path
|
|
||||||
pass
|
|
||||||
except (tarfile.TarError, yaml.YAMLError, IOError, OSError, TypeError):
|
|
||||||
# If we can't read or parse the tarball, treat as non-existent
|
|
||||||
pass
|
|
||||||
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
argspec = dict(
|
argspec = dict(
|
||||||
chart_ref=dict(type="str", required=True),
|
chart_ref=dict(type="str", required=True),
|
||||||
@@ -354,13 +196,11 @@ def main():
|
|||||||
),
|
),
|
||||||
chart_devel=dict(type="bool"),
|
chart_devel=dict(type="bool"),
|
||||||
untar_chart=dict(type="bool", default=False),
|
untar_chart=dict(type="bool", default=False),
|
||||||
force=dict(type="bool", default=False),
|
|
||||||
destination=dict(type="path", required=True),
|
destination=dict(type="path", required=True),
|
||||||
chart_ca_cert=dict(type="path"),
|
chart_ca_cert=dict(type="path"),
|
||||||
chart_ssl_cert_file=dict(type="path"),
|
chart_ssl_cert_file=dict(type="path"),
|
||||||
chart_ssl_key_file=dict(type="path"),
|
chart_ssl_key_file=dict(type="path"),
|
||||||
binary_path=dict(type="path"),
|
binary_path=dict(type="path"),
|
||||||
plain_http=dict(type="bool", default=False),
|
|
||||||
)
|
)
|
||||||
module = AnsibleHelmModule(
|
module = AnsibleHelmModule(
|
||||||
argument_spec=argspec,
|
argument_spec=argspec,
|
||||||
@@ -372,17 +212,19 @@ def main():
|
|||||||
mutually_exclusive=[("chart_version", "chart_devel")],
|
mutually_exclusive=[("chart_version", "chart_devel")],
|
||||||
)
|
)
|
||||||
|
|
||||||
# Validate Helm version >=3.0.0
|
|
||||||
module.validate_helm_version()
|
|
||||||
|
|
||||||
helm_version = module.get_helm_version()
|
helm_version = module.get_helm_version()
|
||||||
|
if LooseVersion(helm_version) < LooseVersion("3.0.0"):
|
||||||
|
module.fail_json(
|
||||||
|
msg="This module requires helm >= 3.0.0, current version is {0}".format(
|
||||||
|
helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
helm_pull_opt_versionning = dict(
|
helm_pull_opt_versionning = dict(
|
||||||
skip_tls_certs_check="3.3.0",
|
skip_tls_certs_check="3.3.0",
|
||||||
chart_ca_cert="3.1.0",
|
chart_ca_cert="3.1.0",
|
||||||
chart_ssl_cert_file="3.1.0",
|
chart_ssl_cert_file="3.1.0",
|
||||||
chart_ssl_key_file="3.1.0",
|
chart_ssl_key_file="3.1.0",
|
||||||
plain_http="3.13.0",
|
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_version_requirement(opt):
|
def test_version_requirement(opt):
|
||||||
@@ -422,7 +264,6 @@ def main():
|
|||||||
skip_tls_certs_check=dict(key="insecure-skip-tls-verify"),
|
skip_tls_certs_check=dict(key="insecure-skip-tls-verify"),
|
||||||
chart_devel=dict(key="devel"),
|
chart_devel=dict(key="devel"),
|
||||||
untar_chart=dict(key="untar"),
|
untar_chart=dict(key="untar"),
|
||||||
plain_http=dict(key="plain-http"),
|
|
||||||
)
|
)
|
||||||
|
|
||||||
for k, v in helm_flag_args.items():
|
for k, v in helm_flag_args.items():
|
||||||
@@ -435,72 +276,8 @@ def main():
|
|||||||
module.params.get("chart_ref"),
|
module.params.get("chart_ref"),
|
||||||
" ".join(helm_pull_opts),
|
" ".join(helm_pull_opts),
|
||||||
)
|
)
|
||||||
|
|
||||||
# Check if chart already exists (idempotency)
|
|
||||||
if module.params.get("chart_version") and not module.params.get("force"):
|
|
||||||
chart_exists_locally = chart_exists(
|
|
||||||
module.params.get("destination"),
|
|
||||||
module.params.get("chart_ref"),
|
|
||||||
module.params.get("chart_version"),
|
|
||||||
module.params.get("untar_chart"),
|
|
||||||
)
|
|
||||||
|
|
||||||
if chart_exists_locally:
|
|
||||||
module.exit_json(
|
|
||||||
failed=False,
|
|
||||||
changed=False,
|
|
||||||
msg="Chart {0} version {1} already exists in destination directory".format(
|
|
||||||
module.params.get("chart_ref"), module.params.get("chart_version")
|
|
||||||
),
|
|
||||||
command="",
|
|
||||||
stdout="",
|
|
||||||
stderr="",
|
|
||||||
rc=0,
|
|
||||||
)
|
|
||||||
|
|
||||||
# When both untar_chart and force are enabled, we need to remove the existing chart directory
|
|
||||||
# BEFORE running helm pull to prevent helm's "directory already exists" error.
|
|
||||||
# We do this by:
|
|
||||||
# 1. Renaming the existing directory to a temporary name (if it exists)
|
|
||||||
# 2. Running helm pull
|
|
||||||
# 3. On success: remove the temporary directory
|
|
||||||
# 4. On failure: restore the temporary directory and report the error
|
|
||||||
chart_dir_renamed = False
|
|
||||||
chart_dir = None
|
|
||||||
chart_dir_backup = None
|
|
||||||
|
|
||||||
if module.params.get("untar_chart") and module.params.get("force"):
|
|
||||||
chart_name = extract_chart_name(module.params.get("chart_ref"))
|
|
||||||
chart_dir = os.path.join(module.params.get("destination"), chart_name)
|
|
||||||
|
|
||||||
# Check if directory exists and contains a Chart.yaml (to be safe)
|
|
||||||
if os.path.isdir(chart_dir):
|
|
||||||
chart_yaml_path = os.path.join(chart_dir, "Chart.yaml")
|
|
||||||
# Only rename if it looks like a Helm chart directory (have Chart.yaml)
|
|
||||||
if os.path.isfile(chart_yaml_path):
|
|
||||||
if not module.check_mode:
|
|
||||||
# Rename to temporary backup name using uuid for uniqueness
|
|
||||||
backup_suffix = uuid.uuid4().hex[:8]
|
|
||||||
chart_dir_backup = os.path.join(
|
|
||||||
module.params.get("destination"),
|
|
||||||
f".{chart_name}_backup_{backup_suffix}",
|
|
||||||
)
|
|
||||||
os.rename(chart_dir, chart_dir_backup)
|
|
||||||
chart_dir_renamed = True
|
|
||||||
|
|
||||||
if not module.check_mode:
|
if not module.check_mode:
|
||||||
rc, out, err = module.run_helm_command(helm_cmd_common, fails_on_error=False)
|
rc, out, err = module.run_helm_command(helm_cmd_common, fails_on_error=False)
|
||||||
|
|
||||||
# Handle cleanup/restore based on helm command result
|
|
||||||
if chart_dir_renamed:
|
|
||||||
if rc == 0:
|
|
||||||
# Success: remove the backup directory
|
|
||||||
if os.path.isdir(chart_dir_backup):
|
|
||||||
shutil.rmtree(chart_dir_backup)
|
|
||||||
else:
|
|
||||||
# Failure: restore the backup directory
|
|
||||||
if os.path.isdir(chart_dir_backup) and not os.path.exists(chart_dir):
|
|
||||||
os.rename(chart_dir_backup, chart_dir)
|
|
||||||
else:
|
else:
|
||||||
rc, out, err = (0, "", "")
|
rc, out, err = (0, "", "")
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ author:
|
|||||||
- Yuriy Novostavskiy (@yurnov)
|
- Yuriy Novostavskiy (@yurnov)
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "helm (https://github.com/helm/helm/releases) >= 3.8.0"
|
- "helm (https://github.com/helm/helm/releases) => 3.8.0"
|
||||||
|
|
||||||
description:
|
description:
|
||||||
- Helm registry authentication module allows you to login C(helm registry login) and logout C(helm registry logout) from a Helm registry.
|
- Helm registry authentication module allows you to login C(helm registry login) and logout C(helm registry logout) from a Helm registry.
|
||||||
@@ -75,14 +75,6 @@ options:
|
|||||||
- Path to the CA certificate SSL file for verify registry server certificate.
|
- Path to the CA certificate SSL file for verify registry server certificate.
|
||||||
required: false
|
required: false
|
||||||
type: path
|
type: path
|
||||||
plain_http:
|
|
||||||
description:
|
|
||||||
- Use insecure HTTP connections for C(helm registry login).
|
|
||||||
- Requires Helm >= 3.18.0
|
|
||||||
required: false
|
|
||||||
type: bool
|
|
||||||
default: False
|
|
||||||
version_added: 6.4.0
|
|
||||||
binary_path:
|
binary_path:
|
||||||
description:
|
description:
|
||||||
- The path of a helm binary to use.
|
- The path of a helm binary to use.
|
||||||
@@ -156,7 +148,6 @@ def arg_spec():
|
|||||||
key_file=dict(type="path", required=False),
|
key_file=dict(type="path", required=False),
|
||||||
cert_file=dict(type="path", required=False),
|
cert_file=dict(type="path", required=False),
|
||||||
ca_file=dict(type="path", required=False),
|
ca_file=dict(type="path", required=False),
|
||||||
plain_http=dict(type="bool", default=False),
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -169,7 +160,6 @@ def login(
|
|||||||
key_file,
|
key_file,
|
||||||
cert_file,
|
cert_file,
|
||||||
ca_file,
|
ca_file,
|
||||||
plain_http,
|
|
||||||
):
|
):
|
||||||
login_command = command + " registry login " + host
|
login_command = command + " registry login " + host
|
||||||
|
|
||||||
@@ -187,8 +177,6 @@ def login(
|
|||||||
|
|
||||||
if ca_file is not None:
|
if ca_file is not None:
|
||||||
login_command += " --ca-file=" + ca_file
|
login_command += " --ca-file=" + ca_file
|
||||||
if plain_http:
|
|
||||||
login_command += " --plain-http"
|
|
||||||
|
|
||||||
return login_command
|
return login_command
|
||||||
|
|
||||||
@@ -206,9 +194,6 @@ def main():
|
|||||||
supports_check_mode=True,
|
supports_check_mode=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
# Validate Helm version >=3.8.0
|
|
||||||
module.validate_helm_version(version="3.8.0")
|
|
||||||
|
|
||||||
changed = False
|
changed = False
|
||||||
|
|
||||||
host = module.params.get("host")
|
host = module.params.get("host")
|
||||||
@@ -219,19 +204,6 @@ def main():
|
|||||||
key_file = module.params.get("key_file")
|
key_file = module.params.get("key_file")
|
||||||
cert_file = module.params.get("cert_file")
|
cert_file = module.params.get("cert_file")
|
||||||
ca_file = module.params.get("ca_file")
|
ca_file = module.params.get("ca_file")
|
||||||
plain_http = module.params.get("plain_http")
|
|
||||||
|
|
||||||
helm_version = module.get_helm_version()
|
|
||||||
|
|
||||||
if plain_http:
|
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.18.0"):
|
|
||||||
module.warn(
|
|
||||||
"plain_http option requires helm >= 3.18.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
# reset option
|
|
||||||
plain_http = False
|
|
||||||
|
|
||||||
helm_cmd = module.get_helm_binary()
|
helm_cmd = module.get_helm_binary()
|
||||||
|
|
||||||
@@ -240,15 +212,7 @@ def main():
|
|||||||
changed = True
|
changed = True
|
||||||
elif state == "present":
|
elif state == "present":
|
||||||
helm_cmd = login(
|
helm_cmd = login(
|
||||||
helm_cmd,
|
helm_cmd, host, insecure, username, password, key_file, cert_file, ca_file
|
||||||
host,
|
|
||||||
insecure,
|
|
||||||
username,
|
|
||||||
password,
|
|
||||||
key_file,
|
|
||||||
cert_file,
|
|
||||||
ca_file,
|
|
||||||
plain_http,
|
|
||||||
)
|
)
|
||||||
changed = True
|
changed = True
|
||||||
|
|
||||||
@@ -271,6 +235,7 @@ def main():
|
|||||||
command=helm_cmd,
|
command=helm_cmd,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
helm_version = module.get_helm_version()
|
||||||
if LooseVersion(helm_version) >= LooseVersion("3.18.0") and state == "absent":
|
if LooseVersion(helm_version) >= LooseVersion("3.18.0") and state == "absent":
|
||||||
# https://github.com/ansible-collections/kubernetes.core/issues/944
|
# https://github.com/ansible-collections/kubernetes.core/issues/944
|
||||||
module.warn(
|
module.warn(
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ author:
|
|||||||
- Lucas Boisserie (@LucasBoisserie)
|
- Lucas Boisserie (@LucasBoisserie)
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
- "helm (https://github.com/helm/helm/releases)"
|
||||||
- "yaml (https://pypi.org/project/PyYAML/)"
|
- "yaml (https://pypi.org/project/PyYAML/)"
|
||||||
|
|
||||||
description:
|
description:
|
||||||
@@ -295,9 +295,6 @@ def main():
|
|||||||
if not IMP_YAML:
|
if not IMP_YAML:
|
||||||
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
||||||
|
|
||||||
# Validate Helm version >= 3.0.0
|
|
||||||
module.validate_helm_version()
|
|
||||||
|
|
||||||
changed = False
|
changed = False
|
||||||
|
|
||||||
repo_name = module.params.get("repo_name")
|
repo_name = module.params.get("repo_name")
|
||||||
|
|||||||
@@ -21,10 +21,6 @@ author:
|
|||||||
description:
|
description:
|
||||||
- Render chart templates to an output directory or as text of concatenated yaml documents.
|
- Render chart templates to an output directory or as text of concatenated yaml documents.
|
||||||
|
|
||||||
requirements:
|
|
||||||
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
|
||||||
- "yaml (https://pypi.org/project/PyYAML/)"
|
|
||||||
|
|
||||||
options:
|
options:
|
||||||
binary_path:
|
binary_path:
|
||||||
description:
|
description:
|
||||||
@@ -151,13 +147,6 @@ options:
|
|||||||
- json
|
- json
|
||||||
- file
|
- file
|
||||||
version_added: 2.4.0
|
version_added: 2.4.0
|
||||||
plain_http:
|
|
||||||
description:
|
|
||||||
- Use HTTP instead of HTTPS when working with OCI registries
|
|
||||||
- Requires Helm >= 3.13.0
|
|
||||||
type: bool
|
|
||||||
default: False
|
|
||||||
version_added: 6.1.0
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = r"""
|
EXAMPLES = r"""
|
||||||
@@ -229,9 +218,6 @@ from ansible.module_utils.basic import missing_required_lib
|
|||||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
||||||
AnsibleHelmModule,
|
AnsibleHelmModule,
|
||||||
)
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
|
||||||
LooseVersion,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def template(
|
def template(
|
||||||
@@ -250,7 +236,6 @@ def template(
|
|||||||
values_files=None,
|
values_files=None,
|
||||||
include_crds=False,
|
include_crds=False,
|
||||||
set_values=None,
|
set_values=None,
|
||||||
plain_http=False,
|
|
||||||
):
|
):
|
||||||
cmd += " template "
|
cmd += " template "
|
||||||
|
|
||||||
@@ -277,9 +262,6 @@ def template(
|
|||||||
if insecure_registry:
|
if insecure_registry:
|
||||||
cmd += " --insecure-skip-tls-verify"
|
cmd += " --insecure-skip-tls-verify"
|
||||||
|
|
||||||
if plain_http:
|
|
||||||
cmd += " --plain-http"
|
|
||||||
|
|
||||||
if show_only:
|
if show_only:
|
||||||
for template in show_only:
|
for template in show_only:
|
||||||
cmd += " -s " + template
|
cmd += " -s " + template
|
||||||
@@ -325,7 +307,6 @@ def main():
|
|||||||
values_files=dict(type="list", default=[], elements="str"),
|
values_files=dict(type="list", default=[], elements="str"),
|
||||||
update_repo_cache=dict(type="bool", default=False),
|
update_repo_cache=dict(type="bool", default=False),
|
||||||
set_values=dict(type="list", elements="dict"),
|
set_values=dict(type="list", elements="dict"),
|
||||||
plain_http=dict(type="bool", default=False),
|
|
||||||
),
|
),
|
||||||
supports_check_mode=True,
|
supports_check_mode=True,
|
||||||
)
|
)
|
||||||
@@ -346,25 +327,12 @@ def main():
|
|||||||
values_files = module.params.get("values_files")
|
values_files = module.params.get("values_files")
|
||||||
update_repo_cache = module.params.get("update_repo_cache")
|
update_repo_cache = module.params.get("update_repo_cache")
|
||||||
set_values = module.params.get("set_values")
|
set_values = module.params.get("set_values")
|
||||||
plain_http = module.params.get("plain_http")
|
|
||||||
|
|
||||||
if not IMP_YAML:
|
if not IMP_YAML:
|
||||||
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
||||||
|
|
||||||
# Validate Helm version >=3.0.0
|
|
||||||
module.validate_helm_version()
|
|
||||||
|
|
||||||
helm_cmd = module.get_helm_binary()
|
helm_cmd = module.get_helm_binary()
|
||||||
|
|
||||||
if plain_http:
|
|
||||||
helm_version = module.get_helm_version()
|
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.13.0"):
|
|
||||||
module.fail_json(
|
|
||||||
msg="plain_http requires helm >= 3.13.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
if update_repo_cache:
|
if update_repo_cache:
|
||||||
update_cmd = helm_cmd + " repo update"
|
update_cmd = helm_cmd + " repo update"
|
||||||
module.run_helm_command(update_cmd)
|
module.run_helm_command(update_cmd)
|
||||||
@@ -389,7 +357,6 @@ def main():
|
|||||||
values_files=values_files,
|
values_files=values_files,
|
||||||
include_crds=include_crds,
|
include_crds=include_crds,
|
||||||
set_values=set_values_args,
|
set_values=set_values_args,
|
||||||
plain_http=plain_http,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
if not check_mode:
|
if not check_mode:
|
||||||
|
|||||||
@@ -383,24 +383,28 @@ result:
|
|||||||
contains:
|
contains:
|
||||||
api_version:
|
api_version:
|
||||||
description: The versioned schema of this representation of an object.
|
description: The versioned schema of this representation of an object.
|
||||||
returned: when O(resource_definition) or O(src) contains a single object.
|
returned: success
|
||||||
type: str
|
type: str
|
||||||
kind:
|
kind:
|
||||||
description: Represents the REST resource this object represents.
|
description: Represents the REST resource this object represents.
|
||||||
returned: when O(resource_definition) or O(src) contains a single object.
|
returned: success
|
||||||
type: str
|
type: str
|
||||||
metadata:
|
metadata:
|
||||||
description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
|
description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
|
||||||
returned: when O(resource_definition) or O(src) contains a single object.
|
returned: success
|
||||||
type: complex
|
type: complex
|
||||||
spec:
|
spec:
|
||||||
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
|
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
|
||||||
returned: when O(resource_definition) or O(src) contains a single object.
|
returned: success
|
||||||
type: complex
|
type: complex
|
||||||
status:
|
status:
|
||||||
description: Current status details for the object.
|
description: Current status details for the object.
|
||||||
returned: when O(resource_definition) or O(src) contains a single object.
|
returned: success
|
||||||
type: complex
|
type: complex
|
||||||
|
items:
|
||||||
|
description: Returned only when multiple yaml documents are passed to src or resource_definition
|
||||||
|
returned: when resource_definition or src contains list of objects
|
||||||
|
type: list
|
||||||
duration:
|
duration:
|
||||||
description: elapsed time of task in seconds
|
description: elapsed time of task in seconds
|
||||||
returned: when C(wait) is true
|
returned: when C(wait) is true
|
||||||
@@ -410,46 +414,6 @@ result:
|
|||||||
description: error while trying to create/delete the object.
|
description: error while trying to create/delete the object.
|
||||||
returned: error
|
returned: error
|
||||||
type: complex
|
type: complex
|
||||||
results:
|
|
||||||
description: An array of created, patched, or otherwise present objects.
|
|
||||||
returned: when O(resource_definition) or O(src) contains a list of objects.
|
|
||||||
type: complex
|
|
||||||
contains:
|
|
||||||
api_version:
|
|
||||||
description: The versioned schema of this representation of an object.
|
|
||||||
returned: when O(resource_definition) or O(src) contains a single object.
|
|
||||||
type: str
|
|
||||||
kind:
|
|
||||||
description: Represents the REST resource this object represents.
|
|
||||||
returned: when O(resource_definition) or O(src) contains a single object.
|
|
||||||
type: str
|
|
||||||
metadata:
|
|
||||||
description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
|
|
||||||
returned: when O(resource_definition) or O(src) contains a single object.
|
|
||||||
type: complex
|
|
||||||
spec:
|
|
||||||
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
|
|
||||||
returned: when O(resource_definition) or O(src) contains a single object.
|
|
||||||
type: complex
|
|
||||||
status:
|
|
||||||
description: Current status details for the object.
|
|
||||||
returned: when O(resource_definition) or O(src) contains a single object.
|
|
||||||
type: complex
|
|
||||||
duration:
|
|
||||||
description: elapsed time of task in seconds
|
|
||||||
returned: when C(wait) is true
|
|
||||||
type: int
|
|
||||||
sample: 48
|
|
||||||
error:
|
|
||||||
description: error while trying to create/delete the object.
|
|
||||||
returned: error
|
|
||||||
type: complex
|
|
||||||
method:
|
|
||||||
description:
|
|
||||||
- The method used to deploy the resource.
|
|
||||||
returned: success
|
|
||||||
type: str
|
|
||||||
sample: create
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import copy
|
import copy
|
||||||
|
|||||||
@@ -79,7 +79,6 @@ options:
|
|||||||
|
|
||||||
notes:
|
notes:
|
||||||
- the tar binary is required on the container when copying from local filesystem to pod.
|
- the tar binary is required on the container when copying from local filesystem to pod.
|
||||||
- the (init) container has to be started before you copy files or directories to it.
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = r"""
|
EXAMPLES = r"""
|
||||||
@@ -140,7 +139,7 @@ result:
|
|||||||
|
|
||||||
import copy
|
import copy
|
||||||
|
|
||||||
from ansible.module_utils.common.text.converters import to_native
|
from ansible.module_utils._text import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -149,7 +149,7 @@ import time
|
|||||||
import traceback
|
import traceback
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
|
|
||||||
from ansible.module_utils.common.text.converters import to_native
|
from ansible.module_utils._text import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
@@ -230,7 +230,7 @@ def filter_pods(pods, force, ignore_daemonset, delete_emptydir_data):
|
|||||||
else:
|
else:
|
||||||
to_delete.append((pod.metadata.namespace, pod.metadata.name))
|
to_delete.append((pod.metadata.namespace, pod.metadata.name))
|
||||||
|
|
||||||
warnings, errors, info = [], [], []
|
warnings, errors = [], []
|
||||||
if unmanaged:
|
if unmanaged:
|
||||||
pod_names = ",".join([pod[0] + "/" + pod[1] for pod in unmanaged])
|
pod_names = ",".join([pod[0] + "/" + pod[1] for pod in unmanaged])
|
||||||
if not force:
|
if not force:
|
||||||
@@ -242,7 +242,7 @@ def filter_pods(pods, force, ignore_daemonset, delete_emptydir_data):
|
|||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
# Pod not managed will be deleted as 'force' is true
|
# Pod not managed will be deleted as 'force' is true
|
||||||
info.append(
|
warnings.append(
|
||||||
"Deleting Pods not managed by ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet: {0}.".format(
|
"Deleting Pods not managed by ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet: {0}.".format(
|
||||||
pod_names
|
pod_names
|
||||||
)
|
)
|
||||||
@@ -264,7 +264,7 @@ def filter_pods(pods, force, ignore_daemonset, delete_emptydir_data):
|
|||||||
"cannot delete Pods with local storage: {0}.".format(pod_names)
|
"cannot delete Pods with local storage: {0}.".format(pod_names)
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
info.append("Deleting Pods with local storage: {0}.".format(pod_names))
|
warnings.append("Deleting Pods with local storage: {0}.".format(pod_names))
|
||||||
for pod in localStorage:
|
for pod in localStorage:
|
||||||
to_delete.append((pod[0], pod[1]))
|
to_delete.append((pod[0], pod[1]))
|
||||||
|
|
||||||
@@ -278,8 +278,8 @@ def filter_pods(pods, force, ignore_daemonset, delete_emptydir_data):
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
info.append("Ignoring DaemonSet-managed Pods: {0}.".format(pod_names))
|
warnings.append("Ignoring DaemonSet-managed Pods: {0}.".format(pod_names))
|
||||||
return to_delete, warnings, errors, info
|
return to_delete, warnings, errors
|
||||||
|
|
||||||
|
|
||||||
class K8sDrainAnsible(object):
|
class K8sDrainAnsible(object):
|
||||||
@@ -334,19 +334,18 @@ class K8sDrainAnsible(object):
|
|||||||
def evict_pods(self, pods):
|
def evict_pods(self, pods):
|
||||||
for namespace, name in pods:
|
for namespace, name in pods:
|
||||||
try:
|
try:
|
||||||
if not self._module.check_mode:
|
if self._drain_options.get("disable_eviction"):
|
||||||
if self._drain_options.get("disable_eviction"):
|
self._api_instance.delete_namespaced_pod(
|
||||||
self._api_instance.delete_namespaced_pod(
|
name=name, namespace=namespace, body=self._delete_options
|
||||||
name=name, namespace=namespace, body=self._delete_options
|
)
|
||||||
)
|
else:
|
||||||
else:
|
body = v1_eviction(
|
||||||
body = v1_eviction(
|
delete_options=self._delete_options,
|
||||||
delete_options=self._delete_options,
|
metadata=V1ObjectMeta(name=name, namespace=namespace),
|
||||||
metadata=V1ObjectMeta(name=name, namespace=namespace),
|
)
|
||||||
)
|
self._api_instance.create_namespaced_pod_eviction(
|
||||||
self._api_instance.create_namespaced_pod_eviction(
|
name=name, namespace=namespace, body=body
|
||||||
name=name, namespace=namespace, body=body
|
)
|
||||||
)
|
|
||||||
self._changed = True
|
self._changed = True
|
||||||
except ApiException as exc:
|
except ApiException as exc:
|
||||||
if exc.reason != "Not Found":
|
if exc.reason != "Not Found":
|
||||||
@@ -363,7 +362,11 @@ class K8sDrainAnsible(object):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def list_pods(self):
|
def list_pods(self):
|
||||||
params = {"field_selector": "spec.nodeName=" + self._module.params.get("name")}
|
params = {
|
||||||
|
"field_selector": "spec.nodeName={name}".format(
|
||||||
|
name=self._module.params.get("name")
|
||||||
|
)
|
||||||
|
}
|
||||||
pod_selectors = self._module.params.get("pod_selectors")
|
pod_selectors = self._module.params.get("pod_selectors")
|
||||||
if pod_selectors:
|
if pod_selectors:
|
||||||
params["label_selector"] = ",".join(pod_selectors)
|
params["label_selector"] = ",".join(pod_selectors)
|
||||||
@@ -373,8 +376,7 @@ class K8sDrainAnsible(object):
|
|||||||
# Mark node as unschedulable
|
# Mark node as unschedulable
|
||||||
result = []
|
result = []
|
||||||
if not node_unschedulable:
|
if not node_unschedulable:
|
||||||
if not self._module.check_mode:
|
self.patch_node(unschedulable=True)
|
||||||
self.patch_node(unschedulable=True)
|
|
||||||
result.append(
|
result.append(
|
||||||
"node {0} marked unschedulable.".format(self._module.params.get("name"))
|
"node {0} marked unschedulable.".format(self._module.params.get("name"))
|
||||||
)
|
)
|
||||||
@@ -389,8 +391,7 @@ class K8sDrainAnsible(object):
|
|||||||
def _revert_node_patch():
|
def _revert_node_patch():
|
||||||
if self._changed:
|
if self._changed:
|
||||||
self._changed = False
|
self._changed = False
|
||||||
if not self._module.check_mode:
|
self.patch_node(unschedulable=False)
|
||||||
self.patch_node(unschedulable=False)
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
pod_list = self.list_pods()
|
pod_list = self.list_pods()
|
||||||
@@ -400,7 +401,7 @@ class K8sDrainAnsible(object):
|
|||||||
delete_emptydir_data = self._drain_options.get(
|
delete_emptydir_data = self._drain_options.get(
|
||||||
"delete_emptydir_data", False
|
"delete_emptydir_data", False
|
||||||
)
|
)
|
||||||
pods, warnings, errors, info = filter_pods(
|
pods, warnings, errors = filter_pods(
|
||||||
pod_list.items, force, ignore_daemonset, delete_emptydir_data
|
pod_list.items, force, ignore_daemonset, delete_emptydir_data
|
||||||
)
|
)
|
||||||
if errors:
|
if errors:
|
||||||
@@ -430,25 +431,17 @@ class K8sDrainAnsible(object):
|
|||||||
if pods:
|
if pods:
|
||||||
self.evict_pods(pods)
|
self.evict_pods(pods)
|
||||||
number_pod = len(pods)
|
number_pod = len(pods)
|
||||||
if self._module.check_mode:
|
if self._drain_options.get("wait_timeout") is not None:
|
||||||
result.append(
|
warn = self.wait_for_pod_deletion(
|
||||||
"Would have deleted {0} Pod(s) from node if not in check mode.".format(
|
pods,
|
||||||
number_pod
|
self._drain_options.get("wait_timeout"),
|
||||||
)
|
self._drain_options.get("wait_sleep"),
|
||||||
)
|
)
|
||||||
else:
|
if warn:
|
||||||
wait_timeout = self._drain_options.get("wait_timeout")
|
warnings.append(warn)
|
||||||
wait_sleep = self._drain_options.get("wait_sleep")
|
result.append("{0} Pod(s) deleted from node.".format(number_pod))
|
||||||
if wait_timeout is not None:
|
|
||||||
warn = self.wait_for_pod_deletion(pods, wait_timeout, wait_sleep)
|
|
||||||
if warn:
|
|
||||||
warnings.append(warn)
|
|
||||||
result.append("{0} Pod(s) deleted from node.".format(number_pod))
|
|
||||||
if warnings:
|
if warnings:
|
||||||
for warning in warnings:
|
return dict(result=" ".join(result), warnings=warnings)
|
||||||
self._module.warn(warning)
|
|
||||||
for line in info:
|
|
||||||
self._module.debug(line)
|
|
||||||
return dict(result=" ".join(result))
|
return dict(result=" ".join(result))
|
||||||
|
|
||||||
def patch_node(self, unschedulable):
|
def patch_node(self, unschedulable):
|
||||||
@@ -489,8 +482,7 @@ class K8sDrainAnsible(object):
|
|||||||
self._module.exit_json(
|
self._module.exit_json(
|
||||||
result="node {0} already marked unschedulable.".format(name)
|
result="node {0} already marked unschedulable.".format(name)
|
||||||
)
|
)
|
||||||
if not self._module.check_mode:
|
self.patch_node(unschedulable=True)
|
||||||
self.patch_node(unschedulable=True)
|
|
||||||
result["result"] = "node {0} marked unschedulable.".format(name)
|
result["result"] = "node {0} marked unschedulable.".format(name)
|
||||||
self._changed = True
|
self._changed = True
|
||||||
|
|
||||||
@@ -499,8 +491,7 @@ class K8sDrainAnsible(object):
|
|||||||
self._module.exit_json(
|
self._module.exit_json(
|
||||||
result="node {0} already marked schedulable.".format(name)
|
result="node {0} already marked schedulable.".format(name)
|
||||||
)
|
)
|
||||||
if not self._module.check_mode:
|
self.patch_node(unschedulable=False)
|
||||||
self.patch_node(unschedulable=False)
|
|
||||||
result["result"] = "node {0} marked schedulable.".format(name)
|
result["result"] = "node {0} marked schedulable.".format(name)
|
||||||
self._changed = True
|
self._changed = True
|
||||||
|
|
||||||
@@ -543,9 +534,7 @@ def argspec():
|
|||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
module = AnsibleK8SModule(
|
module = AnsibleK8SModule(module_class=AnsibleModule, argument_spec=argspec())
|
||||||
module_class=AnsibleModule, argument_spec=argspec(), supports_check_mode=True
|
|
||||||
)
|
|
||||||
|
|
||||||
if not HAS_EVICTION_API:
|
if not HAS_EVICTION_API:
|
||||||
module.fail_json(
|
module.fail_json(
|
||||||
|
|||||||
@@ -131,7 +131,7 @@ except ImportError:
|
|||||||
# ImportError are managed by the common module already.
|
# ImportError are managed by the common module already.
|
||||||
pass
|
pass
|
||||||
|
|
||||||
from ansible.module_utils.common.text.converters import to_native
|
from ansible.module_utils._text import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -33,14 +33,6 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- api
|
- api
|
||||||
- version
|
- version
|
||||||
hidden_fields:
|
|
||||||
description:
|
|
||||||
- List of fields to hide from the diff output.
|
|
||||||
- This is useful for fields that are not relevant to the patch operation, such as `metadata.managedFields`.
|
|
||||||
type: list
|
|
||||||
elements: str
|
|
||||||
default: []
|
|
||||||
version_added: 6.1.0
|
|
||||||
kind:
|
kind:
|
||||||
description:
|
description:
|
||||||
- Use to specify an object model.
|
- Use to specify an object model.
|
||||||
@@ -135,8 +127,8 @@ error:
|
|||||||
import copy
|
import copy
|
||||||
import traceback
|
import traceback
|
||||||
|
|
||||||
|
from ansible.module_utils._text import to_native
|
||||||
from ansible.module_utils.basic import missing_required_lib
|
from ansible.module_utils.basic import missing_required_lib
|
||||||
from ansible.module_utils.common.text.converters import to_native
|
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
@@ -155,7 +147,6 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions imp
|
|||||||
)
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.service import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.service import (
|
||||||
diff_objects,
|
diff_objects,
|
||||||
hide_fields,
|
|
||||||
)
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.waiter import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.waiter import (
|
||||||
get_waiter,
|
get_waiter,
|
||||||
@@ -183,7 +174,6 @@ JSON_PATCH_ARGS = {
|
|||||||
"namespace": {"type": "str"},
|
"namespace": {"type": "str"},
|
||||||
"name": {"type": "str", "required": True},
|
"name": {"type": "str", "required": True},
|
||||||
"patch": {"type": "list", "required": True, "elements": "dict"},
|
"patch": {"type": "list", "required": True, "elements": "dict"},
|
||||||
"hidden_fields": {"type": "list", "elements": "str", "default": []},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -213,7 +203,6 @@ def execute_module(module, client):
|
|||||||
namespace = module.params.get("namespace")
|
namespace = module.params.get("namespace")
|
||||||
patch = module.params.get("patch")
|
patch = module.params.get("patch")
|
||||||
|
|
||||||
hidden_fields = module.params.get("hidden_fields")
|
|
||||||
wait = module.params.get("wait")
|
wait = module.params.get("wait")
|
||||||
wait_sleep = module.params.get("wait_sleep")
|
wait_sleep = module.params.get("wait_sleep")
|
||||||
wait_timeout = module.params.get("wait_timeout")
|
wait_timeout = module.params.get("wait_timeout")
|
||||||
@@ -271,13 +260,13 @@ def execute_module(module, client):
|
|||||||
module.fail_json(msg=msg, error=to_native(exc), status="", reason="")
|
module.fail_json(msg=msg, error=to_native(exc), status="", reason="")
|
||||||
|
|
||||||
success = True
|
success = True
|
||||||
result = {"result": hide_fields(obj, hidden_fields)}
|
result = {"result": obj}
|
||||||
if wait and not module.check_mode:
|
if wait and not module.check_mode:
|
||||||
waiter = get_waiter(client, resource, condition=wait_condition)
|
waiter = get_waiter(client, resource, condition=wait_condition)
|
||||||
success, result["result"], result["duration"] = waiter.wait(
|
success, result["result"], result["duration"] = waiter.wait(
|
||||||
wait_timeout, wait_sleep, name, namespace
|
wait_timeout, wait_sleep, name, namespace
|
||||||
)
|
)
|
||||||
match, diffs = diff_objects(existing.to_dict(), obj, hidden_fields)
|
match, diffs = diff_objects(existing.to_dict(), obj)
|
||||||
result["changed"] = not match
|
result["changed"] = not match
|
||||||
if module._diff:
|
if module._diff:
|
||||||
result["diff"] = diffs
|
result["diff"] = diffs
|
||||||
|
|||||||
@@ -168,9 +168,7 @@ def perform_action(svc, resource):
|
|||||||
module.params["kind"],
|
module.params["kind"],
|
||||||
resource["metadata"]["name"],
|
resource["metadata"]["name"],
|
||||||
)
|
)
|
||||||
if warn:
|
result = {"changed": False, "warnings": [warn]}
|
||||||
module.warn(warn)
|
|
||||||
result = {"changed": False}
|
|
||||||
return result
|
return result
|
||||||
|
|
||||||
if module.params["kind"] == "Deployment":
|
if module.params["kind"] == "Deployment":
|
||||||
|
|||||||
@@ -149,7 +149,7 @@ except ImportError:
|
|||||||
# Handled in module setup
|
# Handled in module setup
|
||||||
pass
|
pass
|
||||||
|
|
||||||
from ansible.module_utils.common.text.converters import to_native
|
from ansible.module_utils._text import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
@@ -243,12 +243,10 @@ def execute_module(client, module):
|
|||||||
module.fail_json(msg=error, **return_attributes)
|
module.fail_json(msg=error, **return_attributes)
|
||||||
|
|
||||||
def _continue_or_exit(warn):
|
def _continue_or_exit(warn):
|
||||||
if warn:
|
|
||||||
module.warn(warn)
|
|
||||||
if multiple_scale:
|
if multiple_scale:
|
||||||
return_attributes["results"].append({"changed": False})
|
return_attributes["results"].append({"warning": warn, "changed": False})
|
||||||
else:
|
else:
|
||||||
module.exit_json(**return_attributes)
|
module.exit_json(warning=warn, **return_attributes)
|
||||||
|
|
||||||
for existing in existing_items:
|
for existing in existing_items:
|
||||||
if kind.lower() == "job":
|
if kind.lower() == "job":
|
||||||
|
|||||||
@@ -126,7 +126,7 @@ result:
|
|||||||
|
|
||||||
import copy
|
import copy
|
||||||
|
|
||||||
from ansible.module_utils.common.text.converters import to_native
|
from ansible.module_utils._text import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1 +1,4 @@
|
|||||||
disabled # used by test targets helm_vX_XX_XX
|
time=100
|
||||||
|
helm_info
|
||||||
|
helm_repository
|
||||||
|
helm_template
|
||||||
|
|||||||
@@ -9,25 +9,23 @@ chart_test_version: 4.2.4
|
|||||||
chart_test_version_local_path: 1.32.0
|
chart_test_version_local_path: 1.32.0
|
||||||
chart_test_version_upgrade: 4.2.5
|
chart_test_version_upgrade: 4.2.5
|
||||||
chart_test_version_upgrade_local_path: 1.33.0
|
chart_test_version_upgrade_local_path: 1.33.0
|
||||||
chart_test_repo: "https://stenic.github.io/k8status/"
|
chart_test_repo: "https://kubernetes.github.io/ingress-nginx"
|
||||||
chart_test_git_repo: "http://github.com/helm/charts.git"
|
chart_test_git_repo: "http://github.com/helm/charts.git"
|
||||||
chart_test_values:
|
chart_test_values:
|
||||||
revisionHistoryLimit: 0
|
revisionHistoryLimit: 0
|
||||||
myValue: "changed"
|
myValue: "changed"
|
||||||
|
|
||||||
test_namespace:
|
test_namespace:
|
||||||
- "helm-test-crds-{{ helm_version | replace('.', '-') }}"
|
- "helm-test-crds"
|
||||||
- "helm-uninstall-{{ helm_version | replace('.', '-') }}"
|
- "helm-uninstall"
|
||||||
- "helm-read-envvars-{{ helm_version | replace('.', '-') }}"
|
- "helm-read-envvars"
|
||||||
- "helm-dep-update-{{ helm_version | replace('.', '-') }}"
|
- "helm-dep-update"
|
||||||
- "helm-local-path-001-{{ helm_version | replace('.', '-') }}"
|
- "helm-local-path-001"
|
||||||
- "helm-local-path-002-{{ helm_version | replace('.', '-') }}"
|
- "helm-local-path-002"
|
||||||
- "helm-local-path-003-{{ helm_version | replace('.', '-') }}"
|
- "helm-local-path-003"
|
||||||
- "helm-from-repository-{{ helm_version | replace('.', '-') }}"
|
- "helm-from-repository"
|
||||||
- "helm-from-url-{{ helm_version | replace('.', '-') }}"
|
- "helm-from-url"
|
||||||
- "helm-reuse-values-{{ helm_version | replace('.', '-') }}"
|
- "helm-reuse-values"
|
||||||
- "helm-chart-with-space-into-name-{{ helm_version | replace('.', '-') }}"
|
- "helm-chart-with-space-into-name"
|
||||||
- "helm-reset-then-reuse-values-{{ helm_version | replace('.', '-') }}"
|
- "helm-reset-then-reuse-values"
|
||||||
- "helm-insecure-{{ helm_version | replace('.', '-') }}"
|
- "helm-insecure"
|
||||||
- "helm-test-take-ownership-{{ helm_version | replace('.', '-') }}"
|
|
||||||
- "helm-skip-schema-validation-{{ helm_version | replace('.', '-') }}"
|
|
||||||
|
|||||||
@@ -52,9 +52,7 @@ import json
|
|||||||
import subprocess
|
import subprocess
|
||||||
import time
|
import time
|
||||||
|
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
AnsibleHelmModule,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class HelmReleaseNotFoundError(Exception):
|
class HelmReleaseNotFoundError(Exception):
|
||||||
@@ -62,9 +60,7 @@ class HelmReleaseNotFoundError(Exception):
|
|||||||
super().__init__(message)
|
super().__init__(message)
|
||||||
|
|
||||||
|
|
||||||
def create_pending_install_release(
|
def create_pending_install_release(helm_binary, chart_ref, chart_release, namespace):
|
||||||
module, helm_binary, chart_ref, chart_release, namespace
|
|
||||||
):
|
|
||||||
# create pending-install release
|
# create pending-install release
|
||||||
command = [
|
command = [
|
||||||
helm_binary,
|
helm_binary,
|
||||||
@@ -82,14 +78,13 @@ def create_pending_install_release(
|
|||||||
command = [
|
command = [
|
||||||
helm_binary,
|
helm_binary,
|
||||||
"list",
|
"list",
|
||||||
|
"--all",
|
||||||
"--output=json",
|
"--output=json",
|
||||||
"--namespace",
|
"--namespace",
|
||||||
namespace,
|
namespace,
|
||||||
"--filter",
|
"--filter",
|
||||||
chart_release,
|
chart_release,
|
||||||
]
|
]
|
||||||
if not module.is_helm_v4():
|
|
||||||
command.append("--all")
|
|
||||||
cmd = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
cmd = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||||||
out, err = cmd.communicate()
|
out, err = cmd.communicate()
|
||||||
|
|
||||||
@@ -97,11 +92,11 @@ def create_pending_install_release(
|
|||||||
if not data:
|
if not data:
|
||||||
error = "Release %s not found." % chart_release
|
error = "Release %s not found." % chart_release
|
||||||
raise HelmReleaseNotFoundError(message=error)
|
raise HelmReleaseNotFoundError(message=error)
|
||||||
return data[0]["status"] in ("pending-install", "failed"), data[0]["status"]
|
return data[0]["status"] == "pending-install", data[0]["status"]
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
module = AnsibleHelmModule(
|
module = AnsibleModule(
|
||||||
argument_spec=dict(
|
argument_spec=dict(
|
||||||
binary_path=dict(type="path", required=True),
|
binary_path=dict(type="path", required=True),
|
||||||
chart_ref=dict(type="str", required=True),
|
chart_ref=dict(type="str", required=True),
|
||||||
@@ -111,7 +106,6 @@ def main():
|
|||||||
)
|
)
|
||||||
|
|
||||||
params = dict(
|
params = dict(
|
||||||
module=module,
|
|
||||||
helm_binary=module.params.get("binary_path"),
|
helm_binary=module.params.get("binary_path"),
|
||||||
chart_release=module.params.get("chart_release"),
|
chart_release=module.params.get("chart_release"),
|
||||||
chart_ref=module.params.get("chart_ref"),
|
chart_ref=module.params.get("chart_ref"),
|
||||||
@@ -122,7 +116,7 @@ def main():
|
|||||||
result, status = create_pending_install_release(**params)
|
result, status = create_pending_install_release(**params)
|
||||||
if not result:
|
if not result:
|
||||||
module.fail_json(
|
module.fail_json(
|
||||||
msg="unable to create pending-install/failed release, current status is %s"
|
msg="unable to create pending-install release, current status is %s"
|
||||||
% status
|
% status
|
||||||
)
|
)
|
||||||
module.exit_json(changed=True, msg="Release created with status '%s'" % status)
|
module.exit_json(changed=True, msg="Release created with status '%s'" % status)
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
---
|
---
|
||||||
collections:
|
collections:
|
||||||
- kubernetes.core
|
- kubernetes.core
|
||||||
|
dependencies:
|
||||||
|
- remove_namespace
|
||||||
|
|||||||
7
tests/integration/targets/helm/playbook.yaml
Normal file
7
tests/integration/targets/helm/playbook.yaml
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
- connection: local
|
||||||
|
gather_facts: true
|
||||||
|
hosts: localhost
|
||||||
|
|
||||||
|
roles:
|
||||||
|
- helm
|
||||||
@@ -2,4 +2,4 @@
|
|||||||
set -eux
|
set -eux
|
||||||
export ANSIBLE_CALLBACKS_ENABLED=profile_tasks
|
export ANSIBLE_CALLBACKS_ENABLED=profile_tasks
|
||||||
export ANSIBLE_ROLES_PATH=../
|
export ANSIBLE_ROLES_PATH=../
|
||||||
ansible-playbook playbook.yaml "$@"
|
ansible-playbook playbook.yaml "$@"
|
||||||
15
tests/integration/targets/helm/tasks/install.yml
Normal file
15
tests/integration/targets/helm/tasks/install.yml
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
---
|
||||||
|
- name: Init Helm folders
|
||||||
|
file:
|
||||||
|
path: /tmp/helm/
|
||||||
|
state: directory
|
||||||
|
|
||||||
|
- name: Unarchive Helm binary
|
||||||
|
unarchive:
|
||||||
|
src: 'https://get.helm.sh/{{ helm_archive_name | default(helm_default_archive_name) }}'
|
||||||
|
dest: /tmp/helm/
|
||||||
|
remote_src: yes
|
||||||
|
retries: 10
|
||||||
|
delay: 5
|
||||||
|
register: result
|
||||||
|
until: result is not failed
|
||||||
@@ -1,22 +1,8 @@
|
|||||||
---
|
---
|
||||||
- name: Ensure helm is not installed
|
|
||||||
file:
|
|
||||||
path: "{{ item }}"
|
|
||||||
state: absent
|
|
||||||
with_items:
|
|
||||||
- "/tmp/helm"
|
|
||||||
|
|
||||||
- name: Check failed if helm is not installed
|
|
||||||
include_tasks: test_helm_not_installed.yml
|
|
||||||
|
|
||||||
- name: Install Helm v4
|
|
||||||
ansible.builtin.include_role:
|
|
||||||
name: install_helm
|
|
||||||
vars:
|
|
||||||
helm_version: v3.6.0
|
|
||||||
|
|
||||||
- name: Test helm uninstall
|
|
||||||
ansible.builtin.include_tasks: test_helm_uninstall.yml
|
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
include_tasks: run_test.yml
|
include_tasks: run_test.yml
|
||||||
|
loop_control:
|
||||||
|
loop_var: helm_version
|
||||||
|
with_items:
|
||||||
|
- "v3.15.4"
|
||||||
|
- "v3.16.0"
|
||||||
|
|||||||
@@ -1,63 +1,55 @@
|
|||||||
---
|
---
|
||||||
|
- name: Ensure helm is not installed
|
||||||
|
file:
|
||||||
|
path: "{{ item }}"
|
||||||
|
state: absent
|
||||||
|
with_items:
|
||||||
|
- "/tmp/helm"
|
||||||
|
|
||||||
|
- name: Check failed if helm is not installed
|
||||||
|
include_tasks: test_helm_not_installed.yml
|
||||||
|
|
||||||
- name: "Install {{ helm_version }}"
|
- name: "Install {{ helm_version }}"
|
||||||
include_role:
|
include_role:
|
||||||
name: install_helm
|
name: install_helm
|
||||||
|
|
||||||
- name: Main helm tests
|
- name: "Ensure we honor the environment variables"
|
||||||
block:
|
include_tasks: test_read_envvars.yml
|
||||||
- name: Install helm-diff plugin
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
plugin_path: https://github.com/databus23/helm-diff
|
|
||||||
plugin_version: "{{ helm_version is version('v4.0.0', '>=') | ternary('v3.14.0', 'v3.10.0') }}"
|
|
||||||
verify: false
|
|
||||||
|
|
||||||
- name: "Ensure we honor the environment variables"
|
- name: Deploy charts
|
||||||
include_tasks: test_read_envvars.yml
|
include_tasks: "tests_chart/{{ test_chart_type }}.yml"
|
||||||
|
loop_control:
|
||||||
|
loop_var: test_chart_type
|
||||||
|
with_items:
|
||||||
|
- from_local_path
|
||||||
|
- from_repository
|
||||||
|
- from_url
|
||||||
|
|
||||||
- name: Deploy charts
|
- name: test helm upgrade with reuse_values
|
||||||
include_tasks: "tests_chart/{{ test_chart_type }}.yml"
|
include_tasks: test_helm_reuse_values.yml
|
||||||
loop_control:
|
|
||||||
loop_var: test_chart_type
|
|
||||||
with_items:
|
|
||||||
- from_local_path
|
|
||||||
- from_repository
|
|
||||||
- from_url
|
|
||||||
|
|
||||||
- name: test helm upgrade with reuse_values
|
- name: test helm upgrade with reset_then_reuse_values
|
||||||
include_tasks: test_helm_reuse_values.yml
|
include_tasks: test_helm_reset_then_reuse_values.yml
|
||||||
|
|
||||||
- name: test helm upgrade with reset_then_reuse_values
|
- name: test helm dependency update
|
||||||
include_tasks: test_helm_reset_then_reuse_values.yml
|
include_tasks: test_up_dep.yml
|
||||||
|
|
||||||
- name: test helm dependency update
|
- name: Test helm uninstall
|
||||||
include_tasks: test_up_dep.yml
|
include_tasks: test_helm_uninstall.yml
|
||||||
|
|
||||||
- name: Test helm install with chart name containing space
|
- name: Test helm install with chart name containing space
|
||||||
include_tasks: test_helm_with_space_into_chart_name.yml
|
include_tasks: test_helm_with_space_into_chart_name.yml
|
||||||
|
|
||||||
# https://github.com/ansible-collections/community.kubernetes/issues/296
|
# https://github.com/ansible-collections/community.kubernetes/issues/296
|
||||||
- name: Test Skip CRDS feature in helm chart install
|
- name: Test Skip CRDS feature in helm chart install
|
||||||
include_tasks: test_crds.yml
|
include_tasks: test_crds.yml
|
||||||
|
|
||||||
- name: Test insecure registry flag feature
|
- name: Test insecure registry flag feature
|
||||||
include_tasks: test_helm_insecure.yml
|
include_tasks: test_helm_insecure.yml
|
||||||
|
|
||||||
- name: Test take ownership flag feature
|
- name: Clean helm install
|
||||||
include_tasks: test_helm_take_ownership.yml
|
file:
|
||||||
|
path: "{{ item }}"
|
||||||
- name: Test helm skip_schema_validation
|
state: absent
|
||||||
include_tasks: test_skip_schema_validation.yml
|
with_items:
|
||||||
|
- "/tmp/helm/"
|
||||||
always:
|
|
||||||
- name: Remove helm-diff plugin
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
plugin_name: diff
|
|
||||||
state: absent
|
|
||||||
ignore_errors: true
|
|
||||||
|
|
||||||
- name: Clean helm install
|
|
||||||
ansible.builtin.file:
|
|
||||||
path: "/tmp/helm/"
|
|
||||||
state: absent
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@
|
|||||||
name: test
|
name: test
|
||||||
chart_ref: "{{ chart_test }}"
|
chart_ref: "{{ chart_test }}"
|
||||||
namespace: "helm-test"
|
namespace: "helm-test"
|
||||||
ignore_errors: true
|
ignore_errors: yes
|
||||||
register: helm_missing_binary
|
register: helm_missing_binary
|
||||||
|
|
||||||
- name: Assert that helm is not installed
|
- name: Assert that helm is not installed
|
||||||
|
|||||||
@@ -36,29 +36,7 @@
|
|||||||
that:
|
that:
|
||||||
- install is changed
|
- install is changed
|
||||||
- '"--reset-then-reuse-values" not in install.command'
|
- '"--reset-then-reuse-values" not in install.command'
|
||||||
- release_value["status"]["release_values"] == chart_release_values
|
- release_value["status"]["values"] == chart_release_values
|
||||||
|
|
||||||
# We need to provide the actual redis password otherwise the update command
|
|
||||||
# will fail with the following:
|
|
||||||
# Error: execution error at (redis/templates/replicas/application.yaml:55:35):
|
|
||||||
# PASSWORDS ERROR: You must provide your current passwords when upgrading the release.
|
|
||||||
# Note that even after reinstallation, old credentials may be needed as they may be kept in persistent volume claims.
|
|
||||||
# Further information can be obtained at https://docs.bitnami.com/general/how-to/troubleshoot-helm-chart-issues/#credential-errors-while-upgrading-chart-releases
|
|
||||||
# 'global.redis.password' must not be empty, please add '--set global.redis.password=$REDIS_PASSWORD' to the command. To get the current value:
|
|
||||||
- name: Retrieve release password
|
|
||||||
kubernetes.core.k8s_info:
|
|
||||||
namespace: "{{ helm_namespace }}"
|
|
||||||
kind: Secret
|
|
||||||
name: test-redis
|
|
||||||
register: redis_secret
|
|
||||||
|
|
||||||
- ansible.builtin.set_fact:
|
|
||||||
chart_reset_then_reuse_values: "{{ chart_reset_then_reuse_values | combine(redis_global_password) }}"
|
|
||||||
vars:
|
|
||||||
redis_global_password:
|
|
||||||
global:
|
|
||||||
redis:
|
|
||||||
password: "{{ redis_secret.resources.0.data['redis-password'] | b64decode }}"
|
|
||||||
|
|
||||||
- name: Upgrade chart using reset_then_reuse_values=true
|
- name: Upgrade chart using reset_then_reuse_values=true
|
||||||
helm:
|
helm:
|
||||||
@@ -86,7 +64,7 @@
|
|||||||
- '"--reset-then-reuse-values" in upgrade.command'
|
- '"--reset-then-reuse-values" in upgrade.command'
|
||||||
- '"--reuse-values " not in upgrade.command'
|
- '"--reuse-values " not in upgrade.command'
|
||||||
- '"--reset-values" not in upgrade.command'
|
- '"--reset-values" not in upgrade.command'
|
||||||
- release_value["status"]["release_values"] == chart_release_values | combine(chart_reset_then_reuse_values, recursive=true)
|
- release_value["status"]["values"] == chart_release_values | combine(chart_reset_then_reuse_values, recursive=true)
|
||||||
|
|
||||||
always:
|
always:
|
||||||
- name: Remove helm namespace
|
- name: Remove helm namespace
|
||||||
@@ -95,4 +73,3 @@
|
|||||||
kind: Namespace
|
kind: Namespace
|
||||||
name: "{{ helm_namespace }}"
|
name: "{{ helm_namespace }}"
|
||||||
state: absent
|
state: absent
|
||||||
wait: false
|
|
||||||
|
|||||||
@@ -36,22 +36,7 @@
|
|||||||
that:
|
that:
|
||||||
- install is changed
|
- install is changed
|
||||||
- '"--reuse-values=True" not in install.command'
|
- '"--reuse-values=True" not in install.command'
|
||||||
- release_value["status"]["release_values"] == chart_release_values
|
- release_value["status"]["values"] == chart_release_values
|
||||||
|
|
||||||
- name: Retrieve release password
|
|
||||||
kubernetes.core.k8s_info:
|
|
||||||
namespace: "{{ helm_namespace }}"
|
|
||||||
kind: Secret
|
|
||||||
name: test-redis
|
|
||||||
register: redis_secret
|
|
||||||
|
|
||||||
- ansible.builtin.set_fact:
|
|
||||||
chart_reuse_values: "{{ chart_reuse_values | combine(redis_global_password) }}"
|
|
||||||
vars:
|
|
||||||
redis_global_password:
|
|
||||||
global:
|
|
||||||
redis:
|
|
||||||
password: "{{ redis_secret.resources.0.data['redis-password'] | b64decode }}"
|
|
||||||
|
|
||||||
- name: Upgrade chart using reuse_values=true
|
- name: Upgrade chart using reuse_values=true
|
||||||
helm:
|
helm:
|
||||||
@@ -77,7 +62,7 @@
|
|||||||
- upgrade is changed
|
- upgrade is changed
|
||||||
- '"--reuse-values=True" in upgrade.command'
|
- '"--reuse-values=True" in upgrade.command'
|
||||||
- '"--reset-values" not in upgrade.command'
|
- '"--reset-values" not in upgrade.command'
|
||||||
- release_value["status"]["release_values"] == chart_release_values | combine(chart_reuse_values, recursive=true)
|
- release_value["status"]["values"] == chart_release_values | combine(chart_reuse_values, recursive=true)
|
||||||
|
|
||||||
always:
|
always:
|
||||||
- name: Remove helm namespace
|
- name: Remove helm namespace
|
||||||
|
|||||||
@@ -1,101 +0,0 @@
|
|||||||
---
|
|
||||||
- name: Test helm take ownership
|
|
||||||
vars:
|
|
||||||
helm_namespace: "{{ test_namespace[13] }}"
|
|
||||||
block:
|
|
||||||
|
|
||||||
- name: Initial chart installation (no flag set)
|
|
||||||
helm:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
chart_ref: "{{ chart_test_oci }}"
|
|
||||||
release_name: test-take-ownership
|
|
||||||
release_namespace: "{{ helm_namespace }}"
|
|
||||||
create_namespace: true
|
|
||||||
register: install
|
|
||||||
|
|
||||||
- name: Validate that take-ownership flag is not set
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- install is changed
|
|
||||||
- '"--take-ownership" not in install.command'
|
|
||||||
|
|
||||||
# We need to provide the actual redis password otherwise the update command
|
|
||||||
# will fail with the following:
|
|
||||||
# Error: execution error at (redis/templates/replicas/application.yaml:55:35):
|
|
||||||
# PASSWORDS ERROR: You must provide your current passwords when upgrading the release.
|
|
||||||
# Note that even after reinstallation, old credentials may be needed as they may be kept in persistent volume claims.
|
|
||||||
# Further information can be obtained at https://docs.bitnami.com/general/how-to/troubleshoot-helm-chart-issues/#credential-errors-while-upgrading-chart-releases
|
|
||||||
# 'global.redis.password' must not be empty, please add '--set global.redis.password=$REDIS_PASSWORD' to the command. To get the current value:
|
|
||||||
- name: Retrieve release password
|
|
||||||
kubernetes.core.k8s_info:
|
|
||||||
namespace: "{{ helm_namespace }}"
|
|
||||||
kind: Secret
|
|
||||||
name: test-take-ownership-redis
|
|
||||||
register: redis_secret
|
|
||||||
|
|
||||||
- name: Upgrade chart (take-onwership flag set)
|
|
||||||
helm:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
chart_ref: "{{ chart_test_oci }}"
|
|
||||||
release_name: test-take-ownership
|
|
||||||
release_namespace: "{{ helm_namespace }}"
|
|
||||||
take_ownership: true
|
|
||||||
values:
|
|
||||||
commonLabels:
|
|
||||||
take-onwership: "set"
|
|
||||||
global:
|
|
||||||
redis:
|
|
||||||
password: "{{ redis_secret.resources.0.data['redis-password'] | b64decode }}"
|
|
||||||
register: upgrade
|
|
||||||
ignore_errors: true
|
|
||||||
|
|
||||||
- name: Validate that take-ownership flag IS set if helm version is >= 3.17.0
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- upgrade is changed
|
|
||||||
- '"--take-ownership" in upgrade.command'
|
|
||||||
when: '"v3.17.0" <= helm_version'
|
|
||||||
|
|
||||||
- name: Validate that feature fails for helm < 3.17.0
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- upgrade is failed
|
|
||||||
- '"take_ownership requires helm >= 3.17.0" in upgrade.msg'
|
|
||||||
when: 'helm_version < "v3.17.0"'
|
|
||||||
|
|
||||||
- name: Upgrade chart (take-onwership flag not set)
|
|
||||||
helm:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
chart_ref: "{{ chart_test_oci }}"
|
|
||||||
release_name: test-take-ownership
|
|
||||||
release_namespace: "{{ helm_namespace }}"
|
|
||||||
values:
|
|
||||||
commonLabels:
|
|
||||||
take-onwership: "not-set"
|
|
||||||
global:
|
|
||||||
redis:
|
|
||||||
password: "{{ redis_secret.resources.0.data['redis-password'] | b64decode }}"
|
|
||||||
register: upgrade
|
|
||||||
ignore_errors: true
|
|
||||||
|
|
||||||
- name: Validate that take-ownership flag IS set if helm version is >= 3.17.0
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- upgrade is changed
|
|
||||||
- '"--take-ownership" not in upgrade.command'
|
|
||||||
when: '"v3.17.0" <= helm_version'
|
|
||||||
|
|
||||||
- name: Validate that feature fails for helm < 3.17.0
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- upgrade is changed
|
|
||||||
- upgrade.msg is not defined
|
|
||||||
when: 'helm_version < "v3.17.0"'
|
|
||||||
|
|
||||||
always:
|
|
||||||
- name: Remove helm namespace
|
|
||||||
k8s:
|
|
||||||
api_version: v1
|
|
||||||
kind: Namespace
|
|
||||||
name: "{{ helm_namespace }}"
|
|
||||||
state: absent
|
|
||||||
@@ -31,18 +31,26 @@
|
|||||||
- name: assert warning has been raised
|
- name: assert warning has been raised
|
||||||
assert:
|
assert:
|
||||||
that:
|
that:
|
||||||
- uninstall.warnings is defined
|
- uninstall.warnings
|
||||||
- '"helm uninstall support option --wait for helm release >= 3.7.0" in uninstall.warnings'
|
|
||||||
|
|
||||||
- name: Install Helm v4
|
- name: Create temp directory
|
||||||
ansible.builtin.include_role:
|
tempfile:
|
||||||
name: install_helm
|
state: directory
|
||||||
vars:
|
suffix: .test
|
||||||
helm_version: v4.0.0
|
register: _result
|
||||||
|
|
||||||
|
- set_fact:
|
||||||
|
helm_tmp_dir: "{{ _result.path }}"
|
||||||
|
|
||||||
|
- name: Unarchive Helm binary
|
||||||
|
unarchive:
|
||||||
|
src: 'https://get.helm.sh/helm-v3.7.0-linux-amd64.tar.gz'
|
||||||
|
dest: "{{ helm_tmp_dir }}"
|
||||||
|
remote_src: yes
|
||||||
|
|
||||||
- name: Install chart
|
- name: Install chart
|
||||||
helm:
|
helm:
|
||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_tmp_dir }}/linux-amd64/helm"
|
||||||
name: "{{ chart_name }}"
|
name: "{{ chart_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
@@ -51,7 +59,7 @@
|
|||||||
- name: uninstall chart again using recent version
|
- name: uninstall chart again using recent version
|
||||||
helm:
|
helm:
|
||||||
state: absent
|
state: absent
|
||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_tmp_dir }}/linux-amd64/helm"
|
||||||
name: "{{ chart_name }}"
|
name: "{{ chart_name }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
wait: yes
|
wait: yes
|
||||||
@@ -88,6 +96,12 @@
|
|||||||
- _info.status is undefined
|
- _info.status is undefined
|
||||||
|
|
||||||
always:
|
always:
|
||||||
|
- name: Delete temp directory
|
||||||
|
file:
|
||||||
|
path: "{{ helm_tmp_dir }}"
|
||||||
|
state: absent
|
||||||
|
ignore_errors: true
|
||||||
|
|
||||||
- name: Remove namespace
|
- name: Remove namespace
|
||||||
k8s:
|
k8s:
|
||||||
kind: Namespace
|
kind: Namespace
|
||||||
|
|||||||
@@ -1,48 +0,0 @@
|
|||||||
---
|
|
||||||
- name: Test helm skip_schema_validation
|
|
||||||
vars:
|
|
||||||
helm_namespace: "{{ test_namespace[14] }}"
|
|
||||||
chart_release_values:
|
|
||||||
replica:
|
|
||||||
replicaCount: 3
|
|
||||||
master:
|
|
||||||
count: 1
|
|
||||||
kind: Deployment
|
|
||||||
block:
|
|
||||||
- name: Chart installation
|
|
||||||
helm:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
chart_ref: oci://registry-1.docker.io/bitnamicharts/redis
|
|
||||||
release_name: test-redis
|
|
||||||
release_namespace: "{{ helm_namespace }}"
|
|
||||||
create_namespace: true
|
|
||||||
release_values: "{{ chart_release_values }}"
|
|
||||||
skip_schema_validation: true
|
|
||||||
register: install
|
|
||||||
ignore_errors: true
|
|
||||||
|
|
||||||
- name: Debug install result
|
|
||||||
debug:
|
|
||||||
var: install
|
|
||||||
|
|
||||||
- name: Validate skip_schema_validation with helm >= 3.16.0 works
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- install is changed
|
|
||||||
- "'--skip-schema-validation' in install.command"
|
|
||||||
when: "helm_version is ansible.builtin.version('v3.16.0', '>=')"
|
|
||||||
|
|
||||||
- name: Validate skip_schema_validation with helm < 3.16.0 fails
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- install is failed
|
|
||||||
- "'skip_schema_validation requires helm >= 3.16.0' in install.msg"
|
|
||||||
when: "helm_version is ansible.builtin.version('v3.16.0', '<')"
|
|
||||||
|
|
||||||
always:
|
|
||||||
- name: Remove helm namespace
|
|
||||||
k8s:
|
|
||||||
api_version: v1
|
|
||||||
kind: Namespace
|
|
||||||
name: "{{ helm_namespace }}"
|
|
||||||
state: absent
|
|
||||||
@@ -30,9 +30,9 @@
|
|||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
ignore_errors: true
|
ignore_errors: yes
|
||||||
register: install_fail
|
register: install_fail
|
||||||
|
|
||||||
- name: "Assert that Install fail {{ chart_test }} from {{ source }}"
|
- name: "Assert that Install fail {{ chart_test }} from {{ source }}"
|
||||||
@@ -46,7 +46,7 @@
|
|||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
create_namespace: true
|
create_namespace: true
|
||||||
register: install_check_mode
|
register: install_check_mode
|
||||||
@@ -57,25 +57,24 @@
|
|||||||
that:
|
that:
|
||||||
- install_check_mode is changed
|
- install_check_mode is changed
|
||||||
- install_check_mode.status is defined
|
- install_check_mode.status is defined
|
||||||
- install_check_mode.status.release_values is defined
|
- install_check_mode.status.values is defined
|
||||||
|
|
||||||
- name: "Install {{ chart_test }} from {{ source }}"
|
- name: "Install {{ chart_test }} from {{ source }}"
|
||||||
helm:
|
helm:
|
||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
create_namespace: true
|
create_namespace: true
|
||||||
register: install
|
register: install
|
||||||
|
|
||||||
- name: "Assert that {{ chart_test }} chart version {{ chart_test_version }} is installed from {{ source }}"
|
- name: "Assert that {{ chart_test }} chart is installed from {{ source }}"
|
||||||
assert:
|
assert:
|
||||||
that:
|
that:
|
||||||
- install is changed
|
- install is changed
|
||||||
- install.status.chart == chart_test+"-"+chart_test_version
|
- install.status.chart == chart_test+"-"+chart_test_version
|
||||||
- install.status.status | lower == 'deployed'
|
- install.status.status | lower == 'deployed'
|
||||||
- install.status.release_values == {}
|
|
||||||
|
|
||||||
- name: Check helm_info content
|
- name: Check helm_info content
|
||||||
helm_info:
|
helm_info:
|
||||||
@@ -93,7 +92,7 @@
|
|||||||
- deployed
|
- deployed
|
||||||
register: release_state_content_info
|
register: release_state_content_info
|
||||||
|
|
||||||
- name: "Assert that {{ chart_test }} chart version {{ chart_test_version }} is installed from {{ source }} with helm_info"
|
- name: "Assert that {{ chart_test }} is installed from {{ source }} with helm_info"
|
||||||
assert:
|
assert:
|
||||||
that:
|
that:
|
||||||
- content_info.status.chart == chart_test+"-"+chart_test_version
|
- content_info.status.chart == chart_test+"-"+chart_test_version
|
||||||
@@ -105,10 +104,9 @@
|
|||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
register: install
|
register: install
|
||||||
diff: true
|
|
||||||
|
|
||||||
- name: Assert idempotency
|
- name: Assert idempotency
|
||||||
assert:
|
assert:
|
||||||
@@ -122,7 +120,7 @@
|
|||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
values: "{{ chart_test_values }}"
|
values: "{{ chart_test_values }}"
|
||||||
register: install
|
register: install
|
||||||
@@ -133,18 +131,17 @@
|
|||||||
- install is changed
|
- install is changed
|
||||||
- install.status.status | lower == 'deployed'
|
- install.status.status | lower == 'deployed'
|
||||||
- install.status.chart == chart_test+"-"+chart_test_version
|
- install.status.chart == chart_test+"-"+chart_test_version
|
||||||
- install.status['release_values'] == chart_test_values
|
- "install.status['values'].revisionHistoryLimit == 0"
|
||||||
|
|
||||||
- name: Check idempotency after adding vars
|
- name: Check idempotency after adding vars
|
||||||
helm:
|
helm:
|
||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
values: "{{ chart_test_values }}"
|
values: "{{ chart_test_values }}"
|
||||||
register: install
|
register: install
|
||||||
diff: true
|
|
||||||
|
|
||||||
- name: Assert idempotency after add vars
|
- name: Assert idempotency after add vars
|
||||||
assert:
|
assert:
|
||||||
@@ -152,14 +149,14 @@
|
|||||||
- install is not changed
|
- install is not changed
|
||||||
- install.status.status | lower == 'deployed'
|
- install.status.status | lower == 'deployed'
|
||||||
- install.status.chart == chart_test+"-"+chart_test_version
|
- install.status.chart == chart_test+"-"+chart_test_version
|
||||||
- install.status['release_values'] == chart_test_values
|
- "install.status['values'].revisionHistoryLimit == 0"
|
||||||
|
|
||||||
- name: "Remove Vars to {{ chart_test }} from {{ source }}"
|
- name: "Remove Vars to {{ chart_test }} from {{ source }}"
|
||||||
helm:
|
helm:
|
||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
register: install
|
register: install
|
||||||
|
|
||||||
@@ -169,17 +166,16 @@
|
|||||||
- install is changed
|
- install is changed
|
||||||
- install.status.status | lower == 'deployed'
|
- install.status.status | lower == 'deployed'
|
||||||
- install.status.chart == chart_test+"-"+chart_test_version
|
- install.status.chart == chart_test+"-"+chart_test_version
|
||||||
- install.status['release_values'] == {}
|
- install.status['values'] == {}
|
||||||
|
|
||||||
- name: Check idempotency after removing vars
|
- name: Check idempotency after removing vars
|
||||||
helm:
|
helm:
|
||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
register: install
|
register: install
|
||||||
diff: true
|
|
||||||
|
|
||||||
- name: Assert idempotency after removing vars
|
- name: Assert idempotency after removing vars
|
||||||
assert:
|
assert:
|
||||||
@@ -187,14 +183,14 @@
|
|||||||
- install is not changed
|
- install is not changed
|
||||||
- install.status.status | lower == 'deployed'
|
- install.status.status | lower == 'deployed'
|
||||||
- install.status.chart == chart_test+"-"+chart_test_version
|
- install.status.chart == chart_test+"-"+chart_test_version
|
||||||
- install.status['release_values'] == {}
|
- install.status['values'] == {}
|
||||||
|
|
||||||
- name: "Upgrade {{ chart_test }} from {{ source }}"
|
- name: "Upgrade {{ chart_test }} from {{ source }}"
|
||||||
helm:
|
helm:
|
||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source_upgrade | default(chart_source) }}"
|
chart_ref: "{{ chart_source_upgrade | default(chart_source) }}"
|
||||||
chart_version: "{{ chart_test_version_upgrade }}"
|
chart_version: "{{ chart_source_version_upgrade | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
register: install
|
register: install
|
||||||
|
|
||||||
@@ -210,10 +206,9 @@
|
|||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source_upgrade | default(chart_source) }}"
|
chart_ref: "{{ chart_source_upgrade | default(chart_source) }}"
|
||||||
chart_version: "{{ chart_test_version_upgrade }}"
|
chart_version: "{{ chart_source_version_upgrade | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
register: install
|
register: install
|
||||||
diff: true
|
|
||||||
|
|
||||||
- name: Assert idempotency after upgrade
|
- name: Assert idempotency after upgrade
|
||||||
assert:
|
assert:
|
||||||
@@ -242,7 +237,6 @@
|
|||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
register: install
|
register: install
|
||||||
diff: true
|
|
||||||
|
|
||||||
- name: Assert idempotency
|
- name: Assert idempotency
|
||||||
assert:
|
assert:
|
||||||
@@ -255,7 +249,7 @@
|
|||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_replaced_name }}"
|
name: "{{ chart_release_replaced_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
register: install
|
register: install
|
||||||
|
|
||||||
@@ -283,7 +277,7 @@
|
|||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_replaced_name }}"
|
name: "{{ chart_release_replaced_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
replace: True
|
replace: True
|
||||||
register: install
|
register: install
|
||||||
@@ -311,7 +305,7 @@
|
|||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
values_files:
|
values_files:
|
||||||
- "{{ role_path }}/files/values.yaml"
|
- "{{ role_path }}/files/values.yaml"
|
||||||
@@ -323,14 +317,14 @@
|
|||||||
- install is changed
|
- install is changed
|
||||||
- install.status.status | lower == 'deployed'
|
- install.status.status | lower == 'deployed'
|
||||||
- install.status.chart == chart_test+"-"+chart_test_version
|
- install.status.chart == chart_test+"-"+chart_test_version
|
||||||
- "install.status['release_values'].revisionHistoryLimit == 0"
|
- "install.status['values'].revisionHistoryLimit == 0"
|
||||||
|
|
||||||
- name: "Install {{ chart_test }} from {{ source }} with values_files (again)"
|
- name: "Install {{ chart_test }} from {{ source }} with values_files (again)"
|
||||||
helm:
|
helm:
|
||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
values_files:
|
values_files:
|
||||||
- "{{ role_path }}/files/values.yaml"
|
- "{{ role_path }}/files/values.yaml"
|
||||||
@@ -352,7 +346,7 @@
|
|||||||
helm_template:
|
helm_template:
|
||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
output_dir: "{{ temp_dir }}"
|
output_dir: "{{ temp_dir }}"
|
||||||
values_files:
|
values_files:
|
||||||
- "{{ role_path }}/files/values.yaml"
|
- "{{ role_path }}/files/values.yaml"
|
||||||
@@ -378,7 +372,7 @@
|
|||||||
helm_template:
|
helm_template:
|
||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
disable_hook: True
|
disable_hook: True
|
||||||
release_name: "myrelease"
|
release_name: "myrelease"
|
||||||
release_namespace: "myreleasenamespace"
|
release_namespace: "myreleasenamespace"
|
||||||
@@ -404,11 +398,11 @@
|
|||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
name: "{{ chart_release_name }}"
|
name: "{{ chart_release_name }}"
|
||||||
chart_ref: "{{ chart_source }}"
|
chart_ref: "{{ chart_source }}"
|
||||||
chart_version: "{{ chart_test_version }}"
|
chart_version: "{{ chart_source_version | default(omit) }}"
|
||||||
namespace: "{{ helm_namespace }}"
|
namespace: "{{ helm_namespace }}"
|
||||||
create_namespace: true
|
create_namespace: true
|
||||||
context: does-not-exist
|
context: does-not-exist
|
||||||
ignore_errors: true
|
ignore_errors: yes
|
||||||
register: result
|
register: result
|
||||||
|
|
||||||
- name: Assert that release fails with non-existent context
|
- name: Assert that release fails with non-existent context
|
||||||
@@ -423,7 +417,6 @@
|
|||||||
state: absent
|
state: absent
|
||||||
path: "{{ temp_dir }}"
|
path: "{{ temp_dir }}"
|
||||||
ignore_errors: true
|
ignore_errors: true
|
||||||
when: temp_dir is defined
|
|
||||||
|
|
||||||
- name: Remove helm namespace
|
- name: Remove helm namespace
|
||||||
k8s:
|
k8s:
|
||||||
|
|||||||
@@ -5,38 +5,18 @@
|
|||||||
name: test_helm
|
name: test_helm
|
||||||
repo_url: "{{ chart_test_repo }}"
|
repo_url: "{{ chart_test_repo }}"
|
||||||
|
|
||||||
- name: Create temporary file to save values in
|
- name: Install Chart from repository
|
||||||
ansible.builtin.tempfile:
|
include_tasks: "../tests_chart.yml"
|
||||||
suffix: .helm_values
|
vars:
|
||||||
register: value_file
|
|
||||||
|
|
||||||
- vars:
|
|
||||||
source: repository
|
source: repository
|
||||||
chart_test: k8status
|
chart_source: "test_helm/{{ chart_test }}"
|
||||||
chart_source: "test_helm/k8status"
|
chart_source_version: "{{ chart_test_version }}"
|
||||||
chart_test_version: "0.16.1"
|
chart_source_version_upgrade: "{{ chart_test_version_upgrade }}"
|
||||||
chart_test_version_upgrade: "0.16.2"
|
|
||||||
helm_namespace: "{{ test_namespace[7] }}"
|
helm_namespace: "{{ test_namespace[7] }}"
|
||||||
chart_test_values:
|
|
||||||
replicaCount: 3
|
|
||||||
block:
|
|
||||||
- name: Save values into file
|
|
||||||
ansible.builtin.copy:
|
|
||||||
content: "{{ chart_test_values }}"
|
|
||||||
dest: "{{ value_file.path }}"
|
|
||||||
|
|
||||||
- name: Install Chart from repository
|
- name: Remove chart repo
|
||||||
ansible.builtin.include_tasks: "../tests_chart.yml"
|
helm_repository:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
always:
|
name: test_helm
|
||||||
- name: Remove temporary file
|
repo_url: "{{ chart_test_repo }}"
|
||||||
ansible.builtin.file:
|
state: absent
|
||||||
state: absent
|
|
||||||
path: "{{ value_file.path }}"
|
|
||||||
|
|
||||||
- name: Remove chart repo
|
|
||||||
helm_repository:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
name: test_helm
|
|
||||||
repo_url: "{{ chart_test_repo }}"
|
|
||||||
state: absent
|
|
||||||
|
|||||||
@@ -3,11 +3,6 @@
|
|||||||
include_tasks: "../tests_chart.yml"
|
include_tasks: "../tests_chart.yml"
|
||||||
vars:
|
vars:
|
||||||
source: url
|
source: url
|
||||||
chart_test: "k8status"
|
chart_source: "https://github.com/kubernetes/ingress-nginx/releases/download/helm-chart-{{ chart_test_version }}/{{ chart_test }}-{{ chart_test_version }}.tgz"
|
||||||
chart_test_values:
|
chart_source_upgrade: "https://github.com/kubernetes/ingress-nginx/releases/download/helm-chart-{{ chart_test_version_upgrade }}/{{ chart_test }}-{{ chart_test_version_upgrade }}.tgz"
|
||||||
replicaCount: 3
|
|
||||||
chart_test_version: "0.16.1"
|
|
||||||
chart_test_version_upgrade: "0.16.2"
|
|
||||||
chart_source: https://github.com/stenic/k8status/releases/download/k8status-0.16.1/k8status-0.16.1.tgz
|
|
||||||
chart_source_upgrade: https://github.com/stenic/k8status/releases/download/k8status-0.16.2/k8status-0.16.2.tgz
|
|
||||||
helm_namespace: "{{ test_namespace[8] }}"
|
helm_namespace: "{{ test_namespace[8] }}"
|
||||||
|
|||||||
@@ -239,7 +239,6 @@
|
|||||||
vars:
|
vars:
|
||||||
chart_local_path: '{{ _tmpd.path }}/test-chart-deployment-time'
|
chart_local_path: '{{ _tmpd.path }}/test-chart-deployment-time'
|
||||||
chart_repo_path: 'testing'
|
chart_repo_path: 'testing'
|
||||||
helm_binary_path: "{{ helm_binary }}"
|
|
||||||
always:
|
always:
|
||||||
- name: Delete temporary directory
|
- name: Delete temporary directory
|
||||||
ansible.builtin.file:
|
ansible.builtin.file:
|
||||||
|
|||||||
@@ -92,11 +92,25 @@
|
|||||||
path: /tmp/helm/
|
path: /tmp/helm/
|
||||||
state: absent
|
state: absent
|
||||||
|
|
||||||
- name: Install old version of helm
|
- name: Init Helm folders
|
||||||
ansible.builtin.include_role:
|
file:
|
||||||
name: install_helm
|
path: /tmp/helm
|
||||||
vars:
|
state: directory
|
||||||
helm_version: "v3.8.0"
|
|
||||||
|
- name: Set Helm old version
|
||||||
|
set_fact:
|
||||||
|
helm_archive_name: "helm-v3.8.0-linux-amd64.tar.gz"
|
||||||
|
helm_diff_old_version: "3.8.0"
|
||||||
|
|
||||||
|
- name: Unarchive Helm binary
|
||||||
|
unarchive:
|
||||||
|
src: "https://get.helm.sh/{{ helm_archive_name | default(helm_default_archive_name) }}"
|
||||||
|
dest: /tmp/helm/
|
||||||
|
remote_src: yes
|
||||||
|
retries: 10
|
||||||
|
delay: 5
|
||||||
|
register: result
|
||||||
|
until: result is not failed
|
||||||
|
|
||||||
- name: Upgrade helm release (with reset_then_reuse_values=true)
|
- name: Upgrade helm release (with reset_then_reuse_values=true)
|
||||||
kubernetes.core.helm:
|
kubernetes.core.helm:
|
||||||
@@ -126,7 +140,7 @@
|
|||||||
binary_path: "{{ helm_binary }}"
|
binary_path: "{{ helm_binary }}"
|
||||||
state: present
|
state: present
|
||||||
plugin_path: https://github.com/databus23/helm-diff
|
plugin_path: https://github.com/databus23/helm-diff
|
||||||
plugin_version: "3.8.0"
|
plugin_version: "{{ helm_diff_old_version }}"
|
||||||
|
|
||||||
- name: Upgrade helm release (with reset_then_reuse_values=true)
|
- name: Upgrade helm release (with reset_then_reuse_values=true)
|
||||||
kubernetes.core.helm:
|
kubernetes.core.helm:
|
||||||
@@ -152,11 +166,6 @@
|
|||||||
- '"reset_then_reuse_values requires helm diff >= 3.9.12, current version is" in helm_upgrade.msg'
|
- '"reset_then_reuse_values requires helm diff >= 3.9.12, current version is" in helm_upgrade.msg'
|
||||||
|
|
||||||
always:
|
always:
|
||||||
- name: Delete Helm folders
|
|
||||||
file:
|
|
||||||
path: /tmp/helm/
|
|
||||||
state: absent
|
|
||||||
|
|
||||||
- name: Remove temporary directory
|
- name: Remove temporary directory
|
||||||
file:
|
file:
|
||||||
path: "{{ helm_dir.path }}"
|
path: "{{ helm_dir.path }}"
|
||||||
|
|||||||
@@ -1,10 +1,7 @@
|
|||||||
---
|
---
|
||||||
|
helm_binary: "/tmp/helm/{{ ansible_system | lower }}-amd64/helm"
|
||||||
default_kubeconfig_path: "~/.kube/config"
|
default_kubeconfig_path: "~/.kube/config"
|
||||||
test_namespace:
|
test_namespace:
|
||||||
- "helm-in-memory-kubeconfig"
|
- "helm-in-memory-kubeconfig"
|
||||||
- "helm-kubeconfig-with-ca-cert"
|
- "helm-kubeconfig-with-ca-cert"
|
||||||
- "helm-kubeconfig-with-insecure-skip-tls-verify"
|
- "helm-kubeconfig-with-insecure-skip-tls-verify"
|
||||||
helm_versions:
|
|
||||||
- v3.10.3
|
|
||||||
- v3.16.4
|
|
||||||
- v4.0.0
|
|
||||||
|
|||||||
4
tests/integration/targets/helm_kubeconfig/meta/main.yml
Normal file
4
tests/integration/targets/helm_kubeconfig/meta/main.yml
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
dependencies:
|
||||||
|
- remove_namespace
|
||||||
|
- install_helm
|
||||||
@@ -57,7 +57,7 @@
|
|||||||
assert:
|
assert:
|
||||||
that:
|
that:
|
||||||
- _install is failed
|
- _install is failed
|
||||||
- '"error: kubernetes cluster unreachable" in _install.msg | lower()'
|
- '"Error: Kubernetes cluster unreachable" in _install.msg'
|
||||||
|
|
||||||
- name: Test helm modules using in-memory kubeconfig
|
- name: Test helm modules using in-memory kubeconfig
|
||||||
include_tasks: "tests_helm_auth.yml"
|
include_tasks: "tests_helm_auth.yml"
|
||||||
|
|||||||
@@ -48,7 +48,7 @@
|
|||||||
assert:
|
assert:
|
||||||
that:
|
that:
|
||||||
- _install is failed
|
- _install is failed
|
||||||
- '"error: kubernetes cluster unreachable" in _install.msg | lower()'
|
- '"Error: Kubernetes cluster unreachable" in _install.msg'
|
||||||
|
|
||||||
- name: Test helm modules using in-memory kubeconfig
|
- name: Test helm modules using in-memory kubeconfig
|
||||||
include_tasks: "tests_helm_auth.yml"
|
include_tasks: "tests_helm_auth.yml"
|
||||||
|
|||||||
@@ -1,5 +1,21 @@
|
|||||||
---
|
---
|
||||||
- ansible.builtin.include_tasks: run_tests.yml
|
- name: Test helm with in-memory kubeconfig
|
||||||
loop: "{{ helm_versions }}"
|
include_tasks: "from_in_memory_kubeconfig.yml"
|
||||||
loop_control:
|
loop_control:
|
||||||
loop_var: helm_version
|
loop_var: test_helm_version
|
||||||
|
with_items:
|
||||||
|
- "v3.10.3"
|
||||||
|
|
||||||
|
- name: Test helm with custom kubeconfig and validate_certs=false
|
||||||
|
include_tasks: "from_kubeconfig_with_validate_certs.yml"
|
||||||
|
loop_control:
|
||||||
|
loop_var: test_helm_version
|
||||||
|
with_items:
|
||||||
|
- "v3.10.3"
|
||||||
|
|
||||||
|
- name: Test helm with custom kubeconfig and ca_cert
|
||||||
|
include_tasks: "from_kubeconfig_with_cacert.yml"
|
||||||
|
loop_control:
|
||||||
|
loop_var: test_helm_version
|
||||||
|
with_items:
|
||||||
|
- "v3.10.3"
|
||||||
|
|||||||
@@ -1,15 +0,0 @@
|
|||||||
---
|
|
||||||
- name: Run tests with helm version "{{ helm_version }}"
|
|
||||||
block:
|
|
||||||
- name: "Install Helm"
|
|
||||||
ansible.builtin.include_role:
|
|
||||||
name: install_helm
|
|
||||||
|
|
||||||
- name: Test helm with in-memory kubeconfig
|
|
||||||
ansible.builtin.include_tasks: "from_in_memory_kubeconfig.yml"
|
|
||||||
|
|
||||||
- name: Test helm with custom kubeconfig and validate_certs=false
|
|
||||||
include_tasks: "from_kubeconfig_with_validate_certs.yml"
|
|
||||||
|
|
||||||
- name: Test helm with custom kubeconfig and ca_cert
|
|
||||||
include_tasks: "from_kubeconfig_with_cacert.yml"
|
|
||||||
@@ -5,6 +5,16 @@
|
|||||||
suffix: .helm
|
suffix: .helm
|
||||||
register: _dir
|
register: _dir
|
||||||
|
|
||||||
|
- name: Install helm binary
|
||||||
|
block:
|
||||||
|
- name: "Install {{ test_helm_version }}"
|
||||||
|
include_role:
|
||||||
|
name: install_helm
|
||||||
|
vars:
|
||||||
|
helm_version: "{{ test_helm_version }}"
|
||||||
|
|
||||||
|
when: test_helm_version is defined
|
||||||
|
|
||||||
- set_fact:
|
- set_fact:
|
||||||
saved_kubeconfig_path: "{{ _dir.path }}/config"
|
saved_kubeconfig_path: "{{ _dir.path }}/config"
|
||||||
|
|
||||||
@@ -34,7 +44,6 @@
|
|||||||
ca_cert: "{{ test_ca_cert | default(omit) }}"
|
ca_cert: "{{ test_ca_cert | default(omit) }}"
|
||||||
state: present
|
state: present
|
||||||
plugin_path: https://github.com/hydeenoble/helm-subenv
|
plugin_path: https://github.com/hydeenoble/helm-subenv
|
||||||
verify: false
|
|
||||||
register: plugin
|
register: plugin
|
||||||
|
|
||||||
- assert:
|
- assert:
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
redis*
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
helm_template
|
|
||||||
helm_pull
|
|
||||||
helm
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
[all]
|
|
||||||
helm-3.12.3 helm_version=v3.12.3 test_namespace=helm-plain-http-v3-12-3 tests_should_failed=true
|
|
||||||
helm-3.18.2 helm_version=v3.18.2 test_namespace=helm-plain-http-v3-18-2 tests_should_failed=false
|
|
||||||
helm-4.0.0 helm_version=v4.0.0 test_namespace=helm-plain-http-v4-0-0 tests_should_failed=false
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
- name: Run test for helm plain http option
|
|
||||||
hosts: all
|
|
||||||
gather_facts: true
|
|
||||||
strategy: free
|
|
||||||
|
|
||||||
vars:
|
|
||||||
ansible_connection: local
|
|
||||||
ansible_python_interpreter: "{{ ansible_playbook_python }}"
|
|
||||||
chart_test_oci: "oci://registry-1.docker.io/bitnamicharts/redis"
|
|
||||||
|
|
||||||
roles:
|
|
||||||
- role: setup_namespace
|
|
||||||
|
|
||||||
tasks:
|
|
||||||
- ansible.builtin.include_tasks: tasks/test.yaml
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
---
|
|
||||||
- name: Run test for helm
|
|
||||||
block:
|
|
||||||
- name: Create temporary directory to install chart In
|
|
||||||
ansible.builtin.tempfile:
|
|
||||||
state: directory
|
|
||||||
suffix: .helm
|
|
||||||
register: install_path
|
|
||||||
|
|
||||||
- name: Install required helm version
|
|
||||||
ansible.builtin.include_role:
|
|
||||||
name: install_helm
|
|
||||||
vars:
|
|
||||||
helm_install_path: "{{ install_path.path }}"
|
|
||||||
|
|
||||||
# helm
|
|
||||||
- name: Run helm with plain_http
|
|
||||||
kubernetes.core.helm:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
chart_ref: "{{ chart_test_oci }}"
|
|
||||||
release_name: test-secure
|
|
||||||
release_namespace: "{{ test_namespace }}"
|
|
||||||
create_namespace: true
|
|
||||||
plain_http: true
|
|
||||||
register: install_chart
|
|
||||||
ignore_errors: true
|
|
||||||
|
|
||||||
- name: Ensure module failed as expected
|
|
||||||
ansible.builtin.assert:
|
|
||||||
that:
|
|
||||||
- install_chart is failed
|
|
||||||
- '"plain_http requires helm >= 3.13.0" in install_chart.msg'
|
|
||||||
when: tests_should_failed | bool
|
|
||||||
|
|
||||||
- name: Ensure the result command contains the expected option
|
|
||||||
ansible.builtin.assert:
|
|
||||||
that:
|
|
||||||
- install_chart is not failed
|
|
||||||
- '"--plain-http" in install_chart.command'
|
|
||||||
when: not (tests_should_failed | bool)
|
|
||||||
|
|
||||||
# helm_pull
|
|
||||||
- name: Trying to download helm chart with option plain_http
|
|
||||||
kubernetes.core.helm_pull:
|
|
||||||
chart_ref: "{{ chart_test_oci }}"
|
|
||||||
destination: "{{ playbook_dir }}"
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
plain_http: true
|
|
||||||
register: pull_chart
|
|
||||||
ignore_errors: true
|
|
||||||
|
|
||||||
- name: Ensure module failed as expected
|
|
||||||
ansible.builtin.assert:
|
|
||||||
that:
|
|
||||||
- pull_chart is failed
|
|
||||||
- '"plain_http requires helm >= 3.13.0" in pull_chart.msg'
|
|
||||||
when: tests_should_failed | bool
|
|
||||||
|
|
||||||
- name: Ensure the result command contains the expected option
|
|
||||||
ansible.builtin.assert:
|
|
||||||
that:
|
|
||||||
- pull_chart is not failed
|
|
||||||
- '"--plain-http" in pull_chart.command'
|
|
||||||
when: not (tests_should_failed | bool)
|
|
||||||
|
|
||||||
# helm_template
|
|
||||||
- name: Test helm render template
|
|
||||||
kubernetes.core.helm_template:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
chart_ref: "{{ chart_test_oci }}"
|
|
||||||
output_dir: "{{ playbook_dir }}"
|
|
||||||
plain_http: true
|
|
||||||
register: template
|
|
||||||
ignore_errors: true
|
|
||||||
|
|
||||||
- name: Ensure module failed as expected
|
|
||||||
ansible.builtin.assert:
|
|
||||||
that:
|
|
||||||
- template is failed
|
|
||||||
- '"plain_http requires helm >= 3.13.0" in template.msg'
|
|
||||||
when: tests_should_failed | bool
|
|
||||||
|
|
||||||
- name: Ensure the result command contains the expected option
|
|
||||||
ansible.builtin.assert:
|
|
||||||
that:
|
|
||||||
- template is not failed
|
|
||||||
- '"--plain-http" in template.command'
|
|
||||||
when: not (tests_should_failed | bool)
|
|
||||||
|
|
||||||
always:
|
|
||||||
- name: Delete temporary file
|
|
||||||
ansible.builtin.file:
|
|
||||||
path: "{{ install_path.path }}"
|
|
||||||
state: absent
|
|
||||||
ignore_errors: true
|
|
||||||
@@ -1,4 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
set -eux
|
|
||||||
export ANSIBLE_ROLES_PATH=../
|
|
||||||
ansible-playbook playbooks/play.yaml -i inventory.ini "$@"
|
|
||||||
3
tests/integration/targets/helm_plugin/meta/main.yml
Normal file
3
tests/integration/targets/helm_plugin/meta/main.yml
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
dependencies:
|
||||||
|
- install_helm
|
||||||
@@ -1,8 +1,165 @@
|
|||||||
---
|
---
|
||||||
- name: Run tests
|
- name: Install env plugin in check mode
|
||||||
include_tasks: run_tests.yml
|
helm_plugin:
|
||||||
loop_control:
|
binary_path: "{{ helm_binary }}"
|
||||||
loop_var: helm_version
|
state: present
|
||||||
with_items:
|
plugin_path: https://github.com/adamreese/helm-env
|
||||||
- "v3.17.0"
|
register: check_install_env
|
||||||
- "v4.0.0"
|
check_mode: true
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- check_install_env.changed
|
||||||
|
|
||||||
|
- name: Install env plugin
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
state: present
|
||||||
|
plugin_path: https://github.com/adamreese/helm-env
|
||||||
|
register: install_env
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- install_env.changed
|
||||||
|
|
||||||
|
- name: Gather info about all plugin
|
||||||
|
helm_plugin_info:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
register: plugin_info
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- plugin_info.plugin_list is defined
|
||||||
|
|
||||||
|
- name: Install env plugin again
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
state: present
|
||||||
|
plugin_path: https://github.com/adamreese/helm-env
|
||||||
|
register: install_env
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- not install_env.changed
|
||||||
|
|
||||||
|
- name: Uninstall env plugin in check mode
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
state: absent
|
||||||
|
plugin_name: env
|
||||||
|
register: check_uninstall_env
|
||||||
|
check_mode: true
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- check_uninstall_env.changed
|
||||||
|
|
||||||
|
- name: Uninstall env plugin
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
state: absent
|
||||||
|
plugin_name: env
|
||||||
|
register: uninstall_env
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- uninstall_env.changed
|
||||||
|
|
||||||
|
- name: Uninstall env plugin again
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
state: absent
|
||||||
|
plugin_name: env
|
||||||
|
register: uninstall_env
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- not uninstall_env.changed
|
||||||
|
|
||||||
|
# https://github.com/ansible-collections/community.kubernetes/issues/399
|
||||||
|
- block:
|
||||||
|
- name: Copy required plugin files
|
||||||
|
copy:
|
||||||
|
src: "files/sample_plugin"
|
||||||
|
dest: "/tmp/helm_plugin_test/"
|
||||||
|
|
||||||
|
- name: Install sample_plugin from the directory
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
state: present
|
||||||
|
plugin_path: "/tmp/helm_plugin_test/sample_plugin"
|
||||||
|
register: sample_plugin_output
|
||||||
|
|
||||||
|
- name: Assert that sample_plugin is installed or not
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- sample_plugin_output.changed
|
||||||
|
|
||||||
|
- name: Gather Helm plugin info
|
||||||
|
helm_plugin_info:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
register: r
|
||||||
|
|
||||||
|
- name: Set sample_plugin version
|
||||||
|
set_fact:
|
||||||
|
plugin_version: "{{ ( r.plugin_list | selectattr('name', 'equalto', plugin_name) | list )[0].version }}"
|
||||||
|
vars:
|
||||||
|
plugin_name: "sample_plugin"
|
||||||
|
|
||||||
|
- name: Assert if sample_plugin with multiline comment is installed
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- plugin_version == "0.0.1"
|
||||||
|
always:
|
||||||
|
- name: Uninstall sample_plugin
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
state: absent
|
||||||
|
plugin_name: sample_plugin
|
||||||
|
ignore_errors: yes
|
||||||
|
|
||||||
|
- block:
|
||||||
|
- name: uninstall helm plugin secrets
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
plugin_name: secrets
|
||||||
|
state: absent
|
||||||
|
|
||||||
|
- name: install helm-secrets on a specific version
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
plugin_path: https://github.com/jkroepke/helm-secrets
|
||||||
|
plugin_version: 3.4.1
|
||||||
|
state: present
|
||||||
|
|
||||||
|
- name: list helm plugin
|
||||||
|
helm_plugin_info:
|
||||||
|
plugin_name: secrets
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
register: plugin_list
|
||||||
|
|
||||||
|
- name: assert that secrets has been installed with specified version
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- plugin_list.plugin_list[0].version == "3.4.1"
|
||||||
|
|
||||||
|
- name: Update helm plugin version to latest
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
plugin_name: secrets
|
||||||
|
state: latest
|
||||||
|
register: _update
|
||||||
|
|
||||||
|
- name: assert update was performed
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- _update.changed
|
||||||
|
- '"Updated plugin: secrets" in _update.stdout'
|
||||||
|
|
||||||
|
always:
|
||||||
|
- name: Uninstall sample_plugin
|
||||||
|
helm_plugin:
|
||||||
|
binary_path: "{{ helm_binary }}"
|
||||||
|
state: absent
|
||||||
|
plugin_name: secrets
|
||||||
|
ignore_errors: yes
|
||||||
|
|||||||
@@ -1,195 +0,0 @@
|
|||||||
---
|
|
||||||
- name: "Install {{ helm_version }}"
|
|
||||||
include_role:
|
|
||||||
name: install_helm
|
|
||||||
|
|
||||||
- block:
|
|
||||||
- name: Install env plugin in check mode
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
state: present
|
|
||||||
plugin_path: https://github.com/adamreese/helm-env
|
|
||||||
verify: false
|
|
||||||
register: check_install_env
|
|
||||||
check_mode: true
|
|
||||||
|
|
||||||
- assert:
|
|
||||||
that:
|
|
||||||
- check_install_env.changed
|
|
||||||
|
|
||||||
- name: Install env plugin
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
state: present
|
|
||||||
plugin_path: https://github.com/adamreese/helm-env
|
|
||||||
verify: false
|
|
||||||
register: install_env
|
|
||||||
|
|
||||||
- assert:
|
|
||||||
that:
|
|
||||||
- install_env.changed
|
|
||||||
|
|
||||||
- name: Gather info about all plugin
|
|
||||||
helm_plugin_info:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
register: plugin_info
|
|
||||||
|
|
||||||
- assert:
|
|
||||||
that:
|
|
||||||
- plugin_info.plugin_list is defined
|
|
||||||
|
|
||||||
- name: Install env plugin again
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
state: present
|
|
||||||
plugin_path: https://github.com/adamreese/helm-env
|
|
||||||
verify: false
|
|
||||||
register: install_env
|
|
||||||
|
|
||||||
- assert:
|
|
||||||
that:
|
|
||||||
- not install_env.changed
|
|
||||||
|
|
||||||
- name: Uninstall env plugin in check mode
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
state: absent
|
|
||||||
plugin_name: env
|
|
||||||
verify: false
|
|
||||||
register: check_uninstall_env
|
|
||||||
check_mode: true
|
|
||||||
|
|
||||||
- assert:
|
|
||||||
that:
|
|
||||||
- check_uninstall_env.changed
|
|
||||||
|
|
||||||
- name: Uninstall env plugin
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
state: absent
|
|
||||||
plugin_name: env
|
|
||||||
register: uninstall_env
|
|
||||||
|
|
||||||
- assert:
|
|
||||||
that:
|
|
||||||
- uninstall_env.changed
|
|
||||||
|
|
||||||
- name: Uninstall env plugin again
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
state: absent
|
|
||||||
plugin_name: env
|
|
||||||
register: uninstall_env
|
|
||||||
|
|
||||||
- assert:
|
|
||||||
that:
|
|
||||||
- not uninstall_env.changed
|
|
||||||
|
|
||||||
always:
|
|
||||||
- name: Uninstall env plugin
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
state: absent
|
|
||||||
plugin_name: env
|
|
||||||
|
|
||||||
# https://github.com/ansible-collections/community.kubernetes/issues/399
|
|
||||||
- block:
|
|
||||||
- name: Copy required plugin files
|
|
||||||
copy:
|
|
||||||
src: "files/sample_plugin"
|
|
||||||
dest: "/tmp/helm_plugin_test/"
|
|
||||||
|
|
||||||
- name: Install sample_plugin from the directory
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
state: present
|
|
||||||
plugin_path: "/tmp/helm_plugin_test/sample_plugin"
|
|
||||||
register: sample_plugin_output
|
|
||||||
|
|
||||||
- name: Assert that sample_plugin is installed or not
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- sample_plugin_output.changed
|
|
||||||
|
|
||||||
- name: Gather Helm plugin info
|
|
||||||
helm_plugin_info:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
register: r
|
|
||||||
|
|
||||||
- name: Set sample_plugin version
|
|
||||||
set_fact:
|
|
||||||
plugin_version: "{{ ( r.plugin_list | selectattr('name', 'equalto', plugin_name) | list )[0].version }}"
|
|
||||||
vars:
|
|
||||||
plugin_name: "sample_plugin"
|
|
||||||
|
|
||||||
- name: Assert if sample_plugin with multiline comment is installed
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- plugin_version == "0.0.1"
|
|
||||||
always:
|
|
||||||
- name: Uninstall sample_plugin
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
state: absent
|
|
||||||
plugin_name: sample_plugin
|
|
||||||
ignore_errors: true
|
|
||||||
|
|
||||||
- block:
|
|
||||||
- name: uninstall helm plugin unittest
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
plugin_name: unittest
|
|
||||||
state: absent
|
|
||||||
|
|
||||||
- name: install helm-unittest on a specific version
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
plugin_path: https://github.com/helm-unittest/helm-unittest
|
|
||||||
plugin_version: v1.0.1
|
|
||||||
verify: false
|
|
||||||
state: present
|
|
||||||
|
|
||||||
- name: list helm plugin
|
|
||||||
helm_plugin_info:
|
|
||||||
plugin_name: unittest
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
register: plugin_list
|
|
||||||
|
|
||||||
- name: assert that unittest has been installed with specified version
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- plugin_list.plugin_list[0].version == "1.0.1"
|
|
||||||
|
|
||||||
- name: Update helm plugin version to latest (check mode)
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
plugin_name: unittest
|
|
||||||
state: latest
|
|
||||||
register: _update_checkmode
|
|
||||||
check_mode: true
|
|
||||||
|
|
||||||
- name: Assert that module reported change while running in check mode
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- _update_checkmode.changed
|
|
||||||
- '"Updated plugin: unittest" not in _update_checkmode.stdout'
|
|
||||||
|
|
||||||
- name: Update helm plugin version to latest
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
plugin_name: unittest
|
|
||||||
state: latest
|
|
||||||
register: _update
|
|
||||||
|
|
||||||
- name: assert update was performed
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- _update.changed
|
|
||||||
- '"Updated plugin: unittest" in _update.stdout'
|
|
||||||
|
|
||||||
always:
|
|
||||||
- name: Uninstall sample_plugin
|
|
||||||
helm_plugin:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
state: absent
|
|
||||||
plugin_name: unittest
|
|
||||||
@@ -5,7 +5,7 @@
|
|||||||
- 3.8.0
|
- 3.8.0
|
||||||
- 3.1.0
|
- 3.1.0
|
||||||
- 3.0.0
|
- 3.0.0
|
||||||
- 4.0.0
|
- 2.3.0
|
||||||
|
|
||||||
- block:
|
- block:
|
||||||
- name: Create temp directory for helm tests
|
- name: Create temp directory for helm tests
|
||||||
@@ -20,13 +20,37 @@
|
|||||||
- set_fact:
|
- set_fact:
|
||||||
destination: "{{ temp_dir }}"
|
destination: "{{ temp_dir }}"
|
||||||
|
|
||||||
- name: Install Helm versions
|
- name: Create Helm directories
|
||||||
ansible.builtin.include_role:
|
file:
|
||||||
name: install_helm
|
state: directory
|
||||||
loop: "{{ helm_versions }}"
|
path: "{{ temp_dir }}/{{ item }}"
|
||||||
|
with_items: "{{ helm_versions }}"
|
||||||
|
|
||||||
|
- name: Unarchive Helm binary
|
||||||
|
unarchive:
|
||||||
|
src: "https://get.helm.sh/helm-v{{ item }}-linux-amd64.tar.gz"
|
||||||
|
dest: "{{ temp_dir }}/{{ item }}"
|
||||||
|
remote_src: yes
|
||||||
|
with_items: "{{ helm_versions }}"
|
||||||
|
|
||||||
|
# Testing helm pull with helm version == 2.3.0
|
||||||
|
- block:
|
||||||
|
- name: Assert that helm pull failed with helm <= 3.0.0
|
||||||
|
helm_pull:
|
||||||
|
binary_path: "{{ helm_path }}"
|
||||||
|
chart_ref: https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz
|
||||||
|
destination: "{{ destination }}"
|
||||||
|
ignore_errors: true
|
||||||
|
register: _result
|
||||||
|
|
||||||
|
- name: assert that module failed with proper message
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- _result is failed
|
||||||
|
- _result.msg == "This module requires helm >= 3.0.0, current version is 2.3.0"
|
||||||
|
|
||||||
vars:
|
vars:
|
||||||
helm_version: "v{{ item }}"
|
helm_path: "{{ temp_dir }}/2.3.0/linux-amd64/helm"
|
||||||
helm_install_path: "{{ temp_dir }}/{{ item }}"
|
|
||||||
|
|
||||||
# Testing helm pull with helm version == 3.0.0
|
# Testing helm pull with helm version == 3.0.0
|
||||||
- block:
|
- block:
|
||||||
@@ -79,7 +103,7 @@
|
|||||||
- _result.msg == "Parameter chart_ca_cert requires helm >= 3.1.0, current version is 3.0.0"
|
- _result.msg == "Parameter chart_ca_cert requires helm >= 3.1.0, current version is 3.0.0"
|
||||||
|
|
||||||
vars:
|
vars:
|
||||||
helm_path: "{{ temp_dir }}/3.0.0/helm"
|
helm_path: "{{ temp_dir }}/3.0.0/linux-amd64/helm"
|
||||||
|
|
||||||
# Testing helm pull with helm version == 3.1.0
|
# Testing helm pull with helm version == 3.1.0
|
||||||
- block:
|
- block:
|
||||||
@@ -119,7 +143,7 @@
|
|||||||
- _result.msg == "Parameter skip_tls_certs_check requires helm >= 3.3.0, current version is 3.1.0"
|
- _result.msg == "Parameter skip_tls_certs_check requires helm >= 3.3.0, current version is 3.1.0"
|
||||||
|
|
||||||
vars:
|
vars:
|
||||||
helm_path: "{{ temp_dir }}/3.1.0/helm"
|
helm_path: "{{ temp_dir }}/3.1.0/linux-amd64/helm"
|
||||||
|
|
||||||
# Testing helm pull with helm version == 3.8.0
|
# Testing helm pull with helm version == 3.8.0
|
||||||
- block:
|
- block:
|
||||||
@@ -197,103 +221,8 @@
|
|||||||
- _chart.stat.exists
|
- _chart.stat.exists
|
||||||
- _chart.stat.isdir
|
- _chart.stat.isdir
|
||||||
|
|
||||||
# Test idempotency with tarred chart
|
|
||||||
- name: Download chart with version (first time)
|
|
||||||
helm_pull:
|
|
||||||
binary_path: "{{ helm_path }}"
|
|
||||||
chart_ref: "oci://registry-1.docker.io/bitnamicharts/redis"
|
|
||||||
destination: "{{ destination }}"
|
|
||||||
chart_version: "24.1.0"
|
|
||||||
register: _result_first
|
|
||||||
|
|
||||||
- name: Download chart with version (second time - should be idempotent)
|
|
||||||
helm_pull:
|
|
||||||
binary_path: "{{ helm_path }}"
|
|
||||||
chart_ref: "oci://registry-1.docker.io/bitnamicharts/redis"
|
|
||||||
destination: "{{ destination }}"
|
|
||||||
chart_version: "24.1.0"
|
|
||||||
register: _result_second
|
|
||||||
|
|
||||||
- name: Validate idempotency for tarred chart
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- _result_first is changed
|
|
||||||
- _result_second is not changed
|
|
||||||
|
|
||||||
# Test force parameter with tarred chart
|
|
||||||
- name: Download chart with force=true (should always download)
|
|
||||||
helm_pull:
|
|
||||||
binary_path: "{{ helm_path }}"
|
|
||||||
chart_ref: "oci://registry-1.docker.io/bitnamicharts/redis"
|
|
||||||
destination: "{{ destination }}"
|
|
||||||
chart_version: "24.1.0"
|
|
||||||
force: true
|
|
||||||
register: _result_force
|
|
||||||
|
|
||||||
- name: Validate force parameter causes download
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- _result_force is changed
|
|
||||||
|
|
||||||
# Test idempotency with untarred chart in the separate folder
|
|
||||||
- name: Create separate directory for untar test under {{ temp_dir }}
|
|
||||||
ansible.builtin.file:
|
|
||||||
path: "{{ destination }}/untar_test"
|
|
||||||
state: directory
|
|
||||||
mode: '0755'
|
|
||||||
|
|
||||||
- name: Download and untar chart (first time)
|
|
||||||
helm_pull:
|
|
||||||
binary_path: "{{ helm_path }}"
|
|
||||||
chart_ref: "oci://registry-1.docker.io/bitnamicharts/redis"
|
|
||||||
destination: "{{ destination }}/untar_test"
|
|
||||||
chart_version: "24.0.0"
|
|
||||||
untar_chart: true
|
|
||||||
register: _result_untar_first
|
|
||||||
|
|
||||||
- name: Download and untar chart (second time - should be idempotent)
|
|
||||||
helm_pull:
|
|
||||||
binary_path: "{{ helm_path }}"
|
|
||||||
chart_ref: "oci://registry-1.docker.io/bitnamicharts/redis"
|
|
||||||
destination: "{{ destination }}/untar_test"
|
|
||||||
chart_version: "24.0.0"
|
|
||||||
untar_chart: true
|
|
||||||
register: _result_untar_second
|
|
||||||
|
|
||||||
- name: Validate idempotency for untarred chart
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- _result_untar_first is changed
|
|
||||||
- _result_untar_second is not changed
|
|
||||||
|
|
||||||
- name: Download and untar chart with force=true (should remove existing directory and re-extract)
|
|
||||||
helm_pull:
|
|
||||||
binary_path: "{{ helm_path }}"
|
|
||||||
chart_ref: "oci://registry-1.docker.io/bitnamicharts/redis"
|
|
||||||
destination: "{{ destination }}/untar_test"
|
|
||||||
chart_version: "24.0.0"
|
|
||||||
untar_chart: true
|
|
||||||
force: true
|
|
||||||
register: _result_untar_force
|
|
||||||
|
|
||||||
- name: Validate first force extraction works
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- _result_untar_force is changed
|
|
||||||
|
|
||||||
- name: Verify chart directory still exists after force re-extraction
|
|
||||||
stat:
|
|
||||||
path: "{{ destination }}/untar_test/redis"
|
|
||||||
register: _chart_after_force
|
|
||||||
|
|
||||||
- name: Validate chart directory exists
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- _chart_after_force.stat.exists
|
|
||||||
- _chart_after_force.stat.isdir
|
|
||||||
|
|
||||||
vars:
|
vars:
|
||||||
helm_path: "{{ temp_dir }}/3.8.0/helm"
|
helm_path: "{{ temp_dir }}/3.8.0/linux-amd64/helm"
|
||||||
|
|
||||||
|
|
||||||
always:
|
always:
|
||||||
|
|||||||
@@ -5,9 +5,5 @@ username: testuser
|
|||||||
password: testpassword
|
password: testpassword
|
||||||
wrong_password: 'WrongPassword'
|
wrong_password: 'WrongPassword'
|
||||||
registry_name: oci_registry
|
registry_name: oci_registry
|
||||||
registry_port: 5002
|
registry_port: 5000
|
||||||
test_chart: https://github.com/grafana/helm-charts/releases/download/k8s-monitoring-1.6.8/k8s-monitoring-1.6.8.tgz
|
test_chart: https://github.com/grafana/helm-charts/releases/download/k8s-monitoring-1.6.8/k8s-monitoring-1.6.8.tgz
|
||||||
helm_versions:
|
|
||||||
- v3.17.0
|
|
||||||
- v3.20.0
|
|
||||||
- v4.0.0
|
|
||||||
|
|||||||
@@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
dependencies:
|
||||||
|
- install_helm
|
||||||
182
tests/integration/targets/helm_registry_auth/tasks/main.yaml
Normal file
182
tests/integration/targets/helm_registry_auth/tasks/main.yaml
Normal file
@@ -0,0 +1,182 @@
|
|||||||
|
---
|
||||||
|
- name: Run module test
|
||||||
|
# using a shell and command module to run the test as test can be non-idempotent
|
||||||
|
# and it allow to not install any additional dependencies
|
||||||
|
block:
|
||||||
|
- name: Ensure that helm is installed
|
||||||
|
ansible.builtin.shell: helm version --client --short | grep v3
|
||||||
|
register: _helm_version
|
||||||
|
failed_when: _helm_version.rc != 0
|
||||||
|
|
||||||
|
- name: Ensure that Docker demon is running
|
||||||
|
ansible.builtin.command: "docker info"
|
||||||
|
register: _docker_info
|
||||||
|
failed_when: _docker_info.rc != 0
|
||||||
|
|
||||||
|
- name: Create a tmpfile htpasswd directory
|
||||||
|
ansible.builtin.tempfile:
|
||||||
|
state: directory
|
||||||
|
suffix: .httppasswd
|
||||||
|
register: _tmpfile
|
||||||
|
|
||||||
|
- name: Copy htpasswd to the tmpfile directory
|
||||||
|
ansible.builtin.copy:
|
||||||
|
src: registry.password
|
||||||
|
dest: "{{ _tmpfile.path }}/registry.password"
|
||||||
|
|
||||||
|
- name: Setup the registry
|
||||||
|
ansible.builtin.command: >-
|
||||||
|
docker run -d --rm
|
||||||
|
-p {{ registry_port }}:5000
|
||||||
|
--name "{{ registry_name }}"
|
||||||
|
-v "{{ _tmpfile.path }}:/auth"
|
||||||
|
-e "REGISTRY_AUTH=htpasswd"
|
||||||
|
-e "REGISTRY_AUTH_HTPASSWD_REALM=Registry Realm"
|
||||||
|
-e REGISTRY_AUTH_HTPASSWD_PATH=/auth/registry.password
|
||||||
|
registry:2
|
||||||
|
register: _setup_registry
|
||||||
|
failed_when: _setup_registry.rc != 0
|
||||||
|
|
||||||
|
- name: Ensure that the registry is running and rechable
|
||||||
|
ansible.builtin.wait_for:
|
||||||
|
host: localhost
|
||||||
|
port: "{{ registry_port }}"
|
||||||
|
|
||||||
|
- name: Test the registry with correct credentials to ensure that the registry is running
|
||||||
|
ansible.builtin.shell: >-
|
||||||
|
echo {{ password | quote }} | helm registry login localhost:{{ registry_port }}
|
||||||
|
-u {{ username }} --password-stdin
|
||||||
|
register: _login_correct
|
||||||
|
failed_when: _login_correct.rc != 0
|
||||||
|
|
||||||
|
- name: Clean up credentials to run test on clean environment
|
||||||
|
ansible.builtin.shell: >-
|
||||||
|
helm registry logout localhost:{{ registry_port }}
|
||||||
|
register: _logout
|
||||||
|
failed_when: _logout.rc != 0
|
||||||
|
|
||||||
|
- name: Create directory for helm chart
|
||||||
|
ansible.builtin.tempfile:
|
||||||
|
state: directory
|
||||||
|
suffix: ".helm"
|
||||||
|
register: _destination
|
||||||
|
|
||||||
|
- name: Pull test helm chart
|
||||||
|
ansible.builtin.uri:
|
||||||
|
url: "{{ test_chart }}"
|
||||||
|
dest: "{{ _destination.path }}/k8s-monitoring-1.6.8.tgz"
|
||||||
|
return_content: no
|
||||||
|
status_code: 200
|
||||||
|
|
||||||
|
- name: Test module helm_registry_auth with correct credentials
|
||||||
|
helm_registry_auth:
|
||||||
|
username: "{{ username }}"
|
||||||
|
password: "{{ password }}"
|
||||||
|
host: localhost:{{ registry_port }}
|
||||||
|
state: present
|
||||||
|
register: _helm_registry_auth_correct
|
||||||
|
|
||||||
|
- name: Assert that the registry is logged in
|
||||||
|
# Helm binary prints the message to stderr, refence: https://github.com/helm/helm/issues/13464
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- "'Login Succeeded' in _helm_registry_auth_correct.stderr"
|
||||||
|
- "'{{ password }}' not in _helm_registry_auth_correct.command"
|
||||||
|
- "'{{ password }}' not in _helm_registry_auth_correct.stdout"
|
||||||
|
- "'{{ password }}' not in _helm_registry_auth_correct.stderr"
|
||||||
|
|
||||||
|
- name: Ensure that push to the registry is working
|
||||||
|
ansible.builtin.shell: >-
|
||||||
|
helm push "{{ _destination.path }}/k8s-monitoring-1.6.8.tgz" oci://localhost:{{ registry_port }}/test/
|
||||||
|
register: _save_chart
|
||||||
|
failed_when: _save_chart.rc != 0
|
||||||
|
|
||||||
|
- name: Assert that the chart is saved
|
||||||
|
# Helm binary prints the message to stderr, refence: https://github.com/helm/helm/issues/13464
|
||||||
|
assert:
|
||||||
|
that: "'Pushed: localhost:{{ registry_port }}/test/k8s-monitoring' in _save_chart.stderr"
|
||||||
|
|
||||||
|
|
||||||
|
- name: Test logout
|
||||||
|
helm_registry_auth:
|
||||||
|
host: localhost:{{ registry_port }}
|
||||||
|
state: absent
|
||||||
|
register: _helm_registry_auth_logout
|
||||||
|
|
||||||
|
- name: Assert logout
|
||||||
|
# Helm binary prints the message to stderr
|
||||||
|
assert:
|
||||||
|
that: "'Removing login credentials' in _helm_registry_auth_logout.stderr"
|
||||||
|
|
||||||
|
- name: Test idempotency of logout with helm < 3.18.0
|
||||||
|
when: _helm_version.stdout is ansible.builtin.version('v3.18.0', '<')
|
||||||
|
block:
|
||||||
|
|
||||||
|
- name: Test logout idempotency
|
||||||
|
helm_registry_auth:
|
||||||
|
host: localhost:{{ registry_port }}
|
||||||
|
state: absent
|
||||||
|
register: _helm_registry_auth_logout_idempotency
|
||||||
|
|
||||||
|
- name: Assert logout operation did not report change
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that: _helm_registry_auth_logout_idempotency is not changed
|
||||||
|
|
||||||
|
- name: Ensure that not able to push to the registry
|
||||||
|
ansible.builtin.shell: >-
|
||||||
|
helm push "{{ _destination.path }}/k8s-monitoring-1.6.8.tgz" oci://localhost:{{ registry_port }}/test/
|
||||||
|
register: _save_chart
|
||||||
|
failed_when: _save_chart.rc == 0
|
||||||
|
|
||||||
|
- name: Read content of ~/.config/helm/registry/config.json
|
||||||
|
ansible.builtin.slurp:
|
||||||
|
src: ~/.config/helm/registry/config.json
|
||||||
|
register: _config_json
|
||||||
|
|
||||||
|
- name: Assert that auth data is remove and the chart is not saved
|
||||||
|
# Helm binary prints the message to stderr
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- "'push access denied' in _save_chart.stderr or 'basic credential not found' in _save_chart.stderr"
|
||||||
|
- "_save_chart.rc != 0"
|
||||||
|
- "'localhost:{{ registry_port }}' not in _config_json.content | b64decode"
|
||||||
|
|
||||||
|
- name: Test module helm_registry_auth with wrong credentials
|
||||||
|
helm_registry_auth:
|
||||||
|
username: "{{ username }}"
|
||||||
|
password: "{{ wrong_password }}"
|
||||||
|
host: localhost:{{ registry_port }}
|
||||||
|
state: present
|
||||||
|
register: _helm_registry_auth_wrong
|
||||||
|
ignore_errors: true
|
||||||
|
|
||||||
|
- name: Read content of ~/.config/helm/registry/config.json
|
||||||
|
ansible.builtin.slurp:
|
||||||
|
src: ~/.config/helm/registry/config.json
|
||||||
|
register: _config_json
|
||||||
|
|
||||||
|
- name: Assert that the registry is not logged in and auth data is not saved
|
||||||
|
ansible.builtin.assert:
|
||||||
|
that:
|
||||||
|
- "'401' in _helm_registry_auth_wrong.stderr"
|
||||||
|
- "'unauthorized' in _helm_registry_auth_wrong.stderr | lower"
|
||||||
|
- "'{{ wrong_password }}' not in _helm_registry_auth_correct.command"
|
||||||
|
- "'{{ wrong_password }}' not in _helm_registry_auth_correct.stdout"
|
||||||
|
- "'{{ wrong_password }}' not in _helm_registry_auth_correct.stderr"
|
||||||
|
- "'localhost:{{ registry_port }}' not in _config_json.content | b64decode"
|
||||||
|
|
||||||
|
# Clean up
|
||||||
|
always:
|
||||||
|
- name: Stop and remove the registry
|
||||||
|
ansible.builtin.command: docker stop {{ registry_name }}
|
||||||
|
ignore_errors: true
|
||||||
|
|
||||||
|
- name: Remove the tmpfile
|
||||||
|
ansible.builtin.file:
|
||||||
|
state: absent
|
||||||
|
path: "{{ item }}"
|
||||||
|
force: true
|
||||||
|
loop:
|
||||||
|
- "{{ _tmpfile.path }}"
|
||||||
|
- "{{ _destination.path }}"
|
||||||
|
ignore_errors: true
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
---
|
|
||||||
- name: Run tests for helm_registry_auth with different helm versions
|
|
||||||
block:
|
|
||||||
- name: Create temporary directory to install helm binaries
|
|
||||||
ansible.builtin.tempfile:
|
|
||||||
state: directory
|
|
||||||
suffix: .helm
|
|
||||||
register: _tmpdir
|
|
||||||
|
|
||||||
- name: Ensure that Docker demon is running
|
|
||||||
ansible.builtin.command: "docker info"
|
|
||||||
register: _docker_info
|
|
||||||
failed_when: _docker_info.rc != 0
|
|
||||||
|
|
||||||
- name: Copy htpasswd to the tmpfile directory
|
|
||||||
ansible.builtin.copy:
|
|
||||||
src: registry.password
|
|
||||||
dest: "{{ _tmpdir.path }}/registry.password"
|
|
||||||
|
|
||||||
- name: Pull test helm chart
|
|
||||||
ansible.builtin.uri:
|
|
||||||
url: "{{ test_chart }}"
|
|
||||||
dest: "{{ _tmpdir.path }}/k8s-monitoring-1.6.8.tgz"
|
|
||||||
return_content: no
|
|
||||||
status_code: 200
|
|
||||||
|
|
||||||
- name: Setup the registry
|
|
||||||
ansible.builtin.command: >-
|
|
||||||
docker run -d --rm
|
|
||||||
-p {{ registry_port }}:5000
|
|
||||||
--name "{{ registry_name }}"
|
|
||||||
-v "{{ _tmpdir.path }}:/auth"
|
|
||||||
-e "REGISTRY_AUTH=htpasswd"
|
|
||||||
-e "REGISTRY_AUTH_HTPASSWD_REALM=Registry Realm"
|
|
||||||
-e REGISTRY_AUTH_HTPASSWD_PATH=/auth/registry.password
|
|
||||||
registry:2
|
|
||||||
register: _setup_registry
|
|
||||||
failed_when: _setup_registry.rc != 0
|
|
||||||
|
|
||||||
- name: Ensure that the registry is running and rechable
|
|
||||||
ansible.builtin.wait_for:
|
|
||||||
host: localhost
|
|
||||||
port: "{{ registry_port }}"
|
|
||||||
|
|
||||||
- name: Run tests
|
|
||||||
ansible.builtin.include_tasks: run_tests.yml
|
|
||||||
loop: "{{ helm_versions }}"
|
|
||||||
loop_control:
|
|
||||||
loop_var: helm_version
|
|
||||||
|
|
||||||
always:
|
|
||||||
- name: Stop and remove the registry
|
|
||||||
ansible.builtin.command: docker stop {{ registry_name }}
|
|
||||||
ignore_errors: true
|
|
||||||
|
|
||||||
- name: Delete temporary directory
|
|
||||||
ansible.builtin.file:
|
|
||||||
state: absent
|
|
||||||
path: "{{ _tmpdir.path }}"
|
|
||||||
ignore_errors: true
|
|
||||||
@@ -1,108 +0,0 @@
|
|||||||
---
|
|
||||||
- block:
|
|
||||||
- name: Install helm versions
|
|
||||||
ansible.builtin.include_role:
|
|
||||||
name: install_helm
|
|
||||||
|
|
||||||
# - name: Test the registry with correct credentials to ensure that the registry is running
|
|
||||||
# ansible.builtin.shell: >-
|
|
||||||
# echo {{ password | quote }} | {{ helm_binary }} registry login localhost:{{ registry_port }}
|
|
||||||
# -u {{ username }} --password-stdin --plain-http
|
|
||||||
# register: _login_correct
|
|
||||||
# failed_when: _login_correct.rc != 0
|
|
||||||
|
|
||||||
# - name: Clean up credentials to run test on clean environment
|
|
||||||
# ansible.builtin.shell: >-
|
|
||||||
# {{ helm_binary }} registry logout localhost:{{ registry_port }}
|
|
||||||
# register: _logout
|
|
||||||
# failed_when: _logout.rc != 0
|
|
||||||
|
|
||||||
- name: Test module helm_registry_auth with correct credentials
|
|
||||||
helm_registry_auth:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
username: "{{ username }}"
|
|
||||||
password: "{{ password }}"
|
|
||||||
host: localhost:{{ registry_port }}
|
|
||||||
plain_http: true
|
|
||||||
state: present
|
|
||||||
register: _helm_registry_auth_correct
|
|
||||||
|
|
||||||
- name: Assert that the registry is logged in
|
|
||||||
# Helm binary prints the message to stderr, refence: https://github.com/helm/helm/issues/13464
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- "'Login Succeeded' in _helm_registry_auth_correct.stdout_lines + _helm_registry_auth_correct.stderr_lines"
|
|
||||||
- password not in _helm_registry_auth_correct.command
|
|
||||||
- password not in _helm_registry_auth_correct.stdout
|
|
||||||
- password not in _helm_registry_auth_correct.stderr
|
|
||||||
|
|
||||||
- name: Ensure that push to the registry is working
|
|
||||||
ansible.builtin.shell: >-
|
|
||||||
{{ helm_binary }} push --plain-http "{{ _tmpdir.path }}/k8s-monitoring-1.6.8.tgz" oci://localhost:{{ registry_port }}/test/
|
|
||||||
register: _save_chart
|
|
||||||
failed_when: _save_chart.rc != 0
|
|
||||||
|
|
||||||
- name: Assert that the chart is saved
|
|
||||||
# Helm binary prints the message to stderr, refence: https://github.com/helm/helm/issues/13464
|
|
||||||
assert:
|
|
||||||
that: "'Pushed: localhost:' + registry_port | string + '/test/k8s-monitoring' in _save_chart.stderr"
|
|
||||||
|
|
||||||
- name: Test logout
|
|
||||||
helm_registry_auth:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
host: localhost:{{ registry_port }}
|
|
||||||
state: absent
|
|
||||||
register: _helm_registry_auth_logout
|
|
||||||
|
|
||||||
- name: Assert logout
|
|
||||||
# Helm binary prints the message to stderr
|
|
||||||
assert:
|
|
||||||
that: "'Removing login credentials' in _helm_registry_auth_logout.stderr"
|
|
||||||
|
|
||||||
- name: Ensure that not able to push to the registry
|
|
||||||
ansible.builtin.shell: >-
|
|
||||||
{{ helm_binary }} push --plain-http "{{ _tmpdir.path }}/k8s-monitoring-1.6.8.tgz" oci://localhost:{{ registry_port }}/test/
|
|
||||||
register: _save_chart
|
|
||||||
failed_when: _save_chart.rc == 0
|
|
||||||
|
|
||||||
- name: Assert that auth data is remove and the chart is not saved
|
|
||||||
# Helm binary prints the message to stderr
|
|
||||||
ansible.builtin.assert:
|
|
||||||
that:
|
|
||||||
- "'push access denied' in _save_chart.stderr or 'basic credential not found' in _save_chart.stderr"
|
|
||||||
- "_save_chart.rc != 0"
|
|
||||||
|
|
||||||
- name: Test idempotency of logout with helm < 3.18.0
|
|
||||||
when: helm_version is ansible.builtin.version('v3.18.0', '<')
|
|
||||||
block:
|
|
||||||
|
|
||||||
- name: Test logout idempotency
|
|
||||||
helm_registry_auth:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
host: localhost:{{ registry_port }}
|
|
||||||
state: absent
|
|
||||||
register: _helm_registry_auth_logout_idempotency
|
|
||||||
|
|
||||||
- name: Assert logout operation did not report change
|
|
||||||
ansible.builtin.assert:
|
|
||||||
that: _helm_registry_auth_logout_idempotency is not changed
|
|
||||||
|
|
||||||
- name: Test module helm_registry_auth with wrong credentials
|
|
||||||
helm_registry_auth:
|
|
||||||
binary_path: "{{ helm_binary }}"
|
|
||||||
username: "{{ username }}"
|
|
||||||
password: "{{ wrong_password }}"
|
|
||||||
host: localhost:{{ registry_port }}
|
|
||||||
state: present
|
|
||||||
plain_http: true
|
|
||||||
register: _helm_registry_auth_wrong
|
|
||||||
ignore_errors: true
|
|
||||||
|
|
||||||
- name: Assert that the registry is not logged in and auth data is not saved
|
|
||||||
ansible.builtin.assert:
|
|
||||||
that:
|
|
||||||
- "'401' in _helm_registry_auth_wrong.stderr"
|
|
||||||
- "'unauthorized' in _helm_registry_auth_wrong.stderr | lower"
|
|
||||||
- "'{{ wrong_password }}' not in _helm_registry_auth_correct.command"
|
|
||||||
- "'{{ wrong_password }}' not in _helm_registry_auth_correct.stdout"
|
|
||||||
- "'{{ wrong_password }}' not in _helm_registry_auth_correct.stderr"
|
|
||||||
@@ -1,2 +1,5 @@
|
|||||||
time=1
|
time=20
|
||||||
helm_repository
|
helm_repository
|
||||||
|
helm_info
|
||||||
|
helm
|
||||||
|
helm_template
|
||||||
@@ -1,5 +1,3 @@
|
|||||||
---
|
---
|
||||||
chart_test_repo: "https://kubernetes.github.io/ingress-nginx"
|
chart_test_repo: "https://kubernetes.github.io/ingress-nginx"
|
||||||
helm_versions:
|
helm_binary: "/tmp/helm/{{ ansible_system | lower }}-amd64/helm"
|
||||||
- v3.20.0
|
|
||||||
- v4.0.0
|
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user