mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-11-21 14:48:37 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e91b3171ea | ||
|
|
693e80389b | ||
|
|
53cb65a740 | ||
|
|
a2803df8e8 | ||
|
|
1016f80aee | ||
|
|
90e868aa37 | ||
|
|
864c7addd1 | ||
|
|
021ffbfec2 | ||
|
|
b40a401ec2 | ||
|
|
e620b92b49 | ||
|
|
40123060c1 | ||
|
|
d44a8501e6 | ||
|
|
c3f7a453fd | ||
|
|
5c06a554a8 | ||
|
|
20b9c3fb7f | ||
|
|
7b17313ace | ||
|
|
569bae6593 | ||
|
|
da42348358 | ||
|
|
79e98c3d6e | ||
|
|
477bb79305 | ||
|
|
fd65a4f09e | ||
|
|
b9749c94f9 | ||
|
|
0f472b53e2 | ||
|
|
a1cd39a71f | ||
|
|
6742eaa725 | ||
|
|
5c98d5696e | ||
|
|
78b82c74f7 | ||
|
|
42963f0536 | ||
|
|
9c3988689f | ||
|
|
08143fc16f | ||
|
|
457a7dc534 | ||
|
|
edee5c994d | ||
|
|
a523a195cb | ||
|
|
7f5c2183c0 | ||
|
|
294c2fce4a | ||
|
|
ebc015955e | ||
|
|
57f4bf76cd | ||
|
|
63f490d123 | ||
|
|
1d49a942d9 | ||
|
|
d8ae230bcf | ||
|
|
71e9aba89c | ||
|
|
fdebba58bc | ||
|
|
e87fe77453 | ||
|
|
714c2f6711 | ||
|
|
2fb6546b03 | ||
|
|
ef9fb67688 |
@@ -4,3 +4,5 @@ plugins/connection/kubectl.py no-changed-when
|
||||
# false positive result
|
||||
plugins/connection/kubectl.py var-naming[no-reserved]
|
||||
plugins/connection/kubectl.py jinja[invalid]
|
||||
# collection EE metadata is not an ansible-builder definition file
|
||||
meta/execution-environment.yml schema[execution-environment]
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
---
|
||||
name: all_green
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.head_ref || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
on: # yamllint disable-line rule:truthy
|
||||
pull_request:
|
||||
types:
|
||||
- opened
|
||||
- reopened
|
||||
- synchronize
|
||||
branches:
|
||||
- main
|
||||
- stable-*
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- stable-*
|
||||
|
||||
jobs:
|
||||
security-check:
|
||||
if: github.event_name == 'pull_request'
|
||||
uses: ./.github/workflows/security-check.yaml
|
||||
|
||||
linters:
|
||||
if: github.event_name == 'pull_request'
|
||||
uses: ./.github/workflows/linters.yaml
|
||||
|
||||
sanity:
|
||||
uses: ./.github/workflows/sanity-tests.yaml
|
||||
|
||||
units:
|
||||
uses: ./.github/workflows/unit-tests.yaml
|
||||
|
||||
coverage:
|
||||
name: Unit test coverage
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
path: ansible_collections/kubernetes/core
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: "3.12"
|
||||
|
||||
- name: Run unit tests with coverage
|
||||
working-directory: ansible_collections/kubernetes/core
|
||||
env:
|
||||
PYTHONPATH: ${{ github.workspace }}
|
||||
run: |
|
||||
python -m pip install --upgrade pip
|
||||
python -m pip install ansible-compat
|
||||
python -m pip install https://github.com/ansible/ansible/archive/stable-2.19.tar.gz
|
||||
# Same deps as the units matrix (build_install_collection); do not use
|
||||
# tests/unit/requirements.txt — its kubernetes pin breaks test_core.py.
|
||||
python -m pip install -r requirements.txt -r test-requirements.txt
|
||||
python -m coverage run --source=plugins -m pytest tests/unit \
|
||||
--ansible-host-pattern localhost
|
||||
python -m coverage xml -o coverage.xml
|
||||
|
||||
- name: Upload coverage artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: coverage
|
||||
path: ansible_collections/kubernetes/core/coverage.xml
|
||||
|
||||
all_green:
|
||||
if: ${{ always() }}
|
||||
needs:
|
||||
- security-check
|
||||
- linters
|
||||
- sanity
|
||||
- units
|
||||
- coverage
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- run: |
|
||||
python -c "
|
||||
import sys
|
||||
|
||||
required = ['sanity', 'units', 'coverage']
|
||||
if '${{ github.event_name }}' == 'pull_request':
|
||||
required = ['security-check', 'linters', 'sanity', 'units', 'coverage']
|
||||
results = {
|
||||
'security-check': '${{ needs.security-check.result }}',
|
||||
'linters': '${{ needs.linters.result }}',
|
||||
'sanity': '${{ needs.sanity.result }}',
|
||||
'units': '${{ needs.units.result }}',
|
||||
'coverage': '${{ needs.coverage.result }}',
|
||||
}
|
||||
|
||||
for name in required:
|
||||
if results[name] == 'failure':
|
||||
print(f'all_green: required job failed: {name} results={results}', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
# cancel-in-progress superseded this run; do not fail (newer run is authoritative)
|
||||
if any(v == 'cancelled' for v in results.values()):
|
||||
print(
|
||||
'all_green: one or more jobs cancelled (usually concurrency); skipping strict gate.',
|
||||
results,
|
||||
)
|
||||
sys.exit(0)
|
||||
|
||||
not_ok = [j for j in required if results[j] != 'success']
|
||||
if not_ok:
|
||||
print(f'all_green: required jobs not success: {not_ok} results={results}', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
for job, status in results.items():
|
||||
if job not in required and status not in ('success', 'skipped'):
|
||||
print(f'all_green: unexpected {job}={status} results={results}', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
|
||||
print('all_green OK', results)
|
||||
"
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Run collection certification checks
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- stable-*
|
||||
workflow_dispatch:
|
||||
|
||||
concurrency:
|
||||
group: cert-ver-${{ github.head_ref || github.run_id }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
call:
|
||||
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e # v4.1.0
|
||||
@@ -56,15 +56,28 @@ jobs:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
# Ref must match a branch/tag on github.com/ansible/ansible (e.g. stable-2.18, not 2.18).
|
||||
ansible-version: ["stable-2.18", "milestone"]
|
||||
#
|
||||
ansible-version: ["stable-2.18", "stable-2.21", "milestone"]
|
||||
enable-turbo-mode: [true, false]
|
||||
python-version: ["3.12", "3.13"]
|
||||
exclude:
|
||||
# stable-2.18 is used mainly because turbo mode, no reason to test it with turbo mode disabled
|
||||
- ansible-version: "stable-2.18"
|
||||
enable-turbo-mode: false
|
||||
# turbo mode is supported only by ansible<2.19
|
||||
- ansible-version: "milestone"
|
||||
enable-turbo-mode: true
|
||||
python-version:
|
||||
- "3.12"
|
||||
- ansible-version: "stable-2.21"
|
||||
enable-turbo-mode: true
|
||||
# stable-2.18 supports 3.12
|
||||
- ansible-version: "stable-2.18"
|
||||
python-version: "3.13"
|
||||
- ansible-version: "stable-2.21"
|
||||
python-version: "3.12"
|
||||
- ansible-version: "milestone"
|
||||
python-version: "3.12"
|
||||
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 tests
|
||||
steps:
|
||||
- name: Read target
|
||||
id: read-targets
|
||||
|
||||
@@ -1,16 +1,7 @@
|
||||
---
|
||||
name: Linters
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- stable-*
|
||||
tags:
|
||||
- '*'
|
||||
on: [workflow_call]
|
||||
|
||||
jobs:
|
||||
linters:
|
||||
|
||||
@@ -1,14 +1,7 @@
|
||||
---
|
||||
name: Sanity tests
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- stable-*
|
||||
on: [workflow_call]
|
||||
|
||||
jobs:
|
||||
sanity:
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
name: Security Check
|
||||
|
||||
on: [workflow_call]
|
||||
|
||||
jobs:
|
||||
security-check:
|
||||
name: Block unsafe directories
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Check for blocked directories
|
||||
uses: ansible/cloud-content-ci-automation/.github/actions/security_check_directories@74b5fe870e1d5346c5fcea332b97a6fb26f1ad8a
|
||||
@@ -0,0 +1,89 @@
|
||||
## SonarCloud Analysis Workflow for kubernetes.core
|
||||
#
|
||||
# This workflow runs SonarCloud analysis triggered by all_green workflow completion.
|
||||
#
|
||||
# FLOW: all_green completes (linters, ansible-test, coverage) → workflow_run triggers this workflow → finalize job runs
|
||||
#
|
||||
# - Triggered by: workflow_run (all_green on pull_request or push to main/stable-*)
|
||||
# - Steps: Checkout → Download coverage from all_green run → Get PR info (if PR) → Run SonarCloud scan
|
||||
# - Coverage: Unit test coverage is produced by the coverage job in all_green and passed to SonarCloud here.
|
||||
|
||||
---
|
||||
name: SonarCloud
|
||||
|
||||
on:
|
||||
workflow_run:
|
||||
workflows:
|
||||
- all_green
|
||||
types:
|
||||
- completed
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
actions: read
|
||||
|
||||
jobs:
|
||||
finalize:
|
||||
name: finalize
|
||||
runs-on: ubuntu-latest
|
||||
if: github.event.workflow_run.conclusion == 'success'
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: ${{ github.event.workflow_run.head_sha }}
|
||||
fetch-depth: 0
|
||||
show-progress: false
|
||||
|
||||
- name: Download coverage artifacts
|
||||
uses: dawidd6/action-download-artifact@2536c51d3d126276eb39f74d6bc9c72ac6ef30d3 # v16
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
workflow: all_green
|
||||
run_id: ${{ github.event.workflow_run.id }}
|
||||
pattern: coverage*
|
||||
|
||||
- name: Set coverage report paths
|
||||
run: |
|
||||
coverage_files=$(find . -name "coverage*.xml" -type f 2>/dev/null | tr '\n' ',' | sed 's/,$//')
|
||||
echo "Found coverage files: ${coverage_files:-none}"
|
||||
echo "COVERAGE_PATHS=${coverage_files}" >> "${GITHUB_ENV}"
|
||||
|
||||
- name: Get PR number and info
|
||||
if: github.event.workflow_run.event == 'pull_request'
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
HEAD_BRANCH: ${{ github.event.workflow_run.head_branch }}
|
||||
REPO: ${{ github.repository }}
|
||||
run: |
|
||||
PR_NUMBER=$(gh pr list --head "$HEAD_BRANCH" --repo "$REPO" --json number -q '.[0].number')
|
||||
echo "PR_NUMBER=${PR_NUMBER}" >> "${GITHUB_ENV}"
|
||||
if [ -n "${PR_NUMBER}" ]; then
|
||||
PR_DATA=$(gh api "repos/${REPO}/pulls/${PR_NUMBER}")
|
||||
echo "PR_BASE=$(echo "${PR_DATA}" | jq -r '.base.ref')" >> "${GITHUB_ENV}"
|
||||
echo "PR_HEAD=$(echo "${PR_DATA}" | jq -r '.head.ref')" >> "${GITHUB_ENV}"
|
||||
fi
|
||||
|
||||
- name: Prepare SonarCloud args
|
||||
env:
|
||||
COMMIT_SHA: ${{ github.event.workflow_run.head_sha }}
|
||||
EVENT_TYPE: ${{ github.event.workflow_run.event }}
|
||||
run: |
|
||||
SONAR_ARGS="-Dsonar.scm.revision=\"${COMMIT_SHA}\""
|
||||
if [[ "${EVENT_TYPE}" == "pull_request" && -n "${PR_NUMBER:-}" ]]; then
|
||||
SONAR_ARGS="${SONAR_ARGS} -Dsonar.pullrequest.key=${PR_NUMBER}"
|
||||
SONAR_ARGS="${SONAR_ARGS} -Dsonar.pullrequest.branch=${PR_HEAD}"
|
||||
SONAR_ARGS="${SONAR_ARGS} -Dsonar.pullrequest.base=${PR_BASE}"
|
||||
fi
|
||||
if [[ -n "${COVERAGE_PATHS:-}" ]]; then
|
||||
SONAR_ARGS="${SONAR_ARGS} -Dsonar.python.coverage.reportPaths=${COVERAGE_PATHS}"
|
||||
fi
|
||||
echo "SONAR_ARGS=${SONAR_ARGS}" >> "${GITHUB_ENV}"
|
||||
|
||||
- name: SonarCloud Scan
|
||||
uses: SonarSource/sonarqube-scan-action@a31c9398be7ace6bbfaf30c0bd5d415f843d45e9 # v7
|
||||
env:
|
||||
SONAR_TOKEN: ${{ secrets.ANSIBLE_COLLECTIONS_ORG_SONAR_TOKEN_CICD_BOT }}
|
||||
with:
|
||||
args: ${{ env.SONAR_ARGS }}
|
||||
@@ -1,13 +1,6 @@
|
||||
name: Unit tests
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
- stable-*
|
||||
on: [workflow_call]
|
||||
|
||||
jobs:
|
||||
unit-source:
|
||||
|
||||
+5
-1
@@ -23,5 +23,9 @@ tests/integration/targets/*/*.tgz
|
||||
tests/integration/inventory
|
||||
tests/integration/*-*.yml
|
||||
|
||||
# VS Code settings
|
||||
# IDE and editor settings
|
||||
.vscode/
|
||||
.claude/
|
||||
|
||||
# Root coverage report for SonarCloud (generated locally or in CI)
|
||||
/coverage.xml
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
repos:
|
||||
- repo: https://github.com/ansible/cloud-content-ci-automation
|
||||
rev: precommit_hook
|
||||
hooks:
|
||||
- id: block-ide-ai-files
|
||||
always_run: true
|
||||
+76
-4
@@ -4,6 +4,78 @@ Kubernetes Collection Release Notes
|
||||
|
||||
.. contents:: Topics
|
||||
|
||||
v6.6.0
|
||||
======
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- Remove the remaining ``ansible.module_utils.six`` import to avoid deprecation warnings, replacing it with the Python standard library equivalent (https://github.com/ansible-collections/kubernetes.core/pull/1197).
|
||||
- helm - Add ``wait_for_jobs`` option to wait for all Jobs to complete before marking a Helm release as successful. Requires Helm >= 3.5.0 (https://github.com/ansible-collections/kubernetes.core/pull/1140).
|
||||
- helm - add the ``cleanup_on_fail`` option, mapping to the ``--cleanup-on-fail`` flag, to allow deletion of new resources created during a failed upgrade. It complements ``atomic`` and can be combined with it, but cannot be used with ``replace``, since that deploys through ``helm install`` which does not accept the flag (https://github.com/ansible-collections/kubernetes.core/pull/1206).
|
||||
- helm - warn when ``reuse_values`` or ``reset_then_reuse_values`` is requested in a combination helm ignores, which happens by default because ``reset_values`` defaults to ``true``, and whenever either is combined with ``replace``. The option descriptions and the examples now state that ``reset_values`` has to be set to ``false`` for either option to take effect (https://github.com/ansible-collections/kubernetes.core/pull/1230).
|
||||
- k8s lookup - warn when ``ENABLE_TURBO_MODE`` is set but the ``cloud.common`` collection is not installed, instead of silently falling back to the standard lookup base (https://github.com/ansible-collections/kubernetes.core/pull/1242).
|
||||
- k8s_cp - Add the ``copy_timeout`` option (default 300 seconds) bounding how long the module will spend streaming an archive to a pod and waiting for the remote ``tar`` to finish, so that a stalled copy fails instead of hanging indefinitely (https://github.com/ansible-collections/kubernetes.core/pull/1217).
|
||||
- k8s_cp - Stream the tar archive to the pod chunk by chunk instead of building the whole archive in memory first, which cuts peak memory use when copying large files (https://github.com/ansible-collections/kubernetes.core/pull/1217).
|
||||
- k8s_cp - When copying to a pod, the module now also uses ``/bin/sh`` and ``head`` in the container, when present, to confirm the copy completed. Containers without them keep the previous behaviour and get a warning that completion could not be verified (https://github.com/ansible-collections/kubernetes.core/pull/1217).
|
||||
- k8s_info - Support for metadata-only fetches in k8s_info module (https://github.com/ansible-collections/kubernetes.core/pull/1030)
|
||||
- meta - Add ``helm_plugin`` and ``helm_plugin_info`` to the ``helm`` action group, and ``k8s_taint`` to the ``k8s`` action group, so that ``module_defaults`` set on those groups applies to them (https://github.com/ansible-collections/kubernetes.core/pull/1216).
|
||||
- use `collections.abc` instead of deprecated `ansible.module_utils.common._collections_compat` (https://github.com/ansible-collections/kubernetes.core/pull/1057).
|
||||
- waiter - Add ``job_complete`` predicate to support waiting for Job resources to reach ``Complete`` or ``Failed`` condition (https://github.com/ansible-collections/kubernetes.core/issues/1201).
|
||||
|
||||
Deprecated Features
|
||||
-------------------
|
||||
|
||||
- Ansible Turbo mode (``ENABLE_TURBO_MODE``) has been deprecated and will be removed in release 8.0.0, as it depends on the ``cloud.common`` collection, which is being retired (https://github.com/ansible-collections/kubernetes.core/pull/1242).
|
||||
- helm - the ``status.values`` return value has been deprecated and will be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
|
||||
- helm - the ``wait_timeout`` parameter has been deprecated and will be removed in version 7.0.0. Use ``timeout`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
|
||||
- helm_info - the ``status.values`` return value has been deprecated and will be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
|
||||
- k8s_exec - the ``return_code`` return value has been deprecated and will be removed in version 7.0.0. Use ``rc`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
|
||||
- k8s_service - the ``merge_type=json`` option has been deprecated and will be removed in version 7.0.0. Use ``kubernetes.core.k8s_json_patch`` module instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
|
||||
|
||||
Bugfixes
|
||||
--------
|
||||
|
||||
- Ansible Turbo mode - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported, and fall back to the standard ``AnsibleModule`` instead of failing with ``byte indices must be integers or slices, not str`` (https://github.com/ansible-collections/kubernetes.core/pull/1242).
|
||||
- helm - do not pass the upgrade-only ``--reuse-values`` and ``--reset-then-reuse-values`` flags to ``helm install``, which rejected them with ``unknown flag`` whenever ``reuse_values`` or ``reset_then_reuse_values`` was combined with ``replace`` (https://github.com/ansible-collections/kubernetes.core/pull/1230).
|
||||
- helm - fix the ``reuse_values`` example, which set only ``reuse_values=true``. ``reset_values`` defaults to ``true`` and helm ignores ``--reuse-values`` whenever ``--reset-values`` is passed, so following the example reset the release values instead of reusing them (https://github.com/ansible-collections/kubernetes.core/pull/1230).
|
||||
- helm - skip Helm's OCI registry progress messages when parsing the output of ``helm show chart``. As of Helm 4.2.1 these are printed to stdout instead of stderr (https://github.com/helm/helm/pull/32056), which made installing a chart from an OCI registry fail with a YAML scanner error when the chart version contained a ``+`` (https://github.com/ansible-collections/kubernetes.core/pull/1223).
|
||||
- helm_repository - normalize both sides of the repository URL comparison, so that a repository already registered with a trailing slash is recognized as matching instead of failing with ``Repository already have a repository named <name>`` (https://github.com/ansible-collections/kubernetes.core/pull/1236).
|
||||
- helm_template - strip Helm's OCI registry progress messages from the returned ``stdout``, which is documented to contain only the rendered templates (https://github.com/ansible-collections/kubernetes.core/pull/1223).
|
||||
- k8s lookup - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported. Fall back to the standard ``LookupBase`` instead of failing with a traceback (https://github.com/ansible-collections/kubernetes.core/pull/1253).
|
||||
- k8s_cp - Fix silent truncation when copying to a pod. The module closed the exec connection immediately after writing the last chunk of the tar archive, which killed the remote ``tar`` before it had finished extracting, and never checked the process exit status, so a partial copy was reported as a success. The archive is now bounded with ``head -c`` so ``tar`` gets a clean EOF and exits on its own, and the module waits for that exit and fails on a non-zero status (https://github.com/ansible-collections/kubernetes.core/pull/1217).
|
||||
- k8s_info - Handle empty template output gracefully by returning ``changed=false`` instead of failing when Jinja2 template renders to an empty string (https://github.com/ansible-collections/kubernetes.core/issues/1042).
|
||||
|
||||
v6.5.0
|
||||
======
|
||||
|
||||
Release Summary
|
||||
---------------
|
||||
|
||||
This release implements minor changes and bug fixes such as a new ``remove`` value to the ``behavior`` option of the ``kubeconfig`` module, allowing entries to be deleted from the kubeconfig file by name, as well as Helm v4 compatibility across the Helm modules.
|
||||
|
||||
Minor Changes
|
||||
-------------
|
||||
|
||||
- helm - add the ``server_side`` and ``force_conflicts`` options to control Helm v4 server-side apply when installing or upgrading a release (https://github.com/ansible-collections/kubernetes.core/pull/1164).
|
||||
- helm_plugin - add ``--keyring`` argument to allow changing the keyring default location. The option is only accepted with ``state=present`` (the ``helm plugin install`` subcommand), as that is the only implemented subcommand that supports ``--keyring`` (https://github.com/ansible-collections/kubernetes.core/pull/1150).
|
||||
- helm_registry_auth - document that, as of Helm 4.2.1, registry success messages such as ``Login Succeeded`` are printed to stdout instead of stderr (https://github.com/ansible-collections/kubernetes.core/pull/1147).
|
||||
- kubeconfig - add ``remove`` value to the ``behavior`` option, allowing entries to be deleted from the kubeconfig file by name (https://github.com/ansible-collections/kubernetes.core/pull/1123).
|
||||
|
||||
Bugfixes
|
||||
--------
|
||||
|
||||
- ee - added ``meta/execution-environment.yml`` to decouple ansible-builder EE builds from the ``openshift-clients`` system dependency declared in ``bindep.txt``, which is not available in standard UBI repositories and caused builds to fail with ``No package matches 'openshift-clients'`` (https://github.com/ansible-collections/kubernetes.core/issues/1141).
|
||||
- helm - use ``--server-side=false --force-replace`` instead of the deprecated/removed ``--force`` flag when ``force=true`` is used with Helm v4, preserving the Helm v3 client-side replacement behaviour and avoiding the server-side apply conflict (https://github.com/ansible-collections/kubernetes.core/pull/1164).
|
||||
- helm - use the ``--rollback-on-failure`` flag instead of the deprecated/removed ``--atomic`` flag when ``atomic=true`` is used with Helm v4 (https://github.com/ansible-collections/kubernetes.core/pull/1144).
|
||||
- helm_repository - correct handling of repository URLs with trailing slashes (https://github.com/ansible-collections/kubernetes.core/pull/1121).
|
||||
- k8s_drain - Fix logic for handling pods with local storage to correctly check for empty_dir volumes in replicated pods and pods managed by DaemonSets (https://github.com/ansible-collections/kubernetes.core/pull/1095).
|
||||
|
||||
New Modules
|
||||
-----------
|
||||
|
||||
- kubeconfig - Generate, update, and optionally write Kubernetes kubeconfig files
|
||||
|
||||
v6.4.0
|
||||
======
|
||||
|
||||
@@ -23,7 +95,7 @@ Minor Changes
|
||||
- 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).
|
||||
- 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
|
||||
--------
|
||||
@@ -97,8 +169,8 @@ This release adds ``plain_http`` and ``take_ownership`` parameters for helm modu
|
||||
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).
|
||||
- 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).
|
||||
@@ -130,7 +202,7 @@ 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).
|
||||
- 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
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
# Continuous Integration (CI)
|
||||
|
||||
## Kubernetes Upstream Testing
|
||||
|
||||
GitHub Actions are used to run the CI for the kubernetes.core collection. The workflows used for the CI can be found in the [.github/workflows](.github/workflows) directory.
|
||||
|
||||
### PR Testing Workflows
|
||||
|
||||
The following tests run on every pull request:
|
||||
|
||||
| Job | Description | Python Versions | ansible-core Versions |
|
||||
| --- | ----------- | --------------- | --------------------- |
|
||||
| [Changelog](.github/workflows/changelog.yaml) | Checks for the presence of changelog fragments | 3.12 | devel |
|
||||
| [Linters](.github/workflows/linters.yaml) | Runs `black`, `flake8`, `isort`, `yamllint`, and `ansible-lint` on plugins and tests | 3.10 | devel |
|
||||
| [Sanity](.github/workflows/sanity-tests.yaml) | Runs ansible sanity checks | See compatibility table below | devel, stable-2.18, stable-2.19, stable-2.20 |
|
||||
| [Unit tests](.github/workflows/unit-tests.yaml) | Executes unit test cases | See compatibility table below | devel, stable-2.16, stable-2.17, stable-2.18, stable-2.19, stable-2.20 |
|
||||
| [Integration](.github/workflows/integration-tests.yaml) | Executes integration test suites using KinD cluster (split across 8 jobs, tests with Turbo mode enabled/disabled) | 3.12 (stable-2.18), 3.13 (milestone) | stable-2.18, milestone |
|
||||
| [all_green](.github/workflows/all_green_check.yaml) | Linters (PR only), sanity, units, coverage XML, aggregate gate, and SonarCloud scan (same-repo PR / push only) | (see jobs) | (see jobs) |
|
||||
|
||||
**Note:** Integration tests require a KinD (Kubernetes in Docker) cluster and test both with Turbo mode enabled and disabled.
|
||||
|
||||
### Python Version Compatibility by ansible-core Version
|
||||
|
||||
These are outlined in the collection's [tox.ini](tox.ini) file (`envlist`) and GitHub Actions workflow exclusions.
|
||||
|
||||
| ansible-core Version | Sanity Tests | Unit Tests | Integration Tests |
|
||||
| -------------------- | ------------ | ---------- | ----------------- |
|
||||
| devel | 3.12, 3.13, 3.14 | 3.13 | 3.13 (milestone) |
|
||||
| stable-2.20 | 3.12, 3.13, 3.14 | 3.12, 3.13, 3.14 | — |
|
||||
| stable-2.19 | 3.11, 3.12, 3.13 | 3.11, 3.12, 3.13 | — |
|
||||
| stable-2.18 | 3.11, 3.12, 3.13 | 3.11, 3.12, 3.13 | 3.12 |
|
||||
| stable-2.17 | 3.10, 3.11, 3.12 | 3.10, 3.11, 3.12 | — |
|
||||
| stable-2.16 | 3.10, 3.11 | 3.10, 3.11 | — |
|
||||
|
||||
## SonarCloud
|
||||
|
||||
SonarCloud analysis runs from **[`all_green_check.yaml`](.github/workflows/all_green_check.yaml)** via the **`sonarcloud`** job, which calls **[`sonarcloud.yml`](.github/workflows/sonarcloud.yml)** (**`workflow_call`**) after the **`all_green`** gate and **coverage** succeed. The reusable workflow checks out the PR head or push SHA, downloads the **`coverage`** artifact, and runs the pinned **SonarSource** scan action. Same-repo **`pull_request`** and **`push`** only (fork PRs are excluded by the job **`if:`** gate). Details: [SONARCLOUD.md](SONARCLOUD.md).
|
||||
@@ -66,6 +66,20 @@ After installation, you can update documentation
|
||||
|
||||
Review the changes and create a pull request using updated files.
|
||||
|
||||
### Pre-Commit Hooks
|
||||
|
||||
To prevent accidental commits of local configuration and IDE files (specifically `.vscode/` and `.claude/`), this repository utilizes the `pre-commit` framework.
|
||||
|
||||
Please set up the hooks locally before making your first commit:
|
||||
|
||||
```bash
|
||||
# Install the pre-commit tool
|
||||
pip install pre-commit
|
||||
|
||||
# Register the hooks with Git
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
### Code of Conduct
|
||||
The `kubernetes.core` collection follows the Ansible project's
|
||||
[Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Also needs to be updated in galaxy.yml
|
||||
VERSION = 6.4.0
|
||||
VERSION = 6.6.0
|
||||
|
||||
TEST_ARGS ?= ""
|
||||
PYTHON_VERSION ?= `python -c 'import platform; print(".".join(platform.python_version_tuple()[0:2]))'`
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
[](https://sonarcloud.io/summary/new_code?id=ansible-collections_kubernetes.core)
|
||||
[](https://sonarcloud.io/summary/new_code?id=ansible-collections_kubernetes.core)
|
||||
[](https://sonarcloud.io/summary/new_code?id=ansible-collections_kubernetes.core)
|
||||
[](https://sonarcloud.io/summary/new_code?id=ansible-collections_kubernetes.core)
|
||||
[](https://sonarcloud.io/summary/new_code?id=ansible-collections_kubernetes.core)
|
||||
[](https://sonarcloud.io/summary/new_code?id=ansible-collections_kubernetes.core)
|
||||
[](https://sonarcloud.io/summary/new_code?id=ansible-collections_kubernetes.core)
|
||||
|
||||
# Kubernetes Collection for Ansible
|
||||
|
||||
This repository hosts the `kubernetes.core` (formerly known as `community.kubernetes`) Ansible Collection.
|
||||
@@ -6,17 +14,53 @@ This repository hosts the `kubernetes.core` (formerly known as `community.kubern
|
||||
|
||||
The collection includes a variety of Ansible content to help automate the management of applications in Kubernetes and OpenShift clusters, as well as the provisioning and maintenance of clusters themselves.
|
||||
|
||||
## Communication
|
||||
### Included Content
|
||||
|
||||
* Join the Ansible forum:
|
||||
* [Get Help](https://forum.ansible.com/c/help/6): get help or help others.
|
||||
* [Posts tagged with 'kubernetes'](https://forum.ansible.com/tag/kubernetes): subscribe to participate in collection-related conversations.
|
||||
* [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.
|
||||
* [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events.
|
||||
Click on the name of a plugin or module to view that content's documentation:
|
||||
|
||||
* The Ansible [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
|
||||
<!--start collection content-->
|
||||
### Connection plugins
|
||||
Name | Description
|
||||
--- | ---
|
||||
[kubernetes.core.kubectl](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.kubectl_connection.rst)|Execute tasks in pods running on Kubernetes.
|
||||
|
||||
For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
|
||||
### K8s filter plugins
|
||||
Name | Description
|
||||
--- | ---
|
||||
kubernetes.core.k8s_config_resource_name|Generate resource name for the given resource of type ConfigMap, Secret
|
||||
|
||||
### Lookup plugins
|
||||
Name | Description
|
||||
--- | ---
|
||||
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API
|
||||
[kubernetes.core.kustomize](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.kustomize_lookup.rst)|Build a set of kubernetes resources using a 'kustomization.yaml' file.
|
||||
|
||||
### Modules
|
||||
Name | Description
|
||||
--- | ---
|
||||
[kubernetes.core.helm](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.helm_module.rst)|Manages Kubernetes packages with the Helm package manager
|
||||
[kubernetes.core.helm_info](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.helm_info_module.rst)|Get information from Helm package deployed inside the cluster
|
||||
[kubernetes.core.helm_plugin](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.helm_plugin_module.rst)|Manage Helm plugins
|
||||
[kubernetes.core.helm_plugin_info](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.helm_plugin_info_module.rst)|Gather information about Helm plugins
|
||||
[kubernetes.core.helm_pull](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.helm_pull_module.rst)|download a chart from a repository and (optionally) unpack it in local directory.
|
||||
[kubernetes.core.helm_registry_auth](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.helm_registry_auth_module.rst)|Helm registry authentication module
|
||||
[kubernetes.core.helm_repository](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.helm_repository_module.rst)|Manage Helm repositories.
|
||||
[kubernetes.core.helm_template](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.helm_template_module.rst)|Render chart templates
|
||||
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_module.rst)|Manage Kubernetes (K8s) objects
|
||||
[kubernetes.core.k8s_cluster_info](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_cluster_info_module.rst)|Describe Kubernetes (K8s) cluster, APIs available and their respective versions
|
||||
[kubernetes.core.k8s_cp](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_cp_module.rst)|Copy files and directories to and from pod.
|
||||
[kubernetes.core.k8s_drain](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_drain_module.rst)|Drain, Cordon, or Uncordon node in k8s cluster
|
||||
[kubernetes.core.k8s_exec](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_exec_module.rst)|Execute command in Pod
|
||||
[kubernetes.core.k8s_info](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_info_module.rst)|Describe Kubernetes (K8s) objects
|
||||
[kubernetes.core.k8s_json_patch](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_json_patch_module.rst)|Apply JSON patch operations to existing objects
|
||||
[kubernetes.core.k8s_log](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_log_module.rst)|Fetch logs from Kubernetes resources
|
||||
[kubernetes.core.k8s_rollback](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_rollback_module.rst)|Rollback Kubernetes (K8S) Deployments and DaemonSets
|
||||
[kubernetes.core.k8s_scale](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_scale_module.rst)|Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
|
||||
[kubernetes.core.k8s_service](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_service_module.rst)|Manage Services on Kubernetes
|
||||
[kubernetes.core.k8s_taint](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.k8s_taint_module.rst)|Taint a node in a Kubernetes/OpenShift cluster
|
||||
[kubernetes.core.kubeconfig](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/kubernetes.core.kubeconfig_module.rst)|Generate, update, and optionally write Kubernetes kubeconfig files
|
||||
|
||||
<!--end collection content-->
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -44,53 +88,6 @@ Note: Python2 is deprecated from [1st January 2020](https://www.python.org/doc/s
|
||||
|
||||
This collection supports Kubernetes versions >= 1.24.
|
||||
|
||||
### Included Content
|
||||
|
||||
Click on the name of a plugin or module to view that content's documentation:
|
||||
|
||||
<!--start collection content-->
|
||||
### Connection plugins
|
||||
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.
|
||||
|
||||
### K8s filter plugins
|
||||
Name | Description
|
||||
--- | ---
|
||||
kubernetes.core.k8s_config_resource_name|Generate resource name for the given resource of type ConfigMap, Secret
|
||||
|
||||
### Lookup plugins
|
||||
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.kustomize](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kustomize_lookup.rst)|Build a set of kubernetes resources using a 'kustomization.yaml' file.
|
||||
|
||||
### Modules
|
||||
Name | Description
|
||||
--- | ---
|
||||
[kubernetes.core.helm](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_module.rst)|Manages Kubernetes packages with the Helm package manager
|
||||
[kubernetes.core.helm_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_info_module.rst)|Get information from Helm package deployed inside the cluster
|
||||
[kubernetes.core.helm_plugin](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_plugin_module.rst)|Manage Helm plugins
|
||||
[kubernetes.core.helm_plugin_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_plugin_info_module.rst)|Gather information about Helm plugins
|
||||
[kubernetes.core.helm_pull](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_pull_module.rst)|download a chart from a repository and (optionally) unpack it in local directory.
|
||||
[kubernetes.core.helm_registry_auth](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_registry_auth_module.rst)|Helm registry authentication module
|
||||
[kubernetes.core.helm_repository](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_repository_module.rst)|Manage Helm repositories.
|
||||
[kubernetes.core.helm_template](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.helm_template_module.rst)|Render chart templates
|
||||
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_module.rst)|Manage Kubernetes (K8s) objects
|
||||
[kubernetes.core.k8s_cluster_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_cluster_info_module.rst)|Describe Kubernetes (K8s) cluster, APIs available and their respective versions
|
||||
[kubernetes.core.k8s_cp](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_cp_module.rst)|Copy files and directories to and from pod.
|
||||
[kubernetes.core.k8s_drain](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_drain_module.rst)|Drain, Cordon, or Uncordon node in k8s cluster
|
||||
[kubernetes.core.k8s_exec](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_exec_module.rst)|Execute command in Pod
|
||||
[kubernetes.core.k8s_info](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_info_module.rst)|Describe Kubernetes (K8s) objects
|
||||
[kubernetes.core.k8s_json_patch](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_json_patch_module.rst)|Apply JSON patch operations to existing objects
|
||||
[kubernetes.core.k8s_log](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_log_module.rst)|Fetch logs from Kubernetes resources
|
||||
[kubernetes.core.k8s_rollback](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_rollback_module.rst)|Rollback Kubernetes (K8S) Deployments and DaemonSets
|
||||
[kubernetes.core.k8s_scale](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_scale_module.rst)|Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.
|
||||
[kubernetes.core.k8s_service](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_service_module.rst)|Manage Services on Kubernetes
|
||||
[kubernetes.core.k8s_taint](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_taint_module.rst)|Taint a node in a Kubernetes/OpenShift cluster
|
||||
|
||||
<!--end collection content-->
|
||||
|
||||
## Installation
|
||||
|
||||
Before using the Kubernetes collection, you need to install it with the Ansible Galaxy CLI:
|
||||
@@ -103,14 +100,16 @@ You can also include it in a `requirements.yml` file and install it via `ansible
|
||||
---
|
||||
collections:
|
||||
- name: kubernetes.core
|
||||
version: 6.4.0
|
||||
version: 6.6.0
|
||||
```
|
||||
|
||||
### Installing the Kubernetes Python Library
|
||||
|
||||
Content in this collection requires the [Kubernetes Python client](https://pypi.org/project/kubernetes/) to interact with Kubernetes' APIs. You can install it with:
|
||||
|
||||
pip3 install kubernetes
|
||||
```bash
|
||||
pip3 install kubernetes
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
@@ -182,7 +181,11 @@ For documentation on how to use individual modules and other content included in
|
||||
|
||||
## 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:
|
||||
> **Deprecated:** Ansible Turbo mode (`ENABLE_TURBO_MODE`) is deprecated and will be removed in a future major release (planned for 8.0.0), since it depends on the `cloud.common` collection, which is being retired. Setting `ENABLE_TURBO_MODE` will keep emitting a deprecation warning until support is removed, at which point the variable will have no effect.
|
||||
|
||||
> **Note:** Ansible Turbo mode is supported only with ``ansible-core`` versions **lower than 2.19**. Starting from ``ansible-core`` 2.19, the ``cloud.common`` collection is no longer supported, and therefore Ansible Turbo mode is also not supported in ``kubernetes.core``. If ``ENABLE_TURBO_MODE`` is set to ``1`` (or any truthy value) with ``ansible-core >= 2.19.0``, Turbo mode is ignored and a warning is emitted; modules run without it.
|
||||
|
||||
The ``kubernetes.core`` collection supports Ansible Turbo mode as a tech preview via the ``cloud.common`` collection (requires `ansible-core < 2.19`). 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
|
||||
---
|
||||
@@ -196,13 +199,7 @@ The ``kubernetes.core`` collection supports Ansible Turbo mode as a tech preview
|
||||
To enable Turbo mode for k8s lookup plugin, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. This is not working when
|
||||
defined in the playbook using `environment` keyword as above, you must set it using `export ENABLE_TURBO_MODE=1`.
|
||||
|
||||
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/ansible_turbo_mode.rst).
|
||||
|
||||
## Contributing to this Collection
|
||||
|
||||
If you want to develop new content for this collection or improve what's already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
|
||||
|
||||
See [Contributing to kubernetes.core](CONTRIBUTING.md).
|
||||
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/ansible_turbo_mode.rst).
|
||||
|
||||
## Testing
|
||||
|
||||
@@ -225,7 +222,40 @@ There are also integration tests in the `molecule` directory which are meant to
|
||||
kind create cluster
|
||||
make test-molecule
|
||||
|
||||
## Publishing New Versions
|
||||
## Contributing to this Collection
|
||||
|
||||
If you want to develop new content for this collection or improve what is already here, clone the Git repository into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths) and work on it there.
|
||||
|
||||
See [Contributing to kubernetes.core](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/CONTRIBUTING.md).
|
||||
|
||||
Join the Ansible community:
|
||||
|
||||
* [Get Help](https://forum.ansible.com/c/help/6)
|
||||
* [Posts tagged with 'kubernetes'](https://forum.ansible.com/tag/kubernetes)
|
||||
* [Social Spaces](https://forum.ansible.com/c/chat/4)
|
||||
* [News & Announcements](https://forum.ansible.com/c/news/5)
|
||||
|
||||
The Ansible [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn) announces releases and important changes. For more information, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
|
||||
|
||||
### Code of Conduct
|
||||
|
||||
This project follows the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html). If you encounter abusive behavior, see the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section for how to raise a complaint.
|
||||
|
||||
## Support
|
||||
|
||||
As Red Hat Ansible Certified Content, this collection is entitled to support through the Ansible Automation Platform (AAP) using the **Create issue** button on the top right corner. If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there may be community help available on the [Ansible Forum](https://forum.ansible.com/).
|
||||
|
||||
> **Note:** The `stable-4` branch (all `4.x.y` releases) is no longer supported. No backports or releases are performed on `stable-4`.
|
||||
|
||||
We announce releases and important changes through Ansible's [The Bullhorn newsletter](https://github.com/ansible/community/wiki/News#the-bullhorn). Subscribe via [this link](https://eepurl.com/gZmiEP).
|
||||
|
||||
We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit). Track The Bullhorn and join when announced.
|
||||
|
||||
For the latest supported versions, see [Release Notes and Roadmap](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/README.md#release-notes-and-roadmap).
|
||||
|
||||
Report bugs, request features, or ask questions by opening an issue in the [GitHub repository](https://github.com/ansible-collections/kubernetes.core/).
|
||||
|
||||
## Release Notes and Roadmap
|
||||
|
||||
Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:
|
||||
|
||||
@@ -242,37 +272,24 @@ Releases are automatically built and pushed to Ansible Galaxy for any new tag. B
|
||||
|
||||
After the version is published, verify it exists on the [Kubernetes Collection Galaxy page](https://galaxy.ansible.com/kubernetes/core).
|
||||
|
||||
The process for uploading a supported release to Automation Hub is documented separately.
|
||||
The process for [uploading a supported release to Automation Hub](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.1/html/uploading_content_to_red_hat_automation_hub/proc-upload-collection) is documented separately.
|
||||
|
||||
## Support
|
||||
## Related Information
|
||||
|
||||
<!--List available communication channels. In addition to channels specific to your collection, we also recommend to use the following ones.-->
|
||||
* [Using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html)
|
||||
* [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html)
|
||||
* [Continuous integration (CI) overview](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/CI.md)
|
||||
* [SonarCloud integration](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/SONARCLOUD.md)
|
||||
* [Ansible Turbo mode (tech preview)](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/ansible_turbo_mode.rst)
|
||||
|
||||
> **Note:** The `stable-4` branch, which handles all `4.x.y` releases of this collection, is no longer supported. This means that no backports nor releases will be performed on the `stable-4` branch.
|
||||
|
||||
We announce releases and important changes through Ansible's [The Bullhorn newsletter](https://github.com/ansible/community/wiki/News#the-bullhorn). Be sure you are [subscribed](https://eepurl.com/gZmiEP).
|
||||
|
||||
We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://eepurl.com/gZmiEP) and join us.
|
||||
|
||||
For more information about communication, refer to the [Ansible Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
|
||||
|
||||
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:
|
||||
- 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
|
||||
|
||||
See the [raw generated changelog](https://github.com/ansible-collections/kubernetes.core/blob/main/CHANGELOG.rst).
|
||||
|
||||
## Code of Conduct
|
||||
### Code of conduct
|
||||
|
||||
We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project.
|
||||
|
||||
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 Information
|
||||
|
||||
GNU General Public License v3.0 or later
|
||||
|
||||
See LICENSE to see the full text.
|
||||
See [LICENSE](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/LICENSE) to see the full text.
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
# SonarCloud
|
||||
|
||||
Dashboard:
|
||||
|
||||
[SonarCloud project overview](https://sonarcloud.io/project/overview?id=ansible-collections_kubernetes.core)
|
||||
|
||||
## CI integration
|
||||
|
||||
Sonar analysis is implemented in **[.github/workflows/sonarcloud.yml](.github/workflows/sonarcloud.yml)** as a **reusable workflow** (`on: workflow_call` only). It is **not** triggered by `workflow_run`.
|
||||
|
||||
**[.github/workflows/all_green_check.yaml](.github/workflows/all_green_check.yaml)** runs **linters** (on pull requests), **sanity**, **units**, and **coverage**, passes the aggregate **`all_green`** gate, then calls **`sonarcloud.yml`** via a **`sonarcloud`** job when the conditions below are met. The **coverage** job uploads a **`coverage`** artifact; the Sonar job downloads it in the **same** workflow run.
|
||||
|
||||
The caller runs on **`pull_request`** or **`push`**, so the reusable workflow inherits that **`github.event`**. **`actions/checkout`** uses **`github.event.pull_request.head.sha`** on pull requests and **`github.sha`** on push (Sonar-friendly checkout). PR parameters (**`sonar.pullrequest.*`**) are taken from **`github.event.pull_request`** (no `gh` API calls in **`sonarcloud.yml`**).
|
||||
|
||||
The scan step uses **`SonarSource/sonarqube-scan-action`** (pinned SHA in the workflow file) with **`sonar.python.coverage.reportPaths`** set from any **`coverage*.xml`** files found under the workspace after the artifact download. The overall flow (coverage in CI, then Sonar with XML) follows the same idea as [ansible-collections/amazon.aws#2871](https://github.com/ansible-collections/amazon.aws/pull/2871), using **`workflow_call`** from **`all_green`** instead of a separate **`workflow_run`** finalize workflow.
|
||||
|
||||
Workflow files:
|
||||
|
||||
- [.github/workflows/all_green_check.yaml](.github/workflows/all_green_check.yaml) -- **`all_green`** gate, **coverage** artifact upload, and **`sonarcloud`** job (**`uses: ./.github/workflows/sonarcloud.yml`**, passing only **`ANSIBLE_COLLECTIONS_ORG_SONAR_TOKEN_CICD_BOT`**) after **`all_green`** and **`coverage`** succeed, gated for **`push`** and same-repo **`pull_request`** only.
|
||||
- [.github/workflows/sonarcloud.yml](.github/workflows/sonarcloud.yml) -- **`scan`** job: checkout, download **`coverage`**, **`SONAR_ARGS`**, SonarCloud scan.
|
||||
|
||||
Scanner configuration lives in [sonar-project.properties](sonar-project.properties).
|
||||
|
||||
The **coverage** job (in **`all_green`**) uses **`ansible-test`** (`units --coverage`, then **`coverage combine`** / **`coverage xml`**) with **ansible-core `stable-2.18`** on **`stable-6`**, then writes **`coverage.xml`** with workspace paths normalized for Sonar. **`pytest-cov`** is listed in **`tests/unit/requirements.txt`** for parity and any direct pytest runs; **`ansible-test`** still owns the coverage data used in CI.
|
||||
|
||||
**`sonarcloud.yml`** declares a required secret **`ANSIBLE_COLLECTIONS_ORG_SONAR_TOKEN_CICD_BOT`** and **`permissions: contents: read`**, **`pull-requests: read`**.
|
||||
|
||||
Org secrets and fork PR behavior follow GitHub's [secrets in Actions](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) documentation. The **`sonarcloud`** job is **`if:`**-gated so the org token is not used for fork-head checkouts; fork PRs still run **`all_green`** for CI without running Sonar.
|
||||
|
||||
## Branch protection (repository settings)
|
||||
|
||||
If **`SonarCloud scan`** or **`all_green`** should block merges, add them under **Settings** > **Branches** > **Required status checks** for the protected branch. That is not configured in YAML.
|
||||
+158
-1
@@ -1114,7 +1114,7 @@ releases:
|
||||
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).
|
||||
- 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).
|
||||
@@ -1203,3 +1203,160 @@ releases:
|
||||
- 20260213-support-helm-v4-for-helm-plugin-modules.yaml
|
||||
- release-6-4-0.yml
|
||||
release_date: '2026-04-22'
|
||||
6.5.0:
|
||||
changes:
|
||||
bugfixes:
|
||||
- ee - added ``meta/execution-environment.yml`` to decouple ansible-builder
|
||||
EE builds from the ``openshift-clients`` system dependency declared in ``bindep.txt``,
|
||||
which is not available in standard UBI repositories and caused builds to fail
|
||||
with ``No package matches 'openshift-clients'`` (https://github.com/ansible-collections/kubernetes.core/issues/1141).
|
||||
- helm - use ``--server-side=false --force-replace`` instead of the deprecated/removed
|
||||
``--force`` flag when ``force=true`` is used with Helm v4, preserving the
|
||||
Helm v3 client-side replacement behaviour and avoiding the server-side apply
|
||||
conflict (https://github.com/ansible-collections/kubernetes.core/pull/1164).
|
||||
- helm - use the ``--rollback-on-failure`` flag instead of the deprecated/removed
|
||||
``--atomic`` flag when ``atomic=true`` is used with Helm v4 (https://github.com/ansible-collections/kubernetes.core/pull/1144).
|
||||
- helm_repository - correct handling of repository URLs with trailing slashes
|
||||
(https://github.com/ansible-collections/kubernetes.core/pull/1121).
|
||||
- k8s_drain - Fix logic for handling pods with local storage to correctly check
|
||||
for empty_dir volumes in replicated pods and pods managed by DaemonSets (https://github.com/ansible-collections/kubernetes.core/pull/1095).
|
||||
minor_changes:
|
||||
- helm - add the ``server_side`` and ``force_conflicts`` options to control
|
||||
Helm v4 server-side apply when installing or upgrading a release (https://github.com/ansible-collections/kubernetes.core/pull/1164).
|
||||
- helm_plugin - add ``--keyring`` argument to allow changing the keyring default
|
||||
location. The option is only accepted with ``state=present`` (the ``helm plugin
|
||||
install`` subcommand), as that is the only implemented subcommand that supports
|
||||
``--keyring`` (https://github.com/ansible-collections/kubernetes.core/pull/1150).
|
||||
- helm_registry_auth - document that, as of Helm 4.2.1, registry success messages
|
||||
such as ``Login Succeeded`` are printed to stdout instead of stderr (https://github.com/ansible-collections/kubernetes.core/pull/1147).
|
||||
- kubeconfig - add ``remove`` value to the ``behavior`` option, allowing entries
|
||||
to be deleted from the kubeconfig file by name (https://github.com/ansible-collections/kubernetes.core/pull/1123).
|
||||
release_summary: This release implements minor changes and bug fixes such as
|
||||
a new ``remove`` value to the ``behavior`` option of the ``kubeconfig`` module,
|
||||
allowing entries to be deleted from the kubeconfig file by name, as well as
|
||||
Helm v4 compatibility across the Helm modules.
|
||||
fragments:
|
||||
- 1123-kubeconfig-remove-behavior.yml
|
||||
- 1173-security-check-workflow.yml
|
||||
- 20260306-k8s_drain-delete-logic-fixes-for-daemonsets.yaml
|
||||
- 20260506-improve_idempotency_for_helm_repository.yaml
|
||||
- 20260611-helm-atomic-helm-v4.yml
|
||||
- 20260612-helm-registry-output-stream.yml
|
||||
- 20260620-add-plugin-keyring-option.yaml
|
||||
- 20260629-helm-force-helm-v4.yml
|
||||
- 6-5-0.yml
|
||||
- fix-openshift-clients-ee-dependency.yaml
|
||||
modules:
|
||||
- description: Generate, update, and optionally write Kubernetes kubeconfig files
|
||||
name: kubeconfig
|
||||
namespace: ''
|
||||
release_date: '2026-07-08'
|
||||
6.6.0:
|
||||
changes:
|
||||
bugfixes:
|
||||
- Ansible Turbo mode - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and
|
||||
later, where the ``cloud.common`` collection is not supported, and fall back
|
||||
to the standard ``AnsibleModule`` instead of failing with ``byte indices must
|
||||
be integers or slices, not str`` (https://github.com/ansible-collections/kubernetes.core/pull/1242).
|
||||
- helm - do not pass the upgrade-only ``--reuse-values`` and ``--reset-then-reuse-values``
|
||||
flags to ``helm install``, which rejected them with ``unknown flag`` whenever
|
||||
``reuse_values`` or ``reset_then_reuse_values`` was combined with ``replace``
|
||||
(https://github.com/ansible-collections/kubernetes.core/pull/1230).
|
||||
- helm - fix the ``reuse_values`` example, which set only ``reuse_values=true``.
|
||||
``reset_values`` defaults to ``true`` and helm ignores ``--reuse-values``
|
||||
whenever ``--reset-values`` is passed, so following the example reset the
|
||||
release values instead of reusing them (https://github.com/ansible-collections/kubernetes.core/pull/1230).
|
||||
- helm - skip Helm's OCI registry progress messages when parsing the output
|
||||
of ``helm show chart``. As of Helm 4.2.1 these are printed to stdout instead
|
||||
of stderr (https://github.com/helm/helm/pull/32056), which made installing
|
||||
a chart from an OCI registry fail with a YAML scanner error when the chart
|
||||
version contained a ``+`` (https://github.com/ansible-collections/kubernetes.core/pull/1223).
|
||||
- helm_repository - normalize both sides of the repository URL comparison, so
|
||||
that a repository already registered with a trailing slash is recognized as
|
||||
matching instead of failing with ``Repository already have a repository named
|
||||
<name>`` (https://github.com/ansible-collections/kubernetes.core/pull/1236).
|
||||
- helm_template - strip Helm's OCI registry progress messages from the returned
|
||||
``stdout``, which is documented to contain only the rendered templates (https://github.com/ansible-collections/kubernetes.core/pull/1223).
|
||||
- k8s lookup - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later,
|
||||
where the ``cloud.common`` collection is not supported. Fall back to the standard
|
||||
``LookupBase`` instead of failing with a traceback (https://github.com/ansible-collections/kubernetes.core/pull/1253).
|
||||
- k8s_cp - Fix silent truncation when copying to a pod. The module closed the
|
||||
exec connection immediately after writing the last chunk of the tar archive,
|
||||
which killed the remote ``tar`` before it had finished extracting, and never
|
||||
checked the process exit status, so a partial copy was reported as a success.
|
||||
The archive is now bounded with ``head -c`` so ``tar`` gets a clean EOF and
|
||||
exits on its own, and the module waits for that exit and fails on a non-zero
|
||||
status (https://github.com/ansible-collections/kubernetes.core/pull/1217).
|
||||
- k8s_info - Handle empty template output gracefully by returning ``changed=false``
|
||||
instead of failing when Jinja2 template renders to an empty string (https://github.com/ansible-collections/kubernetes.core/issues/1042).
|
||||
deprecated_features:
|
||||
- Ansible Turbo mode (``ENABLE_TURBO_MODE``) has been deprecated and will be
|
||||
removed in release 8.0.0, as it depends on the ``cloud.common`` collection,
|
||||
which is being retired (https://github.com/ansible-collections/kubernetes.core/pull/1242).
|
||||
- helm - the ``status.values`` return value has been deprecated and will be
|
||||
removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
|
||||
- helm - the ``wait_timeout`` parameter has been deprecated and will be removed
|
||||
in version 7.0.0. Use ``timeout`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
|
||||
- helm_info - the ``status.values`` return value has been deprecated and will
|
||||
be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
|
||||
- k8s_exec - the ``return_code`` return value has been deprecated and will be
|
||||
removed in version 7.0.0. Use ``rc`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
|
||||
- k8s_service - the ``merge_type=json`` option has been deprecated and will
|
||||
be removed in version 7.0.0. Use ``kubernetes.core.k8s_json_patch`` module
|
||||
instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
|
||||
minor_changes:
|
||||
- Remove the remaining ``ansible.module_utils.six`` import to avoid deprecation
|
||||
warnings, replacing it with the Python standard library equivalent (https://github.com/ansible-collections/kubernetes.core/pull/1197).
|
||||
- helm - Add ``wait_for_jobs`` option to wait for all Jobs to complete before
|
||||
marking a Helm release as successful. Requires Helm >= 3.5.0 (https://github.com/ansible-collections/kubernetes.core/pull/1140).
|
||||
- helm - add the ``cleanup_on_fail`` option, mapping to the ``--cleanup-on-fail``
|
||||
flag, to allow deletion of new resources created during a failed upgrade.
|
||||
It complements ``atomic`` and can be combined with it, but cannot be used
|
||||
with ``replace``, since that deploys through ``helm install`` which does not
|
||||
accept the flag (https://github.com/ansible-collections/kubernetes.core/pull/1206).
|
||||
- helm - warn when ``reuse_values`` or ``reset_then_reuse_values`` is requested
|
||||
in a combination helm ignores, which happens by default because ``reset_values``
|
||||
defaults to ``true``, and whenever either is combined with ``replace``. The
|
||||
option descriptions and the examples now state that ``reset_values`` has to
|
||||
be set to ``false`` for either option to take effect (https://github.com/ansible-collections/kubernetes.core/pull/1230).
|
||||
- k8s lookup - warn when ``ENABLE_TURBO_MODE`` is set but the ``cloud.common``
|
||||
collection is not installed, instead of silently falling back to the standard
|
||||
lookup base (https://github.com/ansible-collections/kubernetes.core/pull/1242).
|
||||
- k8s_cp - Add the ``copy_timeout`` option (default 300 seconds) bounding how
|
||||
long the module will spend streaming an archive to a pod and waiting for the
|
||||
remote ``tar`` to finish, so that a stalled copy fails instead of hanging
|
||||
indefinitely (https://github.com/ansible-collections/kubernetes.core/pull/1217).
|
||||
- k8s_cp - Stream the tar archive to the pod chunk by chunk instead of building
|
||||
the whole archive in memory first, which cuts peak memory use when copying
|
||||
large files (https://github.com/ansible-collections/kubernetes.core/pull/1217).
|
||||
- k8s_cp - When copying to a pod, the module now also uses ``/bin/sh`` and ``head``
|
||||
in the container, when present, to confirm the copy completed. Containers
|
||||
without them keep the previous behaviour and get a warning that completion
|
||||
could not be verified (https://github.com/ansible-collections/kubernetes.core/pull/1217).
|
||||
- k8s_info - Support for metadata-only fetches in k8s_info module (https://github.com/ansible-collections/kubernetes.core/pull/1030)
|
||||
- meta - Add ``helm_plugin`` and ``helm_plugin_info`` to the ``helm`` action
|
||||
group, and ``k8s_taint`` to the ``k8s`` action group, so that ``module_defaults``
|
||||
set on those groups applies to them (https://github.com/ansible-collections/kubernetes.core/pull/1216).
|
||||
- use `collections.abc` instead of deprecated `ansible.module_utils.common._collections_compat`
|
||||
(https://github.com/ansible-collections/kubernetes.core/pull/1057).
|
||||
- waiter - Add ``job_complete`` predicate to support waiting for Job resources
|
||||
to reach ``Complete`` or ``Failed`` condition (https://github.com/ansible-collections/kubernetes.core/issues/1201).
|
||||
fragments:
|
||||
- 1253-k8s-lookup-turbo-version-check.yml
|
||||
- 20250108-fix-empty-template-output.yaml
|
||||
- 20251027-metadata-only-fetches.yaml
|
||||
- 20260109-fix-deprecated-calls.yaml
|
||||
- 20260723-remove-module-utils-six.yaml
|
||||
- 20260805-add-job-wait-condition.yaml
|
||||
- 20260807-helm-cleanup-on-fail.yaml
|
||||
- 20260807-helm-wait-for-jobs.yaml
|
||||
- 20260812-action-groups.yaml
|
||||
- 20260813-k8s-cp-truncation.yaml
|
||||
- 20260817-helm-oci-registry-progress-on-stdout.yml
|
||||
- 20260826-helm-value-reuse-options.yaml
|
||||
- 20260908-helm-repository-trailing-slash.yaml
|
||||
- 20260911-deprecate-status-values.yaml
|
||||
- 20260911-update-deprecation-notices.yaml
|
||||
- deprecate-enable-turbo-mode.yml
|
||||
- fix-ansible-lint-warnings.yaml
|
||||
release_date: '2026-09-16'
|
||||
|
||||
@@ -0,0 +1,162 @@
|
||||
.. _ansible_turbo_mode:
|
||||
|
||||
|
||||
******************
|
||||
Ansible Turbo mode
|
||||
******************
|
||||
|
||||
Following document provides overview of Ansible Turbo mode in ``kubernetes.core`` collection.
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
|
||||
.. warning::
|
||||
Ansible Turbo mode is **deprecated** and will be removed in a future major release
|
||||
(planned for 8.0.0), as it depends on the ``cloud.common`` collection, which is being
|
||||
retired. Setting ``ENABLE_TURBO_MODE`` now emits a deprecation warning; once support is
|
||||
removed, the variable will have no effect. Start planning your migration away from
|
||||
Turbo mode.
|
||||
|
||||
.. warning::
|
||||
Ansible Turbo mode is supported only with ``ansible-core`` versions **lower than 2.19**.
|
||||
Starting from ``ansible-core`` 2.19, the ``cloud.common`` collection is no longer supported,
|
||||
and therefore Ansible Turbo mode is also not supported in ``kubernetes.core``.
|
||||
If ``ENABLE_TURBO_MODE`` is set to ``1`` (or any truthy value) with ``ansible-core >= 2.19.0``,
|
||||
Turbo mode is ignored and a warning is emitted; modules run without it.
|
||||
|
||||
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 requirements are needed on the host that executes this module.
|
||||
|
||||
- ``ansible-core`` version lower than 2.19.
|
||||
- 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.
|
||||
@@ -42,6 +42,92 @@ Basic authentication is also supported using the ``username`` and ``password`` o
|
||||
|
||||
To disable SSL certificate verification, set ``verify_ssl`` to false.
|
||||
|
||||
Sharing options across tasks with action groups
|
||||
===============================================
|
||||
|
||||
Repeating the same authentication options on every task gets verbose quickly. The collection
|
||||
defines two `action groups <https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_module_defaults.html#module-defaults-groups>`_
|
||||
so you can set them once with ``module_defaults``:
|
||||
|
||||
``kubernetes.core.k8s``
|
||||
Modules that talk to the Kubernetes API and accept the standard authentication options
|
||||
(``kubeconfig``, ``context``, ``host``, ``api_key``, ``validate_certs``, and so on):
|
||||
``k8s``, ``k8s_cluster_info``, ``k8s_cp``, ``k8s_drain``, ``k8s_exec``, ``k8s_info``,
|
||||
``k8s_json_patch``, ``k8s_log``, ``k8s_rollback``, ``k8s_scale``, ``k8s_service``, and
|
||||
``k8s_taint``.
|
||||
|
||||
``kubernetes.core.helm``
|
||||
Modules that shell out to the ``helm`` binary and accept its shared authentication
|
||||
options (``binary_path``, ``kubeconfig``, ``context``, ``host``, ``api_key``,
|
||||
``ca_cert``, ``validate_certs``): ``helm``, ``helm_info``, ``helm_plugin``,
|
||||
``helm_plugin_info``, and ``helm_repository``.
|
||||
|
||||
Prefix the group name with ``group/`` to use it:
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
- hosts: localhost
|
||||
module_defaults:
|
||||
group/kubernetes.core.k8s:
|
||||
kubeconfig: /path/to/kubeconfig
|
||||
context: staging
|
||||
group/kubernetes.core.helm:
|
||||
binary_path: /path/to/helm
|
||||
kubeconfig: /path/to/kubeconfig
|
||||
context: staging
|
||||
tasks:
|
||||
- name: Create a namespace
|
||||
kubernetes.core.k8s:
|
||||
definition:
|
||||
apiVersion: v1
|
||||
kind: Namespace
|
||||
metadata:
|
||||
name: monitoring
|
||||
|
||||
- name: Read it back
|
||||
kubernetes.core.k8s_info:
|
||||
kind: Namespace
|
||||
name: monitoring
|
||||
|
||||
- name: Add the prometheus chart repository
|
||||
kubernetes.core.helm_repository:
|
||||
name: prometheus-community
|
||||
repo_url: https://prometheus-community.github.io/helm-charts
|
||||
|
||||
- name: Deploy the kube-prometheus-stack chart
|
||||
kubernetes.core.helm:
|
||||
name: kube-prometheus-stack
|
||||
chart_ref: prometheus-community/kube-prometheus-stack
|
||||
release_namespace: monitoring
|
||||
|
||||
- name: Collect the releases in that namespace
|
||||
kubernetes.core.helm_info:
|
||||
name: kube-prometheus-stack
|
||||
release_namespace: monitoring
|
||||
|
||||
Every task picks up ``kubeconfig`` and ``context`` from its group without repeating them, the
|
||||
``helm`` modules additionally pick up ``binary_path``, and an option set on an individual task
|
||||
still wins over the group default.
|
||||
|
||||
.. note::
|
||||
|
||||
Always write the group name fully qualified as ``group/kubernetes.core.k8s``. A bare
|
||||
``group/k8s`` refers to the legacy ``k8s`` group that ansible-core defined back when the
|
||||
Kubernetes modules shipped in core itself. The two are not the same group, and the legacy
|
||||
one does not cover the modules in this collection.
|
||||
|
||||
Some modules are deliberately **not** in these groups because they do not accept the shared
|
||||
authentication options, and including them would make ``module_defaults`` fail for everyone
|
||||
using the group:
|
||||
|
||||
- ``helm_pull`` and ``helm_template`` accept only ``binary_path``.
|
||||
- ``helm_registry_auth`` accepts ``binary_path`` and its own ``host``, which is an OCI
|
||||
registry URL rather than a Kubernetes API server.
|
||||
- ``kubeconfig`` writes a kubeconfig file locally and takes no cluster connection options.
|
||||
|
||||
Pass options to those modules directly, or give them their own per-module ``module_defaults``
|
||||
entry.
|
||||
|
||||
Reporting an issue
|
||||
==================
|
||||
|
||||
|
||||
@@ -488,7 +488,7 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
|
||||
<td>always</td>
|
||||
<td>
|
||||
<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>
|
||||
<div>This return value has been deprecated and will be removed in version 8.0.0. Use RV(status.release_values) instead.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@@ -73,6 +73,7 @@ Parameters
|
||||
</td>
|
||||
<td>
|
||||
<div>If set, the installation process deletes the installation on failure.</div>
|
||||
<div>With Helm v4 this is translated to the <code>--rollback-on-failure</code> flag, since <code>--atomic</code> was renamed; with Helm v3 the <code>--atomic</code> flag is used. The O(atomic) option works the same way regardless of the installed Helm version.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -156,6 +157,29 @@ Parameters
|
||||
<div>Chart version to install. If this is not specified, the latest version is installed.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>cleanup_on_fail</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.6.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>Allow deletion of new resources created during a failed upgrade.</div>
|
||||
<div>Maps to the <code>--cleanup-on-fail</code> flag, which is available since helm 3.0.0 and was not renamed in Helm v4.</div>
|
||||
<div>Complements O(atomic) rather than replacing it, and the two can be combined so that a rollback also drops resources orphaned by the failed upgrade.</div>
|
||||
<div>Helm only accepts this flag on <code>helm upgrade</code>, so it cannot be used together with O(replace), which deploys through <code>helm install</code>.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
@@ -254,6 +278,30 @@ Parameters
|
||||
</td>
|
||||
<td>
|
||||
<div>Helm option to force reinstall, ignore on new install.</div>
|
||||
<div>With Helm v4 this performs a client-side replacement. Helm v4 deprecated <code>--force</code> (split into <code>--force-replace</code> and <code>--force-conflicts</code>) and enables server-side apply by default, so for Helm v4 the module emits <code>--server-side=false --force-replace</code> to preserve the Helm v3 behaviour. With Helm v3 the <code>--force</code> flag is used. The O(force) option works the same way regardless of the installed Helm version.</div>
|
||||
<div>Mutually exclusive with O(server_side) and O(force_conflicts).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>force_conflicts</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.5.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>When server-side apply is enabled (the Helm v4 default), force changes against conflicts instead of failing.</div>
|
||||
<div>Maps to the <code>--force-conflicts</code> flag.</div>
|
||||
<div>This option requires Helm v4, cannot be combined with O(server_side=false), and is mutually exclusive with O(force).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -497,7 +545,9 @@ Parameters
|
||||
</td>
|
||||
<td>
|
||||
<div>When upgrading package, reset the values to the ones built into the chart, apply the last release's values and merge in any overrides from parameters O(release_values), O(values_files) or O(set_values).</div>
|
||||
<div>If O(reset_values) or O(reuse_values) is set to V(True), this is ignored.</div>
|
||||
<div>Helm ignores this when <code>--reset-values</code> or <code>--reuse-values</code> is passed. Since O(reset_values) defaults to V(true), it has to be set to V(false), and O(reuse_values) left unset or V(false), for this option to take any effect.</div>
|
||||
<div><code>helm install</code> does not accept <code>--reset-then-reuse-values</code>, so this option is ignored when O(replace) is set.</div>
|
||||
<div>The module warns whenever one of those combinations makes this option a no-op.</div>
|
||||
<div>This feature requires helm diff >= 3.9.12.</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -519,6 +569,7 @@ Parameters
|
||||
</td>
|
||||
<td>
|
||||
<div>When upgrading package, reset the values to the ones built into the chart.</div>
|
||||
<div>Defaults to V(true), which makes helm ignore O(reuse_values) and O(reset_then_reuse_values). Set it to V(false) to use either of them.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -538,8 +589,33 @@ Parameters
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<div>When upgrading package, specifies wether to reuse the last release's values and merge in any overrides from parameters <em>release_values</em>, <em>values_files</em> or <em>set_values</em>.</div>
|
||||
<div>If <em>reset_values</em> is set to <code>True</code>, this is ignored.</div>
|
||||
<div>When upgrading package, specifies whether to reuse the last release's values and merge in any overrides from parameters O(release_values), O(values_files) or O(set_values).</div>
|
||||
<div>Helm ignores this when <code>--reset-values</code> is passed. Since O(reset_values) defaults to V(true), it has to be set to V(false) for this option to take any effect.</div>
|
||||
<div><code>helm install</code> does not accept <code>--reuse-values</code>, so this option is ignored when O(replace) is set.</div>
|
||||
<div>The module warns whenever one of those combinations makes this option a no-op.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>server_side</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.5.0</div>
|
||||
</td>
|
||||
<td>
|
||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||
<li>auto</li>
|
||||
<li>true</li>
|
||||
<li>false</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<div>Control Helm v4 server-side apply when installing or upgrading a release.</div>
|
||||
<div>Maps to the <code>--server-side</code> flag, which accepts <code>true</code>, <code>false</code> or <code>auto</code>.</div>
|
||||
<div>This option requires Helm v4 and is mutually exclusive with O(force).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -763,6 +839,28 @@ Parameters
|
||||
<div>When <em>release_state</em> is set to <code>absent</code>, will wait until all the resources are deleted before returning. It will wait for as long as <em>wait_timeout</em>. This feature requires helm>=3.7.0. Added in version 2.3.0.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>wait_for_jobs</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.6.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>When <em>release_state</em> is set to <code>present</code>, and <em>wait</em> is set to <code>True</code>, wait until all jobs are in a completed state before marking the release as successful.</div>
|
||||
<div>Ignored when used without O(wait).</div>
|
||||
<div>Requires Helm >= 3.5.0</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
@@ -776,7 +874,7 @@ Parameters
|
||||
</td>
|
||||
<td>
|
||||
<div>Timeout when wait option is enabled (helm2 is a number of seconds, helm3 is a duration).</div>
|
||||
<div>The use of <em>wait_timeout</em> to wait for kubernetes commands to complete has been deprecated and will be removed after 2022-12-01.</div>
|
||||
<div>The use of <em>wait_timeout</em> to wait for kubernetes commands to complete has been deprecated and will be removed in version 7.0.0. Use O(timeout) instead.</div>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -887,6 +985,7 @@ Examples
|
||||
release_namespace: default
|
||||
force: True
|
||||
wait: True
|
||||
wait_for_jobs: True
|
||||
replace: True
|
||||
update_repo_cache: True
|
||||
disable_hook: True
|
||||
@@ -906,16 +1005,31 @@ Examples
|
||||
enabled: True
|
||||
|
||||
# Deploy latest version
|
||||
# 'reset_values' defaults to true and helm ignores '--reuse-values' when it is set,
|
||||
# so it has to be turned off explicitly.
|
||||
- name: Deploy latest version of Grafana chart using reuse_values
|
||||
kubernetes.core.helm:
|
||||
name: test
|
||||
chart_ref: stable/grafana
|
||||
release_namespace: monitoring
|
||||
reuse_values: true
|
||||
reset_values: false
|
||||
values:
|
||||
replicas: 2
|
||||
version: 3e8ec0b2dffa40fb97d5342e4af887de95faa8c61a62480dd7f8aa03dffcf533
|
||||
|
||||
# Same for 'reset_then_reuse_values', which helm ignores when either
|
||||
# '--reset-values' or '--reuse-values' is set.
|
||||
- name: Deploy latest version of Grafana chart using reset_then_reuse_values
|
||||
kubernetes.core.helm:
|
||||
name: test
|
||||
chart_ref: stable/grafana
|
||||
release_namespace: monitoring
|
||||
reset_then_reuse_values: true
|
||||
reset_values: false
|
||||
values:
|
||||
replicas: 2
|
||||
|
||||
|
||||
|
||||
Return Values
|
||||
@@ -1104,7 +1218,7 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
|
||||
<td>always</td>
|
||||
<td>
|
||||
<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>
|
||||
<div>This return value has been deprecated and will be removed in version 8.0.0. Use RV(status.release_values) instead.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@@ -120,6 +120,24 @@ Parameters
|
||||
<div>Provide a URL for accessing the API. Can also be specified via <code>K8S_AUTH_HOST</code> environment variable.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>keyring</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">path</span>
|
||||
</div>
|
||||
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.5.0</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Location of public keys used for verification.</div>
|
||||
<div>Only valid with <code>state=present</code>, which maps to the <code>helm plugin install</code> subcommand.</div>
|
||||
<div>This option requires helm version >= 4.0.0.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
|
||||
@@ -289,7 +289,9 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
|
||||
</td>
|
||||
<td>always</td>
|
||||
<td>
|
||||
<div>Full <code>helm</code> command stderr, in case you want to display it or examine the event log. Please be note that helm binnary may print messages to stderr even if the command is successful.</div>
|
||||
<div>Full <code>helm</code> command stderr, in case you want to display it or examine the event log.</div>
|
||||
<div>Please note that the helm binary may print messages to stderr even if the command is successful.</div>
|
||||
<div>On Helm versions earlier than 4.2.1, success messages such as <code>Login Succeeded</code> are printed here; as of Helm 4.2.1 they are printed to stdout (see <a href='https://github.com/helm/helm/pull/32056'>https://github.com/helm/helm/pull/32056</a>).</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;">Login Succeeded\n</div>
|
||||
@@ -321,14 +323,17 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
|
||||
</td>
|
||||
<td>always</td>
|
||||
<td>
|
||||
<div>Full <code>helm</code> command stdout, in case you want to display it or examine the event log</div>
|
||||
<div>Full <code>helm</code> command stdout, in case you want to display it or examine the event log.</div>
|
||||
<div>As of Helm 4.2.1 success messages such as <code>Login Succeeded</code> are printed to stdout (see <a href='https://github.com/helm/helm/pull/32056'>https://github.com/helm/helm/pull/32056</a>). On earlier versions they are printed to stderr.</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;">Login Succeeded\n</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>stout_lines</b>
|
||||
<b>stdout_lines</b>
|
||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">list</span>
|
||||
|
||||
@@ -416,7 +416,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -152,6 +152,25 @@ Parameters
|
||||
<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 colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>copy_timeout</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">integer</span>
|
||||
</div>
|
||||
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.6.0</div>
|
||||
</td>
|
||||
<td>
|
||||
<b>Default:</b><br/><div style="color: blue">300</div>
|
||||
</td>
|
||||
<td>
|
||||
<div>Maximum time in seconds to spend streaming the archive to the pod and waiting for the remote <code>tar</code> process to finish extracting it.</div>
|
||||
<div>Raise this when copying large files over a slow connection.</div>
|
||||
<div>This option is ignored when <em>state</em> is set to <code>from_pod</code>.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
@@ -512,6 +531,7 @@ Notes
|
||||
|
||||
.. note::
|
||||
- the tar binary is required on the container when copying from local filesystem to pod.
|
||||
- a POSIX shell at ``/bin/sh`` and ``head`` are also used, when present, to bound the archive sent to the container so that the module can confirm the copy finished. Without them the copy still runs but completion cannot be verified, and a warning is emitted.
|
||||
- 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.
|
||||
|
||||
@@ -571,7 +591,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -627,7 +627,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -481,7 +481,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
@@ -535,7 +535,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
</td>
|
||||
<td></td>
|
||||
<td>
|
||||
<div>The command status code. This attribute is deprecated and will be removed in a future release. Please use rc instead.</div>
|
||||
<div>The command status code. This attribute is deprecated and will be removed in version 7.0.0. Use RV(result.rc) instead.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@@ -280,6 +280,29 @@ Parameters
|
||||
<div>List of label selectors to use to filter results</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>metadata_only</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.6.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>Request metadata only response from the Kubernetes API server.</div>
|
||||
<div>This feature is useful for clients that only need to check for the existence of an object,</div>
|
||||
<div>or that only need to read its metadata.</div>
|
||||
<div>It can significantly reduce the size of the response from the API server.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
@@ -701,11 +724,32 @@ Examples
|
||||
wait_sleep: 10
|
||||
wait_timeout: 360
|
||||
|
||||
- name: Wait for OpenShift bootstrap to complete
|
||||
kubernetes.core.k8s_info:
|
||||
api_version: v1
|
||||
kind: ConfigMap
|
||||
name: bootstrap
|
||||
namespace: kube-system
|
||||
register: ocp_bootstrap_status
|
||||
until: >
|
||||
ocp_bootstrap_status.resources is defined and
|
||||
(ocp_bootstrap_status.resources | length > 0) and
|
||||
(ocp_bootstrap_status.resources[0].data.status is defined) and
|
||||
(ocp_bootstrap_status.resources[0].data.status == 'complete')
|
||||
retries: 60
|
||||
delay: 15
|
||||
|
||||
- name: Get a list of all pods metadata only
|
||||
kubernetes.core.k8s_info:
|
||||
kind: Pod
|
||||
metadata_only: true
|
||||
register: pod_metadata_list
|
||||
|
||||
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -640,7 +640,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -612,7 +612,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -38,13 +38,13 @@ Parameters
|
||||
|
||||
<table border=0 cellpadding=0 class="documentation-table">
|
||||
<tr>
|
||||
<th colspan="1">Parameter</th>
|
||||
<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="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>api_key</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -61,7 +61,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>api_version</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -79,7 +79,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>ca_cert</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -97,7 +97,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>client_cert</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -115,7 +115,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>client_key</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -133,7 +133,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>cluster_info</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -150,7 +150,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>context</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -167,7 +167,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>field_selector</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -184,7 +184,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>host</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -201,7 +201,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>kind</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -219,7 +219,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>kubeconfig</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -236,7 +236,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>label_selector</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -253,7 +253,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>namespace</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -270,7 +270,26 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>no_proxy</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>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.</div>
|
||||
<div>Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).</div>
|
||||
<div>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.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>password</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -287,7 +306,101 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>proxy</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable.</div>
|
||||
<div>Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>proxy_headers</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">dictionary</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>The Header used for the HTTP proxy.</div>
|
||||
<div>Documentation can be found here <a href='https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers'>https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers</a>.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>basic_auth</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Colon-separated username:password for basic authentication header.</div>
|
||||
<div>Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>proxy_basic_auth</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Colon-separated username:password for proxy basic authentication header.</div>
|
||||
<div>Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>user_agent</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>String representing the user-agent you want, such as foo/1.0.</div>
|
||||
<div>Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>resource_definition</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -304,7 +417,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>resource_name</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -321,7 +434,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>src</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -339,7 +452,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>username</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -356,7 +469,7 @@ Parameters
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>validate_certs</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
@@ -432,7 +545,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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 lookup:
|
||||
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 lookup:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -1279,18 +1279,35 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<table border=0 cellpadding=0 class="documentation-table">
|
||||
<tr>
|
||||
<th colspan="2">Key</th>
|
||||
<th colspan="3">Key</th>
|
||||
<th>Returned</th>
|
||||
<th width="100%">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2">
|
||||
<td colspan="3">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>method</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>success</td>
|
||||
<td>
|
||||
<div>The method used to deploy the resource.</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;">create</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="3">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>result</b>
|
||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||
@@ -1306,6 +1323,105 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>api_version</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 O(resource_definition) or O(src) contains a single object.</td>
|
||||
<td>
|
||||
<div>The versioned schema of this representation of an object.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>duration</b>
|
||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">integer</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>when <code>wait</code> is true</td>
|
||||
<td>
|
||||
<div>elapsed time of task in seconds</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;">48</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>error</b>
|
||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">complex</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>error</td>
|
||||
<td>
|
||||
<div>error while trying to create/delete the object.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>kind</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 O(resource_definition) or O(src) contains a single object.</td>
|
||||
<td>
|
||||
<div>Represents the REST resource this object represents.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>metadata</b>
|
||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">complex</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||
<td>
|
||||
<div>Standard object metadata. Includes name, namespace, annotations, labels, etc.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>results</b>
|
||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">complex</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>when O(resource_definition) or O(src) contains a list of objects.</td>
|
||||
<td>
|
||||
<div>An array of created, patched, or otherwise present objects.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>api_version</b>
|
||||
@@ -1314,7 +1430,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>success</td>
|
||||
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||
<td>
|
||||
<div>The versioned schema of this representation of an object.</div>
|
||||
<br/>
|
||||
@@ -1322,6 +1438,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>duration</b>
|
||||
@@ -1340,6 +1457,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>error</b>
|
||||
@@ -1356,21 +1474,6 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>items</b>
|
||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">list</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>when resource_definition or src contains list of objects</td>
|
||||
<td>
|
||||
<div>Returned only when multiple yaml documents are passed to src or resource_definition</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
@@ -1380,7 +1483,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>success</td>
|
||||
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||
<td>
|
||||
<div>Represents the REST resource this object represents.</div>
|
||||
<br/>
|
||||
@@ -1388,6 +1491,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>metadata</b>
|
||||
@@ -1396,7 +1500,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
<span style="color: purple">complex</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>success</td>
|
||||
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||
<td>
|
||||
<div>Standard object metadata. Includes name, namespace, annotations, labels, etc.</div>
|
||||
<br/>
|
||||
@@ -1404,6 +1508,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>spec</b>
|
||||
@@ -1412,7 +1517,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
<span style="color: purple">complex</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>success</td>
|
||||
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||
<td>
|
||||
<div>Specific attributes of the object. Will vary based on the <em>api_version</em> and <em>kind</em>.</div>
|
||||
<br/>
|
||||
@@ -1420,6 +1525,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>status</b>
|
||||
@@ -1428,7 +1534,40 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
||||
<span style="color: purple">complex</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>success</td>
|
||||
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||
<td>
|
||||
<div>Current status details for the object.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>spec</b>
|
||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">complex</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||
<td>
|
||||
<div>Specific attributes of the object. Will vary based on the <em>api_version</em> and <em>kind</em>.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"> </td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>status</b>
|
||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">complex</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||
<td>
|
||||
<div>Current status details for the object.</div>
|
||||
<br/>
|
||||
|
||||
@@ -503,7 +503,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -686,7 +686,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -247,6 +247,7 @@ Parameters
|
||||
<div>See <a href='https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment'>https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment</a></div>
|
||||
<div>If more than one <code>merge_type</code> is given, the merge_types will be tried in order</div>
|
||||
<div>This defaults to <code>['strategic-merge', 'merge']</code>, which is ideal for using the same parameters on resource kinds that combine Custom Resources and built-in resources.</div>
|
||||
<div><em>merge_type=json</em> has been deprecated and will be removed in version 7.0.0. Use <span class='module'>kubernetes.core.k8s_json_patch</span> instead.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -614,7 +615,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -541,7 +541,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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:
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
@@ -0,0 +1,863 @@
|
||||
.. _kubernetes.core.kubeconfig_module:
|
||||
|
||||
|
||||
**************************
|
||||
kubernetes.core.kubeconfig
|
||||
**************************
|
||||
|
||||
**Generate, update, and optionally write Kubernetes kubeconfig files**
|
||||
|
||||
|
||||
Version added: 6.5.0
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
- Build, update, and manage Kubernetes kubeconfig files using structured input.
|
||||
- Supports loading an existing kubeconfig file and merging clusters, users, and contexts.
|
||||
- Can optionally write the resulting kubeconfig to a destination path.
|
||||
- Ensures idempotent behavior by only updating files when changes occur.
|
||||
|
||||
|
||||
|
||||
Requirements
|
||||
------------
|
||||
The below requirements are needed on the host that executes this module.
|
||||
|
||||
- PyYAML >= 5.1
|
||||
|
||||
|
||||
Parameters
|
||||
----------
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<table border=0 cellpadding=0 class="documentation-table">
|
||||
<tr>
|
||||
<th colspan="3">Parameter</th>
|
||||
<th>Choices/<font color="blue">Defaults</font></th>
|
||||
<th width="100%">Comments</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="3">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>clusters</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=dictionary</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<b>Default:</b><br/><div style="color: blue">[]</div>
|
||||
</td>
|
||||
<td>
|
||||
<div>List of cluster definitions to merge into the kubeconfig.</div>
|
||||
<div>Each cluster is identified by its <code>name</code>.</div>
|
||||
<div>When <code>name</code> matches an existing cluster, the default <code>behavior</code> is V(merge).</div>
|
||||
<div>See the <code>behavior</code> suboption for V(replace), V(keep), and V(remove).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>behavior</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||
<li><div style="color: blue"><b>merge</b> ←</div></li>
|
||||
<li>replace</li>
|
||||
<li>keep</li>
|
||||
<li>remove</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<div>How to handle merging if a cluster with this name already exists.</div>
|
||||
<div><code>merge</code> - Update only the specified fields, preserve others (default).</div>
|
||||
<div><code>replace</code> - Replace the entire cluster definition.</div>
|
||||
<div><code>keep</code> - Keep existing cluster, skip this entry.</div>
|
||||
<div><code>remove</code> - Remove the cluster entry entirely. Silently skipped if the entry does not exist.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>cluster</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">dictionary</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Cluster configuration details.</div>
|
||||
<div>Not required when <code>behavior</code> is V(remove).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>certificate-authority</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Path to a CA certificate file for validating the API server certificate.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>certificate-authority-data</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Base64 encoded CA certificate data.</div>
|
||||
<div>Use this instead of <code>certificate-authority</code> for embedded certificates.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>insecure-skip-tls-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>
|
||||
</td>
|
||||
<td>
|
||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||
<li>no</li>
|
||||
<li>yes</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<div>If true, the server's certificate will not be validated.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>proxy-url</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Optional proxy URL for cluster connections.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>server</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
/ <span style="color: red">required</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Kubernetes API server URL (e.g., <code>https://k8s.example.com:6443</code>).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>tls-server-name</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Server name to use for server certificate validation.</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="2">
|
||||
<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">string</span>
|
||||
/ <span style="color: red">required</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Unique name identifier for the cluster.</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td colspan="3">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>contexts</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=dictionary</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<b>Default:</b><br/><div style="color: blue">[]</div>
|
||||
</td>
|
||||
<td>
|
||||
<div>List of context definitions linking users and clusters.</div>
|
||||
<div>Each context is identified by its <code>name</code>.</div>
|
||||
<div>When <code>name</code> matches an existing context, the default <code>behavior</code> is V(merge).</div>
|
||||
<div>See the <code>behavior</code> suboption for V(replace), V(keep), and V(remove).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>behavior</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||
<li><div style="color: blue"><b>merge</b> ←</div></li>
|
||||
<li>replace</li>
|
||||
<li>keep</li>
|
||||
<li>remove</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<div>How to handle merging if a context with this name already exists.</div>
|
||||
<div><code>merge</code> - Update only the specified fields, preserve others (default).</div>
|
||||
<div><code>replace</code> - Replace the entire context definition.</div>
|
||||
<div><code>keep</code> - Keep existing context, skip this entry.</div>
|
||||
<div><code>remove</code> - Remove the context entry entirely. Silently skipped if the entry does not exist.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="2">
|
||||
<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">dictionary</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Context configuration linking cluster and user.</div>
|
||||
<div>Not required when <code>behavior</code> is V(remove).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>cluster</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
/ <span style="color: red">required</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Name of the cluster to use (must match a cluster name in O(clusters)).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>namespace</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Default namespace to use for this context.</div>
|
||||
<div>If not specified, defaults to <code>default</code>.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>user</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
/ <span style="color: red">required</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Name of the user to authenticate as (must match a user name in O(users)).</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="2">
|
||||
<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">string</span>
|
||||
/ <span style="color: red">required</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Unique name identifier for the context.</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td colspan="3">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>current_context</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Name of the context to set as current/active.</div>
|
||||
<div>This context will be used by default when using kubectl.</div>
|
||||
<div>Must match one of the context names defined in O(contexts).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="3">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>dest</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Destination path where the final kubeconfig should be written.</div>
|
||||
<div>If not specified, the kubeconfig will be saved to O(path).</div>
|
||||
<div>Allows copying and modifying a kubeconfig to a new location.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="3">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>path</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
/ <span style="color: red">required</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Path to an existing kubeconfig file to load and merge from.</div>
|
||||
<div>If the file does not exist, a new kubeconfig will be created.</div>
|
||||
<div>This becomes the default destination if O(dest) is not specified.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="3">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>preferences</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">dictionary</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<b>Default:</b><br/><div style="color: blue">{}</div>
|
||||
</td>
|
||||
<td>
|
||||
<div>Kubeconfig preferences.</div>
|
||||
<div>Used for client-side settings like color output, default editor, etc.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="3">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>users</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=dictionary</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<b>Default:</b><br/><div style="color: blue">[]</div>
|
||||
</td>
|
||||
<td>
|
||||
<div>List of user authentication configurations.</div>
|
||||
<div>Each user is identified by its <code>name</code>.</div>
|
||||
<div>When <code>name</code> matches an existing user, the default <code>behavior</code> is V(merge).</div>
|
||||
<div>See the <code>behavior</code> suboption for V(replace), V(keep), and V(remove).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>behavior</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||
<li><div style="color: blue"><b>merge</b> ←</div></li>
|
||||
<li>replace</li>
|
||||
<li>keep</li>
|
||||
<li>remove</li>
|
||||
</ul>
|
||||
</td>
|
||||
<td>
|
||||
<div>How to handle merging if a user with this name already exists.</div>
|
||||
<div><code>merge</code> - Update only the specified fields, preserve others (default).</div>
|
||||
<div><code>replace</code> - Replace the entire user definition.</div>
|
||||
<div><code>keep</code> - Keep existing user, skip this entry.</div>
|
||||
<div><code>remove</code> - Remove the user entry entirely. Silently skipped if the entry does not exist.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="2">
|
||||
<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">string</span>
|
||||
/ <span style="color: red">required</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Unique name identifier for the user.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="2">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>user</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">dictionary</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>User authentication configuration.</div>
|
||||
<div>Not required when <code>behavior</code> is V(remove).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>auth-provider</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">dictionary</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Authentication provider configuration (e.g., for GCP, Azure).</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>client-certificate</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Path to client certificate file.</div>
|
||||
<div>Used for certificate-based authentication.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>client-certificate-data</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Base64 encoded client certificate.</div>
|
||||
<div>Use instead of <code>client-certificate</code> for embedded certificates.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<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">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Path to client private key file.</div>
|
||||
<div>Must be provided with <code>client-certificate</code>.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>client-key-data</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Base64 encoded client private key.</div>
|
||||
<div>Use instead of <code>client-key</code> for embedded keys.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>exec</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">dictionary</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Exec-based credential plugin configuration.</div>
|
||||
<div>Used for external authentication providers.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<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">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Password for basic authentication.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||
<b>token</b>
|
||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||
<div style="font-size: small">
|
||||
<span style="color: purple">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Bearer token for authentication.</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="elbow-placeholder"></td>
|
||||
<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">string</span>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<div>Username for basic authentication.</div>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</table>
|
||||
<br/>
|
||||
|
||||
|
||||
Notes
|
||||
-----
|
||||
|
||||
.. note::
|
||||
- Input data is merged by resource name (cluster, user, context).
|
||||
- Updates under O(clusters), O(users), and O(contexts) are matched by ``name`` against the kubeconfig loaded from O(path).
|
||||
- For an existing ``name``, each entry's ``behavior`` suboption controls the update.
|
||||
- The default is V(merge), which merges nested ``cluster``, ``user``, and ``context`` data so unspecified keys are preserved.
|
||||
- With V(replace), the previous entry for that name is dropped and only the new definition is used.
|
||||
- With V(keep), the existing entry is left unchanged.
|
||||
- With V(remove), the existing entry is deleted from the kubeconfig entirely. If no entry with that name exists, the operation is silently skipped.
|
||||
- This can be used to move kubeconfig files to a different location with different content.
|
||||
- This module does not validate cluster connectivity or authentication.
|
||||
- The module supports ``check_mode`` and will not write files when enabled.
|
||||
- The structure follows standard Kubernetes kubeconfig format as defined in the Kubernetes documentation.
|
||||
- Tokens and sensitive data should be protected using ansible-vault or environment variables.
|
||||
|
||||
|
||||
See Also
|
||||
--------
|
||||
|
||||
.. seealso::
|
||||
|
||||
`Kubernetes kubeconfig documentation <https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/>`_
|
||||
Official Kubernetes documentation for kubeconfig files
|
||||
`kubectl config documentation <https://kubernetes.io/docs/reference/kubectl/generated/kubectl_config/>`_
|
||||
kubectl commands for working with kubeconfig files
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
# Create a new kubeconfig file with a single cluster
|
||||
- name: Create basic kubeconfig
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
clusters:
|
||||
- name: production-cluster
|
||||
cluster:
|
||||
server: https://prod.k8s.example.com:6443
|
||||
certificate-authority-data: LS0tLS1CRUdJTi...
|
||||
users:
|
||||
- name: admin-user
|
||||
user:
|
||||
token: eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9...
|
||||
contexts:
|
||||
- name: prod-admin
|
||||
context:
|
||||
cluster: production-cluster
|
||||
user: admin-user
|
||||
namespace: production
|
||||
current_context: prod-admin
|
||||
|
||||
- name: Add a second cluster to an existing kubeconfig without touching other entries
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
clusters:
|
||||
- name: staging-cluster
|
||||
cluster:
|
||||
server: https://staging.k8s.example.com:6443
|
||||
insecure-skip-tls-verify: true
|
||||
users:
|
||||
- name: staging-user
|
||||
user:
|
||||
client-certificate: /path/to/staging.crt
|
||||
client-key: /path/to/staging.key
|
||||
contexts:
|
||||
- name: staging-admin
|
||||
context:
|
||||
cluster: staging-cluster
|
||||
user: staging-user
|
||||
namespace: staging
|
||||
|
||||
- name: Update only the token for an existing user, preserving all other user fields
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
users:
|
||||
- name: admin-user
|
||||
behavior: merge
|
||||
user:
|
||||
token: "{{ new_admin_token }}"
|
||||
|
||||
- name: Replace a cluster definition entirely.
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
clusters:
|
||||
- name: production-cluster
|
||||
behavior: replace
|
||||
cluster:
|
||||
server: https://new-prod.k8s.example.com:6443
|
||||
certificate-authority-data: LS0tLS1CRUdJTi...
|
||||
|
||||
- name: Remove a decommissioned cluster, user, and context
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
clusters:
|
||||
- name: old-cluster
|
||||
behavior: remove
|
||||
users:
|
||||
- name: old-user
|
||||
behavior: remove
|
||||
contexts:
|
||||
- name: old-context
|
||||
behavior: remove
|
||||
|
||||
- name: Switch the active context
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
current_context: staging-admin
|
||||
|
||||
- name: Copy a kubeconfig to a new location with an additional cluster merged in
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
dest: /home/user/.kube/config-ci
|
||||
clusters:
|
||||
- name: ci-cluster
|
||||
cluster:
|
||||
server: https://ci.k8s.example.com:6443
|
||||
insecure-skip-tls-verify: true
|
||||
|
||||
|
||||
|
||||
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:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
<table border=0 cellpadding=0 class="documentation-table">
|
||||
<tr>
|
||||
<th colspan="1">Key</th>
|
||||
<th>Returned</th>
|
||||
<th width="100%">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>dest</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>always</td>
|
||||
<td>
|
||||
<div>The path where the kubeconfig was written.</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;">/home/user/.kube/config</div>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="1">
|
||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||
<b>kubeconfig</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>
|
||||
</td>
|
||||
<td>always</td>
|
||||
<td>
|
||||
<div>The complete kubeconfig data structure.</div>
|
||||
<br/>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<br/><br/>
|
||||
|
||||
|
||||
Status
|
||||
------
|
||||
|
||||
|
||||
Authors
|
||||
~~~~~~~
|
||||
|
||||
- Youssef Khalid Ali (@YoussefKhalidAli)
|
||||
@@ -383,6 +383,7 @@ Examples
|
||||
# and requires python to be installed in the image
|
||||
- name: Run a command in a pod
|
||||
ansible.builtin.command: echo "Hello, World!"
|
||||
changed_when: false
|
||||
|
||||
- name: Run a command in a pod using local kubectl with inventory variables
|
||||
# Example inventory:
|
||||
@@ -407,6 +408,7 @@ Examples
|
||||
# and requires python to be installed in the image
|
||||
- name: Run a command in a pod
|
||||
ansible.builtin.command: echo "Hello, World!"
|
||||
changed_when: false
|
||||
|
||||
- name: Run a command in a pod using dynamic inventory
|
||||
hosts: localhost
|
||||
@@ -440,6 +442,7 @@ Examples
|
||||
# be aware that the command is executed as the user that started the container
|
||||
# and requires python to be installed in the image
|
||||
ansible.builtin.command: echo "Hello, World!"
|
||||
changed_when: false
|
||||
delegate_to: "{{ my_app_pod_name }}"
|
||||
|
||||
|
||||
|
||||
@@ -177,7 +177,7 @@ Examples
|
||||
|
||||
Return Values
|
||||
-------------
|
||||
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 lookup:
|
||||
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 lookup:
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
+1
-1
@@ -25,7 +25,7 @@ tags:
|
||||
- openshift
|
||||
- okd
|
||||
- cluster
|
||||
version: 6.4.0
|
||||
version: 6.6.0
|
||||
build_ignore:
|
||||
- .DS_Store
|
||||
- "*.tar.gz"
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
kubernetes-client [platform:fedora]
|
||||
@@ -0,0 +1,5 @@
|
||||
---
|
||||
version: 3
|
||||
dependencies:
|
||||
python: requirements.txt
|
||||
system: meta/ee-bindep.txt
|
||||
@@ -1,10 +1,17 @@
|
||||
---
|
||||
requires_ansible: '>=2.16.0'
|
||||
|
||||
# Only modules that accept the shared authentication options belong in these
|
||||
# groups: HELM_AUTH_ARG_SPEC for helm, AUTH_ARG_SPEC for k8s. Adding a module
|
||||
# that does not accept them makes module_defaults fail for every user of the
|
||||
# group. This excludes helm_pull, helm_registry_auth, helm_template and
|
||||
# kubeconfig, which only take a subset (or none) of those options.
|
||||
action_groups:
|
||||
helm:
|
||||
- helm
|
||||
- helm_info
|
||||
- helm_plugin
|
||||
- helm_plugin_info
|
||||
- helm_repository
|
||||
k8s:
|
||||
- k8s
|
||||
@@ -18,6 +25,7 @@ action_groups:
|
||||
- k8s_rollback
|
||||
- k8s_scale
|
||||
- k8s_service
|
||||
- k8s_taint
|
||||
|
||||
plugin_routing:
|
||||
inventory:
|
||||
|
||||
@@ -35,7 +35,11 @@ def _from_yaml_to_definition(buffer):
|
||||
import yaml
|
||||
except ImportError:
|
||||
raise AnsibleError("Failed to import the required Python library (PyYAML).")
|
||||
return list(yaml.safe_load_all(buffer))
|
||||
|
||||
# Handle empty template output
|
||||
if buffer is None:
|
||||
return []
|
||||
return [doc for doc in yaml.safe_load_all(buffer) if doc is not None]
|
||||
|
||||
|
||||
ENV_KUBECONFIG_PATH_SEPARATOR = ";" if platform.system() == "Windows" else ":"
|
||||
@@ -380,10 +384,15 @@ class ActionModule(ActionBase):
|
||||
template = self._task.args.get("template", None)
|
||||
if template:
|
||||
self.load_template(template, new_module_args, task_vars)
|
||||
# If template rendered to empty definition, return early with no changes
|
||||
if not new_module_args.get("definition"):
|
||||
result["changed"] = False
|
||||
return self._ensure_invocation(result)
|
||||
|
||||
local_path = self._task.args.get("local_path")
|
||||
state = self._task.args.get("state", None)
|
||||
if local_path and state == "to_pod" and not remote_transport:
|
||||
is_local_pod_upload = local_path and state == "to_pod" and not remote_transport
|
||||
if is_local_pod_upload:
|
||||
new_module_args["local_path"] = self.get_file_realpath(local_path)
|
||||
|
||||
# Execute the k8s_* module.
|
||||
|
||||
@@ -196,6 +196,7 @@ EXAMPLES = r"""
|
||||
# and requires python to be installed in the image
|
||||
- name: Run a command in a pod
|
||||
ansible.builtin.command: echo "Hello, World!"
|
||||
changed_when: false
|
||||
|
||||
- name: Run a command in a pod using local kubectl with inventory variables
|
||||
# Example inventory:
|
||||
@@ -220,6 +221,7 @@ EXAMPLES = r"""
|
||||
# and requires python to be installed in the image
|
||||
- name: Run a command in a pod
|
||||
ansible.builtin.command: echo "Hello, World!"
|
||||
changed_when: false
|
||||
|
||||
- name: Run a command in a pod using dynamic inventory
|
||||
hosts: localhost
|
||||
@@ -253,6 +255,7 @@ EXAMPLES = r"""
|
||||
# be aware that the command is executed as the user that started the container
|
||||
# and requires python to be installed in the image
|
||||
ansible.builtin.command: echo "Hello, World!"
|
||||
changed_when: false
|
||||
delegate_to: "{{ my_app_pod_name }}"
|
||||
"""
|
||||
|
||||
@@ -262,11 +265,11 @@ import os.path
|
||||
import shutil
|
||||
import subprocess
|
||||
import tempfile
|
||||
from shlex import quote as shlex_quote
|
||||
|
||||
from ansible.errors import AnsibleError, AnsibleFileNotFound
|
||||
from ansible.module_utils.common.text.converters import to_bytes
|
||||
from ansible.module_utils.parsing.convert_bool import boolean
|
||||
from ansible.module_utils.six.moves import shlex_quote
|
||||
from ansible.parsing.yaml.loader import AnsibleLoader
|
||||
from ansible.plugins.connection import BUFSIZE, ConnectionBase
|
||||
from ansible.utils.display import Display
|
||||
|
||||
+33
-1
@@ -209,28 +209,60 @@ RETURN = """
|
||||
"""
|
||||
|
||||
import os
|
||||
from collections.abc import KeysView
|
||||
|
||||
from ansible.errors import AnsibleError
|
||||
from ansible.module_utils.common._collections_compat import KeysView
|
||||
from ansible.module_utils.ansible_release import __version__ as ansible_version
|
||||
from ansible.module_utils.common.validation import check_type_bool
|
||||
from ansible.utils.display import Display
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
||||
get_api_client,
|
||||
)
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.resource import (
|
||||
create_definitions,
|
||||
)
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
||||
LooseVersion,
|
||||
)
|
||||
|
||||
display = Display()
|
||||
|
||||
# cloud.common declares requires_ansible '>=2.15.0,<2.19'. On newer ansible-core the
|
||||
# import still succeeds, so the version has to be checked explicitly: relying on
|
||||
# ImportError alone lets turbo mode fail later with an unrelated traceback.
|
||||
TURBO_UNSUPPORTED_CORE = "2.19.0"
|
||||
|
||||
try:
|
||||
enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE"))
|
||||
except TypeError:
|
||||
enable_turbo_mode = False
|
||||
|
||||
if enable_turbo_mode:
|
||||
display.deprecated(
|
||||
"ENABLE_TURBO_MODE is deprecated, as it relies on the cloud.common "
|
||||
"collection which is being retired. Setting this environment "
|
||||
"variable will have no effect once support is removed.",
|
||||
version="8.0.0",
|
||||
collection_name="kubernetes.core",
|
||||
)
|
||||
if LooseVersion(ansible_version) >= LooseVersion(TURBO_UNSUPPORTED_CORE):
|
||||
display.warning(
|
||||
"ENABLE_TURBO_MODE is ignored on ansible-core %s: Ansible Turbo mode requires "
|
||||
"the cloud.common collection, which supports ansible-core < %s only. "
|
||||
"Continuing without Turbo mode." % (ansible_version, TURBO_UNSUPPORTED_CORE)
|
||||
)
|
||||
enable_turbo_mode = False
|
||||
|
||||
if enable_turbo_mode:
|
||||
try:
|
||||
from ansible_collections.cloud.common.plugins.plugin_utils.turbo.lookup import (
|
||||
TurboLookupBase as LookupBase,
|
||||
)
|
||||
except ImportError:
|
||||
display.warning(
|
||||
"ENABLE_TURBO_MODE is set but the cloud.common collection is not installed. "
|
||||
"Continuing without Turbo mode."
|
||||
)
|
||||
from ansible.plugins.lookup import LookupBase # noqa: F401
|
||||
else:
|
||||
from ansible.plugins.lookup import LookupBase # noqa: F401
|
||||
|
||||
@@ -5,13 +5,39 @@ __metaclass__ = type
|
||||
|
||||
import os
|
||||
|
||||
from ansible.module_utils.ansible_release import __version__ as ansible_version
|
||||
from ansible.module_utils.common.validation import check_type_bool
|
||||
from ansible.module_utils.common.warnings import deprecate, warn
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
||||
LooseVersion,
|
||||
)
|
||||
|
||||
# cloud.common declares requires_ansible '>=2.15.0,<2.19'. On newer ansible-core the
|
||||
# import still succeeds, so the version has to be checked explicitly: relying on
|
||||
# ImportError alone lets turbo mode fail later with an unrelated traceback.
|
||||
TURBO_UNSUPPORTED_CORE = "2.19.0"
|
||||
|
||||
try:
|
||||
enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE"))
|
||||
except TypeError:
|
||||
enable_turbo_mode = False
|
||||
|
||||
if enable_turbo_mode:
|
||||
deprecate(
|
||||
"ENABLE_TURBO_MODE is deprecated, as it relies on the cloud.common collection "
|
||||
"which is being retired. Setting this environment variable will have no effect "
|
||||
"once support is removed.",
|
||||
version="8.0.0",
|
||||
collection_name="kubernetes.core",
|
||||
)
|
||||
if LooseVersion(ansible_version) >= LooseVersion(TURBO_UNSUPPORTED_CORE):
|
||||
warn(
|
||||
"ENABLE_TURBO_MODE is ignored on ansible-core %s: Ansible Turbo mode requires "
|
||||
"the cloud.common collection, which supports ansible-core < %s only. "
|
||||
"Continuing without Turbo mode." % (ansible_version, TURBO_UNSUPPORTED_CORE)
|
||||
)
|
||||
enable_turbo_mode = False
|
||||
|
||||
if enable_turbo_mode:
|
||||
try:
|
||||
from ansible_collections.cloud.common.plugins.module_utils.turbo.module import ( # noqa: F401
|
||||
@@ -20,6 +46,10 @@ if enable_turbo_mode:
|
||||
|
||||
AnsibleModule.collection_name = "kubernetes.core"
|
||||
except ImportError:
|
||||
warn(
|
||||
"ENABLE_TURBO_MODE is set but the cloud.common collection is not installed. "
|
||||
"Continuing without Turbo mode."
|
||||
)
|
||||
from ansible.module_utils.basic import AnsibleModule # noqa: F401
|
||||
else:
|
||||
from ansible.module_utils.basic import AnsibleModule # noqa: F401
|
||||
|
||||
@@ -144,3 +144,18 @@ DELETE_OPTS_ARG_SPEC = {
|
||||
"options": {"resourceVersion": {"type": "str"}, "uid": {"type": "str"}},
|
||||
},
|
||||
}
|
||||
|
||||
METADATA_ONLY_HEADERS_SPEC = {
|
||||
"accept": {"type": "str"},
|
||||
}
|
||||
|
||||
METADATA_ONLY_HEADER_VALUES = {
|
||||
"partial_object": (
|
||||
"application/json;as=PartialObjectMetadata;g=meta.k8s.io;v=v1,"
|
||||
"application/json;q=0.9"
|
||||
),
|
||||
"partial_object_list": (
|
||||
"application/json;as=PartialObjectMetadataList;g=meta.k8s.io;v=v1,"
|
||||
"application/json;q=0.9"
|
||||
),
|
||||
}
|
||||
|
||||
+178
-53
@@ -18,7 +18,9 @@ from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
import os
|
||||
import shlex
|
||||
import tarfile
|
||||
import time
|
||||
from abc import ABCMeta, abstractmethod
|
||||
from select import select
|
||||
from tempfile import NamedTemporaryFile, TemporaryFile
|
||||
@@ -296,14 +298,156 @@ class K8SCopyToPod(K8SCopy):
|
||||
Copy files/directory from local filesystem into remote Pod
|
||||
"""
|
||||
|
||||
# Size of the chunks the tar archive is written to stdin with.
|
||||
CHUNK_SIZE = 1024 * 1024
|
||||
SHELL = "/bin/sh"
|
||||
|
||||
def __init__(self, module, client):
|
||||
super(K8SCopyToPod, self).__init__(module, client)
|
||||
self.files_to_copy = list()
|
||||
self.named_temp_file = None
|
||||
self.copy_timeout = module.params.get("copy_timeout")
|
||||
|
||||
def close_temp_file(self):
|
||||
if self.named_temp_file:
|
||||
self.named_temp_file.close()
|
||||
|
||||
def _fail(self, response, msg, stderr=(), **kwargs):
|
||||
"""Fail, keeping whatever the remote already wrote to stderr.
|
||||
|
||||
An early close or a stall is usually the symptom, not the cause: tar
|
||||
has typically said why on stderr first.
|
||||
"""
|
||||
if stderr:
|
||||
msg = "{0}: {1}".format(msg, "".join(stderr))
|
||||
response.close()
|
||||
self.close_temp_file()
|
||||
self.module.fail_json(
|
||||
msg="Failed to copy local file/directory into Pod: {0}".format(msg),
|
||||
**kwargs,
|
||||
)
|
||||
|
||||
def tar_command(self, dest_file):
|
||||
if self.no_preserve:
|
||||
command = [
|
||||
"tar",
|
||||
"--no-same-permissions",
|
||||
"--no-same-owner",
|
||||
"-xmf",
|
||||
"-",
|
||||
]
|
||||
else:
|
||||
command = ["tar", "-xmf", "-"]
|
||||
|
||||
if dest_file.startswith("/"):
|
||||
command.extend(["-C", "/"])
|
||||
return command
|
||||
|
||||
def can_bound_stream(self):
|
||||
"""Whether the container can run ``sh -c 'head -c ...'``."""
|
||||
error, _out, _err = self._run_from_pod(
|
||||
cmd=[self.SHELL, "-c", "command -v head"]
|
||||
)
|
||||
return (error or {}).get("status") == "Success"
|
||||
|
||||
def remote_command(self, dest_file, archive_size):
|
||||
"""Build the command that extracts the archive inside the container.
|
||||
|
||||
The websocket exec protocol the kubernetes client speaks (v4) cannot
|
||||
half-close stdin, so the only EOF the remote process can get is the
|
||||
connection going away. Relying on that races with tar finishing and
|
||||
truncates the file (issue #776), and tar cannot be relied on to stop at
|
||||
the end-of-archive marker either -- busybox tar blocks for EOF.
|
||||
|
||||
Piping through ``head -c`` bounds the stream at the exact archive size,
|
||||
so tar sees a clean EOF, exits on its own, and the API server reports
|
||||
its exit status on the error channel. Only where the container has no
|
||||
shell do we fall back to feeding tar directly, which cannot confirm
|
||||
that the copy completed.
|
||||
"""
|
||||
command = self.tar_command(dest_file)
|
||||
if not self.can_bound_stream():
|
||||
self.module.warn(
|
||||
"Container has no '{0}' with 'head', falling back to writing the"
|
||||
" archive straight to tar. The module cannot confirm the copy"
|
||||
" completed; verify the file after copying.".format(self.SHELL)
|
||||
)
|
||||
return command, False
|
||||
|
||||
return [
|
||||
self.SHELL,
|
||||
"-c",
|
||||
"head -c {0} | {1}".format(
|
||||
archive_size, " ".join(shlex.quote(arg) for arg in command)
|
||||
),
|
||||
], True
|
||||
|
||||
def _stream_tar_to_pod(self, response, tar_buffer, wait_for_exit):
|
||||
"""Feed the archive to the remote extractor and wait for it to finish.
|
||||
|
||||
Writing the last chunk only hands the bytes to the local socket; they
|
||||
still have to cross the API server and reach the container. Closing the
|
||||
connection at that point kills the extractor mid-write and silently
|
||||
truncates the file, which is what issue #776 reports.
|
||||
"""
|
||||
stdout, stderr = [], []
|
||||
|
||||
def drain(timeout):
|
||||
response.update(timeout=timeout)
|
||||
if response.peek_stdout():
|
||||
stdout.append(response.read_stdout().rstrip("\n"))
|
||||
if response.peek_stderr():
|
||||
stderr.append(response.read_stderr().rstrip("\n"))
|
||||
|
||||
deadline = time.monotonic() + self.copy_timeout
|
||||
|
||||
chunk = tar_buffer.read(self.CHUNK_SIZE)
|
||||
while chunk:
|
||||
if not response.is_open():
|
||||
self._fail(
|
||||
response,
|
||||
"connection to Pod {0}/{1} closed before the whole archive was"
|
||||
" sent, the remote file is incomplete".format(
|
||||
self.namespace, self.name
|
||||
),
|
||||
stderr,
|
||||
)
|
||||
if time.monotonic() > deadline:
|
||||
self._fail(
|
||||
response,
|
||||
"timed out after {0}s sending the archive to Pod {1}/{2}".format(
|
||||
self.copy_timeout, self.namespace, self.name
|
||||
),
|
||||
stderr,
|
||||
)
|
||||
# Non-blocking, keeps the receive buffer clear while we write.
|
||||
drain(0)
|
||||
response.write_stdin(chunk)
|
||||
chunk = tar_buffer.read(self.CHUNK_SIZE)
|
||||
|
||||
if not wait_for_exit:
|
||||
# No way to make the extractor exit, so no status to collect: read
|
||||
# whatever it has already said and close, as the module always did.
|
||||
drain(0)
|
||||
response.close()
|
||||
return None, stdout, stderr
|
||||
|
||||
# The archive is on the wire; wait for the extractor to consume it,
|
||||
# exit, and have its status reported on the error channel.
|
||||
while response.is_open():
|
||||
if time.monotonic() > deadline:
|
||||
self._fail(
|
||||
response,
|
||||
"timed out after {0}s waiting for tar to finish extracting on Pod"
|
||||
" {1}/{2}".format(self.copy_timeout, self.namespace, self.name),
|
||||
stderr,
|
||||
)
|
||||
drain(1)
|
||||
|
||||
error = yaml.safe_load(response.read_channel(ERROR_CHANNEL)) or {}
|
||||
response.close()
|
||||
return error, stdout, stderr
|
||||
|
||||
def run(self):
|
||||
# remove trailing slash from destination path
|
||||
dest_file = self.remote_path.rstrip("/")
|
||||
@@ -336,65 +480,46 @@ class K8SCopyToPod(K8SCopy):
|
||||
dest_file = os.path.join(dest_file, os.path.basename(src_file))
|
||||
|
||||
if not self.check_mode:
|
||||
if self.no_preserve:
|
||||
tar_command = [
|
||||
"tar",
|
||||
"--no-same-permissions",
|
||||
"--no-same-owner",
|
||||
"-xmf",
|
||||
"-",
|
||||
]
|
||||
else:
|
||||
tar_command = ["tar", "-xmf", "-"]
|
||||
|
||||
if dest_file.startswith("/"):
|
||||
tar_command.extend(["-C", "/"])
|
||||
|
||||
response = stream(
|
||||
self.api_instance.connect_get_namespaced_pod_exec,
|
||||
self.name,
|
||||
self.namespace,
|
||||
command=tar_command,
|
||||
stderr=True,
|
||||
stdin=True,
|
||||
stdout=True,
|
||||
tty=False,
|
||||
_preload_content=False,
|
||||
**self.container_arg,
|
||||
)
|
||||
with TemporaryFile() as tar_buffer:
|
||||
# Build the archive first: bounding the remote read needs its
|
||||
# exact size.
|
||||
with tarfile.open(fileobj=tar_buffer, mode="w") as tar:
|
||||
tar.add(src_file, dest_file)
|
||||
archive_size = tar_buffer.tell()
|
||||
tar_buffer.seek(0)
|
||||
commands = []
|
||||
# push command in chunk mode
|
||||
size = 1024 * 1024
|
||||
while True:
|
||||
data = tar_buffer.read(size)
|
||||
if not data:
|
||||
break
|
||||
commands.append(data)
|
||||
|
||||
stderr, stdout = [], []
|
||||
while response.is_open():
|
||||
if response.peek_stdout():
|
||||
stdout.append(response.read_stdout().rstrip("\n"))
|
||||
if response.peek_stderr():
|
||||
stderr.append(response.read_stderr().rstrip("\n"))
|
||||
if commands:
|
||||
cmd = commands.pop(0)
|
||||
response.write_stdin(cmd)
|
||||
else:
|
||||
break
|
||||
response.close()
|
||||
if stderr:
|
||||
self.close_temp_file()
|
||||
self.module.fail_json(
|
||||
command=tar_command,
|
||||
msg="Failed to copy local file/directory into Pod due to: {0}".format(
|
||||
"".join(stderr)
|
||||
),
|
||||
command, wait_for_exit = self.remote_command(dest_file, archive_size)
|
||||
response = stream(
|
||||
self.api_instance.connect_get_namespaced_pod_exec,
|
||||
self.name,
|
||||
self.namespace,
|
||||
command=command,
|
||||
stderr=True,
|
||||
stdin=True,
|
||||
stdout=True,
|
||||
tty=False,
|
||||
_preload_content=False,
|
||||
**self.container_arg,
|
||||
)
|
||||
error, stdout, stderr = self._stream_tar_to_pod(
|
||||
response, tar_buffer, wait_for_exit
|
||||
)
|
||||
|
||||
if error is not None and error.get("status") != "Success":
|
||||
self._fail(
|
||||
response,
|
||||
"".join(stderr) or error.get("message", "unknown error"),
|
||||
command=command,
|
||||
)
|
||||
if error is None and stderr:
|
||||
# Legacy path: no exit status to go on, so any output is fatal.
|
||||
self._fail(response, "".join(stderr), command=command)
|
||||
if stderr:
|
||||
self.module.warn(
|
||||
"tar wrote to stderr while extracting into Pod {0}/{1}: {2}".format(
|
||||
self.namespace, self.name, "".join(stderr)
|
||||
)
|
||||
)
|
||||
self.close_temp_file()
|
||||
if self.content:
|
||||
self.module.exit_json(
|
||||
|
||||
@@ -32,6 +32,53 @@ except ImportError:
|
||||
HAS_YAML = False
|
||||
|
||||
|
||||
# Helm's registry client writes these progress messages to stdout as of helm 4.2.1
|
||||
# (helm/helm#32056); earlier versions sent them to stderr. Anything that parses the
|
||||
# stdout of a helm command which may pull from an OCI registry has to skip them.
|
||||
# Kept verbatim from helm's pkg/registry/client.go so that a reworded message fails
|
||||
# to match, and therefore fails loudly, rather than silently eating real output.
|
||||
REGISTRY_PROGRESS_RE = re.compile(r"^(?:Pulled|Pushed|Digest): \S")
|
||||
|
||||
REGISTRY_UNDERSCORE_SUFFIX = " contains an underscore.\n"
|
||||
|
||||
REGISTRY_UNDERSCORE_MESSAGE = """
|
||||
OCI artifact references (e.g. tags) do not support the plus sign (+). To support
|
||||
storing semantic versions, Helm adopts the convention of changing plus (+) to
|
||||
an underscore (_) in chart version tags when pushing to a registry and back to
|
||||
a plus (+) when pulling from a registry.
|
||||
"""
|
||||
|
||||
REGISTRY_UNDERSCORE_MESSAGE_LINES = len(REGISTRY_UNDERSCORE_MESSAGE.splitlines())
|
||||
|
||||
|
||||
def strip_registry_progress(out):
|
||||
"""
|
||||
Drop OCI registry progress messages from the front of a helm command's stdout.
|
||||
|
||||
Helm emits 'Pulled:'/'Pushed:' and 'Digest:' lines, followed - when the
|
||||
reference contains an underscore - by a free-text explanation that is not
|
||||
valid YAML. Since helm 4.2.1 these land on stdout ahead of the real output,
|
||||
so 'helm show chart' can no longer be parsed and 'helm template' no longer
|
||||
returns only rendered manifests.
|
||||
"""
|
||||
lines = out.splitlines(keepends=True)
|
||||
index = 0
|
||||
while index < len(lines):
|
||||
if REGISTRY_PROGRESS_RE.match(lines[index]):
|
||||
index += 1
|
||||
elif lines[index].endswith(REGISTRY_UNDERSCORE_SUFFIX):
|
||||
# helm prints its registryUnderscoreMessage right after this line, led
|
||||
# by a blank line. Anything else is not a message we know about.
|
||||
start = index + 1
|
||||
end = start + REGISTRY_UNDERSCORE_MESSAGE_LINES
|
||||
if "".join(lines[start:end]) != REGISTRY_UNDERSCORE_MESSAGE:
|
||||
break
|
||||
index = end
|
||||
else:
|
||||
break
|
||||
return "".join(lines[index:])
|
||||
|
||||
|
||||
def parse_helm_plugin_list(output=None):
|
||||
"""
|
||||
Parse `helm plugin list`, return list of plugins
|
||||
|
||||
@@ -181,6 +181,7 @@ def _create_headers(module=None, **kwargs):
|
||||
header_map = {
|
||||
"impersonate_user": "Impersonate-User",
|
||||
"impersonate_groups": "Impersonate-Group",
|
||||
"accept": "Accept",
|
||||
}
|
||||
|
||||
headers = {}
|
||||
|
||||
@@ -47,6 +47,18 @@ def pod_ready(pod: ResourceInstance) -> bool:
|
||||
)
|
||||
|
||||
|
||||
def job_complete(job: ResourceInstance) -> bool:
|
||||
return bool(
|
||||
job.status
|
||||
and job.status.conditions
|
||||
and any(
|
||||
condition["type"] in ("Complete", "Failed")
|
||||
and boolean(condition["status"], strict=False)
|
||||
for condition in job.status.conditions
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
def daemonset_ready(daemonset: ResourceInstance) -> bool:
|
||||
return bool(
|
||||
daemonset.status
|
||||
@@ -89,18 +101,18 @@ def custom_condition(condition: Dict, resource: ResourceInstance) -> bool:
|
||||
if not matches:
|
||||
return False
|
||||
# There should never be more than one condition of a specific type
|
||||
match: ResourceField = matches[0]
|
||||
if match.status == "Unknown":
|
||||
if match.status == condition["status"]:
|
||||
match_condition: ResourceField = matches[0]
|
||||
if match_condition.status == "Unknown":
|
||||
if match_condition.status == condition["status"]:
|
||||
if "reason" not in condition:
|
||||
return True
|
||||
if condition["reason"]:
|
||||
return match.reason == condition["reason"]
|
||||
return match_condition.reason == condition["reason"]
|
||||
return False
|
||||
status = True if match.status == "True" else False
|
||||
status = True if match_condition.status == "True" else False
|
||||
if status == boolean(condition["status"], strict=False):
|
||||
if condition.get("reason"):
|
||||
return match.reason == condition["reason"]
|
||||
return match_condition.reason == condition["reason"]
|
||||
return True
|
||||
return False
|
||||
|
||||
@@ -143,6 +155,7 @@ RESOURCE_PREDICATES = {
|
||||
"DaemonSet": daemonset_ready,
|
||||
"Deployment": deployment_ready,
|
||||
"Pod": pod_ready,
|
||||
"Job": job_complete,
|
||||
"StatefulSet": statefulset_ready,
|
||||
"ClusterOperator": cluster_operator_ready,
|
||||
}
|
||||
|
||||
@@ -0,0 +1,95 @@
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
|
||||
__metaclass__ = type
|
||||
|
||||
import hashlib
|
||||
import os
|
||||
import traceback
|
||||
|
||||
try:
|
||||
import yaml
|
||||
|
||||
IMP_YAML = True
|
||||
IMP_YAML_ERR = None
|
||||
except ImportError:
|
||||
IMP_YAML = False
|
||||
IMP_YAML_ERR = traceback.format_exc()
|
||||
|
||||
|
||||
def load_yaml_file(path):
|
||||
if not path or not os.path.exists(path):
|
||||
return {}
|
||||
with open(path, "r") as f:
|
||||
return yaml.safe_load(f) or {}
|
||||
|
||||
|
||||
def deep_merge(base, updates):
|
||||
result = base.copy()
|
||||
for key, value in updates.items():
|
||||
if key in result and isinstance(result[key], dict) and isinstance(value, dict):
|
||||
result[key] = deep_merge(result[key], value)
|
||||
else:
|
||||
result[key] = value
|
||||
return result
|
||||
|
||||
|
||||
def merge_by_name(existing, new):
|
||||
merged = {}
|
||||
for item in existing:
|
||||
if isinstance(item, dict) and "name" in item:
|
||||
merged[item["name"]] = item
|
||||
|
||||
for item in new:
|
||||
if not isinstance(item, dict) or "name" not in item:
|
||||
continue
|
||||
|
||||
name = item["name"]
|
||||
behavior = item.get("behavior", "merge")
|
||||
item_copy = {k: v for k, v in item.items() if k != "behavior"}
|
||||
|
||||
if name in merged:
|
||||
if behavior == "keep":
|
||||
continue
|
||||
elif behavior == "remove":
|
||||
del merged[name]
|
||||
elif behavior == "replace":
|
||||
merged[name] = item_copy
|
||||
else:
|
||||
result = {"name": name}
|
||||
for key in ["cluster", "user", "context"]:
|
||||
if key in merged[name] or key in item_copy:
|
||||
existing_config = merged[name].get(key, {})
|
||||
new_config = item_copy.get(key, {})
|
||||
result[key] = deep_merge(existing_config, new_config)
|
||||
for key in merged[name]:
|
||||
if key not in ["name", "cluster", "user", "context"]:
|
||||
result[key] = merged[name][key]
|
||||
for key in item_copy:
|
||||
if (
|
||||
key not in ["name", "cluster", "user", "context"]
|
||||
and key not in result
|
||||
):
|
||||
result[key] = item_copy[key]
|
||||
merged[name] = result
|
||||
else:
|
||||
if behavior == "remove":
|
||||
continue
|
||||
merged[name] = item_copy
|
||||
|
||||
return list(merged.values())
|
||||
|
||||
|
||||
def hash_data(data):
|
||||
"""Generate SHA-256 hash for idempotency checking."""
|
||||
return hashlib.sha256(yaml.safe_dump(data, sort_keys=True).encode()).hexdigest()
|
||||
|
||||
|
||||
def write_file(dest, data):
|
||||
if not dest:
|
||||
return False
|
||||
with open(dest, "w") as f:
|
||||
yaml.safe_dump(data, f, sort_keys=False)
|
||||
return True
|
||||
+296
-61
@@ -132,15 +132,19 @@ options:
|
||||
version_added: 2.4.0
|
||||
reuse_values:
|
||||
description:
|
||||
- When upgrading package, specifies wether to reuse the last release's values and merge in any overrides from parameters I(release_values),
|
||||
I(values_files) or I(set_values).
|
||||
- If I(reset_values) is set to C(True), this is ignored.
|
||||
- When upgrading package, specifies whether to reuse the last release's values and merge in any overrides from parameters O(release_values),
|
||||
O(values_files) or O(set_values).
|
||||
- Helm ignores this when C(--reset-values) is passed. Since O(reset_values) defaults to V(true), it has to be set to V(false)
|
||||
for this option to take any effect.
|
||||
- C(helm install) does not accept C(--reuse-values), so this option is ignored when O(replace) is set.
|
||||
- The module warns whenever one of those combinations makes this option a no-op.
|
||||
type: bool
|
||||
required: false
|
||||
version_added: 3.0.0
|
||||
reset_values:
|
||||
description:
|
||||
- When upgrading package, reset the values to the ones built into the chart.
|
||||
- Defaults to V(true), which makes helm ignore O(reuse_values) and O(reset_then_reuse_values). Set it to V(false) to use either of them.
|
||||
type: bool
|
||||
required: false
|
||||
default: True
|
||||
@@ -149,7 +153,10 @@ options:
|
||||
description:
|
||||
- When upgrading package, reset the values to the ones built into the chart, apply the last release's values and merge in any overrides from
|
||||
parameters O(release_values), O(values_files) or O(set_values).
|
||||
- If O(reset_values) or O(reuse_values) is set to V(True), this is ignored.
|
||||
- Helm ignores this when C(--reset-values) or C(--reuse-values) is passed. Since O(reset_values) defaults to V(true), it has to be
|
||||
set to V(false), and O(reuse_values) left unset or V(false), for this option to take any effect.
|
||||
- C(helm install) does not accept C(--reset-then-reuse-values), so this option is ignored when O(replace) is set.
|
||||
- The module warns whenever one of those combinations makes this option a no-op.
|
||||
- This feature requires helm diff >= 3.9.12.
|
||||
type: bool
|
||||
required: false
|
||||
@@ -165,6 +172,13 @@ options:
|
||||
force:
|
||||
description:
|
||||
- Helm option to force reinstall, ignore on new install.
|
||||
- With Helm v4 this performs a client-side replacement. Helm v4 deprecated
|
||||
C(--force) (split into C(--force-replace) and C(--force-conflicts)) and
|
||||
enables server-side apply by default, so for Helm v4 the module emits
|
||||
C(--server-side=false --force-replace) to preserve the Helm v3 behaviour.
|
||||
With Helm v3 the C(--force) flag is used. The O(force) option works the
|
||||
same way regardless of the installed Helm version.
|
||||
- Mutually exclusive with O(server_side) and O(force_conflicts).
|
||||
default: False
|
||||
type: bool
|
||||
purge:
|
||||
@@ -180,10 +194,19 @@ options:
|
||||
It will wait for as long as I(wait_timeout). This feature requires helm>=3.7.0. Added in version 2.3.0.
|
||||
default: False
|
||||
type: bool
|
||||
wait_for_jobs:
|
||||
description:
|
||||
- When I(release_state) is set to C(present), and I(wait) is set to C(True), wait until all jobs are in a
|
||||
completed state before marking the release as successful.
|
||||
- Ignored when used without O(wait).
|
||||
- Requires Helm >= 3.5.0
|
||||
version_added: 6.6.0
|
||||
default: False
|
||||
type: bool
|
||||
wait_timeout:
|
||||
description:
|
||||
- Timeout when wait option is enabled (helm2 is a number of seconds, helm3 is a duration).
|
||||
- The use of I(wait_timeout) to wait for kubernetes commands to complete has been deprecated and will be removed after 2022-12-01.
|
||||
- The use of I(wait_timeout) to wait for kubernetes commands to complete has been deprecated and will be removed in version 7.0.0. Use O(timeout) instead.
|
||||
type: str
|
||||
timeout:
|
||||
description:
|
||||
@@ -195,8 +218,44 @@ options:
|
||||
atomic:
|
||||
description:
|
||||
- If set, the installation process deletes the installation on failure.
|
||||
- With Helm v4 this is translated to the C(--rollback-on-failure) flag, since
|
||||
C(--atomic) was renamed; with Helm v3 the C(--atomic) flag is used. The
|
||||
O(atomic) option works the same way regardless of the installed Helm version.
|
||||
type: bool
|
||||
default: False
|
||||
cleanup_on_fail:
|
||||
description:
|
||||
- Allow deletion of new resources created during a failed upgrade.
|
||||
- Maps to the C(--cleanup-on-fail) flag, which is available since helm 3.0.0 and
|
||||
was not renamed in Helm v4.
|
||||
- Complements O(atomic) rather than replacing it, and the two can be combined so
|
||||
that a rollback also drops resources orphaned by the failed upgrade.
|
||||
- Helm only accepts this flag on C(helm upgrade), so it cannot be used together
|
||||
with O(replace), which deploys through C(helm install).
|
||||
type: bool
|
||||
default: False
|
||||
version_added: 6.6.0
|
||||
server_side:
|
||||
description:
|
||||
- Control Helm v4 server-side apply when installing or upgrading a release.
|
||||
- Maps to the C(--server-side) flag, which accepts C(true), C(false) or C(auto).
|
||||
- This option requires Helm v4 and is mutually exclusive with O(force).
|
||||
type: str
|
||||
choices:
|
||||
- "auto"
|
||||
- "true"
|
||||
- "false"
|
||||
version_added: 6.5.0
|
||||
force_conflicts:
|
||||
description:
|
||||
- When server-side apply is enabled (the Helm v4 default), force changes
|
||||
against conflicts instead of failing.
|
||||
- Maps to the C(--force-conflicts) flag.
|
||||
- This option requires Helm v4, cannot be combined with O(server_side=false),
|
||||
and is mutually exclusive with O(force).
|
||||
type: bool
|
||||
default: False
|
||||
version_added: 6.5.0
|
||||
create_namespace:
|
||||
description:
|
||||
- Create the release namespace if not present.
|
||||
@@ -354,6 +413,7 @@ EXAMPLES = r"""
|
||||
release_namespace: default
|
||||
force: True
|
||||
wait: True
|
||||
wait_for_jobs: True
|
||||
replace: True
|
||||
update_repo_cache: True
|
||||
disable_hook: True
|
||||
@@ -373,15 +433,30 @@ EXAMPLES = r"""
|
||||
enabled: True
|
||||
|
||||
# Deploy latest version
|
||||
# 'reset_values' defaults to true and helm ignores '--reuse-values' when it is set,
|
||||
# so it has to be turned off explicitly.
|
||||
- name: Deploy latest version of Grafana chart using reuse_values
|
||||
kubernetes.core.helm:
|
||||
name: test
|
||||
chart_ref: stable/grafana
|
||||
release_namespace: monitoring
|
||||
reuse_values: true
|
||||
reset_values: false
|
||||
values:
|
||||
replicas: 2
|
||||
version: 3e8ec0b2dffa40fb97d5342e4af887de95faa8c61a62480dd7f8aa03dffcf533
|
||||
|
||||
# Same for 'reset_then_reuse_values', which helm ignores when either
|
||||
# '--reset-values' or '--reuse-values' is set.
|
||||
- name: Deploy latest version of Grafana chart using reset_then_reuse_values
|
||||
kubernetes.core.helm:
|
||||
name: test
|
||||
chart_ref: stable/grafana
|
||||
release_namespace: monitoring
|
||||
reset_then_reuse_values: true
|
||||
reset_values: false
|
||||
values:
|
||||
replicas: 2
|
||||
"""
|
||||
|
||||
RETURN = r"""
|
||||
@@ -423,8 +498,8 @@ status:
|
||||
returned: always
|
||||
description:
|
||||
- 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.
|
||||
- This return value has been deprecated and will be removed in version 8.0.0.
|
||||
Use RV(status.release_values) instead.
|
||||
release_values:
|
||||
type: dict
|
||||
returned: always
|
||||
@@ -470,6 +545,7 @@ from ansible.module_utils.basic import missing_required_lib
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
||||
AnsibleHelmModule,
|
||||
parse_helm_plugin_list,
|
||||
strip_registry_progress,
|
||||
)
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common import (
|
||||
HELM_AUTH_ARG_SPEC,
|
||||
@@ -517,6 +593,13 @@ def get_release_status(module, release_name, all_status=False):
|
||||
release["release_values"] = module.get_values(release_name)
|
||||
release["values"] = release["release_values"]
|
||||
|
||||
# Add deprecation warning for status.values
|
||||
module.deprecate(
|
||||
"The 'status.values' return value is deprecated and will be removed in version 8.0.0. Use 'status.release_values' instead.",
|
||||
version="8.0.0",
|
||||
collection_name="kubernetes.core",
|
||||
)
|
||||
|
||||
return release
|
||||
|
||||
|
||||
@@ -560,7 +643,52 @@ def fetch_chart_info(
|
||||
|
||||
rc, out, err = module.run_helm_command(inspect_command)
|
||||
|
||||
return yaml.safe_load(out)
|
||||
return yaml.safe_load(strip_registry_progress(out))
|
||||
|
||||
|
||||
def validate_value_options(
|
||||
module, replace, reuse_values, reset_values, reset_then_reuse_values
|
||||
):
|
||||
"""
|
||||
Check the value-reuse options against each other and against 'replace'.
|
||||
|
||||
'helm install' accepts none of these flags, so 'replace' drops all three. The rest
|
||||
are precedence rules helm applies silently: '--reset-values' wins over
|
||||
'--reuse-values', and both win over '--reset-then-reuse-values'. Since 'reset_values'
|
||||
defaults to true, requesting either of the other two on its own is a no-op.
|
||||
|
||||
Warn rather than fail throughout. Every one of these combinations is accepted by
|
||||
playbooks today: 'reuse_values' has existed since 3.0.0, and a release that is
|
||||
already converged never reaches deploy(), so the invalid command was never built.
|
||||
Failing here would turn tasks that pass today into tasks that fail.
|
||||
"""
|
||||
if replace:
|
||||
for name, requested in (
|
||||
("reuse_values", reuse_values is not None),
|
||||
("reset_then_reuse_values", reset_then_reuse_values),
|
||||
):
|
||||
if requested:
|
||||
module.warn(
|
||||
"{0} is ignored because replace=true deploys through 'helm install',"
|
||||
" which does not accept the flag.".format(name)
|
||||
)
|
||||
return
|
||||
|
||||
if reset_values:
|
||||
for name, requested in (
|
||||
("reuse_values", reuse_values),
|
||||
("reset_then_reuse_values", reset_then_reuse_values),
|
||||
):
|
||||
if requested:
|
||||
module.warn(
|
||||
"{0} is ignored because reset_values is true. "
|
||||
"Set reset_values=false to make it take effect.".format(name)
|
||||
)
|
||||
elif reuse_values and reset_then_reuse_values:
|
||||
module.warn(
|
||||
"reset_then_reuse_values is ignored because reuse_values is true. "
|
||||
"Set reuse_values=false to make it take effect."
|
||||
)
|
||||
|
||||
|
||||
def deploy(
|
||||
@@ -570,12 +698,14 @@ def deploy(
|
||||
release_values,
|
||||
chart_name,
|
||||
wait,
|
||||
wait_for_jobs,
|
||||
wait_timeout,
|
||||
disable_hook,
|
||||
force,
|
||||
values_files,
|
||||
history_max,
|
||||
atomic=False,
|
||||
cleanup_on_fail=False,
|
||||
create_namespace=False,
|
||||
replace=False,
|
||||
post_renderer=None,
|
||||
@@ -590,6 +720,8 @@ def deploy(
|
||||
plain_http=False,
|
||||
take_ownership=False,
|
||||
skip_schema_validation=False,
|
||||
server_side=None,
|
||||
force_conflicts=False,
|
||||
):
|
||||
"""
|
||||
Install/upgrade/rollback release chart
|
||||
@@ -601,38 +733,99 @@ def deploy(
|
||||
deploy_command += " --dependency-update"
|
||||
else:
|
||||
deploy_command = command + " upgrade -i" # install/upgrade
|
||||
if reset_values:
|
||||
deploy_command += " --reset-values"
|
||||
if take_ownership:
|
||||
deploy_command += " --take-ownership"
|
||||
|
||||
if reuse_values is not None:
|
||||
deploy_command += " --reuse-values=" + str(reuse_values)
|
||||
# '--reset-values', '--reuse-values' and '--reset-then-reuse-values' are all
|
||||
# upgrade-only flags, so they must not leak into the 'replace' branch above.
|
||||
# validate_value_options() has already warned about that combination.
|
||||
if reset_values:
|
||||
deploy_command += " --reset-values"
|
||||
|
||||
if reset_then_reuse_values:
|
||||
helm_version = module.get_helm_version()
|
||||
if LooseVersion(helm_version) < LooseVersion("3.14.0"):
|
||||
module.fail_json(
|
||||
msg="reset_then_reuse_values requires helm >= 3.14.0, current version is {0}".format(
|
||||
helm_version
|
||||
if reuse_values is not None:
|
||||
deploy_command += " --reuse-values=" + str(reuse_values)
|
||||
|
||||
if reset_then_reuse_values:
|
||||
helm_version = module.get_helm_version()
|
||||
if LooseVersion(helm_version) < LooseVersion("3.14.0"):
|
||||
module.fail_json(
|
||||
msg="reset_then_reuse_values requires helm >= 3.14.0, current version is {0}".format(
|
||||
helm_version
|
||||
)
|
||||
)
|
||||
)
|
||||
else:
|
||||
deploy_command += " --reset-then-reuse-values"
|
||||
else:
|
||||
deploy_command += " --reset-then-reuse-values"
|
||||
|
||||
if wait:
|
||||
deploy_command += " --wait"
|
||||
if wait_for_jobs:
|
||||
helm_version = module.get_helm_version()
|
||||
if LooseVersion(helm_version) < LooseVersion("3.5.0"):
|
||||
module.fail_json(
|
||||
msg="wait_for_jobs requires helm >= 3.5.0, current version is {0}".format(
|
||||
helm_version
|
||||
)
|
||||
)
|
||||
else:
|
||||
deploy_command += " --wait-for-jobs"
|
||||
if wait_timeout is not None:
|
||||
deploy_command += " --timeout " + wait_timeout
|
||||
|
||||
if atomic:
|
||||
deploy_command += " --atomic"
|
||||
# Helm v4 renamed '--atomic' to '--rollback-on-failure'. The old flag is
|
||||
# deprecated on 'helm upgrade' and removed from 'helm install', so always
|
||||
# emit the version-appropriate flag.
|
||||
if module.is_helm_v4():
|
||||
deploy_command += " --rollback-on-failure"
|
||||
else:
|
||||
deploy_command += " --atomic"
|
||||
|
||||
if cleanup_on_fail:
|
||||
# '--cleanup-on-fail' is only accepted by 'helm upgrade', so it cannot be
|
||||
# combined with 'replace', which deploys through 'helm install'. The flag
|
||||
# exists since helm 3.0.0 and kept its name in v4, so no version gate is
|
||||
# needed on top of the module-wide helm >= 3.0.0 requirement.
|
||||
if replace:
|
||||
module.fail_json(
|
||||
msg="cleanup_on_fail is only supported by 'helm upgrade' and cannot be used with replace=true"
|
||||
)
|
||||
deploy_command += " --cleanup-on-fail"
|
||||
|
||||
if timeout:
|
||||
deploy_command += " --timeout " + timeout
|
||||
|
||||
if server_side is not None:
|
||||
if not module.is_helm_v4():
|
||||
module.fail_json(
|
||||
msg="server_side requires helm >= 4.0.0, current version is {0}".format(
|
||||
module.get_helm_version()
|
||||
)
|
||||
)
|
||||
deploy_command += " --server-side=" + server_side
|
||||
|
||||
if force_conflicts:
|
||||
if not module.is_helm_v4():
|
||||
module.fail_json(
|
||||
msg="force_conflicts requires helm >= 4.0.0, current version is {0}".format(
|
||||
module.get_helm_version()
|
||||
)
|
||||
)
|
||||
if server_side == "false":
|
||||
module.fail_json(
|
||||
msg="force_conflicts requires server-side apply to be enabled and cannot be used with server_side=false"
|
||||
)
|
||||
deploy_command += " --force-conflicts"
|
||||
|
||||
if force:
|
||||
deploy_command += " --force"
|
||||
# Helm v4 deprecated '--force' (split into '--force-replace' and
|
||||
# '--force-conflicts') and enables server-side apply by default, which is
|
||||
# incompatible with '--force-replace'. Emit the version-appropriate flags,
|
||||
# disabling server-side apply on v4 to preserve the v3 client-side
|
||||
# replacement behaviour. 'force' is mutually exclusive with 'server_side'.
|
||||
if module.is_helm_v4():
|
||||
deploy_command += " --server-side=false --force-replace"
|
||||
else:
|
||||
deploy_command += " --force"
|
||||
|
||||
if replace:
|
||||
deploy_command += " --replace"
|
||||
@@ -796,10 +989,10 @@ def helmdiff_check(
|
||||
if set_value_args:
|
||||
cmd += " " + set_value_args
|
||||
|
||||
if reuse_values:
|
||||
if not replace and reuse_values:
|
||||
cmd += " --reuse-values"
|
||||
|
||||
if reset_then_reuse_values:
|
||||
if not replace and reset_then_reuse_values:
|
||||
helm_diff_version = get_plugin_version("diff")
|
||||
helm_version = module.get_helm_version()
|
||||
fail_msg = ""
|
||||
@@ -873,42 +1066,58 @@ def default_check(release_status, chart_info, values=None, values_files=None):
|
||||
def argument_spec():
|
||||
arg_spec = copy.deepcopy(HELM_AUTH_ARG_SPEC)
|
||||
arg_spec.update(
|
||||
dict(
|
||||
chart_ref=dict(type="path"),
|
||||
chart_repo_url=dict(type="str"),
|
||||
chart_version=dict(type="str"),
|
||||
dependency_update=dict(type="bool", default=False, aliases=["dep_up"]),
|
||||
release_name=dict(type="str", required=True, aliases=["name"]),
|
||||
release_namespace=dict(type="str", required=True, aliases=["namespace"]),
|
||||
release_state=dict(
|
||||
default="present", choices=["present", "absent"], aliases=["state"]
|
||||
),
|
||||
release_values=dict(type="dict", default={}, aliases=["values"]),
|
||||
values_files=dict(type="list", default=[], elements="str"),
|
||||
update_repo_cache=dict(type="bool", default=False),
|
||||
disable_hook=dict(type="bool", default=False),
|
||||
force=dict(type="bool", default=False),
|
||||
purge=dict(type="bool", default=True),
|
||||
wait=dict(type="bool", default=False),
|
||||
wait_timeout=dict(type="str"),
|
||||
timeout=dict(type="str"),
|
||||
atomic=dict(type="bool", default=False),
|
||||
create_namespace=dict(type="bool", default=False),
|
||||
post_renderer=dict(type="str"),
|
||||
replace=dict(type="bool", default=False),
|
||||
skip_crds=dict(type="bool", default=False),
|
||||
history_max=dict(type="int"),
|
||||
set_values=dict(type="list", elements="dict"),
|
||||
reuse_values=dict(type="bool"),
|
||||
reset_values=dict(type="bool", default=True),
|
||||
reset_then_reuse_values=dict(type="bool", default=False),
|
||||
insecure_skip_tls_verify=dict(
|
||||
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),
|
||||
)
|
||||
{
|
||||
"chart_ref": {"type": "path"},
|
||||
"chart_repo_url": {"type": "str"},
|
||||
"chart_version": {"type": "str"},
|
||||
"dependency_update": {
|
||||
"type": "bool",
|
||||
"default": False,
|
||||
"aliases": ["dep_up"],
|
||||
},
|
||||
"release_name": {"type": "str", "required": True, "aliases": ["name"]},
|
||||
"release_namespace": {
|
||||
"type": "str",
|
||||
"required": True,
|
||||
"aliases": ["namespace"],
|
||||
},
|
||||
"release_state": {
|
||||
"default": "present",
|
||||
"choices": ["present", "absent"],
|
||||
"aliases": ["state"],
|
||||
},
|
||||
"release_values": {"type": "dict", "default": {}, "aliases": ["values"]},
|
||||
"values_files": {"type": "list", "default": [], "elements": "str"},
|
||||
"update_repo_cache": {"type": "bool", "default": False},
|
||||
"disable_hook": {"type": "bool", "default": False},
|
||||
"force": {"type": "bool", "default": False},
|
||||
"purge": {"type": "bool", "default": True},
|
||||
"wait": {"type": "bool", "default": False},
|
||||
"wait_for_jobs": {"type": "bool", "default": False},
|
||||
"wait_timeout": {"type": "str"},
|
||||
"timeout": {"type": "str"},
|
||||
"atomic": {"type": "bool", "default": False},
|
||||
"server_side": {"type": "str", "choices": ["auto", "true", "false"]},
|
||||
"force_conflicts": {"type": "bool", "default": False},
|
||||
"create_namespace": {"type": "bool", "default": False},
|
||||
"post_renderer": {"type": "str"},
|
||||
"replace": {"type": "bool", "default": False},
|
||||
"skip_crds": {"type": "bool", "default": False},
|
||||
"history_max": {"type": "int"},
|
||||
"set_values": {"type": "list", "elements": "dict"},
|
||||
"reuse_values": {"type": "bool"},
|
||||
"reset_values": {"type": "bool", "default": True},
|
||||
"reset_then_reuse_values": {"type": "bool", "default": False},
|
||||
"insecure_skip_tls_verify": {
|
||||
"type": "bool",
|
||||
"default": False,
|
||||
"aliases": ["skip_tls_certs_check"],
|
||||
},
|
||||
"plain_http": {"type": "bool", "default": False},
|
||||
"take_ownership": {"type": "bool", "default": False},
|
||||
"skip_schema_validation": {"type": "bool", "default": False},
|
||||
"cleanup_on_fail": {"type": "bool", "default": False},
|
||||
}
|
||||
)
|
||||
return arg_spec
|
||||
|
||||
@@ -925,10 +1134,20 @@ def main():
|
||||
("context", "ca_cert"),
|
||||
("replace", "history_max"),
|
||||
("wait_timeout", "timeout"),
|
||||
("force", "server_side"),
|
||||
("force", "force_conflicts"),
|
||||
],
|
||||
supports_check_mode=True,
|
||||
)
|
||||
|
||||
# Add deprecation warning for wait_timeout
|
||||
if module.params.get("wait_timeout") is not None:
|
||||
module.deprecate(
|
||||
"The 'wait_timeout' parameter is deprecated and will be removed in version 7.0.0. Use 'timeout' instead.",
|
||||
version="7.0.0",
|
||||
collection_name="kubernetes.core",
|
||||
)
|
||||
|
||||
if not IMP_YAML:
|
||||
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
||||
|
||||
@@ -952,8 +1171,12 @@ def main():
|
||||
force = module.params.get("force")
|
||||
purge = module.params.get("purge")
|
||||
wait = module.params.get("wait")
|
||||
wait_for_jobs = module.params.get("wait_for_jobs")
|
||||
wait_timeout = module.params.get("wait_timeout")
|
||||
atomic = module.params.get("atomic")
|
||||
cleanup_on_fail = module.params.get("cleanup_on_fail")
|
||||
server_side = module.params.get("server_side")
|
||||
force_conflicts = module.params.get("force_conflicts")
|
||||
create_namespace = module.params.get("create_namespace")
|
||||
post_renderer = module.params.get("post_renderer")
|
||||
replace = module.params.get("replace")
|
||||
@@ -1024,6 +1247,10 @@ def main():
|
||||
)
|
||||
changed = True
|
||||
elif release_state == "present":
|
||||
validate_value_options(
|
||||
module, replace, reuse_values, reset_values, reset_then_reuse_values
|
||||
)
|
||||
|
||||
if chart_version is not None:
|
||||
helm_cmd += " --version=" + chart_version
|
||||
|
||||
@@ -1077,11 +1304,15 @@ def main():
|
||||
release_values,
|
||||
chart_ref,
|
||||
wait,
|
||||
wait_for_jobs,
|
||||
wait_timeout,
|
||||
disable_hook,
|
||||
False,
|
||||
values_files=values_files,
|
||||
atomic=atomic,
|
||||
cleanup_on_fail=cleanup_on_fail,
|
||||
server_side=server_side,
|
||||
force_conflicts=force_conflicts,
|
||||
create_namespace=create_namespace,
|
||||
post_renderer=post_renderer,
|
||||
replace=replace,
|
||||
@@ -1161,11 +1392,15 @@ def main():
|
||||
release_values,
|
||||
chart_ref,
|
||||
wait,
|
||||
wait_for_jobs,
|
||||
wait_timeout,
|
||||
disable_hook,
|
||||
force,
|
||||
values_files=values_files,
|
||||
atomic=atomic,
|
||||
cleanup_on_fail=cleanup_on_fail,
|
||||
server_side=server_side,
|
||||
force_conflicts=force_conflicts,
|
||||
create_namespace=create_namespace,
|
||||
post_renderer=post_renderer,
|
||||
replace=replace,
|
||||
|
||||
@@ -119,8 +119,8 @@ status:
|
||||
returned: always
|
||||
description:
|
||||
- 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.
|
||||
- This return value has been deprecated and will be removed in version 8.0.0.
|
||||
Use RV(status.release_values) instead.
|
||||
release_values:
|
||||
type: dict
|
||||
returned: always
|
||||
@@ -213,6 +213,14 @@ def get_release_status(module, release_name, release_state, get_all_values=False
|
||||
|
||||
release["release_values"] = module.get_values(release_name, get_all_values)
|
||||
release["values"] = release["release_values"]
|
||||
|
||||
# Add deprecation warning for status.values
|
||||
module.deprecate(
|
||||
"The 'status.values' return value is deprecated and will be removed in version 8.0.0. Use 'status.release_values' instead.",
|
||||
version="8.0.0",
|
||||
collection_name="kubernetes.core",
|
||||
)
|
||||
|
||||
release["manifest"] = module.get_manifest(release_name)
|
||||
release["notes"] = module.get_notes(release_name)
|
||||
release["hooks"] = module.get_hooks(release_name)
|
||||
|
||||
@@ -56,6 +56,14 @@ options:
|
||||
type: bool
|
||||
default: true
|
||||
version_added: 6.4.0
|
||||
keyring:
|
||||
description:
|
||||
- Location of public keys used for verification.
|
||||
- Only valid with C(state=present), which maps to the C(helm plugin install) subcommand.
|
||||
- This option requires helm version >= 4.0.0.
|
||||
type: path
|
||||
required: false
|
||||
version_added: 6.5.0
|
||||
extends_documentation_fragment:
|
||||
- kubernetes.core.helm_common_options
|
||||
"""
|
||||
@@ -153,6 +161,10 @@ def argument_spec():
|
||||
type="bool",
|
||||
default=True,
|
||||
),
|
||||
keyring=dict(
|
||||
type="path",
|
||||
required=False,
|
||||
),
|
||||
)
|
||||
)
|
||||
return arg_spec
|
||||
@@ -181,16 +193,28 @@ def main():
|
||||
|
||||
state = module.params.get("state")
|
||||
|
||||
# The ``--keyring`` flag is only supported by the ``install``, ``verify`` and
|
||||
# ``package`` plugin subcommands. Of those, this module only implements
|
||||
# ``install`` (state=present); using ``keyring`` with other states emits a
|
||||
# warning and the option is not passed to Helm.
|
||||
if module.params.get("keyring") is not None and state != "present":
|
||||
module.warn(
|
||||
"The 'keyring' option is only supported with state=present "
|
||||
"(the 'helm plugin install' subcommand)."
|
||||
)
|
||||
|
||||
helm_cmd_common = module.get_helm_binary() + " plugin"
|
||||
|
||||
if state == "present":
|
||||
helm_cmd_common += " install %s" % module.params.get("plugin_path")
|
||||
plugin_version = module.params.get("plugin_version")
|
||||
verify = module.params.get("verify")
|
||||
keyring = module.params.get("keyring")
|
||||
if plugin_version is not None:
|
||||
helm_cmd_common += " --version=%s" % plugin_version
|
||||
if not verify:
|
||||
if not verify or keyring is not None:
|
||||
helm_version = module.get_helm_version()
|
||||
if not verify:
|
||||
if LooseVersion(helm_version) < LooseVersion("4.0.0"):
|
||||
module.warn(
|
||||
"verify parameter requires helm >= 4.0.0, current version is {0}".format(
|
||||
@@ -199,6 +223,15 @@ def main():
|
||||
)
|
||||
else:
|
||||
helm_cmd_common += " --verify=false"
|
||||
if keyring is not None:
|
||||
if LooseVersion(helm_version) < LooseVersion("4.0.0"):
|
||||
module.warn(
|
||||
"keyring parameter requires helm >= 4.0.0, current version is {0}".format(
|
||||
helm_version
|
||||
)
|
||||
)
|
||||
else:
|
||||
helm_cmd_common += " --keyring=" + keyring
|
||||
if not module.check_mode:
|
||||
rc, out, err = module.run_helm_command(
|
||||
helm_cmd_common, fails_on_error=False
|
||||
|
||||
@@ -106,17 +106,23 @@ EXAMPLES = r"""
|
||||
RETURN = r"""
|
||||
stdout:
|
||||
type: str
|
||||
description: Full C(helm) command stdout, in case you want to display it or examine the event log
|
||||
description:
|
||||
- Full C(helm) command stdout, in case you want to display it or examine the event log.
|
||||
- As of Helm 4.2.1 success messages such as C(Login Succeeded) are printed to stdout
|
||||
(see U(https://github.com/helm/helm/pull/32056)). On earlier versions they are printed to stderr.
|
||||
returned: always
|
||||
stout_lines:
|
||||
sample: 'Login Succeeded\n'
|
||||
stdout_lines:
|
||||
type: list
|
||||
description: Full C(helm) command stdout, in case you want to display it or examine the event log
|
||||
returned: always
|
||||
stderr:
|
||||
type: str
|
||||
description: >-
|
||||
Full C(helm) command stderr, in case you want to display it or examine the event log.
|
||||
Please be note that helm binnary may print messages to stderr even if the command is successful.
|
||||
description:
|
||||
- Full C(helm) command stderr, in case you want to display it or examine the event log.
|
||||
- Please note that the helm binary may print messages to stderr even if the command is successful.
|
||||
- On Helm versions earlier than 4.2.1, success messages such as C(Login Succeeded) are printed
|
||||
here; as of Helm 4.2.1 they are printed to stdout (see U(https://github.com/helm/helm/pull/32056)).
|
||||
returned: always
|
||||
sample: 'Login Succeeded\n'
|
||||
stderr_lines:
|
||||
|
||||
@@ -302,6 +302,8 @@ def main():
|
||||
|
||||
repo_name = module.params.get("repo_name")
|
||||
repo_url = module.params.get("repo_url")
|
||||
if repo_url:
|
||||
repo_url = repo_url.rstrip("/")
|
||||
repo_username = module.params.get("repo_username")
|
||||
repo_password = module.params.get("repo_password")
|
||||
repo_state = module.params.get("repo_state")
|
||||
@@ -329,7 +331,7 @@ def main():
|
||||
insecure_skip_tls_verify,
|
||||
)
|
||||
changed = True
|
||||
elif repository_status["url"] != repo_url:
|
||||
elif repository_status["url"].rstrip("/") != repo_url:
|
||||
module.fail_json(
|
||||
msg="Repository already have a repository named {0}".format(repo_name)
|
||||
)
|
||||
|
||||
@@ -228,6 +228,7 @@ except ImportError:
|
||||
from ansible.module_utils.basic import missing_required_lib
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
||||
AnsibleHelmModule,
|
||||
strip_registry_progress,
|
||||
)
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
||||
LooseVersion,
|
||||
@@ -394,6 +395,9 @@ def main():
|
||||
|
||||
if not check_mode:
|
||||
rc, out, err = module.run_helm_command(tmpl_cmd)
|
||||
# 'stdout' is documented to hold the rendered templates, so keep helm's
|
||||
# OCI registry progress messages out of it.
|
||||
out = strip_registry_progress(out)
|
||||
else:
|
||||
out = err = ""
|
||||
rc = 0
|
||||
|
||||
@@ -76,9 +76,21 @@ options:
|
||||
- This option is ignored when I(content) is set or when I(state) is set to C(from_pod).
|
||||
type: bool
|
||||
default: False
|
||||
copy_timeout:
|
||||
description:
|
||||
- Maximum time in seconds to spend streaming the archive to the pod and waiting for the remote
|
||||
C(tar) process to finish extracting it.
|
||||
- Raise this when copying large files over a slow connection.
|
||||
- This option is ignored when I(state) is set to C(from_pod).
|
||||
type: int
|
||||
default: 300
|
||||
version_added: 6.6.0
|
||||
|
||||
notes:
|
||||
- the tar binary is required on the container when copying from local filesystem to pod.
|
||||
- a POSIX shell at C(/bin/sh) and C(head) are also used, when present, to bound the archive
|
||||
sent to the container so that the module can confirm the copy finished. Without them the
|
||||
copy still runs but completion cannot be verified, and a warning is emitted.
|
||||
- the (init) container has to be started before you copy files or directories to it.
|
||||
"""
|
||||
|
||||
@@ -180,6 +192,7 @@ def argspec():
|
||||
"choices": ["to_pod", "from_pod"],
|
||||
}
|
||||
argument_spec["no_preserve"] = {"type": "bool", "default": False}
|
||||
argument_spec["copy_timeout"] = {"type": "int", "default": 300}
|
||||
return argument_spec
|
||||
|
||||
|
||||
|
||||
@@ -214,21 +214,21 @@ def filter_pods(pods, force, ignore_daemonset, delete_emptydir_data):
|
||||
to_delete.append((pod.metadata.namespace, pod.metadata.name))
|
||||
continue
|
||||
|
||||
# Pod with local storage cannot be deleted
|
||||
if pod.spec.volumes and any(vol.empty_dir for vol in pod.spec.volumes):
|
||||
localStorage.append((pod.metadata.namespace, pod.metadata.name))
|
||||
continue
|
||||
|
||||
# Check replicated Pod
|
||||
owner_ref = pod.metadata.owner_references
|
||||
if not owner_ref:
|
||||
owner_ref = pod.metadata.owner_references or []
|
||||
has_local_storage = bool(
|
||||
pod.spec.volumes and any(vol.empty_dir for vol in pod.spec.volumes)
|
||||
)
|
||||
is_daemonset_managed = any(owner.kind == "DaemonSet" for owner in owner_ref)
|
||||
|
||||
if is_daemonset_managed:
|
||||
daemonSet.append((pod.metadata.namespace, pod.metadata.name))
|
||||
elif has_local_storage:
|
||||
localStorage.append((pod.metadata.namespace, pod.metadata.name))
|
||||
elif not owner_ref:
|
||||
unmanaged.append((pod.metadata.namespace, pod.metadata.name))
|
||||
else:
|
||||
for owner in owner_ref:
|
||||
if owner.kind == "DaemonSet":
|
||||
daemonSet.append((pod.metadata.namespace, pod.metadata.name))
|
||||
else:
|
||||
to_delete.append((pod.metadata.namespace, pod.metadata.name))
|
||||
to_delete.append((pod.metadata.namespace, pod.metadata.name))
|
||||
|
||||
warnings, errors, info = [], [], []
|
||||
if unmanaged:
|
||||
|
||||
@@ -118,7 +118,7 @@ result:
|
||||
type: int
|
||||
version_added: 2.2.0
|
||||
return_code:
|
||||
description: The command status code. This attribute is deprecated and will be removed in a future release. Please use rc instead.
|
||||
description: The command status code. This attribute is deprecated and will be removed in version 7.0.0. Use RV(result.rc) instead.
|
||||
type: int
|
||||
"""
|
||||
|
||||
@@ -219,6 +219,13 @@ def execute_module(module, client):
|
||||
else:
|
||||
rc = int(err["details"]["causes"][0]["message"])
|
||||
|
||||
# Add deprecation warning for return_code return value
|
||||
module.deprecate(
|
||||
"The 'return_code' return value is deprecated and will be removed in version 7.0.0. Use 'rc' instead.",
|
||||
version="7.0.0",
|
||||
collection_name="kubernetes.core",
|
||||
)
|
||||
|
||||
module.exit_json(
|
||||
# Some command might change environment, but ultimately failing at end
|
||||
changed=True,
|
||||
|
||||
+55
-10
@@ -53,6 +53,15 @@ options:
|
||||
type: list
|
||||
elements: str
|
||||
version_added: 3.0.0
|
||||
metadata_only:
|
||||
description:
|
||||
- Request metadata only response from the Kubernetes API server.
|
||||
- This feature is useful for clients that only need to check for the existence of an object,
|
||||
- or that only need to read its metadata.
|
||||
- It can significantly reduce the size of the response from the API server.
|
||||
type: bool
|
||||
default: false
|
||||
version_added: 6.6.0
|
||||
|
||||
extends_documentation_fragment:
|
||||
- kubernetes.core.k8s_auth_options
|
||||
@@ -120,6 +129,27 @@ EXAMPLES = r"""
|
||||
namespace: default
|
||||
wait_sleep: 10
|
||||
wait_timeout: 360
|
||||
|
||||
- name: Wait for OpenShift bootstrap to complete
|
||||
kubernetes.core.k8s_info:
|
||||
api_version: v1
|
||||
kind: ConfigMap
|
||||
name: bootstrap
|
||||
namespace: kube-system
|
||||
register: ocp_bootstrap_status
|
||||
until: >
|
||||
ocp_bootstrap_status.resources is defined and
|
||||
(ocp_bootstrap_status.resources | length > 0) and
|
||||
(ocp_bootstrap_status.resources[0].data.status is defined) and
|
||||
(ocp_bootstrap_status.resources[0].data.status == 'complete')
|
||||
retries: 60
|
||||
delay: 15
|
||||
|
||||
- name: Get a list of all pods metadata only
|
||||
kubernetes.core.k8s_info:
|
||||
kind: Pod
|
||||
metadata_only: true
|
||||
register: pod_metadata_list
|
||||
"""
|
||||
|
||||
RETURN = r"""
|
||||
@@ -164,6 +194,8 @@ from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule impo
|
||||
)
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||
AUTH_ARG_SPEC,
|
||||
METADATA_ONLY_HEADER_VALUES,
|
||||
METADATA_ONLY_HEADERS_SPEC,
|
||||
WAIT_ARG_SPEC,
|
||||
)
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
||||
@@ -201,15 +233,16 @@ def argspec():
|
||||
args = copy.deepcopy(AUTH_ARG_SPEC)
|
||||
args.update(WAIT_ARG_SPEC)
|
||||
args.update(
|
||||
dict(
|
||||
kind=dict(required=True),
|
||||
api_version=dict(default="v1", aliases=["api", "version"]),
|
||||
name=dict(),
|
||||
namespace=dict(),
|
||||
label_selectors=dict(type="list", elements="str", default=[]),
|
||||
field_selectors=dict(type="list", elements="str", default=[]),
|
||||
hidden_fields=dict(type="list", elements="str"),
|
||||
)
|
||||
{
|
||||
"kind": {"required": True},
|
||||
"api_version": {"default": "v1", "aliases": ["api", "version"]},
|
||||
"name": {},
|
||||
"namespace": {},
|
||||
"label_selectors": {"type": "list", "elements": "str", "default": []},
|
||||
"field_selectors": {"type": "list", "elements": "str", "default": []},
|
||||
"hidden_fields": {"type": "list", "elements": "str"},
|
||||
"metadata_only": {"type": "bool", "default": False},
|
||||
}
|
||||
)
|
||||
return args
|
||||
|
||||
@@ -218,8 +251,20 @@ def main():
|
||||
module = AnsibleK8SModule(
|
||||
module_class=AnsibleModule, argument_spec=argspec(), supports_check_mode=True
|
||||
)
|
||||
|
||||
metadata_only_headers = {}
|
||||
if module.params["metadata_only"]:
|
||||
metadata_only_headers = copy.deepcopy(METADATA_ONLY_HEADERS_SPEC)
|
||||
metadata_only_headers.update(
|
||||
{"accept": METADATA_ONLY_HEADER_VALUES["partial_object_list"]}
|
||||
)
|
||||
if module.params["name"]:
|
||||
metadata_only_headers.update(
|
||||
{"accept": METADATA_ONLY_HEADER_VALUES["partial_object"]}
|
||||
)
|
||||
|
||||
try:
|
||||
client = get_api_client(module)
|
||||
client = get_api_client(module, **metadata_only_headers)
|
||||
svc = K8sService(client, module)
|
||||
execute_module(module, svc)
|
||||
except CoreException as e:
|
||||
|
||||
@@ -36,6 +36,7 @@ options:
|
||||
- If more than one C(merge_type) is given, the merge_types will be tried in order
|
||||
- This defaults to C(['strategic-merge', 'merge']), which is ideal for using the same parameters
|
||||
on resource kinds that combine Custom Resources and built-in resources.
|
||||
- I(merge_type=json) has been deprecated and will be removed in version 7.0.0. Use M(kubernetes.core.k8s_json_patch) instead.
|
||||
choices:
|
||||
- json
|
||||
- merge
|
||||
@@ -251,6 +252,15 @@ def main():
|
||||
supports_check_mode=True,
|
||||
)
|
||||
|
||||
# Add deprecation warning for merge_type=json
|
||||
merge_type = module.params.get("merge_type")
|
||||
if merge_type and "json" in merge_type:
|
||||
module.deprecate(
|
||||
"The 'merge_type=json' option is deprecated and will be removed in version 7.0.0. Use the 'kubernetes.core.k8s_json_patch' module instead.",
|
||||
version="7.0.0",
|
||||
collection_name="kubernetes.core",
|
||||
)
|
||||
|
||||
try:
|
||||
client = get_api_client(module=module)
|
||||
svc = K8sService(client, module)
|
||||
|
||||
@@ -0,0 +1,490 @@
|
||||
#!/usr/bin/python
|
||||
#
|
||||
# Copyright (c) Ansible Project
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
DOCUMENTATION = r"""
|
||||
---
|
||||
module: kubeconfig
|
||||
|
||||
short_description: Generate, update, and optionally write Kubernetes kubeconfig files
|
||||
|
||||
version_added: "6.5.0"
|
||||
|
||||
author: "Youssef Khalid Ali (@YoussefKhalidAli)"
|
||||
|
||||
description:
|
||||
- Build, update, and manage Kubernetes kubeconfig files using structured input.
|
||||
- Supports loading an existing kubeconfig file and merging clusters, users, and contexts.
|
||||
- Can optionally write the resulting kubeconfig to a destination path.
|
||||
- Ensures idempotent behavior by only updating files when changes occur.
|
||||
|
||||
requirements:
|
||||
- "PyYAML >= 5.1"
|
||||
|
||||
notes:
|
||||
- Input data is merged by resource name (cluster, user, context).
|
||||
- Updates under O(clusters), O(users), and O(contexts) are matched by C(name) against the kubeconfig loaded from O(path).
|
||||
- For an existing C(name), each entry's C(behavior) suboption controls the update.
|
||||
- The default is V(merge), which merges nested C(cluster), C(user), and C(context) data so unspecified keys are preserved.
|
||||
- With V(replace), the previous entry for that name is dropped and only the new definition is used.
|
||||
- With V(keep), the existing entry is left unchanged.
|
||||
- With V(remove), the existing entry is deleted from the kubeconfig entirely. If no entry with that name exists, the operation is silently skipped.
|
||||
- This can be used to move kubeconfig files to a different location with different content.
|
||||
- This module does not validate cluster connectivity or authentication.
|
||||
- The module supports C(check_mode) and will not write files when enabled.
|
||||
- The structure follows standard Kubernetes kubeconfig format as defined in the Kubernetes documentation.
|
||||
- Tokens and sensitive data should be protected using ansible-vault or environment variables.
|
||||
|
||||
options:
|
||||
path:
|
||||
description:
|
||||
- Path to an existing kubeconfig file to load and merge from.
|
||||
- If the file does not exist, a new kubeconfig will be created.
|
||||
- This becomes the default destination if O(dest) is not specified.
|
||||
type: str
|
||||
required: true
|
||||
|
||||
dest:
|
||||
description:
|
||||
- Destination path where the final kubeconfig should be written.
|
||||
- If not specified, the kubeconfig will be saved to O(path).
|
||||
- Allows copying and modifying a kubeconfig to a new location.
|
||||
type: str
|
||||
required: false
|
||||
|
||||
clusters:
|
||||
description:
|
||||
- List of cluster definitions to merge into the kubeconfig.
|
||||
- Each cluster is identified by its C(name).
|
||||
- When C(name) matches an existing cluster, the default C(behavior) is V(merge).
|
||||
- See the C(behavior) suboption for V(replace), V(keep), and V(remove).
|
||||
type: list
|
||||
elements: dict
|
||||
required: false
|
||||
default: []
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- Unique name identifier for the cluster.
|
||||
type: str
|
||||
required: true
|
||||
behavior:
|
||||
description:
|
||||
- How to handle merging if a cluster with this name already exists.
|
||||
- C(merge) - Update only the specified fields, preserve others (default).
|
||||
- C(replace) - Replace the entire cluster definition.
|
||||
- C(keep) - Keep existing cluster, skip this entry.
|
||||
- C(remove) - Remove the cluster entry entirely. Silently skipped if the entry does not exist.
|
||||
type: str
|
||||
choices: ['merge', 'replace', 'keep', 'remove']
|
||||
default: merge
|
||||
cluster:
|
||||
description:
|
||||
- Cluster configuration details.
|
||||
- Not required when C(behavior) is V(remove).
|
||||
type: dict
|
||||
suboptions:
|
||||
server:
|
||||
description:
|
||||
- Kubernetes API server URL (e.g., C(https://k8s.example.com:6443)).
|
||||
type: str
|
||||
required: true
|
||||
certificate-authority:
|
||||
description:
|
||||
- Path to a CA certificate file for validating the API server certificate.
|
||||
type: str
|
||||
certificate-authority-data:
|
||||
description:
|
||||
- Base64 encoded CA certificate data.
|
||||
- Use this instead of C(certificate-authority) for embedded certificates.
|
||||
type: str
|
||||
insecure-skip-tls-verify:
|
||||
description:
|
||||
- If true, the server's certificate will not be validated.
|
||||
type: bool
|
||||
proxy-url:
|
||||
description:
|
||||
- Optional proxy URL for cluster connections.
|
||||
type: str
|
||||
tls-server-name:
|
||||
description:
|
||||
- Server name to use for server certificate validation.
|
||||
type: str
|
||||
|
||||
users:
|
||||
description:
|
||||
- List of user authentication configurations.
|
||||
- Each user is identified by its C(name).
|
||||
- When C(name) matches an existing user, the default C(behavior) is V(merge).
|
||||
- See the C(behavior) suboption for V(replace), V(keep), and V(remove).
|
||||
type: list
|
||||
elements: dict
|
||||
required: false
|
||||
default: []
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- Unique name identifier for the user.
|
||||
type: str
|
||||
required: true
|
||||
behavior:
|
||||
description:
|
||||
- How to handle merging if a user with this name already exists.
|
||||
- C(merge) - Update only the specified fields, preserve others (default).
|
||||
- C(replace) - Replace the entire user definition.
|
||||
- C(keep) - Keep existing user, skip this entry.
|
||||
- C(remove) - Remove the user entry entirely. Silently skipped if the entry does not exist.
|
||||
type: str
|
||||
choices: ['merge', 'replace', 'keep', 'remove']
|
||||
default: merge
|
||||
user:
|
||||
description:
|
||||
- User authentication configuration.
|
||||
- Not required when C(behavior) is V(remove).
|
||||
type: dict
|
||||
suboptions:
|
||||
token:
|
||||
description:
|
||||
- Bearer token for authentication.
|
||||
type: str
|
||||
username:
|
||||
description:
|
||||
- Username for basic authentication.
|
||||
type: str
|
||||
password:
|
||||
description:
|
||||
- Password for basic authentication.
|
||||
type: str
|
||||
client-certificate:
|
||||
description:
|
||||
- Path to client certificate file.
|
||||
- Used for certificate-based authentication.
|
||||
type: str
|
||||
client-key:
|
||||
description:
|
||||
- Path to client private key file.
|
||||
- Must be provided with C(client-certificate).
|
||||
type: str
|
||||
client-certificate-data:
|
||||
description:
|
||||
- Base64 encoded client certificate.
|
||||
- Use instead of C(client-certificate) for embedded certificates.
|
||||
type: str
|
||||
client-key-data:
|
||||
description:
|
||||
- Base64 encoded client private key.
|
||||
- Use instead of C(client-key) for embedded keys.
|
||||
type: str
|
||||
auth-provider:
|
||||
description:
|
||||
- Authentication provider configuration (e.g., for GCP, Azure).
|
||||
type: dict
|
||||
exec:
|
||||
description:
|
||||
- Exec-based credential plugin configuration.
|
||||
- Used for external authentication providers.
|
||||
type: dict
|
||||
|
||||
contexts:
|
||||
description:
|
||||
- List of context definitions linking users and clusters.
|
||||
- Each context is identified by its C(name).
|
||||
- When C(name) matches an existing context, the default C(behavior) is V(merge).
|
||||
- See the C(behavior) suboption for V(replace), V(keep), and V(remove).
|
||||
type: list
|
||||
elements: dict
|
||||
required: false
|
||||
default: []
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- Unique name identifier for the context.
|
||||
type: str
|
||||
required: true
|
||||
behavior:
|
||||
description:
|
||||
- How to handle merging if a context with this name already exists.
|
||||
- C(merge) - Update only the specified fields, preserve others (default).
|
||||
- C(replace) - Replace the entire context definition.
|
||||
- C(keep) - Keep existing context, skip this entry.
|
||||
- C(remove) - Remove the context entry entirely. Silently skipped if the entry does not exist.
|
||||
type: str
|
||||
choices: ['merge', 'replace', 'keep', 'remove']
|
||||
default: merge
|
||||
context:
|
||||
description:
|
||||
- Context configuration linking cluster and user.
|
||||
- Not required when C(behavior) is V(remove).
|
||||
type: dict
|
||||
suboptions:
|
||||
cluster:
|
||||
description:
|
||||
- Name of the cluster to use (must match a cluster name in O(clusters)).
|
||||
type: str
|
||||
required: true
|
||||
user:
|
||||
description:
|
||||
- Name of the user to authenticate as (must match a user name in O(users)).
|
||||
type: str
|
||||
required: true
|
||||
namespace:
|
||||
description:
|
||||
- Default namespace to use for this context.
|
||||
- If not specified, defaults to C(default).
|
||||
type: str
|
||||
|
||||
preferences:
|
||||
description:
|
||||
- Kubeconfig preferences.
|
||||
- Used for client-side settings like color output, default editor, etc.
|
||||
type: dict
|
||||
required: false
|
||||
default: {}
|
||||
|
||||
current_context:
|
||||
description:
|
||||
- Name of the context to set as current/active.
|
||||
- This context will be used by default when using kubectl.
|
||||
- Must match one of the context names defined in O(contexts).
|
||||
type: str
|
||||
required: false
|
||||
|
||||
seealso:
|
||||
- name: Kubernetes kubeconfig documentation
|
||||
description: Official Kubernetes documentation for kubeconfig files
|
||||
link: https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/
|
||||
- name: kubectl config documentation
|
||||
description: kubectl commands for working with kubeconfig files
|
||||
link: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_config/
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
# Create a new kubeconfig file with a single cluster
|
||||
- name: Create basic kubeconfig
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
clusters:
|
||||
- name: production-cluster
|
||||
cluster:
|
||||
server: https://prod.k8s.example.com:6443
|
||||
certificate-authority-data: LS0tLS1CRUdJTi...
|
||||
users:
|
||||
- name: admin-user
|
||||
user:
|
||||
token: eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9...
|
||||
contexts:
|
||||
- name: prod-admin
|
||||
context:
|
||||
cluster: production-cluster
|
||||
user: admin-user
|
||||
namespace: production
|
||||
current_context: prod-admin
|
||||
|
||||
- name: Add a second cluster to an existing kubeconfig without touching other entries
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
clusters:
|
||||
- name: staging-cluster
|
||||
cluster:
|
||||
server: https://staging.k8s.example.com:6443
|
||||
insecure-skip-tls-verify: true
|
||||
users:
|
||||
- name: staging-user
|
||||
user:
|
||||
client-certificate: /path/to/staging.crt
|
||||
client-key: /path/to/staging.key
|
||||
contexts:
|
||||
- name: staging-admin
|
||||
context:
|
||||
cluster: staging-cluster
|
||||
user: staging-user
|
||||
namespace: staging
|
||||
|
||||
- name: Update only the token for an existing user, preserving all other user fields
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
users:
|
||||
- name: admin-user
|
||||
behavior: merge
|
||||
user:
|
||||
token: "{{ new_admin_token }}"
|
||||
|
||||
- name: Replace a cluster definition entirely.
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
clusters:
|
||||
- name: production-cluster
|
||||
behavior: replace
|
||||
cluster:
|
||||
server: https://new-prod.k8s.example.com:6443
|
||||
certificate-authority-data: LS0tLS1CRUdJTi...
|
||||
|
||||
- name: Remove a decommissioned cluster, user, and context
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
clusters:
|
||||
- name: old-cluster
|
||||
behavior: remove
|
||||
users:
|
||||
- name: old-user
|
||||
behavior: remove
|
||||
contexts:
|
||||
- name: old-context
|
||||
behavior: remove
|
||||
|
||||
- name: Switch the active context
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
current_context: staging-admin
|
||||
|
||||
- name: Copy a kubeconfig to a new location with an additional cluster merged in
|
||||
kubernetes.core.kubeconfig:
|
||||
path: /home/user/.kube/config
|
||||
dest: /home/user/.kube/config-ci
|
||||
clusters:
|
||||
- name: ci-cluster
|
||||
cluster:
|
||||
server: https://ci.k8s.example.com:6443
|
||||
insecure-skip-tls-verify: true
|
||||
"""
|
||||
|
||||
RETURN = r"""
|
||||
kubeconfig:
|
||||
description: The complete kubeconfig data structure.
|
||||
type: dict
|
||||
returned: always
|
||||
|
||||
dest:
|
||||
description: The path where the kubeconfig was written.
|
||||
type: str
|
||||
returned: always
|
||||
sample: /home/user/.kube/config
|
||||
"""
|
||||
import os
|
||||
import traceback
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
||||
from ansible.module_utils.common.text.converters import to_native
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||
extract_sensitive_values_from_kubeconfig,
|
||||
)
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.kubeconfig import (
|
||||
hash_data,
|
||||
load_yaml_file,
|
||||
merge_by_name,
|
||||
write_file,
|
||||
)
|
||||
|
||||
try:
|
||||
import yaml
|
||||
|
||||
IMP_YAML = True
|
||||
IMP_YAML_ERR = None
|
||||
except ImportError:
|
||||
IMP_YAML = False
|
||||
IMP_YAML_ERR = traceback.format_exc()
|
||||
|
||||
|
||||
def run_module():
|
||||
module_args = dict(
|
||||
path=dict(type="str", required=True),
|
||||
dest=dict(type="str", required=False),
|
||||
clusters=dict(type="list", elements="dict", required=False, default=[]),
|
||||
users=dict(type="list", elements="dict", required=False, default=[]),
|
||||
contexts=dict(type="list", elements="dict", required=False, default=[]),
|
||||
preferences=dict(type="dict", required=False, default={}),
|
||||
current_context=dict(type="str", required=False),
|
||||
)
|
||||
|
||||
module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
|
||||
|
||||
path = module.params["path"]
|
||||
dest = module.params["dest"] or path
|
||||
|
||||
clusters_input = module.params["clusters"]
|
||||
users_input = module.params["users"]
|
||||
contexts_input = module.params["contexts"]
|
||||
|
||||
preferences = module.params["preferences"]
|
||||
current_context = module.params["current_context"]
|
||||
|
||||
# Load existing kubeconfig
|
||||
try:
|
||||
if not IMP_YAML:
|
||||
module.fail_json(
|
||||
msg=missing_required_lib("pyyaml"),
|
||||
exception=IMP_YAML_ERR,
|
||||
)
|
||||
existing = load_yaml_file(path) if path else {}
|
||||
except Exception as e:
|
||||
module.fail_json(
|
||||
msg="Failed to load existing kubeconfig: %s" % to_native(e),
|
||||
exception=traceback.format_exc(),
|
||||
)
|
||||
|
||||
clusters = merge_by_name(existing.get("clusters", []), clusters_input)
|
||||
users = merge_by_name(existing.get("users", []), users_input)
|
||||
contexts = merge_by_name(existing.get("contexts", []), contexts_input)
|
||||
|
||||
# Build final kubeconfig
|
||||
kubeconfig = {
|
||||
"apiVersion": "v1",
|
||||
"kind": "Config",
|
||||
"preferences": preferences or existing.get("preferences", {}),
|
||||
"clusters": clusters,
|
||||
"users": users,
|
||||
"contexts": contexts,
|
||||
"current-context": current_context or existing.get("current-context") or "",
|
||||
}
|
||||
|
||||
changed = False
|
||||
old_data = {}
|
||||
|
||||
if os.path.exists(dest):
|
||||
try:
|
||||
with open(dest, "r") as f:
|
||||
old_data = yaml.safe_load(f) or {}
|
||||
except Exception as e:
|
||||
module.fail_json(
|
||||
msg="Failed to read destination file: %s" % to_native(e),
|
||||
exception=traceback.format_exc(),
|
||||
)
|
||||
|
||||
old_hash = hash_data(old_data)
|
||||
new_hash = hash_data(kubeconfig)
|
||||
|
||||
if old_hash != new_hash:
|
||||
if not module.check_mode:
|
||||
try:
|
||||
write_file(dest, kubeconfig)
|
||||
except Exception as e:
|
||||
module.fail_json(
|
||||
msg="Failed to write kubeconfig: %s" % to_native(e),
|
||||
exception=traceback.format_exc(),
|
||||
)
|
||||
changed = True
|
||||
|
||||
if isinstance(kubeconfig, dict):
|
||||
module.no_log_values.update(
|
||||
extract_sensitive_values_from_kubeconfig(kubeconfig)
|
||||
)
|
||||
|
||||
module.exit_json(
|
||||
changed=changed,
|
||||
kubeconfig=kubeconfig,
|
||||
dest=dest,
|
||||
msg=(
|
||||
"Kubeconfig file has been updated."
|
||||
if changed
|
||||
else "Kubeconfig file is already up to date."
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
def main():
|
||||
run_module()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,47 @@
|
||||
# SonarCloud project configuration for kubernetes.core
|
||||
# Parameters: https://docs.sonarqube.org/latest/analysis/analysis-parameters/
|
||||
|
||||
sonar.projectKey=ansible-collections_kubernetes.core
|
||||
sonar.organization=ansible-collections
|
||||
sonar.sources=.
|
||||
sonar.projectName=kubernetes.core
|
||||
sonar.python.coverage.reportPaths=coverage.xml
|
||||
|
||||
sonar.tests=tests/unit,tests/integration
|
||||
sonar.python.version=3.12
|
||||
sonar.newCode.referenceBranch=stable-6
|
||||
|
||||
sonar.exclusions=tests/**,.tox/**
|
||||
|
||||
# Exclude test code from copy/paste detection. 'sonar.exclusions' above only
|
||||
# filters the *source* set (it disambiguates 'sonar.sources=.' from
|
||||
# 'sonar.tests'), so test files are still indexed as tests and still scored for
|
||||
# duplication. Unit tests here are unittest.TestCase classes: every class needs
|
||||
# its own setUp, and per-case arrange/assert blocks are deliberately repeated so
|
||||
# a failing test reads on its own. Because SonarCloud scores only *new code* on
|
||||
# a pull request, any PR adding cases to an already-repetitive test module
|
||||
# inherits duplication accrued across earlier PRs. Production code under
|
||||
# plugins/ stays fully covered by duplication analysis.
|
||||
sonar.cpd.exclusions=tests/**
|
||||
|
||||
# Ansible module argument_spec is conventionally defined with the dict(...)
|
||||
# constructor (not {...} literals) for readability and consistency across the
|
||||
# collection. Suppress python:S7498 ("prefer literal syntax"), which conflicts
|
||||
# with that convention and otherwise re-fires on every new module argument.
|
||||
sonar.issue.ignore.multicriteria=e1,e2,e3
|
||||
sonar.issue.ignore.multicriteria.e1.ruleKey=python:S7498
|
||||
sonar.issue.ignore.multicriteria.e1.resourceKey=**/*.py
|
||||
|
||||
# Unit tests pass hardcoded '/tmp/...' strings as fake module arguments (e.g.
|
||||
# chart_ref) to fully mocked commands; no file is ever created there. Suppress
|
||||
# python:S5443 ("temporary files in publicly writable directories") for test
|
||||
# code only. Production code creates temp files via tempfile.mkstemp /
|
||||
# NamedTemporaryFile and stays covered by the rule.
|
||||
sonar.issue.ignore.multicriteria.e2.ruleKey=python:S5443
|
||||
sonar.issue.ignore.multicriteria.e2.resourceKey=tests/**/*.py
|
||||
|
||||
# GitHub Actions workflows in this repo use @main for internal reusable actions
|
||||
# (ansible-network/github_actions, ansible-collections/cloud-content-ci-automation)
|
||||
# to simplify maintenance. Suppress githubactions:S7637 ("use full commit SHA").
|
||||
sonar.issue.ignore.multicriteria.e3.ruleKey=githubactions:S7637
|
||||
sonar.issue.ignore.multicriteria.e3.resourceKey=.github/workflows/**/*.yaml
|
||||
+1
-1
@@ -1,2 +1,2 @@
|
||||
modules:
|
||||
python_requires: ">=3.6"
|
||||
python_requires: ">=3.9"
|
||||
|
||||
@@ -31,3 +31,4 @@ test_namespace:
|
||||
- "helm-insecure-{{ helm_version | replace('.', '-') }}"
|
||||
- "helm-test-take-ownership-{{ helm_version | replace('.', '-') }}"
|
||||
- "helm-skip-schema-validation-{{ helm_version | replace('.', '-') }}"
|
||||
- "helm-wait-for-jobs-{{ helm_version | replace('.', '-') }}"
|
||||
|
||||
@@ -0,0 +1,6 @@
|
||||
apiVersion: v2
|
||||
name: test-chart-job
|
||||
description: A chart with a Job for testing wait_for_jobs
|
||||
type: application
|
||||
version: 0.1.0
|
||||
appVersion: "default"
|
||||
@@ -0,0 +1,21 @@
|
||||
apiVersion: batch/v1
|
||||
kind: Job
|
||||
metadata:
|
||||
name: "{{ .Release.Name }}-job"
|
||||
spec:
|
||||
backoffLimit: 0
|
||||
template:
|
||||
spec:
|
||||
automountServiceAccountToken: false
|
||||
restartPolicy: Never
|
||||
containers:
|
||||
- name: test
|
||||
image: "busybox:1.37"
|
||||
command: ["sh", "-c", "echo done"]
|
||||
resources:
|
||||
requests:
|
||||
cpu: "50m"
|
||||
memory: "32Mi"
|
||||
ephemeral-storage: "16Mi"
|
||||
limits:
|
||||
memory: "64Mi"
|
||||
@@ -49,6 +49,9 @@
|
||||
- name: Test helm skip_schema_validation
|
||||
include_tasks: test_skip_schema_validation.yml
|
||||
|
||||
- name: Test helm wait_for_jobs
|
||||
include_tasks: test_helm_wait_for_jobs.yml
|
||||
|
||||
always:
|
||||
- name: Remove helm-diff plugin
|
||||
helm_plugin:
|
||||
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
- name: Test helm wait_for_jobs
|
||||
vars:
|
||||
helm_namespace: "{{ test_namespace[15] }}"
|
||||
chart_local: "{{ role_path }}/files/test-chart-job"
|
||||
block:
|
||||
|
||||
- name: Install chart with wait and wait_for_jobs
|
||||
helm:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
chart_ref: "{{ chart_local }}"
|
||||
release_name: test-wait-for-jobs
|
||||
release_namespace: "{{ helm_namespace }}"
|
||||
create_namespace: true
|
||||
wait: true
|
||||
wait_for_jobs: true
|
||||
wait_timeout: "120s"
|
||||
register: install
|
||||
ignore_errors: true
|
||||
|
||||
- name: Validate wait_for_jobs with helm >= 3.5.0 works
|
||||
assert:
|
||||
that:
|
||||
- install is changed
|
||||
- "'--wait' in install.command"
|
||||
- "'--wait-for-jobs' in install.command"
|
||||
when: "helm_version is ansible.builtin.version('v3.5.0', '>=')"
|
||||
|
||||
- name: Validate wait_for_jobs with helm < 3.5.0 fails
|
||||
assert:
|
||||
that:
|
||||
- install is failed
|
||||
- "'wait_for_jobs requires helm >= 3.5.0' in install.msg"
|
||||
when: "helm_version is ansible.builtin.version('v3.5.0', '<')"
|
||||
|
||||
- name: Install chart with wait_for_jobs but without wait
|
||||
helm:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
chart_ref: "{{ chart_local }}"
|
||||
release_name: test-wait-for-jobs-no-wait
|
||||
release_namespace: "{{ helm_namespace }}"
|
||||
create_namespace: true
|
||||
wait_for_jobs: true
|
||||
register: install_no_wait
|
||||
|
||||
- name: Validate wait_for_jobs is ignored without wait
|
||||
assert:
|
||||
that:
|
||||
- install_no_wait is changed
|
||||
- "'--wait-for-jobs' not in install_no_wait.command"
|
||||
- "'--wait' not in install_no_wait.command"
|
||||
|
||||
always:
|
||||
- name: Remove helm namespace
|
||||
k8s:
|
||||
api_version: v1
|
||||
kind: Namespace
|
||||
name: "{{ helm_namespace }}"
|
||||
state: absent
|
||||
@@ -0,0 +1,3 @@
|
||||
time=10
|
||||
helm
|
||||
helm_template
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
# Helm >= 4.2.1 is required for this test to be meaningful: that is the release which
|
||||
# moved the OCI registry progress messages from stderr to stdout (helm/helm#32056).
|
||||
helm_oci_version: v4.2.4
|
||||
|
||||
helm_oci_namespace: helm-oci-registry-progress
|
||||
test_namespace: "{{ helm_oci_namespace }}"
|
||||
|
||||
# Matches the registry stood up by the setup_helm_registry role.
|
||||
helm_oci_registry: "localhost:6035"
|
||||
helm_oci_registry_username: testuser
|
||||
helm_oci_registry_password: 'pass123!'
|
||||
helm_oci_repo_path: testing
|
||||
|
||||
helm_oci_chart_name: test-chart-plus-version
|
||||
# '+' is not allowed in an OCI tag, so Helm stores this as '1.0.0_build.1'.
|
||||
helm_oci_chart_version: 1.0.0+build.1
|
||||
# A version without build metadata, to cover the case where the progress messages
|
||||
# happen to be valid YAML and so corrupt the parsed output silently.
|
||||
helm_oci_chart_version_plain: 1.0.1
|
||||
+6
@@ -0,0 +1,6 @@
|
||||
apiVersion: v2
|
||||
name: test-chart-plus-version
|
||||
description: A chart whose version carries semver build metadata
|
||||
type: application
|
||||
version: 1.0.0+build.1
|
||||
appVersion: "default"
|
||||
+6
@@ -0,0 +1,6 @@
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: test-chart-plus-version-configmap
|
||||
data:
|
||||
myValue: test
|
||||
@@ -0,0 +1,4 @@
|
||||
---
|
||||
dependencies:
|
||||
- remove_namespace
|
||||
- setup_helm_registry
|
||||
@@ -0,0 +1,158 @@
|
||||
---
|
||||
# Regression test for https://github.com/ansible-collections/kubernetes.core/issues/1222
|
||||
#
|
||||
# Helm >= 4.2.1 writes OCI registry progress messages to stdout rather than stderr
|
||||
# (helm/helm#32056): 'Pulled:', 'Digest:' and, when the reference contains an
|
||||
# underscore, a free-text explanation. Helm rewrites '+' to '_' in OCI tags, so a
|
||||
# chart version carrying semver build metadata is what triggers that explanation,
|
||||
# which is not valid YAML.
|
||||
#
|
||||
# The helm module parses the stdout of 'helm show chart', and helm_template returns
|
||||
# the stdout of 'helm template' as its documented result, so both have to skip those
|
||||
# messages. Without the fix, the helm task below fails with
|
||||
# "could not find expected ':'".
|
||||
- name: Test OCI charts whose version contains build metadata
|
||||
vars:
|
||||
chart_ref: "oci://{{ helm_oci_registry }}/{{ helm_oci_repo_path }}/{{ helm_oci_chart_name }}"
|
||||
block:
|
||||
- name: "Install Helm {{ helm_oci_version }}"
|
||||
ansible.builtin.include_role:
|
||||
name: install_helm
|
||||
vars:
|
||||
helm_version: "{{ helm_oci_version }}"
|
||||
|
||||
- name: Create temporary directory to hold the chart
|
||||
ansible.builtin.tempfile:
|
||||
state: directory
|
||||
suffix: .chart
|
||||
register: _tmpd
|
||||
|
||||
- name: Copy the test chart
|
||||
ansible.builtin.copy:
|
||||
src: "{{ helm_oci_chart_name }}"
|
||||
dest: "{{ _tmpd.path }}/"
|
||||
|
||||
- name: Log into the helm registry
|
||||
ansible.builtin.command: >-
|
||||
{{ helm_binary }} registry login --plain-http
|
||||
-u {{ helm_oci_registry_username }} -p {{ helm_oci_registry_password }}
|
||||
{{ helm_oci_registry }}
|
||||
|
||||
- name: Package and push both chart versions
|
||||
ansible.builtin.command: "{{ item }}"
|
||||
loop:
|
||||
- >-
|
||||
{{ helm_binary }} package {{ _tmpd.path }}/{{ helm_oci_chart_name }}
|
||||
--version {{ helm_oci_chart_version }} --destination {{ _tmpd.path }}
|
||||
- >-
|
||||
{{ helm_binary }} package {{ _tmpd.path }}/{{ helm_oci_chart_name }}
|
||||
--version {{ helm_oci_chart_version_plain }} --destination {{ _tmpd.path }}
|
||||
- >-
|
||||
{{ helm_binary }} push --plain-http
|
||||
{{ _tmpd.path }}/{{ helm_oci_chart_name }}-{{ helm_oci_chart_version }}.tgz
|
||||
oci://{{ helm_oci_registry }}/{{ helm_oci_repo_path }}
|
||||
- >-
|
||||
{{ helm_binary }} push --plain-http
|
||||
{{ _tmpd.path }}/{{ helm_oci_chart_name }}-{{ helm_oci_chart_version_plain }}.tgz
|
||||
oci://{{ helm_oci_registry }}/{{ helm_oci_repo_path }}
|
||||
register: _push
|
||||
|
||||
- name: Ensure Helm stored the build metadata version with an underscore
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- "'1.0.0_build.1' in (_push.results[2].stdout + _push.results[2].stderr)"
|
||||
fail_msg: >-
|
||||
Expected Helm to rewrite '+' to '_' when pushing the chart tag. Without
|
||||
that rewrite this target no longer covers the case it was written for.
|
||||
|
||||
# helm - the version with build metadata is the case that failed outright.
|
||||
- name: Install the chart from the OCI registry
|
||||
kubernetes.core.helm:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: "{{ helm_oci_chart_name }}"
|
||||
chart_ref: "{{ chart_ref }}"
|
||||
chart_version: "{{ helm_oci_chart_version }}"
|
||||
release_namespace: "{{ helm_oci_namespace }}"
|
||||
create_namespace: true
|
||||
plain_http: true
|
||||
register: _install
|
||||
|
||||
- name: Ensure the release reports the chart version verbatim
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- _install is changed
|
||||
- _install.status.chart == helm_oci_chart_name ~ '-' ~ helm_oci_chart_version
|
||||
|
||||
- name: Install the same chart again
|
||||
kubernetes.core.helm:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: "{{ helm_oci_chart_name }}"
|
||||
chart_ref: "{{ chart_ref }}"
|
||||
chart_version: "{{ helm_oci_chart_version }}"
|
||||
release_namespace: "{{ helm_oci_namespace }}"
|
||||
plain_http: true
|
||||
register: _reinstall
|
||||
|
||||
- name: Ensure the module is idempotent
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- _reinstall is not changed
|
||||
|
||||
# helm_template - stdout is documented to hold only the rendered templates. Both
|
||||
# chart versions are checked: the plain one covers the case where the progress
|
||||
# messages are valid YAML and would otherwise be parsed as a manifest.
|
||||
- name: Render the chart from the OCI registry
|
||||
kubernetes.core.helm_template:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
chart_ref: "{{ chart_ref }}"
|
||||
chart_version: "{{ item }}"
|
||||
release_name: "{{ helm_oci_chart_name }}"
|
||||
plain_http: true
|
||||
loop:
|
||||
- "{{ helm_oci_chart_version }}"
|
||||
- "{{ helm_oci_chart_version_plain }}"
|
||||
register: _template
|
||||
|
||||
- name: Ensure stdout holds the rendered manifests and nothing else
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- "'Pulled:' not in item.stdout"
|
||||
- "'Digest:' not in item.stdout"
|
||||
- "'contains an underscore' not in item.stdout"
|
||||
- item.stdout.startswith('---')
|
||||
- (item.stdout | from_yaml_all | list | map(attribute='kind') | list) == ['ConfigMap']
|
||||
fail_msg: "helm_template stdout was not only rendered manifests: {{ item.stdout[:200] }}"
|
||||
loop: "{{ _template.results }}"
|
||||
loop_control:
|
||||
label: "{{ item.item }}"
|
||||
|
||||
always:
|
||||
- name: Uninstall the release
|
||||
kubernetes.core.helm:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: "{{ helm_oci_chart_name }}"
|
||||
release_namespace: "{{ helm_oci_namespace }}"
|
||||
state: absent
|
||||
when: helm_binary is defined
|
||||
ignore_errors: true
|
||||
|
||||
- name: Remove the test namespace
|
||||
kubernetes.core.k8s:
|
||||
api_version: v1
|
||||
kind: Namespace
|
||||
name: "{{ helm_oci_namespace }}"
|
||||
state: absent
|
||||
wait: true
|
||||
ignore_errors: true
|
||||
|
||||
- name: Log out of the helm registry
|
||||
ansible.builtin.command: "{{ helm_binary }} registry logout {{ helm_oci_registry }}"
|
||||
when: helm_binary is defined
|
||||
ignore_errors: true
|
||||
|
||||
- name: Remove the temporary directory
|
||||
ansible.builtin.file:
|
||||
path: "{{ _tmpd.path }}"
|
||||
state: absent
|
||||
when: _tmpd is defined and _tmpd.path is defined
|
||||
ignore_errors: true
|
||||
@@ -28,7 +28,9 @@
|
||||
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
|
||||
# Helm < 4.2.1 prints success messages to stderr (https://github.com/helm/helm/issues/13464),
|
||||
# Helm >= 4.2.1 moves them to stdout (https://github.com/helm/helm/pull/32056).
|
||||
# Check both streams to stay version-agnostic.
|
||||
assert:
|
||||
that:
|
||||
- "'Login Succeeded' in _helm_registry_auth_correct.stdout_lines + _helm_registry_auth_correct.stderr_lines"
|
||||
@@ -43,9 +45,11 @@
|
||||
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
|
||||
# Helm < 4.2.1 prints success messages to stderr (https://github.com/helm/helm/issues/13464),
|
||||
# Helm >= 4.2.1 moves them to stdout (https://github.com/helm/helm/pull/32056).
|
||||
# Check both streams to stay version-agnostic.
|
||||
assert:
|
||||
that: "'Pushed: localhost:' + registry_port | string + '/test/k8s-monitoring' in _save_chart.stderr"
|
||||
that: "'Pushed: localhost:' + registry_port | string + '/test/k8s-monitoring' in _save_chart.stdout + _save_chart.stderr"
|
||||
|
||||
- name: Test logout
|
||||
helm_registry_auth:
|
||||
@@ -55,9 +59,11 @@
|
||||
register: _helm_registry_auth_logout
|
||||
|
||||
- name: Assert logout
|
||||
# Helm binary prints the message to stderr
|
||||
# Helm < 4.2.1 prints success messages to stderr (https://github.com/helm/helm/issues/13464),
|
||||
# Helm >= 4.2.1 moves them to stdout (https://github.com/helm/helm/pull/32056).
|
||||
# Check both streams to stay version-agnostic.
|
||||
assert:
|
||||
that: "'Removing login credentials' in _helm_registry_auth_logout.stderr"
|
||||
that: "'Removing login credentials' in _helm_registry_auth_logout.stdout + _helm_registry_auth_logout.stderr"
|
||||
|
||||
- name: Ensure that not able to push to the registry
|
||||
ansible.builtin.shell: >-
|
||||
|
||||
@@ -103,3 +103,81 @@
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: test_helm_repo
|
||||
state: absent
|
||||
|
||||
# https://github.com/ansible-collections/kubernetes.core/issues/1235
|
||||
- name: Ensure the trailing slash test repositories don't exist
|
||||
helm_repository:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: "{{ item }}"
|
||||
state: absent
|
||||
loop:
|
||||
- test_helm_repo_slash
|
||||
- test_helm_repo_noslash
|
||||
|
||||
- name: Register test_helm_repo_slash directly through helm, keeping the trailing slash
|
||||
ansible.builtin.command: "{{ helm_binary }} repo add test_helm_repo_slash {{ chart_test_repo }}/"
|
||||
changed_when: true
|
||||
|
||||
- name: Add test_helm_repo_noslash chart repository without a trailing slash
|
||||
helm_repository:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: test_helm_repo_noslash
|
||||
repo_url: "{{ chart_test_repo }}"
|
||||
|
||||
- name: Check idempotency when the stored and the requested URL both have a trailing slash
|
||||
helm_repository:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: test_helm_repo_slash
|
||||
repo_url: "{{ chart_test_repo }}/"
|
||||
register: repository
|
||||
|
||||
- name: Assert idempotency when the stored and the requested URL both have a trailing slash
|
||||
assert:
|
||||
that:
|
||||
- repository is not changed
|
||||
|
||||
- name: Check idempotency when only the stored URL has a trailing slash
|
||||
helm_repository:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: test_helm_repo_slash
|
||||
repo_url: "{{ chart_test_repo }}"
|
||||
register: repository
|
||||
|
||||
- name: Assert idempotency when only the stored URL has a trailing slash
|
||||
assert:
|
||||
that:
|
||||
- repository is not changed
|
||||
|
||||
- name: Check idempotency when only the requested URL has a trailing slash
|
||||
helm_repository:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: test_helm_repo_noslash
|
||||
repo_url: "{{ chart_test_repo }}/"
|
||||
register: repository
|
||||
|
||||
- name: Assert idempotency when only the requested URL has a trailing slash
|
||||
assert:
|
||||
that:
|
||||
- repository is not changed
|
||||
|
||||
- name: Failed to add repository with the same name and a different URL, trailing slash aside
|
||||
helm_repository:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: test_helm_repo_slash
|
||||
repo_url: "https://other-charts.url/"
|
||||
register: repository_errors
|
||||
ignore_errors: true
|
||||
|
||||
- name: Assert that adding repository with the same name and a different URL failed
|
||||
assert:
|
||||
that:
|
||||
- repository_errors is failed
|
||||
|
||||
- name: Clean the trailing slash test repositories
|
||||
helm_repository:
|
||||
binary_path: "{{ helm_binary }}"
|
||||
name: "{{ item }}"
|
||||
state: absent
|
||||
loop:
|
||||
- test_helm_repo_slash
|
||||
- test_helm_repo_noslash
|
||||
|
||||
@@ -143,9 +143,7 @@ def compare_directories(dir1, dir2):
|
||||
[len(test.left_only) > 0, len(test.right_only) > 0, len(test.funny_files) > 0]
|
||||
):
|
||||
return False
|
||||
(t, mismatch, errors) = filecmp.cmpfiles(
|
||||
dir1, dir2, test.common_files, shallow=False
|
||||
)
|
||||
t, mismatch, errors = filecmp.cmpfiles(dir1, dir2, test.common_files, shallow=False)
|
||||
if len(mismatch) > 0 or len(errors) > 0:
|
||||
return False
|
||||
for common_dir in test.common_dirs:
|
||||
|
||||
@@ -41,6 +41,7 @@
|
||||
- include_tasks: test_multi_container_pod.yml
|
||||
- include_tasks: test_copy_directory.yml
|
||||
- include_tasks: test_copy_large_file.yml
|
||||
- include_tasks: test_copy_repeated.yml
|
||||
- include_tasks: test_copy_item_with_space_in_its_name.yml
|
||||
- include_tasks: test_init_container_pod.yml
|
||||
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
# Regression coverage for
|
||||
# https://github.com/ansible-collections/kubernetes.core/issues/776
|
||||
#
|
||||
# The module used to close the exec connection as soon as the last chunk had
|
||||
# been written, which killed the remote tar mid-extract and truncated the file.
|
||||
# The failure was timing dependent, so a single copy rarely caught it: repeat
|
||||
# the copy and compare every time.
|
||||
- name: create temporary directory for local files
|
||||
ansible.builtin.tempfile:
|
||||
state: directory
|
||||
suffix: k8scp_repeated
|
||||
register: test_dir
|
||||
|
||||
- name: test repeated copies are never truncated
|
||||
block:
|
||||
- set_fact:
|
||||
test_directory: "{{ test_dir.path }}"
|
||||
copy_iterations: 10
|
||||
no_log: true
|
||||
|
||||
# Large enough to span several 1MiB write chunks, so the last chunk is not
|
||||
# also the first and the drain actually has something to wait for.
|
||||
- name: create a multi-chunk file
|
||||
ansible.builtin.command:
|
||||
cmd: dd if=/dev/urandom of={{ test_directory }}/repeated.bin bs=1M count=12
|
||||
|
||||
- name: copy the same file repeatedly and verify each time
|
||||
ansible.builtin.include_tasks: verify_one_copy.yml
|
||||
loop: "{{ range(0, copy_iterations) | list }}"
|
||||
loop_control:
|
||||
loop_var: iteration
|
||||
|
||||
always:
|
||||
- name: delete temporary directory created for the test
|
||||
ansible.builtin.file:
|
||||
path: "{{ test_dir.path }}"
|
||||
state: absent
|
||||
ignore_errors: true
|
||||
|
||||
- name: delete file created on Pod
|
||||
k8s_exec:
|
||||
namespace: '{{ copy_namespace }}'
|
||||
pod: '{{ pod_with_one_container.name }}'
|
||||
command: 'rm -f /repeated.bin'
|
||||
ignore_errors: true
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
# One iteration of the repeated-copy regression check, see test_copy_repeated.yml
|
||||
- name: remove any file left by the previous iteration
|
||||
k8s_exec:
|
||||
namespace: '{{ copy_namespace }}'
|
||||
pod: '{{ pod_with_one_container.name }}'
|
||||
command: 'rm -f /repeated.bin'
|
||||
ignore_errors: true
|
||||
|
||||
- name: "copy file into remote Pod (iteration {{ iteration }})"
|
||||
k8s_cp:
|
||||
namespace: '{{ copy_namespace }}'
|
||||
pod: '{{ pod_with_one_container.name }}'
|
||||
remote_path: /repeated.bin
|
||||
local_path: "{{ test_directory }}/repeated.bin"
|
||||
state: to_pod
|
||||
|
||||
- name: "compare local and remote file (iteration {{ iteration }})"
|
||||
kubectl_file_compare:
|
||||
namespace: '{{ copy_namespace }}'
|
||||
pod: '{{ pod_with_one_container.name }}'
|
||||
remote_path: /repeated.bin
|
||||
local_path: "{{ test_directory }}/repeated.bin"
|
||||
@@ -4,3 +4,4 @@
|
||||
- wait
|
||||
- api-server-caching
|
||||
- discovery
|
||||
- metadata-only-fetches
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
- name: Retrieve Node list with metadata_only
|
||||
kubernetes.core.k8s_info:
|
||||
kind: Node
|
||||
metadata_only: true
|
||||
register: node_metadata_only_list
|
||||
|
||||
- name: Assert response has kind PartialObjectMetadata
|
||||
assert:
|
||||
that:
|
||||
- node_metadata_only_list.resources[0].kind == "PartialObjectMetadata"
|
||||
|
||||
- name: Retrieve full Node list
|
||||
kubernetes.core.k8s_info:
|
||||
kind: Node
|
||||
metadata_only: false
|
||||
register: node_full_list
|
||||
|
||||
- name: Assert response has kind Node
|
||||
assert:
|
||||
that:
|
||||
- node_full_list.resources[0].kind == "Node"
|
||||
@@ -238,7 +238,55 @@
|
||||
- resource.result.results | selectattr('changed') | list | length == 1
|
||||
- resource.result.results | selectattr('error', 'defined') | list | length == 1
|
||||
|
||||
- name: Apply template where all items are disabled (empty output)
|
||||
kubernetes.core.k8s:
|
||||
state: present
|
||||
template:
|
||||
path: "conditional_empty.j2"
|
||||
vars:
|
||||
items:
|
||||
- name: test1
|
||||
enabled: false
|
||||
- name: test2
|
||||
enabled: false
|
||||
k8s_pod_namespace: "{{ template_namespace }}"
|
||||
register: r
|
||||
|
||||
- name: Check that empty template succeeds with no changes
|
||||
assert:
|
||||
that:
|
||||
- r is successful
|
||||
- r is not changed
|
||||
|
||||
- name: Apply template where some items are enabled
|
||||
kubernetes.core.k8s:
|
||||
state: present
|
||||
template:
|
||||
path: "conditional_empty.j2"
|
||||
vars:
|
||||
items:
|
||||
- name: conditional-configmap-1
|
||||
enabled: true
|
||||
- name: conditional-configmap-2
|
||||
enabled: false
|
||||
k8s_pod_namespace: "{{ template_namespace }}"
|
||||
register: r
|
||||
|
||||
- name: Check that partial template creates resources
|
||||
assert:
|
||||
that:
|
||||
- r is successful
|
||||
- r is changed
|
||||
|
||||
always:
|
||||
- name: Cleanup conditional configmap
|
||||
kubernetes.core.k8s:
|
||||
state: absent
|
||||
kind: ConfigMap
|
||||
name: conditional-configmap-1
|
||||
namespace: "{{ template_namespace }}"
|
||||
ignore_errors: true
|
||||
|
||||
- name: Remove namespace (Cleanup)
|
||||
kubernetes.core.k8s:
|
||||
kind: Namespace
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
{% for item in items %}
|
||||
{% if item.enabled %}
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: ConfigMap
|
||||
metadata:
|
||||
name: "{{ item.name }}"
|
||||
namespace: "{{ k8s_pod_namespace }}"
|
||||
data:
|
||||
key: value
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
@@ -0,0 +1 @@
|
||||
test_directory: /tmp
|
||||
@@ -0,0 +1,186 @@
|
||||
---
|
||||
- name: Set test variables
|
||||
set_fact:
|
||||
test_config_path: /tmp/test-kubeconfig
|
||||
test_cluster_name: test-cluster
|
||||
test_user_name: test-user
|
||||
test_context_name: test-context
|
||||
|
||||
# Test 1: Create new kubeconfig
|
||||
- name: Create new kubeconfig file
|
||||
kubernetes.core.kubeconfig:
|
||||
path: "{{ test_config_path }}"
|
||||
clusters:
|
||||
- name: "{{ test_cluster_name }}"
|
||||
cluster:
|
||||
server: https://test.example.com:6443
|
||||
insecure-skip-tls-verify: true
|
||||
users:
|
||||
- name: "{{ test_user_name }}"
|
||||
user:
|
||||
token: test-token-123
|
||||
contexts:
|
||||
- name: "{{ test_context_name }}"
|
||||
context:
|
||||
cluster: "{{ test_cluster_name }}"
|
||||
user: "{{ test_user_name }}"
|
||||
namespace: default
|
||||
current_context: "{{ test_context_name }}"
|
||||
register: create_result
|
||||
|
||||
- name: Verify file was created
|
||||
assert:
|
||||
that:
|
||||
- create_result is changed
|
||||
- create_result.kubeconfig.clusters | length == 1
|
||||
- create_result.kubeconfig['current-context'] == test_context_name
|
||||
|
||||
# Test 2: Idempotency check
|
||||
- name: Run same configuration again
|
||||
kubernetes.core.kubeconfig:
|
||||
path: "{{ test_config_path }}"
|
||||
clusters:
|
||||
- name: "{{ test_cluster_name }}"
|
||||
cluster:
|
||||
server: https://test.example.com:6443
|
||||
insecure-skip-tls-verify: true
|
||||
users:
|
||||
- name: "{{ test_user_name }}"
|
||||
user:
|
||||
token: test-token-123
|
||||
contexts:
|
||||
- name: "{{ test_context_name }}"
|
||||
context:
|
||||
cluster: "{{ test_cluster_name }}"
|
||||
user: "{{ test_user_name }}"
|
||||
namespace: default
|
||||
current_context: "{{ test_context_name }}"
|
||||
register: idempotent_result
|
||||
|
||||
- name: Verify idempotency
|
||||
assert:
|
||||
that:
|
||||
- idempotent_result is not changed
|
||||
|
||||
# Test 3: Merge new cluster
|
||||
- name: Add second cluster
|
||||
kubernetes.core.kubeconfig:
|
||||
path: "{{ test_config_path }}"
|
||||
clusters:
|
||||
- name: cluster-2
|
||||
cluster:
|
||||
server: https://cluster2.example.com:6443
|
||||
users:
|
||||
- name: user-2
|
||||
user:
|
||||
token: token-2
|
||||
contexts:
|
||||
- name: context-2
|
||||
context:
|
||||
cluster: cluster-2
|
||||
user: user-2
|
||||
register: merge_result
|
||||
|
||||
- name: Verify merge
|
||||
assert:
|
||||
that:
|
||||
- merge_result is changed
|
||||
- merge_result.kubeconfig.clusters | length == 2
|
||||
|
||||
# Test 4: Update existing entry
|
||||
- name: Update cluster server
|
||||
kubernetes.core.kubeconfig:
|
||||
path: "{{ test_config_path }}"
|
||||
clusters:
|
||||
- name: "{{ test_cluster_name }}"
|
||||
cluster:
|
||||
server: https://updated.example.com:6443
|
||||
insecure-skip-tls-verify: true
|
||||
register: update_result
|
||||
|
||||
- name: Verify update
|
||||
assert:
|
||||
that:
|
||||
- update_result is changed
|
||||
- update_result.kubeconfig.clusters | selectattr('name', 'equalto', test_cluster_name) | map(attribute='cluster') | map(attribute='server') | first == "https://updated.example.com:6443"
|
||||
|
||||
# Test 5: Check mode
|
||||
- name: Test check mode
|
||||
kubernetes.core.kubeconfig:
|
||||
path: "{{ test_config_path }}"
|
||||
clusters:
|
||||
- name: check-mode-cluster
|
||||
cluster:
|
||||
server: https://check.example.com:6443
|
||||
check_mode: true
|
||||
register: check_mode_result
|
||||
|
||||
- name: Verify check mode reports change but does not write
|
||||
assert:
|
||||
that:
|
||||
- check_mode_result is changed
|
||||
- check_mode_result.kubeconfig.clusters | length == 3
|
||||
|
||||
- name: Verify check mode cluster was not actually written to disk
|
||||
kubernetes.core.kubeconfig:
|
||||
path: "{{ test_config_path }}"
|
||||
register: after_check_mode
|
||||
|
||||
- name: Confirm check-mode-cluster is absent from disk
|
||||
assert:
|
||||
that:
|
||||
- after_check_mode.kubeconfig.clusters | selectattr('name', 'equalto', 'check-mode-cluster') | list | length == 0
|
||||
|
||||
# Test 6: Remove behavior
|
||||
- name: Remove cluster-2, user-2, and context-2
|
||||
kubernetes.core.kubeconfig:
|
||||
path: "{{ test_config_path }}"
|
||||
clusters:
|
||||
- name: cluster-2
|
||||
behavior: remove
|
||||
users:
|
||||
- name: user-2
|
||||
behavior: remove
|
||||
contexts:
|
||||
- name: context-2
|
||||
behavior: remove
|
||||
register: remove_result
|
||||
|
||||
- name: Verify entries were removed
|
||||
assert:
|
||||
that:
|
||||
- remove_result is changed
|
||||
- remove_result.kubeconfig.clusters | selectattr('name', 'equalto', 'cluster-2') | list | length == 0
|
||||
- remove_result.kubeconfig.users | selectattr('name', 'equalto', 'user-2') | list | length == 0
|
||||
- remove_result.kubeconfig.contexts | selectattr('name', 'equalto', 'context-2') | list | length == 0
|
||||
|
||||
# Test 7: Remove behavior is idempotent when entry does not exist
|
||||
- name: Remove already-absent entry
|
||||
kubernetes.core.kubeconfig:
|
||||
path: "{{ test_config_path }}"
|
||||
clusters:
|
||||
- name: cluster-2
|
||||
behavior: remove
|
||||
register: remove_idempotent_result
|
||||
|
||||
- name: Verify no change when removing nonexistent entry
|
||||
assert:
|
||||
that:
|
||||
- remove_idempotent_result is not changed
|
||||
|
||||
# Test 8: Keep behavior protects existing entry
|
||||
- name: Attempt to overwrite protected cluster
|
||||
kubernetes.core.kubeconfig:
|
||||
path: "{{ test_config_path }}"
|
||||
clusters:
|
||||
- name: "{{ test_cluster_name }}"
|
||||
behavior: keep
|
||||
cluster:
|
||||
server: https://should-not-apply.example.com:6443
|
||||
register: keep_result
|
||||
|
||||
- name: Verify keep behavior left existing entry unchanged
|
||||
assert:
|
||||
that:
|
||||
- keep_result is not changed
|
||||
- keep_result.kubeconfig.clusters | selectattr('name', 'equalto', test_cluster_name) | map(attribute='cluster') | map(attribute='server') | first == "https://updated.example.com:6443"
|
||||
@@ -21,6 +21,7 @@ tests/integration/targets/k8s_delete/files/deployments.yaml yamllint!skip
|
||||
tests/unit/module_utils/fixtures/pods.yml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-job/Chart.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm_diff/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
|
||||
@@ -21,6 +21,7 @@ tests/integration/targets/k8s_delete/files/deployments.yaml yamllint!skip
|
||||
tests/unit/module_utils/fixtures/pods.yml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-job/Chart.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm_diff/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
|
||||
@@ -1,9 +1,15 @@
|
||||
plugins/module_utils/client/discovery.py import-3.9!skip
|
||||
plugins/module_utils/client/discovery.py import-3.10!skip
|
||||
plugins/module_utils/client/discovery.py import-3.11!skip
|
||||
plugins/module_utils/client/discovery.py import-3.12!skip
|
||||
plugins/module_utils/client/discovery.py import-3.13!skip
|
||||
plugins/module_utils/client/resource.py import-3.9!skip
|
||||
plugins/module_utils/client/resource.py import-3.10!skip
|
||||
plugins/module_utils/client/resource.py import-3.11!skip
|
||||
plugins/module_utils/client/resource.py import-3.12!skip
|
||||
plugins/module_utils/client/resource.py import-3.13!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.9!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.10!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.11!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.12!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.13!skip
|
||||
@@ -18,6 +24,7 @@ tests/integration/targets/k8s_delete/files/deployments.yaml yamllint!skip
|
||||
tests/unit/module_utils/fixtures/pods.yml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-job/Chart.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm_diff/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
|
||||
@@ -1,9 +1,15 @@
|
||||
plugins/module_utils/client/discovery.py import-3.9!skip
|
||||
plugins/module_utils/client/discovery.py import-3.10!skip
|
||||
plugins/module_utils/client/discovery.py import-3.11!skip
|
||||
plugins/module_utils/client/discovery.py import-3.12!skip
|
||||
plugins/module_utils/client/discovery.py import-3.13!skip
|
||||
plugins/module_utils/client/resource.py import-3.9!skip
|
||||
plugins/module_utils/client/resource.py import-3.10!skip
|
||||
plugins/module_utils/client/resource.py import-3.11!skip
|
||||
plugins/module_utils/client/resource.py import-3.12!skip
|
||||
plugins/module_utils/client/resource.py import-3.13!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.9!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.10!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.11!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.12!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.13!skip
|
||||
@@ -18,6 +24,7 @@ tests/integration/targets/k8s_delete/files/deployments.yaml yamllint!skip
|
||||
tests/unit/module_utils/fixtures/pods.yml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-job/Chart.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm_diff/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
|
||||
@@ -1,11 +1,17 @@
|
||||
plugins/module_utils/client/discovery.py import-3.9!skip
|
||||
plugins/module_utils/client/discovery.py import-3.10!skip
|
||||
plugins/module_utils/client/discovery.py import-3.11!skip
|
||||
plugins/module_utils/client/discovery.py import-3.12!skip
|
||||
plugins/module_utils/client/discovery.py import-3.13!skip
|
||||
plugins/module_utils/client/discovery.py import-3.14!skip
|
||||
plugins/module_utils/client/resource.py import-3.9!skip
|
||||
plugins/module_utils/client/resource.py import-3.10!skip
|
||||
plugins/module_utils/client/resource.py import-3.11!skip
|
||||
plugins/module_utils/client/resource.py import-3.12!skip
|
||||
plugins/module_utils/client/resource.py import-3.13!skip
|
||||
plugins/module_utils/client/resource.py import-3.14!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.9!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.10!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.11!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.12!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.13!skip
|
||||
@@ -21,6 +27,7 @@ tests/integration/targets/k8s_delete/files/deployments.yaml yamllint!skip
|
||||
tests/unit/module_utils/fixtures/pods.yml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-job/Chart.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm_diff/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
|
||||
@@ -1,11 +1,17 @@
|
||||
plugins/module_utils/client/discovery.py import-3.9!skip
|
||||
plugins/module_utils/client/discovery.py import-3.10!skip
|
||||
plugins/module_utils/client/discovery.py import-3.11!skip
|
||||
plugins/module_utils/client/discovery.py import-3.12!skip
|
||||
plugins/module_utils/client/discovery.py import-3.13!skip
|
||||
plugins/module_utils/client/discovery.py import-3.14!skip
|
||||
plugins/module_utils/client/resource.py import-3.9!skip
|
||||
plugins/module_utils/client/resource.py import-3.10!skip
|
||||
plugins/module_utils/client/resource.py import-3.11!skip
|
||||
plugins/module_utils/client/resource.py import-3.12!skip
|
||||
plugins/module_utils/client/resource.py import-3.13!skip
|
||||
plugins/module_utils/client/resource.py import-3.14!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.9!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.10!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.11!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.12!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.13!skip
|
||||
@@ -21,6 +27,7 @@ tests/integration/targets/k8s_delete/files/deployments.yaml yamllint!skip
|
||||
tests/unit/module_utils/fixtures/pods.yml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-job/Chart.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm_diff/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
|
||||
@@ -1,15 +1,24 @@
|
||||
plugins/module_utils/client/discovery.py import-3.9!skip
|
||||
plugins/module_utils/client/discovery.py import-3.10!skip
|
||||
plugins/module_utils/client/discovery.py import-3.11!skip
|
||||
plugins/module_utils/client/discovery.py import-3.12!skip
|
||||
plugins/module_utils/client/discovery.py import-3.13!skip
|
||||
plugins/module_utils/client/discovery.py import-3.14!skip
|
||||
plugins/module_utils/client/discovery.py import-3.15!skip
|
||||
plugins/module_utils/client/resource.py import-3.9!skip
|
||||
plugins/module_utils/client/resource.py import-3.10!skip
|
||||
plugins/module_utils/client/resource.py import-3.11!skip
|
||||
plugins/module_utils/client/resource.py import-3.12!skip
|
||||
plugins/module_utils/client/resource.py import-3.13!skip
|
||||
plugins/module_utils/client/resource.py import-3.14!skip
|
||||
plugins/module_utils/client/resource.py import-3.15!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.9!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.10!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.11!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.12!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.13!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.14!skip
|
||||
plugins/module_utils/k8sdynamicclient.py import-3.15!skip
|
||||
plugins/module_utils/version.py pylint!skip
|
||||
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
|
||||
plugins/modules/k8s_scale.py validate-modules:parameter-type-not-in-doc
|
||||
@@ -21,6 +30,7 @@ tests/integration/targets/k8s_delete/files/deployments.yaml yamllint!skip
|
||||
tests/unit/module_utils/fixtures/pods.yml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/appversionless-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-job/Chart.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart-v2/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
tests/integration/targets/helm_diff/files/test-chart/templates/configmap.yaml yamllint!skip
|
||||
|
||||
@@ -4,11 +4,11 @@ __metaclass__ = type
|
||||
|
||||
import json
|
||||
import sys
|
||||
from collections.abc import MutableMapping
|
||||
from io import BytesIO
|
||||
|
||||
import ansible.module_utils.basic
|
||||
import pytest
|
||||
from ansible.module_utils.common._collections_compat import MutableMapping
|
||||
from ansible.module_utils.common.text.converters import to_bytes
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,111 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright: (c) 2026, 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
|
||||
|
||||
import pytest
|
||||
import yaml
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
||||
strip_registry_progress,
|
||||
)
|
||||
|
||||
# What helm's registry client prints, verbatim. Since helm 4.2.1 this goes to
|
||||
# stdout ahead of the command's real output (helm/helm#32056).
|
||||
PULLED = "Pulled: registry.example.com/charts/demochart:109.0.1_up1.0.2\n"
|
||||
DIGEST = (
|
||||
"Digest: sha256:41e9b37f85fa7f5df5fc7f2b7b068eb56ae1592784eee28f535563b599850249\n"
|
||||
)
|
||||
PUSHED = "Pushed: registry.example.com/charts/demochart:109.0.1_up1.0.2\n"
|
||||
UNDERSCORE_WARNING = (
|
||||
"registry.example.com/charts/demochart:109.0.1_up1.0.2 contains an underscore.\n"
|
||||
"\n"
|
||||
"OCI artifact references (e.g. tags) do not support the plus sign (+). To support\n"
|
||||
"storing semantic versions, Helm adopts the convention of changing plus (+) to\n"
|
||||
"an underscore (_) in chart version tags when pushing to a registry and back to\n"
|
||||
"a plus (+) when pulling from a registry.\n"
|
||||
)
|
||||
|
||||
# 'helm show chart' output. Note that helm marshals Chart.yaml with sorted keys, so
|
||||
# 'annotations' precedes 'apiVersion' and the metadata does not reliably start with
|
||||
# a fixed key.
|
||||
CHART_YAML = (
|
||||
"annotations:\n"
|
||||
" category: Demo\n"
|
||||
"apiVersion: v2\n"
|
||||
"appVersion: 1.16.0\n"
|
||||
"description: A Helm chart for Kubernetes\n"
|
||||
"name: demochart\n"
|
||||
"type: application\n"
|
||||
"version: 109.0.1+up1.0.2\n"
|
||||
)
|
||||
|
||||
# 'helm template' output.
|
||||
MANIFESTS = (
|
||||
"---\n"
|
||||
"# Source: demochart/templates/serviceaccount.yaml\n"
|
||||
"apiVersion: v1\n"
|
||||
"kind: ServiceAccount\n"
|
||||
"metadata:\n"
|
||||
" name: rel-demochart\n"
|
||||
)
|
||||
|
||||
# 'helm template --output-dir' output.
|
||||
WROTE = (
|
||||
"wrote outdir/demochart/templates/serviceaccount.yaml\n"
|
||||
"wrote outdir/demochart/templates/service.yaml\n"
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"payload",
|
||||
[CHART_YAML, MANIFESTS, WROTE, ""],
|
||||
ids=["show_chart", "template", "template_output_dir", "empty"],
|
||||
)
|
||||
@pytest.mark.parametrize(
|
||||
"progress",
|
||||
[
|
||||
"",
|
||||
PULLED + DIGEST,
|
||||
PULLED + DIGEST + UNDERSCORE_WARNING,
|
||||
PUSHED + DIGEST + UNDERSCORE_WARNING,
|
||||
],
|
||||
ids=["none", "pulled_digest", "with_warning", "pushed_with_warning"],
|
||||
)
|
||||
def test_progress_is_stripped_and_payload_is_untouched(progress, payload):
|
||||
assert strip_registry_progress(progress + payload) == payload
|
||||
|
||||
|
||||
def test_show_chart_output_is_parseable_once_stripped():
|
||||
# Unstripped, the free-text warning makes this invalid YAML.
|
||||
out = PULLED + DIGEST + UNDERSCORE_WARNING + CHART_YAML
|
||||
with pytest.raises(yaml.YAMLError):
|
||||
yaml.safe_load(out)
|
||||
|
||||
chart_info = yaml.safe_load(strip_registry_progress(out))
|
||||
assert chart_info["name"] == "demochart"
|
||||
assert chart_info["version"] == "109.0.1+up1.0.2"
|
||||
assert chart_info["annotations"] == {"category": "Demo"}
|
||||
|
||||
|
||||
def test_pulled_and_digest_alone_parse_as_yaml_but_pollute_the_result():
|
||||
# Without the warning the output is still valid YAML, so the pollution is silent.
|
||||
assert yaml.safe_load(PULLED + DIGEST + CHART_YAML)["Pulled"]
|
||||
assert "Pulled" not in yaml.safe_load(
|
||||
strip_registry_progress(PULLED + DIGEST + CHART_YAML)
|
||||
)
|
||||
|
||||
|
||||
def test_reworded_warning_is_left_alone():
|
||||
# A message helm no longer emits verbatim must not be partially consumed: better
|
||||
# to fail loudly than to silently drop a line of real output.
|
||||
reworded = UNDERSCORE_WARNING.replace("plus sign (+)", "plus character (+)")
|
||||
out = PULLED + DIGEST + reworded + CHART_YAML
|
||||
assert strip_registry_progress(out) == reworded + CHART_YAML
|
||||
|
||||
|
||||
def test_progress_like_lines_inside_the_payload_are_kept():
|
||||
payload = "description: |\n Digest: not a helm message\n" + CHART_YAML
|
||||
assert strip_registry_progress(PULLED + payload) == payload
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user