mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-05-12 04:22:02 +00:00
Compare commits
45 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
90bc4c4b3b | ||
|
|
1590c6a4cc | ||
|
|
76eccacab6 | ||
|
|
620abbac26 | ||
|
|
66a820e03a | ||
|
|
a3f2438e9d | ||
|
|
0709ea31c9 | ||
|
|
44ab1fc478 | ||
|
|
80c33c5573 | ||
|
|
73dc94be68 | ||
|
|
1bc65230bb | ||
|
|
91427a5b6a | ||
|
|
1d1a23b1ab | ||
|
|
6edc84678d | ||
|
|
66bd8620e4 | ||
|
|
94b43dc582 | ||
|
|
3c4f9cee60 | ||
|
|
a54b4a13b6 | ||
|
|
e16b3c46b0 | ||
|
|
bc60523372 | ||
|
|
64f3f07c5a | ||
|
|
d6492b66d9 | ||
|
|
4d5388ddf8 | ||
|
|
6dadd06252 | ||
|
|
69dc7d5c5d | ||
|
|
2fa1c2c6e5 | ||
|
|
f2623dd3cf | ||
|
|
8772d8c997 | ||
|
|
a32108f64f | ||
|
|
365e5e9159 | ||
|
|
448a68da3d | ||
|
|
46acab9c4c | ||
|
|
fdb77182c8 | ||
|
|
fa3d94f793 | ||
|
|
9ec27cf37c | ||
|
|
10cb241256 | ||
|
|
92e1f581fe | ||
|
|
7f69aff0d6 | ||
|
|
8c65ac066d | ||
|
|
1d962fb932 | ||
|
|
27ce23aa72 | ||
|
|
993652b581 | ||
|
|
9bd9d22db3 | ||
|
|
0593426918 | ||
|
|
8fa5b201a4 |
18
.github/workflows/label-new-issues.yaml
vendored
18
.github/workflows/label-new-issues.yaml
vendored
@@ -1,18 +0,0 @@
|
|||||||
---
|
|
||||||
name: label new issues
|
|
||||||
on:
|
|
||||||
issues:
|
|
||||||
types:
|
|
||||||
- opened
|
|
||||||
- reopened
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
add_label:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
issues: write
|
|
||||||
steps:
|
|
||||||
- uses: actions-ecosystem/action-add-labels@v1
|
|
||||||
with:
|
|
||||||
labels: needs_triage
|
|
||||||
70
.github/workflows/sonarcloud.yml
vendored
70
.github/workflows/sonarcloud.yml
vendored
@@ -1,70 +0,0 @@
|
|||||||
---
|
|
||||||
# SonarCloud analysis for kubernetes.core
|
|
||||||
#
|
|
||||||
# Uses the same-repo + default-branch push model: GitHub does not expose org secrets to workflows
|
|
||||||
# from fork PRs (see https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions).
|
|
||||||
# This job is gated so the Sonar token is never available in untrusted fork contexts. A follow-up
|
|
||||||
# workflow triggered by workflow_run + artifacts is an alternative if the org later requires Sonar
|
|
||||||
# with coverage on fork PRs (see https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run).
|
|
||||||
name: SonarCloud
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
- stable-*
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
- stable-*
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pull-requests: read
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
sonarqube:
|
|
||||||
name: SonarCloud Scan
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
|
|
||||||
env:
|
|
||||||
# Pin ansible-test behavior; bump when raising supported ansible-core (see meta/runtime.yml).
|
|
||||||
ANSIBLE_CORE_VERSION: "2.19.5"
|
|
||||||
steps:
|
|
||||||
- name: Checkout
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Set up Python
|
|
||||||
uses: actions/setup-python@v5
|
|
||||||
with:
|
|
||||||
python-version: "3.12"
|
|
||||||
|
|
||||||
- name: Install Ansible (ansible-test)
|
|
||||||
run: |
|
|
||||||
pip install --upgrade pip
|
|
||||||
pip install "ansible-core==${ANSIBLE_CORE_VERSION}"
|
|
||||||
|
|
||||||
- name: Unit tests with coverage
|
|
||||||
run: ansible-test units --venv --coverage --python 3.12 --requirements
|
|
||||||
|
|
||||||
- name: Coverage combine and XML for Sonar
|
|
||||||
run: |
|
|
||||||
ansible-test coverage combine --venv --python 3.12 --requirements
|
|
||||||
ansible-test coverage xml --venv --python 3.12 --requirements
|
|
||||||
|
|
||||||
- name: Copy coverage report to repo root
|
|
||||||
run: |
|
|
||||||
set -euo pipefail
|
|
||||||
ls -la tests/output/reports/
|
|
||||||
xml=$(find tests/output/reports -maxdepth 1 -name '*.xml' ! -name '*powershell*' | head -1)
|
|
||||||
test -n "$xml"
|
|
||||||
cp "$xml" coverage.xml
|
|
||||||
|
|
||||||
- name: SonarCloud Scan
|
|
||||||
# Same pinned version as ansible-collections/amazon.aws sonarcloud.yml
|
|
||||||
uses: SonarSource/sonarqube-scan-action@a31c9398be7ace6bbfaf30c0bd5d415f843d45e9
|
|
||||||
env:
|
|
||||||
SONAR_TOKEN: ${{ secrets.ANSIBLE_COLLECTIONS_ORG_SONAR_TOKEN_CICD_BOT }}
|
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -25,6 +25,3 @@ tests/integration/*-*.yml
|
|||||||
|
|
||||||
# VS Code settings
|
# VS Code settings
|
||||||
.vscode/
|
.vscode/
|
||||||
|
|
||||||
# Root coverage report for SonarCloud (generated locally or in CI)
|
|
||||||
/coverage.xml
|
|
||||||
|
|||||||
@@ -112,52 +112,12 @@ Bugfixes
|
|||||||
v6.0.0
|
v6.0.0
|
||||||
======
|
======
|
||||||
|
|
||||||
Release Summary
|
|
||||||
---------------
|
|
||||||
|
|
||||||
This major release removes the deprecated ``k8s`` inventory plugin and also removes ``ansible-core<2.16`` support.
|
|
||||||
|
|
||||||
Breaking Changes / Porting Guide
|
Breaking Changes / Porting Guide
|
||||||
--------------------------------
|
--------------------------------
|
||||||
|
|
||||||
- Remove deprecated ``k8s`` invetory plugin (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
- Remove deprecated ``k8s`` invetory plugin (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
||||||
- Remove support for ``ansible-core<2.16`` (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
- Remove support for ``ansible-core<2.16`` (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
||||||
|
|
||||||
v5.4.2
|
|
||||||
======
|
|
||||||
|
|
||||||
Release Summary
|
|
||||||
---------------
|
|
||||||
|
|
||||||
This release includes bugfixes such as replacing the passing of ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` as well as a security update for selectively redacting sensitive information from kubeconfig.
|
|
||||||
|
|
||||||
Minor Changes
|
|
||||||
-------------
|
|
||||||
|
|
||||||
- helm - add ``release_values`` key to ``status`` return value that can be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- helm_info - add ``release_values`` key to ``status`` return value that can be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
|
|
||||||
Deprecated Features
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
- helm - the ``status.values`` return value has been deprecated and will be removed in a release after 2027-01-08. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- helm_info - the ``status.values`` return value has been deprecated and will be removed in a release after 2027-01-08. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
|
|
||||||
Security Fixes
|
|
||||||
--------------
|
|
||||||
|
|
||||||
- Selectively redact sensitive info from kubeconfig instead of applying blanket ``no_log=True`` (https://github.com/ansible-collections/kubernetes.core/pull/1014).
|
|
||||||
|
|
||||||
Bugfixes
|
|
||||||
--------
|
|
||||||
|
|
||||||
- Add idempotency for ``helm_pull`` module (https://github.com/ansible-collections/kubernetes.core/pull/1055).
|
|
||||||
- Fixed a bug where setting ``K8S_AUTH_VERIFY_SSL=true`` (or any string value) caused the value to be treated as a separate ``kubectl`` command argument (https://github.com/ansible-collections/kubernetes.core/pull/1049).
|
|
||||||
- Limit supported versions of Helm to <4.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/1039).
|
|
||||||
- Replace passing ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` in the ``k8s_drain``, ``k8s_rollback.py`` and ``k8s_scale.py`` modules as it deprecated in ``ansible-core>=2.19.0`` and will be removed in ``ansible-core>=2.23.0`` (https://github.com/ansible-collections/kubernetes.core/pull/1033).
|
|
||||||
- k8s - Fix return block from the module documentation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- meta - Add ``k8s_cluster_info``, ``k8s_json_patch`` and ``k8s_rollback`` to k8s action group (https://github.com/ansible-collections/kubernetes.core/pull/992).
|
|
||||||
|
|
||||||
v5.4.1
|
v5.4.1
|
||||||
======
|
======
|
||||||
|
|
||||||
|
|||||||
32
CI.md
32
CI.md
@@ -1,32 +0,0 @@
|
|||||||
# 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 | milestone |
|
|
||||||
|
|
||||||
**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 |
|
|
||||||
| -------------------- | ------------ | ---------- |
|
|
||||||
| devel | 3.12, 3.13, 3.14 | 3.12, 3.13 |
|
|
||||||
| 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 |
|
|
||||||
| 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 |
|
|
||||||
2
Makefile
2
Makefile
@@ -1,5 +1,5 @@
|
|||||||
# Also needs to be updated in galaxy.yml
|
# Also needs to be updated in galaxy.yml
|
||||||
VERSION = 7.0.0-dev0
|
VERSION = 6.4.0
|
||||||
|
|
||||||
TEST_ARGS ?= ""
|
TEST_ARGS ?= ""
|
||||||
PYTHON_VERSION ?= `python -c 'import platform; print(".".join(platform.python_version_tuple()[0:2]))'`
|
PYTHON_VERSION ?= `python -c 'import platform; print(".".join(platform.python_version_tuple()[0:2]))'`
|
||||||
|
|||||||
18
README.md
18
README.md
@@ -6,24 +6,6 @@ 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.
|
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.
|
||||||
|
|
||||||
## SonarCloud (code quality)
|
|
||||||
|
|
||||||
Static analysis runs on [SonarCloud](https://sonarcloud.io) using `sonar-project.properties` and
|
|
||||||
`.github/workflows/sonarcloud.yml`. Coverage shown in Sonar comes from unit-test coverage exported as
|
|
||||||
`coverage.xml` at the repository root during CI.
|
|
||||||
|
|
||||||
The SonarCloud project key must match `sonar.projectKey` (`ansible-collections_kubernetes.core`). Adding
|
|
||||||
or renaming the project is coordinated via Ansible Collections maintainers.
|
|
||||||
|
|
||||||
GitHub does not expose organization secrets to workflows for pull requests opened from forks. The
|
|
||||||
Sonar job therefore only runs on pushes to this repository's branches and on pull requests where the
|
|
||||||
head branch is on `ansible-collections/kubernetes.core` (not from forks). That matches GitHub's
|
|
||||||
documented behavior for [secrets in Actions](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions).
|
|
||||||
|
|
||||||
If the project later needs Sonar with coverage on **fork** PRs, maintainers typically add a separate
|
|
||||||
trusted job after a workflow that uploads coverage artifacts, using GitHub's `workflow_run` event.
|
|
||||||
See [workflow_run (GitHub Docs)](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_run).
|
|
||||||
|
|
||||||
## Communication
|
## Communication
|
||||||
|
|
||||||
* Join the Ansible forum:
|
* Join the Ansible forum:
|
||||||
|
|||||||
@@ -1073,49 +1073,6 @@ releases:
|
|||||||
- 20250922-remove-ansible-six-imports.yaml
|
- 20250922-remove-ansible-six-imports.yaml
|
||||||
- 5.4.1.yml
|
- 5.4.1.yml
|
||||||
release_date: '2025-10-07'
|
release_date: '2025-10-07'
|
||||||
5.4.2:
|
|
||||||
changes:
|
|
||||||
bugfixes:
|
|
||||||
- Add idempotency for ``helm_pull`` module (https://github.com/ansible-collections/kubernetes.core/pull/1055).
|
|
||||||
- Fixed a bug where setting ``K8S_AUTH_VERIFY_SSL=true`` (or any string value)
|
|
||||||
caused the value to be treated as a separate ``kubectl`` command argument
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/1049).
|
|
||||||
- Limit supported versions of Helm to <4.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/1039).
|
|
||||||
- Replace passing ``warnings`` to ``exit_json`` with ``AnsibleModule.warn``
|
|
||||||
in the ``k8s_drain``, ``k8s_rollback.py`` and ``k8s_scale.py`` modules as
|
|
||||||
it deprecated in ``ansible-core>=2.19.0`` and will be removed in ``ansible-core>=2.23.0``
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/1033).
|
|
||||||
- k8s - Fix return block from the module documentation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- meta - Add ``k8s_cluster_info``, ``k8s_json_patch`` and ``k8s_rollback`` to
|
|
||||||
k8s action group (https://github.com/ansible-collections/kubernetes.core/pull/992).
|
|
||||||
deprecated_features:
|
|
||||||
- helm - the ``status.values`` return value has been deprecated and will be
|
|
||||||
removed in a release after 2027-01-08. Use ``status.release_values`` instead
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- helm_info - the ``status.values`` return value has been deprecated and will
|
|
||||||
be removed in a release after 2027-01-08. Use ``status.release_values`` instead
|
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
minor_changes:
|
|
||||||
- helm - added ``release_values`` key to ``status`` return value that can be
|
|
||||||
accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
- helm_info - added ``release_values`` key to ``status`` return value that can
|
|
||||||
be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
|
||||||
release_summary: This release includes various bugfixes such as replacing the
|
|
||||||
passing of ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` as well
|
|
||||||
as security updates for selectively redacting sensitive information from kubeconfig.
|
|
||||||
security_fixes:
|
|
||||||
- Selectively redact sensitive info from kubeconfig instead of applying blanket
|
|
||||||
``no_log=True`` (https://github.com/ansible-collections/kubernetes.core/pull/1014).
|
|
||||||
fragments:
|
|
||||||
- 1033-warnings-deprecations.yaml
|
|
||||||
- 20251002-fix-k8s-actiongroup.yaml
|
|
||||||
- 20251007-selective-kubeconfig-redaction.yaml
|
|
||||||
- 20251115-limit-versions-of-helm.yaml
|
|
||||||
- 20251220-fix-K8S_AUTH_VERIFY_SSL-in-kubectl-connecton-plugion.yaml
|
|
||||||
- 20260107-add-idempodency-for-helm-pull.yaml
|
|
||||||
- 20260108-fix-sanity-failures.yml
|
|
||||||
- 5-4-2.yaml
|
|
||||||
release_date: '2026-02-03'
|
|
||||||
6.0.0:
|
6.0.0:
|
||||||
changes:
|
changes:
|
||||||
breaking_changes:
|
breaking_changes:
|
||||||
|
|||||||
@@ -701,21 +701,6 @@ Examples
|
|||||||
wait_sleep: 10
|
wait_sleep: 10
|
||||||
wait_timeout: 360
|
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
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ tags:
|
|||||||
- openshift
|
- openshift
|
||||||
- okd
|
- okd
|
||||||
- cluster
|
- cluster
|
||||||
version: 7.0.0-dev0
|
version: 6.4.0
|
||||||
build_ignore:
|
build_ignore:
|
||||||
- .DS_Store
|
- .DS_Store
|
||||||
- "*.tar.gz"
|
- "*.tar.gz"
|
||||||
|
|||||||
@@ -1,91 +0,0 @@
|
|||||||
# 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 == "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:
|
|
||||||
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
|
|
||||||
@@ -120,21 +120,6 @@ EXAMPLES = r"""
|
|||||||
namespace: default
|
namespace: default
|
||||||
wait_sleep: 10
|
wait_sleep: 10
|
||||||
wait_timeout: 360
|
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
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
RETURN = r"""
|
RETURN = r"""
|
||||||
|
|||||||
@@ -1,441 +0,0 @@
|
|||||||
#!/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.
|
|
||||||
- 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) and V(keep).
|
|
||||||
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.
|
|
||||||
type: str
|
|
||||||
choices: ['merge', 'replace', 'keep']
|
|
||||||
default: merge
|
|
||||||
cluster:
|
|
||||||
description:
|
|
||||||
- Cluster configuration details.
|
|
||||||
type: dict
|
|
||||||
required: true
|
|
||||||
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) and V(keep).
|
|
||||||
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.
|
|
||||||
type: str
|
|
||||||
choices: ['merge', 'replace', 'keep']
|
|
||||||
default: merge
|
|
||||||
user:
|
|
||||||
description:
|
|
||||||
- User authentication configuration.
|
|
||||||
type: dict
|
|
||||||
required: true
|
|
||||||
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) and V(keep).
|
|
||||||
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.
|
|
||||||
type: str
|
|
||||||
choices: ['merge', 'replace', 'keep']
|
|
||||||
default: merge
|
|
||||||
context:
|
|
||||||
description:
|
|
||||||
- Context configuration linking cluster and user.
|
|
||||||
type: dict
|
|
||||||
required: true
|
|
||||||
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: Copy and modify kubeconfig
|
|
||||||
kubernetes.core.kubeconfig:
|
|
||||||
path: /home/user/.kube/config
|
|
||||||
dest: /home/user/.kube/config-backup
|
|
||||||
clusters:
|
|
||||||
- name: new-cluster
|
|
||||||
cluster:
|
|
||||||
server: https://new.example.com:6443
|
|
||||||
|
|
||||||
- name: Switch current context
|
|
||||||
kubernetes.core.kubeconfig:
|
|
||||||
path: ~/.kube/config
|
|
||||||
current_context: prod-context
|
|
||||||
|
|
||||||
- name: Update user credentials
|
|
||||||
kubernetes.core.kubeconfig:
|
|
||||||
path: ~/.kube/config
|
|
||||||
users:
|
|
||||||
- name: admin-user
|
|
||||||
user:
|
|
||||||
token: "{{ new_admin_token }}"
|
|
||||||
"""
|
|
||||||
|
|
||||||
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()
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
# 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=main
|
|
||||||
|
|
||||||
sonar.exclusions=tests/**,.tox/**
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
test_directory: /tmp
|
|
||||||
@@ -1,122 +0,0 @@
|
|||||||
---
|
|
||||||
- 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[0].cluster.server == "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 didn't write
|
|
||||||
assert:
|
|
||||||
that:
|
|
||||||
- check_mode_result is changed
|
|
||||||
- check_mode_result.kubeconfig.clusters | length == 3 # Includes new cluster in output
|
|
||||||
@@ -1,231 +0,0 @@
|
|||||||
# 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 yaml
|
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.kubeconfig import (
|
|
||||||
deep_merge,
|
|
||||||
hash_data,
|
|
||||||
load_yaml_file,
|
|
||||||
merge_by_name,
|
|
||||||
write_file,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# load_yaml_file
|
|
||||||
def test_load_yaml_file_returns_empty_dict_for_missing_file():
|
|
||||||
assert load_yaml_file("/nonexistent/path/config") == {}
|
|
||||||
|
|
||||||
|
|
||||||
def test_load_yaml_file_returns_empty_dict_for_none():
|
|
||||||
assert load_yaml_file(None) == {}
|
|
||||||
|
|
||||||
|
|
||||||
def test_load_yaml_file_returns_empty_dict_for_empty_string():
|
|
||||||
assert load_yaml_file("") == {}
|
|
||||||
|
|
||||||
|
|
||||||
def test_load_yaml_file_loads_valid_yaml(tmp_path):
|
|
||||||
config = {"apiVersion": "v1", "kind": "Config", "clusters": []}
|
|
||||||
f = tmp_path / "config"
|
|
||||||
f.write_text(yaml.safe_dump(config))
|
|
||||||
assert load_yaml_file(str(f)) == config
|
|
||||||
|
|
||||||
|
|
||||||
def test_load_yaml_file_returns_empty_dict_for_empty_file(tmp_path):
|
|
||||||
f = tmp_path / "config"
|
|
||||||
f.write_text("")
|
|
||||||
assert load_yaml_file(str(f)) == {}
|
|
||||||
|
|
||||||
|
|
||||||
# deep_merge
|
|
||||||
def test_deep_merge_adds_new_keys():
|
|
||||||
base = {"a": 1}
|
|
||||||
updates = {"b": 2}
|
|
||||||
assert deep_merge(base, updates) == {"a": 1, "b": 2}
|
|
||||||
|
|
||||||
|
|
||||||
def test_deep_merge_overwrites_scalar():
|
|
||||||
base = {"a": 1}
|
|
||||||
updates = {"a": 99}
|
|
||||||
assert deep_merge(base, updates) == {"a": 99}
|
|
||||||
|
|
||||||
|
|
||||||
def test_deep_merge_recursively_merges_dicts():
|
|
||||||
base = {
|
|
||||||
"cluster": {
|
|
||||||
"server": "https://old.example.com",
|
|
||||||
"insecure-skip-tls-verify": True,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
updates = {"cluster": {"server": "https://new.example.com"}}
|
|
||||||
result = deep_merge(base, updates)
|
|
||||||
assert result["cluster"]["server"] == "https://new.example.com"
|
|
||||||
assert result["cluster"]["insecure-skip-tls-verify"] is True
|
|
||||||
|
|
||||||
|
|
||||||
def test_deep_merge_does_not_mutate_base():
|
|
||||||
base = {"a": {"b": 1}}
|
|
||||||
updates = {"a": {"c": 2}}
|
|
||||||
deep_merge(base, updates)
|
|
||||||
assert base == {"a": {"b": 1}}
|
|
||||||
|
|
||||||
|
|
||||||
def test_deep_merge_overwrites_dict_with_scalar():
|
|
||||||
base = {"a": {"nested": 1}}
|
|
||||||
updates = {"a": "flat"}
|
|
||||||
assert deep_merge(base, updates) == {"a": "flat"}
|
|
||||||
|
|
||||||
|
|
||||||
# merge_by_name
|
|
||||||
def test_merge_by_name_adds_new_entry():
|
|
||||||
existing = []
|
|
||||||
new = [{"name": "cluster-a", "cluster": {"server": "https://a.example.com"}}]
|
|
||||||
result = merge_by_name(existing, new)
|
|
||||||
assert len(result) == 1
|
|
||||||
assert result[0]["name"] == "cluster-a"
|
|
||||||
|
|
||||||
|
|
||||||
def test_merge_by_name_preserves_existing_when_no_new():
|
|
||||||
existing = [{"name": "cluster-a", "cluster": {"server": "https://a.example.com"}}]
|
|
||||||
result = merge_by_name(existing, [])
|
|
||||||
assert len(result) == 1
|
|
||||||
assert result[0]["name"] == "cluster-a"
|
|
||||||
|
|
||||||
|
|
||||||
def test_merge_by_name_default_behavior_merges_fields():
|
|
||||||
existing = [
|
|
||||||
{
|
|
||||||
"name": "cluster-a",
|
|
||||||
"cluster": {"server": "https://old.com", "insecure-skip-tls-verify": True},
|
|
||||||
}
|
|
||||||
]
|
|
||||||
new = [{"name": "cluster-a", "cluster": {"server": "https://new.com"}}]
|
|
||||||
result = merge_by_name(existing, new)
|
|
||||||
assert len(result) == 1
|
|
||||||
assert result[0]["cluster"]["server"] == "https://new.com"
|
|
||||||
assert result[0]["cluster"]["insecure-skip-tls-verify"] is True
|
|
||||||
|
|
||||||
|
|
||||||
def test_merge_by_name_replace_behavior_replaces_entire_entry():
|
|
||||||
existing = [
|
|
||||||
{
|
|
||||||
"name": "cluster-a",
|
|
||||||
"cluster": {"server": "https://old.com", "insecure-skip-tls-verify": True},
|
|
||||||
}
|
|
||||||
]
|
|
||||||
new = [
|
|
||||||
{
|
|
||||||
"name": "cluster-a",
|
|
||||||
"behavior": "replace",
|
|
||||||
"cluster": {"server": "https://new.com"},
|
|
||||||
}
|
|
||||||
]
|
|
||||||
result = merge_by_name(existing, new)
|
|
||||||
assert result[0]["cluster"] == {"server": "https://new.com"}
|
|
||||||
assert "insecure-skip-tls-verify" not in result[0]["cluster"]
|
|
||||||
|
|
||||||
|
|
||||||
def test_merge_by_name_keep_behavior_preserves_existing():
|
|
||||||
existing = [{"name": "cluster-a", "cluster": {"server": "https://old.com"}}]
|
|
||||||
new = [
|
|
||||||
{
|
|
||||||
"name": "cluster-a",
|
|
||||||
"behavior": "keep",
|
|
||||||
"cluster": {"server": "https://new.com"},
|
|
||||||
}
|
|
||||||
]
|
|
||||||
result = merge_by_name(existing, new)
|
|
||||||
assert result[0]["cluster"]["server"] == "https://old.com"
|
|
||||||
|
|
||||||
|
|
||||||
def test_merge_by_name_behavior_key_not_in_output():
|
|
||||||
existing = []
|
|
||||||
new = [
|
|
||||||
{
|
|
||||||
"name": "cluster-a",
|
|
||||||
"behavior": "replace",
|
|
||||||
"cluster": {"server": "https://a.com"},
|
|
||||||
}
|
|
||||||
]
|
|
||||||
result = merge_by_name(existing, new)
|
|
||||||
assert "behavior" not in result[0]
|
|
||||||
|
|
||||||
|
|
||||||
def test_merge_by_name_skips_items_without_name():
|
|
||||||
existing = []
|
|
||||||
new = [{"cluster": {"server": "https://a.com"}}]
|
|
||||||
result = merge_by_name(existing, new)
|
|
||||||
assert result == []
|
|
||||||
|
|
||||||
|
|
||||||
def test_merge_by_name_skips_non_dict_items():
|
|
||||||
existing = []
|
|
||||||
new = ["not-a-dict", 42]
|
|
||||||
result = merge_by_name(existing, new)
|
|
||||||
assert result == []
|
|
||||||
|
|
||||||
|
|
||||||
def test_merge_by_name_adds_multiple_new_entries():
|
|
||||||
existing = []
|
|
||||||
new = [
|
|
||||||
{"name": "cluster-a", "cluster": {"server": "https://a.com"}},
|
|
||||||
{"name": "cluster-b", "cluster": {"server": "https://b.com"}},
|
|
||||||
]
|
|
||||||
result = merge_by_name(existing, new)
|
|
||||||
names = [r["name"] for r in result]
|
|
||||||
assert "cluster-a" in names
|
|
||||||
assert "cluster-b" in names
|
|
||||||
|
|
||||||
|
|
||||||
def test_merge_by_name_existing_non_dict_items_are_skipped():
|
|
||||||
existing = ["not-a-dict", {"cluster": {"server": "https://a.com"}}]
|
|
||||||
new = [{"name": "cluster-b", "cluster": {"server": "https://b.com"}}]
|
|
||||||
result = merge_by_name(existing, new)
|
|
||||||
assert len(result) == 1
|
|
||||||
assert result[0]["name"] == "cluster-b"
|
|
||||||
|
|
||||||
|
|
||||||
# hash_data
|
|
||||||
def test_hash_data_returns_string():
|
|
||||||
assert isinstance(hash_data({}), str)
|
|
||||||
|
|
||||||
|
|
||||||
def test_hash_data_different_input_different_hash():
|
|
||||||
assert hash_data({"a": 1}) != hash_data({"a": 2})
|
|
||||||
|
|
||||||
|
|
||||||
def test_hash_data_order_independent():
|
|
||||||
a = {"x": 1, "y": 2}
|
|
||||||
b = {"y": 2, "x": 1}
|
|
||||||
assert hash_data(a) == hash_data(b)
|
|
||||||
|
|
||||||
|
|
||||||
# write_file
|
|
||||||
def test_write_file_returns_false_for_empty_dest():
|
|
||||||
assert write_file("", {"apiVersion": "v1"}) is False
|
|
||||||
|
|
||||||
|
|
||||||
def test_write_file_returns_false_for_none_dest():
|
|
||||||
assert write_file(None, {"apiVersion": "v1"}) is False
|
|
||||||
|
|
||||||
|
|
||||||
def test_write_file_writes_valid_yaml(tmp_path):
|
|
||||||
dest = str(tmp_path / "config")
|
|
||||||
data = {"apiVersion": "v1", "kind": "Config"}
|
|
||||||
result = write_file(dest, data)
|
|
||||||
assert result is True
|
|
||||||
with open(dest, "r") as f:
|
|
||||||
written = yaml.safe_load(f)
|
|
||||||
assert written == data
|
|
||||||
|
|
||||||
|
|
||||||
def test_write_file_overwrites_existing_file(tmp_path):
|
|
||||||
dest = str(tmp_path / "config")
|
|
||||||
write_file(dest, {"apiVersion": "v1"})
|
|
||||||
write_file(dest, {"apiVersion": "v2"})
|
|
||||||
with open(dest, "r") as f:
|
|
||||||
written = yaml.safe_load(f)
|
|
||||||
assert written["apiVersion"] == "v2"
|
|
||||||
Reference in New Issue
Block a user