mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-11-21 22:50:20 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
11b861f77e | ||
|
|
536eded7d0 | ||
|
|
408802cb67 | ||
|
|
782672d2fd | ||
|
|
ebb0d7f087 | ||
|
|
b7e1ed5661 | ||
|
|
f650940f0a | ||
|
|
4314ad6091 | ||
|
|
177297fdae | ||
|
|
10584acdbb | ||
|
|
094240ab77 | ||
|
|
f42c78ce83 | ||
|
|
c46180bb6f | ||
|
|
8a9dd54fe7 | ||
|
|
031bc475fa | ||
|
|
c098ecc8c8 | ||
|
|
732925b986 | ||
|
|
cb00cf3c9e | ||
|
|
7df5e01974 | ||
|
|
a7922e498c | ||
|
|
d9e0218dba | ||
|
|
0bc99117af | ||
|
|
c643719085 | ||
|
|
e475d06403 | ||
|
|
f31ecce59c | ||
|
|
3e58e3a9ad | ||
|
|
d4ef10fc80 | ||
|
|
ec8942dd90 | ||
|
|
08a761fc17 | ||
|
|
dd4ca7a8b0 | ||
|
|
b1d809d9f3 | ||
|
|
18f8894a22 | ||
|
|
3876bc1a21 | ||
|
|
470c042690 | ||
|
|
75a5560aec | ||
|
|
a80e2d067c | ||
|
|
6bb9cce51b | ||
|
|
4b3e24bf02 | ||
|
|
bc17b33d44 | ||
|
|
3634105366 | ||
|
|
ceeafa8c6d | ||
|
|
a4fc40732a | ||
|
|
0836e96c2d | ||
|
|
d211f316ad | ||
|
|
bb80dde66d | ||
|
|
8bf31513f5 | ||
|
|
ae90b60fd6 | ||
|
|
1c20b53bdc | ||
|
|
f69761f37c | ||
|
|
cb7a932951 | ||
|
|
248e0d7db9 | ||
|
|
53c6c0ee80 | ||
|
|
b58b2ca70e | ||
|
|
8a58d3b6de | ||
|
|
e79ed52a4d | ||
|
|
4d7dc2a7d1 | ||
|
|
c2cfa51655 | ||
|
|
fb10b41918 | ||
|
|
210467b26d | ||
|
|
11f619b69e | ||
|
|
16e92a20e8 | ||
|
|
58f8f2e6e9 | ||
|
|
52f9a5b54b | ||
|
|
e6076e5568 | ||
|
|
42acb4f52b | ||
|
|
d239adbbbc | ||
|
|
6d942f5e45 | ||
|
|
bc0406cf02 | ||
|
|
23b6cec173 | ||
|
|
34beacf32b | ||
|
|
3e32c12c40 | ||
|
|
13791ec7bf | ||
|
|
452fb3d7cb | ||
|
|
12abc9bda9 | ||
|
|
987c029c87 | ||
|
|
6c00f7c7de | ||
|
|
bd1cacc0cf | ||
|
|
9cfa9038fc | ||
|
|
1c16a2d2b5 | ||
|
|
798f5493f9 | ||
|
|
4fa36487ab | ||
|
|
34467d42b3 | ||
|
|
ae624cfa44 | ||
|
|
05e5e0a5ac | ||
|
|
87344b93fc | ||
|
|
200d64f5ea | ||
|
|
ec35c74e2e | ||
|
|
027700c3f4 | ||
|
|
da93cce1fa | ||
|
|
448d3fe156 | ||
|
|
6158300062 | ||
|
|
3160e4aad6 | ||
|
|
93734fcefc | ||
|
|
a861079dc1 | ||
|
|
5148ee5f74 | ||
|
|
c48778d709 | ||
|
|
cf3c3a9dcc | ||
|
|
1705ced1b5 | ||
|
|
6a0635a2bb | ||
|
|
f568c9da62 | ||
|
|
94e42354cd | ||
|
|
642eb936c0 | ||
|
|
775959c3f9 | ||
|
|
77627bb8d9 | ||
|
|
b1fbd38352 | ||
|
|
a06b2c3969 | ||
|
|
34fd40d46a |
@@ -1,8 +1,12 @@
|
|||||||
---
|
---
|
||||||
profile: production
|
profile: production
|
||||||
|
|
||||||
|
warn_list:
|
||||||
|
- no-log-password
|
||||||
|
|
||||||
exclude_paths:
|
exclude_paths:
|
||||||
- .ansible/
|
- .ansible/
|
||||||
|
- .github/
|
||||||
- tests/integration
|
- tests/integration
|
||||||
- tests/unit
|
- tests/unit
|
||||||
- tests/sanity
|
- tests/sanity
|
||||||
@@ -1,5 +1,4 @@
|
|||||||
# https://docs.ansible.com/ansible-lint/docs/rules/
|
# https://docs.ansible.com/ansible-lint/docs/rules/
|
||||||
# no-changed-when is not requried for examples
|
plugins/connection/kubectl.py jinja[invalid]
|
||||||
plugins/connection/kubectl.py no-changed-when
|
# collection EE metadata is not an ansible-builder definition file
|
||||||
# false positive result
|
meta/execution-environment.yml schema[execution-environment]
|
||||||
plugins/connection/kubectl.py var-naming[no-reserved]
|
|
||||||
|
|||||||
@@ -0,0 +1,97 @@
|
|||||||
|
---
|
||||||
|
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 "
|
||||||
|
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 }}',
|
||||||
|
}
|
||||||
|
ok = all(results[j] == 'success' for j in required)
|
||||||
|
skipped_ok = all(results[j] in ('success', 'skipped') for j in results)
|
||||||
|
assert ok and skipped_ok, f'required={required} results={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
|
||||||
@@ -0,0 +1,210 @@
|
|||||||
|
name: Integration tests Helm
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: integration-tests-helm-${{ github.head_ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types:
|
||||||
|
- opened
|
||||||
|
- reopened
|
||||||
|
- labeled
|
||||||
|
- unlabeled
|
||||||
|
- synchronize
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
- stable-*
|
||||||
|
|
||||||
|
permissions: {}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
splitter:
|
||||||
|
env:
|
||||||
|
source_dir: "./source"
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
helm_targets: ${{ steps.select-targets.outputs.targets }}
|
||||||
|
permissions:
|
||||||
|
pull-requests: read
|
||||||
|
contents: read
|
||||||
|
steps:
|
||||||
|
- name: Checkout the collection repository
|
||||||
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||||
|
with:
|
||||||
|
path: ${{ env.source_dir }}
|
||||||
|
fetch-depth: "0"
|
||||||
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: list changes for pull request
|
||||||
|
id: splitter
|
||||||
|
uses: ansible-network/github_actions/.github/actions/ansible_test_splitter@4678c74a7d712d55e663c88f66eec6d9c3642550
|
||||||
|
with:
|
||||||
|
collections_to_test: ${{ env.source_dir }}
|
||||||
|
total_jobs: 8
|
||||||
|
|
||||||
|
- name: Select Helm targets
|
||||||
|
id: select-targets
|
||||||
|
run: |
|
||||||
|
import os, json
|
||||||
|
with open(os.environ.get('GITHUB_OUTPUT'), "a", encoding="utf-8") as fh:
|
||||||
|
data = os.environ.get("ALL_TEST_TARGETS")
|
||||||
|
targets = []
|
||||||
|
for target in data.split(";"):
|
||||||
|
if target and ':' in target:
|
||||||
|
targets.extend([v for v in target.split(':', maxsplit=1)[1].split(',') if v.startswith('helm')])
|
||||||
|
fh.write(f'targets={json.dumps(targets)}\n')
|
||||||
|
shell: python
|
||||||
|
env:
|
||||||
|
ALL_TEST_TARGETS: ${{ steps.splitter.outputs.test_targets }}
|
||||||
|
|
||||||
|
integration:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 60
|
||||||
|
needs:
|
||||||
|
- splitter
|
||||||
|
if: ${{ needs.splitter.outputs.helm_targets != '' && needs.splitter.outputs.helm_targets != '[]' }}
|
||||||
|
env:
|
||||||
|
source: "./source"
|
||||||
|
ansible_posix: "./ansible_posix"
|
||||||
|
community_general: "./community_general"
|
||||||
|
ansible-version: "milestone"
|
||||||
|
python-version: "3.13"
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
helm-version:
|
||||||
|
- v3.0.0
|
||||||
|
- v3.1.0
|
||||||
|
- v3.8.0
|
||||||
|
- v3.10.3
|
||||||
|
- v3.15.4
|
||||||
|
- v3.16.0
|
||||||
|
- v3.17.0
|
||||||
|
- v3.22.0
|
||||||
|
- v4.0.0
|
||||||
|
- v4.2.1
|
||||||
|
- latest
|
||||||
|
ansible_test_target: ${{ fromJson(needs.splitter.outputs.helm_targets) }}
|
||||||
|
exclude:
|
||||||
|
# helm_registry_auth: only test against recent versions to reduce CI cost
|
||||||
|
- ansible_test_target: "helm_registry_auth"
|
||||||
|
helm-version: "v3.0.0"
|
||||||
|
- ansible_test_target: "helm_registry_auth"
|
||||||
|
helm-version: "v3.1.0"
|
||||||
|
- ansible_test_target: "helm_registry_auth"
|
||||||
|
helm-version: "v3.8.0"
|
||||||
|
- ansible_test_target: "helm_registry_auth"
|
||||||
|
helm-version: "v3.10.3"
|
||||||
|
- ansible_test_target: "helm_registry_auth"
|
||||||
|
helm-version: "v3.15.4"
|
||||||
|
- ansible_test_target: "helm_registry_auth"
|
||||||
|
helm-version: "v3.16.0"
|
||||||
|
# helm install/upgrade --create-namespace requires helm >= 3.2.0
|
||||||
|
- ansible_test_target: "helm_diff"
|
||||||
|
helm-version: "v3.0.0"
|
||||||
|
- ansible_test_target: "helm_diff"
|
||||||
|
helm-version: "v3.1.0"
|
||||||
|
- ansible_test_target: "helm_diff"
|
||||||
|
helm-version: "v3.8.0"
|
||||||
|
- ansible_test_target: "helm_diff"
|
||||||
|
helm-version: "v3.10.3"
|
||||||
|
# UPGRADE FAILED: conflict occurred while applying object helm-diff/test-chart-another-configmap /v1
|
||||||
|
- ansible_test_target: "helm_diff"
|
||||||
|
helm-version: "v4.0.0"
|
||||||
|
- ansible_test_target: "helm_repository"
|
||||||
|
helm-version: "v3.0.0"
|
||||||
|
- ansible_test_target: "helm_repository"
|
||||||
|
helm-version: "v3.1.0"
|
||||||
|
- ansible_test_target: "helm_kubeconfig"
|
||||||
|
helm-version: "v3.0.0"
|
||||||
|
- ansible_test_target: "helm_kubeconfig"
|
||||||
|
helm-version: "v3.1.0"
|
||||||
|
- ansible_test_target: "helm_set_values"
|
||||||
|
helm-version: "v3.0.0"
|
||||||
|
- ansible_test_target: "helm_set_values"
|
||||||
|
helm-version: "v3.1.0"
|
||||||
|
- ansible_test_target: "helm_set_values"
|
||||||
|
helm-version: "v3.8.0"
|
||||||
|
- ansible_test_target: "helm"
|
||||||
|
helm-version: "v3.0.0"
|
||||||
|
- ansible_test_target: "helm"
|
||||||
|
helm-version: "v3.1.0"
|
||||||
|
- ansible_test_target: "helm_uninstall"
|
||||||
|
helm-version: "v3.0.0"
|
||||||
|
- ansible_test_target: "helm_uninstall"
|
||||||
|
helm-version: "v3.1.0"
|
||||||
|
name: "${{ matrix.ansible_test_target }}-${{ matrix.helm-version }}"
|
||||||
|
steps:
|
||||||
|
- name: Checkout kubernetes.core repository
|
||||||
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||||
|
with:
|
||||||
|
path: ${{ env.source }}
|
||||||
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: Set up Python ${{ env.python-version }}
|
||||||
|
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||||
|
with:
|
||||||
|
python-version: ${{ env.python-version }}
|
||||||
|
|
||||||
|
# install ansible
|
||||||
|
- name: Install ansible-core (${{ env.ansible-version }})
|
||||||
|
env:
|
||||||
|
ANSIBLE_VERSION: ${{ env.ansible-version }}
|
||||||
|
run: |
|
||||||
|
curl -sSL --proto '=https' --tlsv1.2 --retry 5 --retry-delay 10 --retry-all-errors \
|
||||||
|
"https://github.com/ansible/ansible/archive/${ANSIBLE_VERSION}.tar.gz" \
|
||||||
|
-o ansible.tar.gz
|
||||||
|
python3 -m pip install --disable-pip-version-check ./ansible.tar.gz
|
||||||
|
rm ansible.tar.gz
|
||||||
|
shell: bash
|
||||||
|
|
||||||
|
- name: Build and install collection
|
||||||
|
id: install-src
|
||||||
|
uses: ansible-network/github_actions/.github/actions/build_install_collection@4678c74a7d712d55e663c88f66eec6d9c3642550
|
||||||
|
with:
|
||||||
|
install_python_dependencies: true
|
||||||
|
source_path: ${{ env.source }}
|
||||||
|
|
||||||
|
- name: create kubernetes cluster
|
||||||
|
uses: helm/kind-action@ef37e7f390d99f746eb8b610417061a60e82a6cc # v1.14.0
|
||||||
|
with:
|
||||||
|
node_image: "kindest/node:v1.29.2"
|
||||||
|
|
||||||
|
- name: "Install Helm version ${{ matrix.helm-version }}"
|
||||||
|
uses: azure/setup-helm@9bc31f4ebc9c6b171d7bfbaa5d006ae7abdb4310 # v5.0.1
|
||||||
|
with:
|
||||||
|
version: '${{ matrix.helm-version }}'
|
||||||
|
|
||||||
|
- name: Verify Helm Installation
|
||||||
|
run: helm version
|
||||||
|
|
||||||
|
- name: Disable selinux with selinux_please_lie_to_me
|
||||||
|
run: |
|
||||||
|
python3 -m pip uninstall -y selinux
|
||||||
|
python3 -m pip install --only-binary=:all: selinux_please_lie_to_me==1.0.1
|
||||||
|
shell: bash
|
||||||
|
|
||||||
|
- name: Install python requirements
|
||||||
|
run: python3 -m pip install -r requirements.txt -r test-requirements.txt
|
||||||
|
shell: bash
|
||||||
|
working-directory: ${{ steps.install-src.outputs.collection_path }}
|
||||||
|
|
||||||
|
- name: Run integration tests
|
||||||
|
run: >-
|
||||||
|
ansible-test integration
|
||||||
|
--diff
|
||||||
|
--no-temp-workdir
|
||||||
|
--color
|
||||||
|
--skip-tags False
|
||||||
|
--retry-on-error
|
||||||
|
--continue-on-error
|
||||||
|
--python ${{ env.python-version }}
|
||||||
|
-v
|
||||||
|
${{ matrix.ansible_test_target }}
|
||||||
|
shell: bash
|
||||||
|
working-directory: ${{ steps.install-src.outputs.collection_path }}
|
||||||
@@ -17,15 +17,15 @@ jobs:
|
|||||||
source_dir: "./source"
|
source_dir: "./source"
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
outputs:
|
outputs:
|
||||||
test_targets: ${{ steps.splitter.outputs.test_targets }}
|
test_targets: ${{ steps.select-targets.outputs.targets }}
|
||||||
test_targets_json: ${{ steps.splitter.outputs.test_targets_json }}
|
test_jobs: ${{ steps.select-targets.outputs.jobs }}
|
||||||
test_jobs: ${{ steps.splitter.outputs.test_jobs }}
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout the collection repository
|
- name: Checkout the collection repository
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
with:
|
with:
|
||||||
path: ${{ env.source_dir }}
|
path: ${{ env.source_dir }}
|
||||||
fetch-depth: "0"
|
fetch-depth: "0"
|
||||||
|
ref: ${{ github.event.pull_request.head.sha }}
|
||||||
|
|
||||||
- name: list changes for pull request
|
- name: list changes for pull request
|
||||||
id: splitter
|
id: splitter
|
||||||
@@ -34,18 +34,40 @@ jobs:
|
|||||||
collections_to_test: ${{ env.source_dir }}
|
collections_to_test: ${{ env.source_dir }}
|
||||||
total_jobs: 8
|
total_jobs: 8
|
||||||
|
|
||||||
- name: Display splitter output
|
- name: Remove all Helm related targets
|
||||||
|
id: select-targets
|
||||||
run: |
|
run: |
|
||||||
echo "test_targets=${{ steps.splitter.outputs.test_targets }}"
|
import os, json
|
||||||
echo "test_targets_json=${{ steps.splitter.outputs.test_targets_json }}"
|
with open(os.environ.get('GITHUB_OUTPUT'), "a", encoding="utf-8") as fh:
|
||||||
echo "test_jobs=${{ steps.splitter.outputs.test_jobs }}"
|
data = os.environ.get("ALL_TEST_TARGETS")
|
||||||
|
index = 0
|
||||||
|
result = {}
|
||||||
|
for target in data.split(";"):
|
||||||
|
if target and ':' in target:
|
||||||
|
k8s = [v for v in target.split(':', maxsplit=1)[1].split(',') if not v.startswith('helm')]
|
||||||
|
if k8s:
|
||||||
|
result[index] = ' '.join(k8s)
|
||||||
|
index += 1
|
||||||
|
fh.write(f'targets={json.dumps(result)}\n')
|
||||||
|
fh.write(f'jobs={json.dumps(list(result.keys()))}\n')
|
||||||
|
shell: python
|
||||||
|
env:
|
||||||
|
ALL_TEST_TARGETS: ${{ steps.splitter.outputs.test_targets }}
|
||||||
|
|
||||||
|
- name: Display splitter output
|
||||||
|
env:
|
||||||
|
TARGETS: ${{ steps.select-targets.outputs.targets }}
|
||||||
|
JOBS: ${{ steps.select-targets.outputs.jobs }}
|
||||||
|
run: |
|
||||||
|
echo "targets => $TARGETS"
|
||||||
|
echo "jobs => $JOBS"
|
||||||
shell: bash
|
shell: bash
|
||||||
integration:
|
integration:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
timeout-minutes: 60
|
timeout-minutes: 60
|
||||||
needs:
|
needs:
|
||||||
- splitter
|
- splitter
|
||||||
if: ${{ needs.splitter.outputs.test_targets != '' }}
|
if: ${{ needs.splitter.outputs.test_jobs != '' && needs.splitter.outputs.test_jobs != '[]' }}
|
||||||
env:
|
env:
|
||||||
source: "./source"
|
source: "./source"
|
||||||
cloud_common: "./cloudcommon"
|
cloud_common: "./cloudcommon"
|
||||||
@@ -54,15 +76,29 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
ansible-version:
|
# Ref must match a branch/tag on github.com/ansible/ansible (e.g. stable-2.18, not 2.18).
|
||||||
- milestone
|
#
|
||||||
python-version:
|
ansible-version: ["stable-2.18", "stable-2.21", "milestone"]
|
||||||
- "3.12"
|
enable-turbo-mode: [true, false]
|
||||||
enable-turbo-mode:
|
python-version: ["3.12", "3.13"]
|
||||||
- true
|
exclude:
|
||||||
- false
|
# 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
|
||||||
|
- 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) }}
|
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:
|
steps:
|
||||||
- name: Read target
|
- name: Read target
|
||||||
id: read-targets
|
id: read-targets
|
||||||
@@ -72,12 +108,14 @@ jobs:
|
|||||||
fh.write(f'ansible_test_targets={json.loads(os.environ.get("ALL_TEST_TARGETS")).get(os.environ.get("WORKFLOW_ID"))}\n')
|
fh.write(f'ansible_test_targets={json.loads(os.environ.get("ALL_TEST_TARGETS")).get(os.environ.get("WORKFLOW_ID"))}\n')
|
||||||
shell: python
|
shell: python
|
||||||
env:
|
env:
|
||||||
ALL_TEST_TARGETS: ${{ needs.splitter.outputs.test_targets_json }}
|
ALL_TEST_TARGETS: ${{ needs.splitter.outputs.test_targets }}
|
||||||
WORKFLOW_ID: ${{ matrix.workflow-id }}
|
WORKFLOW_ID: ${{ matrix.workflow-id }}
|
||||||
|
|
||||||
- name: Display ansible test targets
|
- name: Display ansible test targets
|
||||||
|
env:
|
||||||
|
ANSIBLE_TEST_TARGETS: ${{ steps.read-targets.outputs.ansible_test_targets }}
|
||||||
run: |
|
run: |
|
||||||
echo "ansible_test_targets -> ${{ steps.read-targets.outputs.ansible_test_targets }}"
|
echo "ansible_test_targets -> $ANSIBLE_TEST_TARGETS"
|
||||||
|
|
||||||
- name: Checkout kubernetes.core repository
|
- name: Checkout kubernetes.core repository
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
@@ -106,6 +144,7 @@ jobs:
|
|||||||
source_path: ${{ env.source }}
|
source_path: ${{ env.source }}
|
||||||
|
|
||||||
- name: checkout ansible-collections/cloud.common
|
- name: checkout ansible-collections/cloud.common
|
||||||
|
if: ${{ matrix.enable-turbo-mode == true }}
|
||||||
uses: ansible-network/github_actions/.github/actions/checkout_dependency@main
|
uses: ansible-network/github_actions/.github/actions/checkout_dependency@main
|
||||||
with:
|
with:
|
||||||
repository: ansible-collections/cloud.common
|
repository: ansible-collections/cloud.common
|
||||||
@@ -127,6 +166,7 @@ jobs:
|
|||||||
ref: main
|
ref: main
|
||||||
|
|
||||||
- name: install cloud.common collection
|
- name: install cloud.common collection
|
||||||
|
if: ${{ matrix.enable-turbo-mode == true }}
|
||||||
uses: ansible-network/github_actions/.github/actions/build_install_collection@main
|
uses: ansible-network/github_actions/.github/actions/build_install_collection@main
|
||||||
with:
|
with:
|
||||||
install_python_dependencies: true
|
install_python_dependencies: true
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
---
|
||||||
|
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
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
---
|
||||||
|
name: label new prs
|
||||||
|
on:
|
||||||
|
pull_request_target:
|
||||||
|
types:
|
||||||
|
- opened
|
||||||
|
- reopened
|
||||||
|
- converted_to_draft
|
||||||
|
- ready_for_review
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
add_label:
|
||||||
|
if: github.actor != 'patchback[bot]'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
pull-requests: write
|
||||||
|
steps:
|
||||||
|
- name: Add 'needs_triage' label if the pr is not a draft
|
||||||
|
uses: actions-ecosystem/action-add-labels@v1
|
||||||
|
if: github.event.pull_request.draft == false
|
||||||
|
with:
|
||||||
|
labels: needs_triage
|
||||||
|
|
||||||
|
- name: Remove 'needs_triage' label if the pr is a draft
|
||||||
|
uses: actions-ecosystem/action-remove-labels@v1
|
||||||
|
if: github.event.pull_request.draft == true
|
||||||
|
with:
|
||||||
|
labels: needs_triage
|
||||||
@@ -1,16 +1,7 @@
|
|||||||
---
|
---
|
||||||
name: Linters
|
name: Linters
|
||||||
concurrency:
|
|
||||||
group: ${{ github.workflow }}-${{ github.ref }}
|
|
||||||
cancel-in-progress: true
|
|
||||||
|
|
||||||
on:
|
on: [workflow_call]
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
- stable-*
|
|
||||||
tags:
|
|
||||||
- '*'
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
linters:
|
linters:
|
||||||
@@ -20,4 +11,6 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: run-ansible-lint
|
- name: run-ansible-lint
|
||||||
uses: ansible/ansible-lint@v25.1.2
|
uses: ansible/ansible-lint@main
|
||||||
|
with:
|
||||||
|
gh_action_ref: "v25.5.0"
|
||||||
|
|||||||
@@ -1,14 +1,7 @@
|
|||||||
---
|
---
|
||||||
name: Sanity tests
|
name: Sanity tests
|
||||||
concurrency:
|
|
||||||
group: ${{ github.workflow }}-${{ github.ref }}
|
|
||||||
cancel-in-progress: true
|
|
||||||
|
|
||||||
on:
|
on: [workflow_call]
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
- stable-*
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
sanity:
|
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
|
name: Unit tests
|
||||||
concurrency:
|
|
||||||
group: ${{ github.workflow }}-${{ github.ref }}
|
|
||||||
cancel-in-progress: true
|
|
||||||
|
|
||||||
on:
|
on: [workflow_call]
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
- stable-*
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
unit-source:
|
unit-source:
|
||||||
|
|||||||
+10
-1
@@ -16,8 +16,17 @@ tests/integration/cloud-config-*
|
|||||||
.ansible
|
.ansible
|
||||||
|
|
||||||
# Helm charts
|
# Helm charts
|
||||||
tests/integration/*-chart-*.tgz
|
tests/integration/*.tgz
|
||||||
|
tests/integration/targets/*/*.tgz
|
||||||
|
|
||||||
# ansible-test generated file
|
# ansible-test generated file
|
||||||
tests/integration/inventory
|
tests/integration/inventory
|
||||||
tests/integration/*-*.yml
|
tests/integration/*-*.yml
|
||||||
|
tests/integration/integration_config.yml
|
||||||
|
|
||||||
|
# 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: 77f45b0357b6b3c27b04e934f0f51c9b50b7aa25
|
||||||
|
hooks:
|
||||||
|
- id: block-ide-ai-files
|
||||||
|
always_run: true
|
||||||
@@ -26,3 +26,4 @@ ignore: |
|
|||||||
.tox
|
.tox
|
||||||
.ansible
|
.ansible
|
||||||
tests/output
|
tests/output
|
||||||
|
plugins/connection/kubectl.py
|
||||||
|
|||||||
+318
-4
@@ -4,6 +4,320 @@ Kubernetes Collection Release Notes
|
|||||||
|
|
||||||
.. contents:: Topics
|
.. 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
|
||||||
|
======
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
This release adds Helm v4 compatibility across the Helm modules and improves ``k8s_drain`` with check mode. When you explicitly allow evicting unmanaged pods, pods with local storage, or pods managed by a ``DaemonSet``, those cases are reported as informational output instead of module warnings.
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- helm_info - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- helm_plugin - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- helm_plugin_info - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- helm_pull - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- helm_registry_auth - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- helm_registry_auth - add new option plain_http to allow insecure http connection when running ``helm registry login`` (https://github.com/ansible-collections/kubernetes.core/pull/1090).
|
||||||
|
- helm_repository - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- k8s_drain - Add support for ``check_mode`` (https://github.com/ansible-collections/kubernetes.core/pull/1086).
|
||||||
|
- k8s_drain - Convert module warnings into informational displays when users explicitly request the deletion of unmanaged pods, pods with local storage, or those managed by a ``DaemonSet`` (https://github.com/ansible-collections/kubernetes.core/issues/1037).
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Helm - Allow taking ownership of existing Kubernetes resources on the first installation of a Helm release. Previously, the ``take_ownership`` parameter was always disabled during the initial install, preventing resource adoption (https://github.com/ansible-collections/kubernetes.core/pull/1034).
|
||||||
|
|
||||||
|
v6.3.0
|
||||||
|
======
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
This release includes bugfixes such as implementing idempotency for the ``helm_pull`` module as well as a security update for selectively redacting sensitive information from kubeconfig.
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Remove deprecated import from ``ansible.module_utils._text`` (https://github.com/ansible-collections/kubernetes.core/pull/1053).
|
||||||
|
- helm - add ``release_values`` key to ``status`` return value that can be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
- helm_info - add ``release_values`` key to ``status`` return value that can be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
|
||||||
|
Deprecated Features
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
- helm - the ``status.values`` return value has been deprecated and will be removed in a release after 2027-01-08. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
- helm_info - the ``status.values`` return value has been deprecated and will be removed in a release after 2027-01-08. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
|
||||||
|
Security Fixes
|
||||||
|
--------------
|
||||||
|
|
||||||
|
- Selectively redact sensitive info from kubeconfig instead of applying blanket ``no_log=True`` (https://github.com/ansible-collections/kubernetes.core/pull/1014).
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Add idempotency for ``helm_pull`` module (https://github.com/ansible-collections/kubernetes.core/pull/1055).
|
||||||
|
- Fixed a bug where setting ``K8S_AUTH_VERIFY_SSL=true`` (or any string value) caused the value to be treated as a separate ``kubectl`` command argument. (https://github.com/ansible-collections/kubernetes.core/pull/1049).
|
||||||
|
- Limit supported versions of Helm to <4.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/1039).
|
||||||
|
- Replace passing ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` in the ``k8s_drain``, ``k8s_rollback.py`` and ``k8s_scale.py`` modules as it deprecated in ``ansible-core>=2.19.0`` and will be removed in ``ansible-core>=2.23.0`` (https://github.com/ansible-collections/kubernetes.core/pull/1033).
|
||||||
|
- k8s - Fix return block from the module documentation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
- meta - Add ``k8s_cluster_info``, ``k8s_json_patch`` and ``k8s_rollback`` to k8s action group (https://github.com/ansible-collections/kubernetes.core/pull/992).
|
||||||
|
|
||||||
|
v6.2.0
|
||||||
|
======
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
This release adds minor changes and bugfixes, including support of skip-schema-validation in ``helm`` module and removing deprecated ``ansible.module_utils.six`` imports.
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Add support of skip-schema-validation in ``helm`` module (https://github.com/ansible-collections/kubernetes.core/pull/995)
|
||||||
|
- kustomize - Add support of local environ (https://github.com/ansible-collections/kubernetes.core/pull/786).
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Remove ``ansible.module_utils.six`` imports to avoid warnings (https://github.com/ansible-collections/kubernetes.core/pull/998).
|
||||||
|
- Update the ``k8s_cp`` module to also work for init containers (https://github.com/ansible-collections/kubernetes.core/pull/971).
|
||||||
|
|
||||||
|
v6.1.0
|
||||||
|
======
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
This release adds ``plain_http`` and ``take_ownership`` parameters for helm modules, support for ``hidden_fields`` in ``k8s_json_patch``, documented lack of idempotency support in ``helm_registry_auth`` with ``helm ≥ 3.18.0``, and improved ``k8s_rollback`` test coverage.
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Module ``helm_registry_auth`` does not support idempotency with `helm >= 3.18.0` (https://github.com/ansible-collections/kubernetes.core/pull/946).
|
||||||
|
- Module k8s_json_patch - Add support for ``hidden_fields`` (https://github.com/ansible-collections/kubernetes.core/pull/964).
|
||||||
|
- helm - Parameter plain_http added for working with insecure OCI registries (https://github.com/ansible-collections/kubernetes.core/pull/934).
|
||||||
|
- helm - Parameter take_ownership added (https://github.com/ansible-collections/kubernetes.core/pull/957).
|
||||||
|
- helm_pull - Parameter plain_http added for working with insecure OCI registries (https://github.com/ansible-collections/kubernetes.core/pull/934).
|
||||||
|
- helm_template - Parameter plain_http added for working with insecure OCI registries (https://github.com/ansible-collections/kubernetes.core/pull/934).
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- module_utils/k8s/service - hide fields first before creating diffs (https://github.com/ansible-collections/kubernetes.core/pull/915).
|
||||||
|
|
||||||
|
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
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
- Remove deprecated ``k8s`` invetory plugin (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
||||||
|
- Remove support for ``ansible-core<2.16`` (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
||||||
|
|
||||||
|
v5.5.0
|
||||||
|
======
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
This minor release deprecates Ansible Turbo mode (``ENABLE_TURBO_MODE``), the ``status.values`` return value of the ``helm`` and ``helm_info`` modules, the ``wait_timeout`` parameter of the ``helm`` module, the ``return_code`` return value of the ``k8s_exec`` module, and the ``merge_type=json`` option of the ``k8s_service`` module. It also includes bugfixes for ``helm_repository`` URL comparison and for empty template output handling in ``k8s_info``.
|
||||||
|
|
||||||
|
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).
|
||||||
|
- 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).
|
||||||
|
|
||||||
|
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_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).
|
||||||
|
- 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_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).
|
||||||
|
|
||||||
|
v5.4.4
|
||||||
|
======
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
This release corrects the documented and enforced minimum ``ansible-core`` version to ``>=2.16.0``.
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- meta - Update ``requires_ansible`` in ``runtime.yml`` and README to ``>=2.16.0`` to match the actual minimum supported ``ansible-core`` version (https://github.com/ansible-collections/kubernetes.core/pull/1193).
|
||||||
|
|
||||||
|
v5.4.3
|
||||||
|
======
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
This release contains bugfixes such as improved idempotency for helm repository URLs with trailing slashes.
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- ee - Add ``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_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).
|
||||||
|
|
||||||
|
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, and adds a new ``release_values`` key to the ``status`` return value.
|
||||||
|
|
||||||
|
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
|
||||||
|
======
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
This release includes bugfixes for k8s service field handling, k8s_cp init containers support, and removes deprecated ansible.module_utils.six imports.
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Remove ``ansible.module_utils.six`` imports to avoid warnings (https://github.com/ansible-collections/kubernetes.core/pull/998).
|
||||||
|
- Update the ``k8s_cp`` module to also work for init containers (https://github.com/ansible-collections/kubernetes.core/pull/971).
|
||||||
|
- module_utils/k8s/service - hide fields first before creating diffs (https://github.com/ansible-collections/kubernetes.core/pull/915).
|
||||||
|
|
||||||
|
v5.4.0
|
||||||
|
======
|
||||||
|
|
||||||
|
Release Summary
|
||||||
|
---------------
|
||||||
|
|
||||||
|
This release updates the ``helm_registry_auth`` module to match the behavior of ``helm >= 3.18.0`` which reports a successful logout regardless of the current state (i.e., no idempotency).
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Module ``helm_registry_auth`` does not support idempotency with ``helm >= 3.18.0`` (https://github.com/ansible-collections/kubernetes.core/pull/946).
|
||||||
|
|
||||||
v5.3.0
|
v5.3.0
|
||||||
======
|
======
|
||||||
|
|
||||||
@@ -15,15 +329,15 @@ This release includes minor changes, bug fixes and also bumps ``ansible-lint`` v
|
|||||||
Minor Changes
|
Minor Changes
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
- kubernetes.core - Bump version of ``ansible-lint`` to ``25.1.2`` (https://github.com/ansible-collections/kubernetes.core/pull/919).
|
|
||||||
- action/k8s_info - update templating mechanism with changes from ``ansible-core 2.19`` (https://github.com/ansible-collections/kubernetes.core/pull/888).
|
- action/k8s_info - update templating mechanism with changes from ``ansible-core 2.19`` (https://github.com/ansible-collections/kubernetes.core/pull/888).
|
||||||
- helm - add ``reset_then_reuse_values`` support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/803).
|
- helm - add ``reset_then_reuse_values`` support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/803).
|
||||||
- helm - add support for ``insecure_skip_tls_verify`` option to helm and ``helm_repository`` (https://github.com/ansible-collections/kubernetes.core/issues/694).
|
- helm - add support for ``insecure_skip_tls_verify`` option to helm and ``helm_repository`` (https://github.com/ansible-collections/kubernetes.core/issues/694).
|
||||||
|
- kubernetes.core - Bump version of ``ansible-lint`` to ``25.1.2`` (https://github.com/ansible-collections/kubernetes.core/pull/919).
|
||||||
|
|
||||||
Bugfixes
|
Bugfixes
|
||||||
--------
|
--------
|
||||||
|
|
||||||
- module_utils/k8s/service - Fix issue when trying to delete resource using ``delete_options`` and ``check_mode=true`` (https://github.com/ansible-collections/kubernetes.core/issues/892).
|
- module_utils/k8s/service - fix issue when trying to delete resource using `delete_options` and `check_mode=true` (https://github.com/ansible-collections/kubernetes.core/issues/892).
|
||||||
|
|
||||||
v5.2.0
|
v5.2.0
|
||||||
======
|
======
|
||||||
@@ -51,7 +365,7 @@ This release came with new module ``helm_registry_auth``, improvements to the er
|
|||||||
Minor Changes
|
Minor Changes
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
- Bump version of ansible-lint to minimum 24.7.0 (https://github.com/ansible-collections/kubernetes.core/pull/765).
|
- Bump version of ``ansible-lint`` to minimum 24.7.0 (https://github.com/ansible-collections/kubernetes.core/pull/765).
|
||||||
- Parameter insecure_registry added to helm_template as equivalent of insecure-skip-tls-verify (https://github.com/ansible-collections/kubernetes.core/pull/805).
|
- Parameter insecure_registry added to helm_template as equivalent of insecure-skip-tls-verify (https://github.com/ansible-collections/kubernetes.core/pull/805).
|
||||||
- k8s_drain - Improve error message for pod disruption budget when draining a node (https://github.com/ansible-collections/kubernetes.core/issues/797).
|
- k8s_drain - Improve error message for pod disruption budget when draining a node (https://github.com/ansible-collections/kubernetes.core/issues/797).
|
||||||
|
|
||||||
@@ -124,7 +438,7 @@ Bugfixes
|
|||||||
- integrations test helm_kubeconfig - set helm version to v3.10.3 to avoid incompatability with new bitnami charts (https://github.com/ansible-collections/kubernetes.core/pull/670).
|
- integrations test helm_kubeconfig - set helm version to v3.10.3 to avoid incompatability with new bitnami charts (https://github.com/ansible-collections/kubernetes.core/pull/670).
|
||||||
|
|
||||||
v3.3.1
|
v3.3.1
|
||||||
=======
|
======
|
||||||
|
|
||||||
Release Summary
|
Release Summary
|
||||||
---------------
|
---------------
|
||||||
|
|||||||
@@ -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.
|
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
|
### Code of Conduct
|
||||||
The `kubernetes.core` collection follows the Ansible project's
|
The `kubernetes.core` collection follows the Ansible project's
|
||||||
[Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).
|
[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
|
# Also needs to be updated in galaxy.yml
|
||||||
VERSION = 6.0.0-dev0
|
VERSION = 7.0.0-dev0
|
||||||
|
|
||||||
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]))'`
|
||||||
|
|||||||
@@ -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
|
# Kubernetes Collection for Ansible
|
||||||
|
|
||||||
This repository hosts the `kubernetes.core` (formerly known as `community.kubernetes`) Ansible Collection.
|
This repository hosts the `kubernetes.core` (formerly known as `community.kubernetes`) Ansible Collection.
|
||||||
@@ -6,58 +14,22 @@ 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.
|
||||||
|
|
||||||
## Communication
|
|
||||||
|
|
||||||
* 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.
|
|
||||||
|
|
||||||
* The Ansible [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
|
|
||||||
|
|
||||||
For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
<!--start requires_ansible-->
|
|
||||||
### Ansible Version Compatibility
|
|
||||||
|
|
||||||
This collection has been tested against following Ansible versions: **>=2.16.0**.
|
|
||||||
|
|
||||||
For collections that support Ansible 2.9, please ensure you update your `network_os` to use the
|
|
||||||
fully qualified collection name (for example, `cisco.ios.ios`).
|
|
||||||
Plugins and modules within a collection may be tested with only specific Ansible versions.
|
|
||||||
A collection may contain metadata that identifies these versions.
|
|
||||||
PEP440 is the schema used to describe the versions of Ansible.
|
|
||||||
<!--end requires_ansible-->
|
|
||||||
|
|
||||||
### Python Support
|
|
||||||
|
|
||||||
* Collection supports 3.9+
|
|
||||||
|
|
||||||
Note: Python2 is deprecated from [1st January 2020](https://www.python.org/doc/sunset-python-2/). Please switch to Python3.
|
|
||||||
|
|
||||||
### Kubernetes Version Support
|
|
||||||
|
|
||||||
This collection supports Kubernetes versions >= 1.24.
|
|
||||||
|
|
||||||
### Included Content
|
### Included Content
|
||||||
|
|
||||||
Click on the name of a plugin or module to view that content's documentation:
|
Click on the name of a plugin or module to view that content's documentation:
|
||||||
|
|
||||||
<!--start collection content-->
|
<!--start collection content-->
|
||||||
### Connection Plugins
|
### Connection plugins
|
||||||
Name | Description
|
Name | Description
|
||||||
--- | ---
|
--- | ---
|
||||||
[kubernetes.core.kubectl](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kubectl_connection.rst)|Execute tasks in pods running on Kubernetes.
|
[kubernetes.core.kubectl](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kubectl_connection.rst)|Execute tasks in pods running on Kubernetes.
|
||||||
|
|
||||||
### K8s Filter Plugins
|
### K8s filter plugins
|
||||||
Name | Description
|
Name | Description
|
||||||
--- | ---
|
--- | ---
|
||||||
kubernetes.core.k8s_config_resource_name|Generate resource name for the given resource of type ConfigMap, Secret
|
kubernetes.core.k8s_config_resource_name|Generate resource name for the given resource of type ConfigMap, Secret
|
||||||
|
|
||||||
### Lookup Plugins
|
### Lookup plugins
|
||||||
Name | Description
|
Name | Description
|
||||||
--- | ---
|
--- | ---
|
||||||
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API
|
[kubernetes.core.k8s](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.k8s_lookup.rst)|Query the K8s API
|
||||||
@@ -86,29 +58,62 @@ Name | Description
|
|||||||
[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_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_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
|
[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
|
||||||
|
[kubernetes.core.kubeconfig](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/kubernetes.core.kubeconfig_module.rst)|Generate, update, and optionally write Kubernetes kubeconfig files
|
||||||
|
|
||||||
<!--end collection content-->
|
<!--end collection content-->
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
<!--start requires_ansible-->
|
||||||
|
## Ansible version compatibility
|
||||||
|
|
||||||
|
This collection has been tested against the following Ansible versions: **>=2.16.0**.
|
||||||
|
|
||||||
|
Plugins and modules within a collection may be tested with only specific Ansible versions.
|
||||||
|
A collection may contain metadata that identifies these versions.
|
||||||
|
PEP440 is the schema used to describe the versions of Ansible.
|
||||||
|
<!--end requires_ansible-->
|
||||||
|
|
||||||
|
### Helm Version Compatibility
|
||||||
|
|
||||||
|
This collection supports Helm v3.x and newer. Please note that specific modules or certain parameters may have additional version requirements.
|
||||||
|
|
||||||
|
### Python Support
|
||||||
|
|
||||||
|
* Collection supports 3.9+
|
||||||
|
|
||||||
|
Note: Python2 is deprecated from [1st January 2020](https://www.python.org/doc/sunset-python-2/). Please switch to Python3.
|
||||||
|
|
||||||
|
### Kubernetes Version Support
|
||||||
|
|
||||||
|
This collection supports Kubernetes versions >= 1.24.
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Before using the Kubernetes collection, you need to install it with the Ansible Galaxy CLI:
|
Before using the Kubernetes collection, you need to install it with the Ansible Galaxy CLI:
|
||||||
|
|
||||||
ansible-galaxy collection install kubernetes.core
|
ansible-galaxy collection install kubernetes.core
|
||||||
|
|
||||||
|
Red Hat customers can install certified content from [Ansible Automation Hub](https://console.redhat.com/ansible/automation-hub). Configure Automation Hub as the primary content source for the Ansible Galaxy CLI by following the [Red Hat configuration guide](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/getting_started_with_automation_hub/configure-hub-primary), then install the collection with `ansible-galaxy collection install kubernetes.core`.
|
||||||
|
|
||||||
You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml`, using the format:
|
You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml`, using the format:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
---
|
---
|
||||||
collections:
|
collections:
|
||||||
- name: kubernetes.core
|
- name: kubernetes.core
|
||||||
version: 5.2.0
|
version: 6.6.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### Installing the Kubernetes Python Library
|
### 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:
|
Content in this collection requires the [Kubernetes Python client](https://pypi.org/project/kubernetes/) to interact with Kubernetes' APIs. For installs outside an execution environment, install it with:
|
||||||
|
|
||||||
pip3 install kubernetes
|
```bash
|
||||||
|
pip3 install kubernetes
|
||||||
|
```
|
||||||
|
|
||||||
|
Execution environments install this dependency when they are built with `ansible-builder`; you do not need to install it separately with `pip3` in that case.
|
||||||
|
|
||||||
## Use Cases
|
## Use Cases
|
||||||
|
|
||||||
@@ -180,8 +185,11 @@ For documentation on how to use individual modules and other content included in
|
|||||||
|
|
||||||
## Ansible Turbo Mode Tech Preview
|
## Ansible Turbo Mode Tech Preview
|
||||||
|
|
||||||
|
> **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.
|
||||||
|
|
||||||
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:
|
> **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
|
```yaml
|
||||||
---
|
---
|
||||||
@@ -197,12 +205,6 @@ defined in the playbook using `environment` keyword as above, you must set it us
|
|||||||
|
|
||||||
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/ansible_turbo_mode.rst).
|
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).
|
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
[](https://github.com/ansible-collections/kubernetes.core/actions/workflows/linters.yaml) [](https://github.com/ansible-collections/kubernetes.core/actions/workflows/integration-tests.yaml) [](https://github.com/ansible-collections/kubernetes.core/actions/workflows/sanity-tests.yaml) [](https://github.com/ansible-collections/kubernetes.core/actions/workflows/unit-tests.yaml) [](https://app.codecov.io/gh/ansible-collections/kubernetes.core)
|
[](https://github.com/ansible-collections/kubernetes.core/actions/workflows/linters.yaml) [](https://github.com/ansible-collections/kubernetes.core/actions/workflows/integration-tests.yaml) [](https://github.com/ansible-collections/kubernetes.core/actions/workflows/sanity-tests.yaml) [](https://github.com/ansible-collections/kubernetes.core/actions/workflows/unit-tests.yaml) [](https://app.codecov.io/gh/ansible-collections/kubernetes.core)
|
||||||
@@ -217,14 +219,51 @@ You can run the collection's test suites with the commands:
|
|||||||
make test-integration
|
make test-integration
|
||||||
make test-unit
|
make test-unit
|
||||||
|
|
||||||
|
For instructions on running Helm integration tests locally, see the [integration tests README](https://github.com/ansible-collections/kubernetes.core/blob/main/tests/integration/README.md).
|
||||||
|
|
||||||
### Testing with `molecule`
|
### Testing with `molecule`
|
||||||
|
|
||||||
There are also integration tests in the `molecule` directory which are meant to be run against a local Kubernetes cluster, e.g. using [KinD](https://kind.sigs.k8s.io) or [Minikube](https://minikube.sigs.k8s.io). To setup a local cluster using KinD and run Molecule:
|
There are also integration tests in the `molecule` directory which are meant to be run against a local Kubernetes cluster, e.g. using [KinD](https://kind.sigs.k8s.io) or [Minikube](https://minikube.sigs.k8s.io). To set up a local cluster using KinD and run Molecule:
|
||||||
|
|
||||||
kind create cluster
|
kind create cluster
|
||||||
make test-molecule
|
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/main/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
|
||||||
|
|
||||||
|
This collection is maintained by Red Hat Ansible Cloud Content.
|
||||||
|
|
||||||
|
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/main/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:
|
Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:
|
||||||
|
|
||||||
@@ -232,7 +271,7 @@ Releases are automatically built and pushed to Ansible Galaxy for any new tag. B
|
|||||||
1. The `version` in `galaxy.yml`
|
1. The `version` in `galaxy.yml`
|
||||||
2. This README's `requirements.yml` example
|
2. This README's `requirements.yml` example
|
||||||
3. The `VERSION` in `Makefile`
|
3. The `VERSION` in `Makefile`
|
||||||
2. Update the CHANGELOG:
|
2. Update the [CHANGELOG](CHANGELOG.rst):
|
||||||
1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
|
1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
|
||||||
2. Make sure there are fragments for all known changes in `changelogs/fragments`.
|
2. Make sure there are fragments for all known changes in `changelogs/fragments`.
|
||||||
3. Run `antsibull-changelog release`.
|
3. Run `antsibull-changelog release`.
|
||||||
@@ -241,38 +280,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).
|
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/main/CI.md)
|
||||||
|
* [SonarCloud integration](https://github.com/ansible-collections/kubernetes.core/blob/main/SONARCLOUD.md)
|
||||||
|
* [Ansible Turbo mode (tech preview)](https://github.com/ansible-collections/kubernetes.core/blob/main/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.
|
### Code of conduct
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
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.
|
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.
|
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 Information
|
||||||
## License
|
|
||||||
|
|
||||||
GNU General Public License v3.0 or later
|
GNU General Public License v3.0 or later
|
||||||
|
|
||||||
See LICENCE to see the full text.
|
See [LICENSE](https://github.com/ansible-collections/kubernetes.core/blob/main/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`**), 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.
|
||||||
+447
-5
@@ -977,7 +977,7 @@ releases:
|
|||||||
- kustomize - kustomize plugin fails with deprecation warnings (https://github.com/ansible-collections/kubernetes.core/issues/639).
|
- kustomize - kustomize plugin fails with deprecation warnings (https://github.com/ansible-collections/kubernetes.core/issues/639).
|
||||||
- waiter - Fix waiting for daemonset when desired number of pods is 0. (https://github.com/ansible-collections/kubernetes.core/pull/756).
|
- waiter - Fix waiting for daemonset when desired number of pods is 0. (https://github.com/ansible-collections/kubernetes.core/pull/756).
|
||||||
minor_changes:
|
minor_changes:
|
||||||
- Bump version of ansible-lint to minimum 24.7.0 (https://github.com/ansible-collections/kubernetes.core/pull/765).
|
- Bump version of ``ansible-lint`` to minimum 24.7.0 (https://github.com/ansible-collections/kubernetes.core/pull/765).
|
||||||
- Parameter insecure_registry added to helm_template as equivalent of insecure-skip-tls-verify
|
- Parameter insecure_registry added to helm_template as equivalent of insecure-skip-tls-verify
|
||||||
(https://github.com/ansible-collections/kubernetes.core/pull/805).
|
(https://github.com/ansible-collections/kubernetes.core/pull/805).
|
||||||
- k8s_drain - Improve error message for pod disruption budget when draining
|
- k8s_drain - Improve error message for pod disruption budget when draining
|
||||||
@@ -1027,15 +1027,15 @@ releases:
|
|||||||
changes:
|
changes:
|
||||||
bugfixes:
|
bugfixes:
|
||||||
- module_utils/k8s/service - fix issue when trying to delete resource using
|
- module_utils/k8s/service - fix issue when trying to delete resource using
|
||||||
`delete_options` and `check_mode=true` (https://github.com/ansible-collections/kubernetes.core/issues/892).
|
``delete_options`` and ``check_mode=true`` (https://github.com/ansible-collections/kubernetes.core/issues/892).
|
||||||
minor_changes:
|
minor_changes:
|
||||||
- Bump version of ansible-lint to 25.1.2 (https://github.com/ansible-collections/kubernetes.core/pull/919).
|
- Bump version of ``ansible-lint`` to 25.1.2 (https://github.com/ansible-collections/kubernetes.core/pull/919).
|
||||||
- action/k8s_info - update templating mechanism with changes from ``ansible-core
|
- action/k8s_info - update templating mechanism with changes from ``ansible-core
|
||||||
2.19`` (https://github.com/ansible-collections/kubernetes.core/pull/888).
|
2.19`` (https://github.com/ansible-collections/kubernetes.core/pull/888).
|
||||||
- helm - add reset_then_reuse_values support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/803).
|
- helm - add ``reset_then_reuse_values`` support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/803).
|
||||||
- helm - add support for ``insecure_skip_tls_verify`` option to helm and helm_repository(https://github.com/ansible-collections/kubernetes.core/issues/694).
|
- helm - add support for ``insecure_skip_tls_verify`` option to helm and helm_repository(https://github.com/ansible-collections/kubernetes.core/issues/694).
|
||||||
release_summary: This release includes minor changes, bug fixes and also bumps
|
release_summary: This release includes minor changes, bug fixes and also bumps
|
||||||
ansible-lint version to ``25.1.2``.
|
``ansible-lint`` version to ``25.1.2``.
|
||||||
fragments:
|
fragments:
|
||||||
- 20250324-k8s_info-templating.yaml
|
- 20250324-k8s_info-templating.yaml
|
||||||
- 5.3.0.yml
|
- 5.3.0.yml
|
||||||
@@ -1044,3 +1044,445 @@ releases:
|
|||||||
- 898-k8s-dont-delete-in-check-mode.yaml
|
- 898-k8s-dont-delete-in-check-mode.yaml
|
||||||
- 919-update-ansible-lint-version.yaml
|
- 919-update-ansible-lint-version.yaml
|
||||||
release_date: '2025-05-16'
|
release_date: '2025-05-16'
|
||||||
|
5.4.0:
|
||||||
|
changes:
|
||||||
|
minor_changes:
|
||||||
|
- Module ``helm_registry_auth`` does not support idempotency with ``helm >=
|
||||||
|
3.18.0`` (https://github.com/ansible-collections/kubernetes.core/pull/946).
|
||||||
|
release_summary: This release updates the ``helm_registry_auth`` module to match
|
||||||
|
the behavior of ``helm >= 3.18.0`` which reports a successful logout regardless
|
||||||
|
of the current state (i.e., no idempotency).
|
||||||
|
fragments:
|
||||||
|
- 20250411-kubeconfig-no_log-revert.yaml
|
||||||
|
- 20250503-fix-unit-tests.yml
|
||||||
|
- 20250605-fix-helm_registry_auth-integration_test.yaml
|
||||||
|
- 5.4.0.yml
|
||||||
|
release_date: '2025-08-12'
|
||||||
|
5.4.1:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- Remove ``ansible.module_utils.six`` imports to avoid warnings (https://github.com/ansible-collections/kubernetes.core/pull/998).
|
||||||
|
- Update the ``k8s_cp`` module to also work for init containers (https://github.com/ansible-collections/kubernetes.core/pull/971).
|
||||||
|
- module_utils/k8s/service - hide fields first before creating diffs (https://github.com/ansible-collections/kubernetes.core/pull/915).
|
||||||
|
release_summary: This release includes bugfixes for k8s service field handling,
|
||||||
|
k8s_cp init containers support, and removes deprecated ansible.module_utils.six
|
||||||
|
imports.
|
||||||
|
fragments:
|
||||||
|
- 20250428-k8s-service-hide-fields-first.yaml
|
||||||
|
- 20250731-fix-k8s_cp-initcontainers.yaml
|
||||||
|
- 20250922-remove-ansible-six-imports.yaml
|
||||||
|
- 5.4.1.yml
|
||||||
|
release_date: '2025-10-07'
|
||||||
|
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 - Add ``release_values`` key to ``status`` return value that can be accessed
|
||||||
|
using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
- helm_info - Add ``release_values`` key to ``status`` return value that can
|
||||||
|
be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
release_summary: This release includes bugfixes such as replacing the passing
|
||||||
|
of ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` as well as a
|
||||||
|
security update for selectively redacting sensitive information from kubeconfig,
|
||||||
|
and adds a new ``release_values`` key to the ``status`` return value.
|
||||||
|
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'
|
||||||
|
5.4.3:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- ee - Add ``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_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).
|
||||||
|
release_summary: This release contains bugfixes such as improved idempotency
|
||||||
|
for helm repository URLs with trailing slashes.
|
||||||
|
fragments:
|
||||||
|
- 1173-security-check-workflow.yml
|
||||||
|
- 20260306-k8s_drain-delete-logic-fixes-for-daemonsets.yaml
|
||||||
|
- 20260506-improve_idempotency_for_helm_repository.yaml
|
||||||
|
- 5-4-3.yml
|
||||||
|
- fix-openshift-clients-ee-dependency.yaml
|
||||||
|
release_date: '2026-07-08'
|
||||||
|
5.4.4:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- meta - Update ``requires_ansible`` in ``runtime.yml`` and README to ``>=2.16.0``
|
||||||
|
to match the actual minimum supported ``ansible-core`` version (https://github.com/ansible-collections/kubernetes.core/pull/1193).
|
||||||
|
release_summary: This release corrects the documented and enforced minimum ``ansible-core``
|
||||||
|
version to ``>=2.16.0``.
|
||||||
|
release_date: '2026-07-09'
|
||||||
|
5.5.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_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).
|
||||||
|
- 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_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).
|
||||||
|
- 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).
|
||||||
|
release_summary: This minor release deprecates Ansible Turbo mode (``ENABLE_TURBO_MODE``),
|
||||||
|
the ``status.values`` return value of the ``helm`` and ``helm_info`` modules,
|
||||||
|
the ``wait_timeout`` parameter of the ``helm`` module, the ``return_code``
|
||||||
|
return value of the ``k8s_exec`` module, and the ``merge_type=json`` option
|
||||||
|
of the ``k8s_service`` module. It also includes bugfixes for ``helm_repository``
|
||||||
|
URL comparison and for empty template output handling in ``k8s_info``.
|
||||||
|
fragments:
|
||||||
|
- 1253-k8s-lookup-turbo-version-check.yml
|
||||||
|
- 20250108-fix-empty-template-output.yaml
|
||||||
|
- 20260723-remove-module-utils-six.yaml
|
||||||
|
- 20260908-helm-repository-trailing-slash.yaml
|
||||||
|
- 20260911-deprecate-status-values.yaml
|
||||||
|
- 20260911-update-deprecation-notices.yaml
|
||||||
|
- 5.5.0.yml
|
||||||
|
- deprecate-enable-turbo-mode.yml
|
||||||
|
- fix-ansible-lint-warnings.yaml
|
||||||
|
release_date: '2026-09-15'
|
||||||
|
6.0.0:
|
||||||
|
changes:
|
||||||
|
breaking_changes:
|
||||||
|
- Remove deprecated ``k8s`` invetory plugin (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
||||||
|
- Remove support for ``ansible-core<2.16`` (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
||||||
|
fragments:
|
||||||
|
- 20250121-breaking-changes-6.0.0.yml
|
||||||
|
release_date: '2025-05-19'
|
||||||
|
6.1.0:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- module_utils/k8s/service - hide fields first before creating diffs (https://github.com/ansible-collections/kubernetes.core/pull/915).
|
||||||
|
minor_changes:
|
||||||
|
- Module ``helm_registry_auth`` does not support idempotency with `helm >= 3.18.0`
|
||||||
|
(https://github.com/ansible-collections/kubernetes.core/pull/946).
|
||||||
|
- Module k8s_json_patch - Add support for ``hidden_fields`` (https://github.com/ansible-collections/kubernetes.core/pull/964).
|
||||||
|
- helm - Parameter plain_http added for working with insecure OCI registries
|
||||||
|
(https://github.com/ansible-collections/kubernetes.core/pull/934).
|
||||||
|
- helm - Parameter take_ownership added (https://github.com/ansible-collections/kubernetes.core/pull/957).
|
||||||
|
- helm_pull - Parameter plain_http added for working with insecure OCI registries
|
||||||
|
(https://github.com/ansible-collections/kubernetes.core/pull/934).
|
||||||
|
- helm_template - Parameter plain_http added for working with insecure OCI registries
|
||||||
|
(https://github.com/ansible-collections/kubernetes.core/pull/934).
|
||||||
|
release_summary: "This release adds ``plain_http`` and ``take_ownership`` parameters
|
||||||
|
for helm modules, support for ``hidden_fields`` in ``k8s_json_patch``, documented
|
||||||
|
lack of idempotency support in ``helm_registry_auth`` with ``helm \u2265 3.18.0``,
|
||||||
|
and improved ``k8s_rollback`` test coverage."
|
||||||
|
fragments:
|
||||||
|
- 20250411-kubeconfig-no_log-revert.yaml
|
||||||
|
- 20250428-k8s-service-hide-fields-first.yaml
|
||||||
|
- 20250522-add-plain-http-for-oci-registries.yaml
|
||||||
|
- 20250605-fix-helm_registry_auth-integration_test.yaml
|
||||||
|
- 20250704-k8s-rollback-integration-test-coverage.yaml
|
||||||
|
- 20250720-k8s-patch-add-hidden-fields.yaml
|
||||||
|
- 20250911-add-support-helm-take-ownership.yaml
|
||||||
|
- release_summary.yml
|
||||||
|
release_date: '2025-08-12'
|
||||||
|
6.2.0:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- Remove ``ansible.module_utils.six`` imports to avoid warnings (https://github.com/ansible-collections/kubernetes.core/pull/998).
|
||||||
|
- Update the ``k8s_cp`` module to also work for init containers (https://github.com/ansible-collections/kubernetes.core/pull/971).
|
||||||
|
minor_changes:
|
||||||
|
- Add support of skip-schema-validation in ``helm`` module (https://github.com/ansible-collections/kubernetes.core/pull/995)
|
||||||
|
- kustomize - Add support of local environ (https://github.com/ansible-collections/kubernetes.core/pull/786).
|
||||||
|
release_summary: This release adds minor changes and bugfixes, including support
|
||||||
|
of skip-schema-validation in ``helm`` module and removing deprecated ``ansible.module_utils.six``
|
||||||
|
imports.
|
||||||
|
fragments:
|
||||||
|
- 20241030-support-of-evrion-for-kustomize-lookup-plugin.yaml
|
||||||
|
- 20250731-fix-k8s_cp-initcontainers.yaml
|
||||||
|
- 20250916-skip-schema-validation.yaml
|
||||||
|
- 20250922-remove-ansible-six-imports.yaml
|
||||||
|
- 6_2_0.yml
|
||||||
|
release_date: '2025-10-07'
|
||||||
|
6.3.0:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- Add idempotency for ``helm_pull`` module (https://github.com/ansible-collections/kubernetes.core/pull/1055).
|
||||||
|
- Fixed a bug where setting ``K8S_AUTH_VERIFY_SSL=true`` (or any string value)
|
||||||
|
caused the value to be treated as a separate ``kubectl`` command argument.
|
||||||
|
(https://github.com/ansible-collections/kubernetes.core/pull/1049).
|
||||||
|
- Limit supported versions of Helm to <4.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/1039).
|
||||||
|
- Replace passing ``warnings`` to ``exit_json`` with ``AnsibleModule.warn``
|
||||||
|
in the ``k8s_drain``, ``k8s_rollback.py`` and ``k8s_scale.py`` modules as
|
||||||
|
it deprecated in ``ansible-core>=2.19.0`` and will be removed in ``ansible-core>=2.23.0``
|
||||||
|
(https://github.com/ansible-collections/kubernetes.core/pull/1033).
|
||||||
|
- k8s - Fix return block from the module documentation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
- meta - Add ``k8s_cluster_info``, ``k8s_json_patch`` and ``k8s_rollback`` to
|
||||||
|
k8s action group (https://github.com/ansible-collections/kubernetes.core/pull/992).
|
||||||
|
deprecated_features:
|
||||||
|
- helm - the ``status.values`` return value has been deprecated and will be
|
||||||
|
removed in a release after 2027-01-08. Use ``status.release_values`` instead
|
||||||
|
(https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
- helm_info - the ``status.values`` return value has been deprecated and will
|
||||||
|
be removed in a release after 2027-01-08. Use ``status.release_values`` instead
|
||||||
|
(https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
minor_changes:
|
||||||
|
- Remove deprecated import from ``ansible.module_utils._text`` (https://github.com/ansible-collections/kubernetes.core/pull/1053).
|
||||||
|
- helm - add ``release_values`` key to ``status`` return value that can be accessed
|
||||||
|
using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
- helm_info - add ``release_values`` key to ``status`` return value that can
|
||||||
|
be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
|
||||||
|
release_summary: This release includes bugfixes such as implementing idempotency
|
||||||
|
for the ``helm_pull`` module as well as a security update for selectively
|
||||||
|
redacting sensitive information from kubeconfig.
|
||||||
|
security_fixes:
|
||||||
|
- Selectively redact sensitive info from kubeconfig instead of applying blanket
|
||||||
|
``no_log=True`` (https://github.com/ansible-collections/kubernetes.core/pull/1014).
|
||||||
|
fragments:
|
||||||
|
- 1033-warnings-deprecations.yaml
|
||||||
|
- 20251002-fix-k8s-actiongroup.yaml
|
||||||
|
- 20251007-selective-kubeconfig-redaction.yaml
|
||||||
|
- 20251115-limit-versions-of-helm.yaml
|
||||||
|
- 20251220-fix-K8S_AUTH_VERIFY_SSL-in-kubectl-connecton-plugion.yaml
|
||||||
|
- 20251228-1053-remove-deprecated-import.yaml
|
||||||
|
- 20260107-add-idempodency-for-helm-pull.yaml
|
||||||
|
- 20260108-fix-sanity-failures.yml
|
||||||
|
- 6-3-0.yaml
|
||||||
|
release_date: '2026-02-03'
|
||||||
|
6.4.0:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- Helm - Allow taking ownership of existing Kubernetes resources on the first
|
||||||
|
installation of a Helm release. Previously, the ``take_ownership`` parameter
|
||||||
|
was always disabled during the initial install, preventing resource adoption
|
||||||
|
(https://github.com/ansible-collections/kubernetes.core/pull/1034).
|
||||||
|
minor_changes:
|
||||||
|
- helm_info - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- helm_plugin - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- helm_plugin_info - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- helm_pull - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- helm_registry_auth - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- helm_registry_auth - add new option plain_http to allow insecure http connection
|
||||||
|
when running ``helm registry login`` (https://github.com/ansible-collections/kubernetes.core/pull/1090).
|
||||||
|
- helm_repository - Ensure compatibility with Helm v4 (https://github.com/ansible-collections/kubernetes.core/issues/1038).
|
||||||
|
- k8s_drain - Add support for ``check_mode`` (https://github.com/ansible-collections/kubernetes.core/pull/1086).
|
||||||
|
- k8s_drain - Convert module warnings into informational displays when users
|
||||||
|
explicitly request the deletion of unmanaged pods, pods with local storage,
|
||||||
|
or those managed by a ``DaemonSet`` (https://github.com/ansible-collections/kubernetes.core/issues/1037).
|
||||||
|
release_summary: This release adds Helm v4 compatibility across the Helm modules
|
||||||
|
and improves ``k8s_drain`` with check mode. When you explicitly allow evicting
|
||||||
|
unmanaged pods, pods with local storage, or pods managed by a ``DaemonSet``,
|
||||||
|
those cases are reported as informational output instead of module warnings.
|
||||||
|
fragments:
|
||||||
|
- 20251224-take-ownership-helm-initialization.yaml
|
||||||
|
- 20260203-k8s_drain-warning-fixes.yaml
|
||||||
|
- 20260213-support-helm-v4-for-helm-plugin-modules.yaml
|
||||||
|
- release-6-4-0.yml
|
||||||
|
release_date: '2026-04-22'
|
||||||
|
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'
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
---
|
|
||||||
breaking_changes:
|
|
||||||
- Remove support for ``ansible-core<2.16`` (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
|
||||||
- Remove deprecated ``k8s`` invetory plugin (https://github.com/ansible-collections/kubernetes.core/pull/867).
|
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
bugfixes:
|
||||||
|
- helm - Remove `--plain-http` option from `helm diff upgrade`, as it is not supported by the helm-diff plugin (https://github.com/ansible-collections/kubernetes.core/pull/1232).
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
---
|
||||||
|
bugfixes:
|
||||||
|
- k8s, k8s_service - emit warnings through ``AnsibleModule.warn`` instead of putting them in the result dict that is unpacked into ``exit_json``/``fail_json``. Passing ``warnings`` that way is deprecated since ansible-core 2.19 and will be removed in 2.23, so every run that produced a warning (for example the "No meaningful diff was generated" hint, warnings returned by the Kubernetes API, or ``validate`` findings) also emitted a deprecation warning (https://github.com/ansible-collections/kubernetes.core/pull/1267).
|
||||||
|
- k8s - warnings raised while processing a multi-document manifest are now shown to the user. They were previously nested under ``result.results[*].warnings``, where ansible-core never picked them up, so they were silently dropped whenever more than one resource was processed (https://github.com/ansible-collections/kubernetes.core/pull/1267).
|
||||||
@@ -12,6 +12,20 @@ Following document provides overview of Ansible Turbo mode in ``kubernetes.core`
|
|||||||
:depth: 1
|
: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
|
Synopsis
|
||||||
--------
|
--------
|
||||||
- A brief introduction about Ansible Turbo mode in ``kuberentes.core`` collection.
|
- A brief introduction about Ansible Turbo mode in ``kuberentes.core`` collection.
|
||||||
@@ -20,8 +34,9 @@ Synopsis
|
|||||||
Requirements
|
Requirements
|
||||||
------------
|
------------
|
||||||
|
|
||||||
The following requirement is needed on the host that executes this module.
|
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)
|
- 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::
|
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::
|
||||||
|
|||||||
@@ -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.
|
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
|
Reporting an issue
|
||||||
==================
|
==================
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm (https://github.com/helm/helm/releases)
|
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
||||||
- yaml (https://pypi.org/project/PyYAML/)
|
- yaml (https://pypi.org/project/PyYAML/)
|
||||||
|
|
||||||
|
|
||||||
@@ -268,7 +268,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/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
|
.. raw:: html
|
||||||
|
|
||||||
@@ -410,6 +410,40 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
<br/>
|
<br/>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>release_values</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">dictionary</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.3.0</div>
|
||||||
|
</td>
|
||||||
|
<td>always</td>
|
||||||
|
<td>
|
||||||
|
<div>Dict of Values used to deploy.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>release_values</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">dictionary</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.3.0</div>
|
||||||
|
</td>
|
||||||
|
<td>always</td>
|
||||||
|
<td>
|
||||||
|
<div>Dict of Values used to deploy.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<td class="elbow-placeholder"> </td>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
@@ -465,12 +499,13 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
<b>values</b>
|
<b>values</b>
|
||||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
<div style="font-size: small">
|
<div style="font-size: small">
|
||||||
<span style="color: purple">string</span>
|
<span style="color: purple">dictionary</span>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>always</td>
|
<td>always</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Dict of Values used to deploy</div>
|
<div>Dict of Values used to deploy</div>
|
||||||
|
<div>This return value has been deprecated and will be removed in version 8.0.0. Use RV(status.release_values) instead.</div>
|
||||||
<br/>
|
<br/>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm (https://github.com/helm/helm/releases)
|
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
||||||
- yaml (https://pypi.org/project/PyYAML/)
|
- yaml (https://pypi.org/project/PyYAML/)
|
||||||
|
|
||||||
|
|
||||||
@@ -73,6 +73,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div>If set, the installation process deletes the installation on failure.</div>
|
<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>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -156,6 +157,29 @@ Parameters
|
|||||||
<div>Chart version to install. If this is not specified, the latest version is installed.</div>
|
<div>Chart version to install. If this is not specified, the latest version is installed.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</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>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -254,6 +278,30 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Helm option to force reinstall, ignore on new install.</div>
|
<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>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -289,6 +337,29 @@ Parameters
|
|||||||
<div>Provide a URL for accessing the API. Can also be specified via <code>K8S_AUTH_HOST</code> environment variable.</div>
|
<div>Provide a URL for accessing the API. Can also be specified via <code>K8S_AUTH_HOST</code> environment variable.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<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>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 5.3.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Skip tls certificate checks for the chart download.</div>
|
||||||
|
<div>Do not confuse with the <code>validate_certs</code> option.</div>
|
||||||
|
<div>This option is only available for helm >= 3.16.0.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: skip_tls_certs_check</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -307,6 +378,27 @@ Parameters
|
|||||||
<div style="font-size: small; color: darkgreen"><br/>aliases: kubeconfig_path</div>
|
<div style="font-size: small; color: darkgreen"><br/>aliases: kubeconfig_path</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>plain_http</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.1.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Use HTTP instead of HTTPS when working with OCI registries</div>
|
||||||
|
<div>Requires Helm >= 3.13.0</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -453,7 +545,9 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
<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>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>
|
<div>This feature requires helm diff >= 3.9.12.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@@ -475,6 +569,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div>When upgrading package, reset the values to the ones built into the chart.</div>
|
<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>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -494,8 +589,33 @@ Parameters
|
|||||||
</ul>
|
</ul>
|
||||||
</td>
|
</td>
|
||||||
<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>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>If <em>reset_values</em> is set to <code>True</code>, this is ignored.</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>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -578,6 +698,48 @@ Parameters
|
|||||||
<div>Skip custom resource definitions when installing or upgrading.</div>
|
<div>Skip custom resource definitions when installing or upgrading.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>skip_schema_validation</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.2.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Disables JSON schema validation for Chart and values.</div>
|
||||||
|
<div>This feature requires helm >= 3.16.0</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>take_ownership</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.1.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Helm will ignore the check for helm annotations and take ownership of the existing resources</div>
|
||||||
|
<div>This feature requires helm >= 3.17.0</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -677,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>
|
<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>
|
</td>
|
||||||
</tr>
|
</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>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -690,7 +874,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Timeout when wait option is enabled (helm2 is a number of seconds, helm3 is a duration).</div>
|
<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>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
@@ -787,6 +971,12 @@ Examples
|
|||||||
chart_ref: "https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz"
|
chart_ref: "https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz"
|
||||||
release_namespace: monitoring
|
release_namespace: monitoring
|
||||||
|
|
||||||
|
- name: Deploy Bitnami's MongoDB latest chart from OCI registry
|
||||||
|
kubernetes.core.helm:
|
||||||
|
name: test
|
||||||
|
chart_ref: "oci://registry-1.docker.io/bitnamicharts/mongodb"
|
||||||
|
release_namespace: database
|
||||||
|
|
||||||
# Using complex Values
|
# Using complex Values
|
||||||
- name: Deploy new-relic client chart
|
- name: Deploy new-relic client chart
|
||||||
kubernetes.core.helm:
|
kubernetes.core.helm:
|
||||||
@@ -795,6 +985,7 @@ Examples
|
|||||||
release_namespace: default
|
release_namespace: default
|
||||||
force: True
|
force: True
|
||||||
wait: True
|
wait: True
|
||||||
|
wait_for_jobs: True
|
||||||
replace: True
|
replace: True
|
||||||
update_repo_cache: True
|
update_repo_cache: True
|
||||||
disable_hook: True
|
disable_hook: True
|
||||||
@@ -814,21 +1005,37 @@ Examples
|
|||||||
enabled: True
|
enabled: True
|
||||||
|
|
||||||
# Deploy latest version
|
# 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
|
- name: Deploy latest version of Grafana chart using reuse_values
|
||||||
kubernetes.core.helm:
|
kubernetes.core.helm:
|
||||||
name: test
|
name: test
|
||||||
chart_ref: stable/grafana
|
chart_ref: stable/grafana
|
||||||
release_namespace: monitoring
|
release_namespace: monitoring
|
||||||
reuse_values: true
|
reuse_values: true
|
||||||
|
reset_values: false
|
||||||
values:
|
values:
|
||||||
replicas: 2
|
replicas: 2
|
||||||
version: 3e8ec0b2dffa40fb97d5342e4af887de95faa8c61a62480dd7f8aa03dffcf533
|
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
|
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:
|
||||||
|
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
|
.. raw:: html
|
||||||
|
|
||||||
@@ -934,6 +1141,23 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
<br/>
|
<br/>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>release_values</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">dictionary</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.3.0</div>
|
||||||
|
</td>
|
||||||
|
<td>always</td>
|
||||||
|
<td>
|
||||||
|
<div>Dict of Values used to deploy.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<td class="elbow-placeholder"> </td>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
@@ -989,12 +1213,13 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
<b>values</b>
|
<b>values</b>
|
||||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
<div style="font-size: small">
|
<div style="font-size: small">
|
||||||
<span style="color: purple">string</span>
|
<span style="color: purple">dictionary</span>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>always</td>
|
<td>always</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Dict of Values used to deploy</div>
|
<div>Dict of Values used to deploy.</div>
|
||||||
|
<div>This return value has been deprecated and will be removed in version 8.0.0. Use RV(status.release_values) instead.</div>
|
||||||
<br/>
|
<br/>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm (https://github.com/helm/helm/releases)
|
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
@@ -196,7 +196,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm (https://github.com/helm/helm/releases)
|
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
@@ -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>
|
<div>Provide a URL for accessing the API. Can also be specified via <code>K8S_AUTH_HOST</code> environment variable.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</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>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -231,6 +249,28 @@ Parameters
|
|||||||
<div style="font-size: small; color: darkgreen"><br/>aliases: verify_ssl</div>
|
<div style="font-size: small; color: darkgreen"><br/>aliases: verify_ssl</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>verify</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.4.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li>no</li>
|
||||||
|
<li><div style="color: blue"><b>yes</b> ←</div></li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Verify the plugin signature before installing.</div>
|
||||||
|
<div>This option requires helm version >= 4.0.0</div>
|
||||||
|
<div>Used with <em>state=present</em>.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
@@ -272,7 +312,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm >= 3.0 (https://github.com/helm/helm/releases)
|
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
@@ -174,6 +174,28 @@ Parameters
|
|||||||
<div>location to write the chart.</div>
|
<div>location to write the chart.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>force</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.3.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Force download of the chart even if it already exists in the destination directory.</div>
|
||||||
|
<div>By default, the module will skip downloading if the chart with the same version already exists for idempotency.</div>
|
||||||
|
<div>When used with O(untar_chart=true), will remove any existing chart directory before extracting.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -193,6 +215,27 @@ Parameters
|
|||||||
<div>Pass credentials to all domains.</div>
|
<div>Pass credentials to all domains.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>plain_http</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.1.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Use HTTP instead of HTTPS when working with OCI registries</div>
|
||||||
|
<div>Requires Helm >= 3.13.0</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -279,7 +322,8 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Whether or not to check tls certificate for the chart download.</div>
|
<div>Whether or not to check tls certificate for the chart download.</div>
|
||||||
<div>Requires helm >= 3.3.0.</div>
|
<div>Requires helm >= 3.3.0. Alias <code>insecure_skip_tls_verify</code> added in 5.3.0.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: insecure_skip_tls_verify</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -375,11 +419,28 @@ Examples
|
|||||||
username: myuser
|
username: myuser
|
||||||
password: mypassword123
|
password: mypassword123
|
||||||
|
|
||||||
|
- name: Download Chart (force re-download even if exists)
|
||||||
|
kubernetes.core.helm_pull:
|
||||||
|
chart_ref: redis
|
||||||
|
repo_url: https://charts.bitnami.com/bitnami
|
||||||
|
chart_version: '17.0.0'
|
||||||
|
destination: /path/to/chart
|
||||||
|
force: yes
|
||||||
|
|
||||||
|
- name: Download and untar chart (force re-extraction even if directory exists)
|
||||||
|
kubernetes.core.helm_pull:
|
||||||
|
chart_ref: redis
|
||||||
|
repo_url: https://charts.bitnami.com/bitnami
|
||||||
|
chart_version: '17.0.0'
|
||||||
|
destination: /path/to/chart
|
||||||
|
untar_chart: yes
|
||||||
|
force: yes
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
Common return values are documented `here <https://docs.ansible.com/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
|
.. raw:: html
|
||||||
|
|
||||||
@@ -406,6 +467,23 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">helm pull --repo test ...</div>
|
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">helm pull --repo test ...</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>msg</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>when chart already exists</td>
|
||||||
|
<td>
|
||||||
|
<div>A message indicating the result of the operation.</div>
|
||||||
|
<br/>
|
||||||
|
<div style="font-size: smaller"><b>Sample:</b></div>
|
||||||
|
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">Chart redis version 17.0.0 already exists in destination directory</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm (https://github.com/helm/helm/releases) => 3.8.0
|
- helm (https://github.com/helm/helm/releases) >= 3.8.0
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
@@ -151,6 +151,27 @@ Parameters
|
|||||||
<div style="font-size: small; color: darkgreen"><br/>aliases: repo_password</div>
|
<div style="font-size: small; color: darkgreen"><br/>aliases: repo_password</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>plain_http</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.4.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Use insecure HTTP connections for <code>helm registry login</code>.</div>
|
||||||
|
<div>Requires Helm >= 3.18.0</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -170,6 +191,7 @@ Parameters
|
|||||||
<div>Desired state of the registry.</div>
|
<div>Desired state of the registry.</div>
|
||||||
<div>If set to V(present) attempt to log in to the remote registry server using the URL specified in O(host).</div>
|
<div>If set to V(present) attempt to log in to the remote registry server using the URL specified in O(host).</div>
|
||||||
<div>If set to V(absent) attempt to log out from the remote registry server using the URL specified in O(host).</div>
|
<div>If set to V(absent) attempt to log out from the remote registry server using the URL specified in O(host).</div>
|
||||||
|
<div>As helm >= 3.18.0 reports successful logout even if the user is not logged in, this module will report a change regardless of the current state.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -214,7 +236,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
@@ -267,7 +289,9 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
</td>
|
</td>
|
||||||
<td>always</td>
|
<td>always</td>
|
||||||
<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/>
|
<br/>
|
||||||
<div style="font-size: smaller"><b>Sample:</b></div>
|
<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>
|
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">Login Succeeded\n</div>
|
||||||
@@ -299,14 +323,17 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
</td>
|
</td>
|
||||||
<td>always</td>
|
<td>always</td>
|
||||||
<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/>
|
<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>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
<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>
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
<div style="font-size: small">
|
<div style="font-size: small">
|
||||||
<span style="color: purple">list</span>
|
<span style="color: purple">list</span>
|
||||||
|
|||||||
@@ -25,7 +25,7 @@ Requirements
|
|||||||
------------
|
------------
|
||||||
The below requirements are needed on the host that executes this module.
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
- helm (https://github.com/helm/helm/releases)
|
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
||||||
- yaml (https://pypi.org/project/PyYAML/)
|
- yaml (https://pypi.org/project/PyYAML/)
|
||||||
|
|
||||||
|
|
||||||
@@ -143,6 +143,27 @@ Parameters
|
|||||||
<div>Provide a URL for accessing the API. Can also be specified via <code>K8S_AUTH_HOST</code> environment variable.</div>
|
<div>Provide a URL for accessing the API. Can also be specified via <code>K8S_AUTH_HOST</code> environment variable.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<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>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 5.3.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Skip tls certificate checks for the repository url.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: skip_tls_certs_check</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -315,7 +336,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -20,6 +20,13 @@ Synopsis
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
|
- helm >= 3.0.0 (https://github.com/helm/helm/releases)
|
||||||
|
- yaml (https://pypi.org/project/PyYAML/)
|
||||||
|
|
||||||
|
|
||||||
Parameters
|
Parameters
|
||||||
----------
|
----------
|
||||||
@@ -194,6 +201,27 @@ Parameters
|
|||||||
<div>If the directory already exists, it will be overwritten.</div>
|
<div>If the directory already exists, it will be overwritten.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>plain_http</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.1.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Use HTTP instead of HTTPS when working with OCI registries</div>
|
||||||
|
<div>Requires Helm >= 3.13.0</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -409,7 +437,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -416,7 +416,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. 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>
|
<div>The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>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>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -512,6 +531,8 @@ Notes
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
- the tar binary is required on the container when copying from local filesystem to pod.
|
- the tar binary is required on the container when copying from local filesystem to pod.
|
||||||
|
- 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.
|
- 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.
|
||||||
|
|
||||||
|
|
||||||
@@ -570,7 +591,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -627,7 +627,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -481,7 +481,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
@@ -535,7 +535,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
</td>
|
</td>
|
||||||
<td></td>
|
<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/>
|
<br/>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|||||||
@@ -174,8 +174,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Hide fields matching any of the field definitions in the result</div>
|
<div>Hide fields matching any of the field definitions in the result</div>
|
||||||
<div>An example might be <code>hidden_fields=[metadata.managedFields]</code></div>
|
<div>An example might be <code>hidden_fields=[metadata.managedFields]</code> or V(hidden_fields=[spec.containers[0].env[3].value]) or V(hidden_fields=[metadata.annotations[kubectl.kubernetes.io/last-applied-configuration]])</div>
|
||||||
<div>Only field definitions that don't reference list items are supported (so V(spec.containers[0]) would not work)</div>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -281,6 +280,29 @@ Parameters
|
|||||||
<div>List of label selectors to use to filter results</div>
|
<div>List of label selectors to use to filter results</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</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>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -702,11 +724,32 @@ 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
|
||||||
|
|
||||||
|
- name: Get a list of all pods metadata only
|
||||||
|
kubernetes.core.k8s_info:
|
||||||
|
kind: Pod
|
||||||
|
metadata_only: true
|
||||||
|
register: pod_metadata_list
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -140,6 +140,25 @@ Parameters
|
|||||||
<div>The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.</div>
|
<div>The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>hidden_fields</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">list</span>
|
||||||
|
/ <span style="color: purple">elements=string</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.1.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">[]</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>List of fields to hide from the diff output.</div>
|
||||||
|
<div>This is useful for fields that are not relevant to the patch operation, such as `metadata.managedFields`.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -621,7 +640,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -612,7 +612,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -38,13 +38,13 @@ Parameters
|
|||||||
|
|
||||||
<table border=0 cellpadding=0 class="documentation-table">
|
<table border=0 cellpadding=0 class="documentation-table">
|
||||||
<tr>
|
<tr>
|
||||||
<th colspan="1">Parameter</th>
|
<th colspan="2">Parameter</th>
|
||||||
<th>Choices/<font color="blue">Defaults</font></th>
|
<th>Choices/<font color="blue">Defaults</font></th>
|
||||||
<th>Configuration</th>
|
<th>Configuration</th>
|
||||||
<th width="100%">Comments</th>
|
<th width="100%">Comments</th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>api_key</b>
|
<b>api_key</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -61,7 +61,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>api_version</b>
|
<b>api_version</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -79,7 +79,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>ca_cert</b>
|
<b>ca_cert</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -97,7 +97,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>client_cert</b>
|
<b>client_cert</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -115,7 +115,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>client_key</b>
|
<b>client_key</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -133,7 +133,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>cluster_info</b>
|
<b>cluster_info</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -150,7 +150,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>context</b>
|
<b>context</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -167,7 +167,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>field_selector</b>
|
<b>field_selector</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -184,7 +184,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>host</b>
|
<b>host</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -201,7 +201,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>kind</b>
|
<b>kind</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -219,7 +219,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>kubeconfig</b>
|
<b>kubeconfig</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -236,7 +236,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>label_selector</b>
|
<b>label_selector</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -253,7 +253,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>namespace</b>
|
<b>namespace</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -270,7 +270,26 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<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>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>password</b>
|
<b>password</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -287,7 +306,101 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<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">
|
<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>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>resource_definition</b>
|
<b>resource_definition</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -304,7 +417,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>resource_name</b>
|
<b>resource_name</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -321,7 +434,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>src</b>
|
<b>src</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -339,7 +452,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>username</b>
|
<b>username</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -356,7 +469,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="2">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
<b>validate_certs</b>
|
<b>validate_certs</b>
|
||||||
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
@@ -432,7 +545,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -395,8 +395,7 @@ Parameters
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Hide fields matching this option in the result</div>
|
<div>Hide fields matching this option in the result</div>
|
||||||
<div>An example might be <code>hidden_fields=[metadata.managedFields]</code></div>
|
<div>An example might be <code>hidden_fields=[metadata.managedFields]</code> or V(hidden_fields=[spec.containers[0].env[3].value]) or V(hidden_fields=[metadata.annotations[kubectl.kubernetes.io/last-applied-configuration]])</div>
|
||||||
<div>Only field definitions that don't reference list items are supported (so V(spec.containers[0]) would not work)</div>
|
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -814,7 +813,7 @@ Parameters
|
|||||||
</ul>
|
</ul>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Determines if an object should be created, patched, or deleted. When set to <code>present</code>, an object will be created, if it does not already exist. If set to <code>absent</code>, an existing object will be deleted. If set to <code>present</code>, an existing object will be patched, if its attributes differ from those specified using <em>resource_definition</em> or <em>src</em>.</div>
|
<div>Determines if an object should be created, patched, or deleted. When set to <code>present</code>, an object will be created if it does not already exist, and an existing object will be patched if its attributes differ from those specified using <em>resource_definition</em> or <em>src</em>. If set to <code>absent</code>, an existing object will be deleted.</div>
|
||||||
<div><code>patched</code> state is an existing resource that has a given patch applied. If the resource doesn't exist, silently skip it (do not raise an error).</div>
|
<div><code>patched</code> state is an existing resource that has a given patch applied. If the resource doesn't exist, silently skip it (do not raise an error).</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@@ -1280,18 +1279,35 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
<table border=0 cellpadding=0 class="documentation-table">
|
<table border=0 cellpadding=0 class="documentation-table">
|
||||||
<tr>
|
<tr>
|
||||||
<th colspan="2">Key</th>
|
<th colspan="3">Key</th>
|
||||||
<th>Returned</th>
|
<th>Returned</th>
|
||||||
<th width="100%">Description</th>
|
<th width="100%">Description</th>
|
||||||
</tr>
|
</tr>
|
||||||
<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>
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
<b>result</b>
|
<b>result</b>
|
||||||
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
@@ -1307,6 +1323,105 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<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">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
<b>api_version</b>
|
<b>api_version</b>
|
||||||
@@ -1315,7 +1430,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
<span style="color: purple">string</span>
|
<span style="color: purple">string</span>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>success</td>
|
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||||
<td>
|
<td>
|
||||||
<div>The versioned schema of this representation of an object.</div>
|
<div>The versioned schema of this representation of an object.</div>
|
||||||
<br/>
|
<br/>
|
||||||
@@ -1323,6 +1438,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
<b>duration</b>
|
<b>duration</b>
|
||||||
@@ -1341,6 +1457,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
<b>error</b>
|
<b>error</b>
|
||||||
@@ -1357,21 +1474,6 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<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 class="elbow-placeholder"> </td>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
@@ -1381,7 +1483,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
<span style="color: purple">string</span>
|
<span style="color: purple">string</span>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>success</td>
|
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Represents the REST resource this object represents.</div>
|
<div>Represents the REST resource this object represents.</div>
|
||||||
<br/>
|
<br/>
|
||||||
@@ -1389,6 +1491,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
<b>metadata</b>
|
<b>metadata</b>
|
||||||
@@ -1397,7 +1500,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
<span style="color: purple">complex</span>
|
<span style="color: purple">complex</span>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>success</td>
|
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Standard object metadata. Includes name, namespace, annotations, labels, etc.</div>
|
<div>Standard object metadata. Includes name, namespace, annotations, labels, etc.</div>
|
||||||
<br/>
|
<br/>
|
||||||
@@ -1405,6 +1508,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
<b>spec</b>
|
<b>spec</b>
|
||||||
@@ -1413,7 +1517,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
<span style="color: purple">complex</span>
|
<span style="color: purple">complex</span>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
<td>success</td>
|
<td>when O(resource_definition) or O(src) contains a single object.</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Specific attributes of the object. Will vary based on the <em>api_version</em> and <em>kind</em>.</div>
|
<div>Specific attributes of the object. Will vary based on the <em>api_version</em> and <em>kind</em>.</div>
|
||||||
<br/>
|
<br/>
|
||||||
@@ -1421,6 +1525,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td class="elbow-placeholder"> </td>
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="return-"></div>
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
<b>status</b>
|
<b>status</b>
|
||||||
@@ -1429,7 +1534,40 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
|
|||||||
<span style="color: purple">complex</span>
|
<span style="color: purple">complex</span>
|
||||||
</div>
|
</div>
|
||||||
</td>
|
</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>
|
<td>
|
||||||
<div>Current status details for the object.</div>
|
<div>Current status details for the object.</div>
|
||||||
<br/>
|
<br/>
|
||||||
|
|||||||
@@ -503,7 +503,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -686,7 +686,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. 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>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>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>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>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -508,7 +509,7 @@ Parameters
|
|||||||
</ul>
|
</ul>
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<div>Determines if an object should be created, patched, or deleted. When set to <code>present</code>, an object will be created, if it does not already exist. If set to <code>absent</code>, an existing object will be deleted. If set to <code>present</code>, an existing object will be patched, if its attributes differ from those specified using <em>resource_definition</em> or <em>src</em>.</div>
|
<div>Determines if an object should be created, patched, or deleted. When set to <code>present</code>, an object will be created if it does not already exist, and an existing object will be patched if its attributes differ from those specified using <em>resource_definition</em> or <em>src</em>. If set to <code>absent</code>, an existing object will be deleted.</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -614,7 +615,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
@@ -541,7 +541,7 @@ Examples
|
|||||||
|
|
||||||
Return Values
|
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
|
.. 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
|
# and requires python to be installed in the image
|
||||||
- name: Run a command in a pod
|
- name: Run a command in a pod
|
||||||
ansible.builtin.command: echo "Hello, World!"
|
ansible.builtin.command: echo "Hello, World!"
|
||||||
|
changed_when: false
|
||||||
|
|
||||||
- name: Run a command in a pod using local kubectl with inventory variables
|
- name: Run a command in a pod using local kubectl with inventory variables
|
||||||
# Example inventory:
|
# Example inventory:
|
||||||
@@ -407,6 +408,7 @@ Examples
|
|||||||
# and requires python to be installed in the image
|
# and requires python to be installed in the image
|
||||||
- name: Run a command in a pod
|
- name: Run a command in a pod
|
||||||
ansible.builtin.command: echo "Hello, World!"
|
ansible.builtin.command: echo "Hello, World!"
|
||||||
|
changed_when: false
|
||||||
|
|
||||||
- name: Run a command in a pod using dynamic inventory
|
- name: Run a command in a pod using dynamic inventory
|
||||||
hosts: localhost
|
hosts: localhost
|
||||||
@@ -440,6 +442,7 @@ Examples
|
|||||||
# be aware that the command is executed as the user that started the container
|
# be aware that the command is executed as the user that started the container
|
||||||
# and requires python to be installed in the image
|
# and requires python to be installed in the image
|
||||||
ansible.builtin.command: echo "Hello, World!"
|
ansible.builtin.command: echo "Hello, World!"
|
||||||
|
changed_when: false
|
||||||
delegate_to: "{{ my_app_pod_name }}"
|
delegate_to: "{{ my_app_pod_name }}"
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -95,6 +95,26 @@ Parameters
|
|||||||
<div>Enable the helm chart inflation generator</div>
|
<div>Enable the helm chart inflation generator</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>environment</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">raw</span>
|
||||||
|
</div>
|
||||||
|
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.2.0</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">{}</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>The environment variables to pass to the kustomize or kubectl command.</div>
|
||||||
|
<div>This can be a dictionary or a string in the format key=value, multiple pairs separated by space.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="1">
|
<td colspan="1">
|
||||||
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
@@ -145,11 +165,19 @@ Examples
|
|||||||
kubernetes.core.k8s:
|
kubernetes.core.k8s:
|
||||||
definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization', enable_helm=True) }}"
|
definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization', enable_helm=True) }}"
|
||||||
|
|
||||||
|
- name: Create kubernetes resources for lookup output with environment variables in string format
|
||||||
|
kubernetes.core.k8s:
|
||||||
|
definition: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kubectl', environment='HTTP_PROXY=http://proxy.example.com:3128') }}"
|
||||||
|
|
||||||
|
- name: Create kubernetes resources for lookup output with environment variables in dict format
|
||||||
|
kubernetes.core.k8s:
|
||||||
|
definition: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kubectl', environment={'HTTP_PROXY': 'http://proxy.example.com:3128'}) }}"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
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
|
.. raw:: html
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -25,7 +25,7 @@ tags:
|
|||||||
- openshift
|
- openshift
|
||||||
- okd
|
- okd
|
||||||
- cluster
|
- cluster
|
||||||
version: 6.0.0-dev0
|
version: 7.0.0-dev0
|
||||||
build_ignore:
|
build_ignore:
|
||||||
- .DS_Store
|
- .DS_Store
|
||||||
- "*.tar.gz"
|
- "*.tar.gz"
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
kubernetes-client [platform:fedora]
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
version: 3
|
||||||
|
dependencies:
|
||||||
|
python: requirements.txt
|
||||||
|
system: meta/ee-bindep.txt
|
||||||
+17
-7
@@ -1,20 +1,31 @@
|
|||||||
---
|
---
|
||||||
requires_ansible: '>=2.16.0'
|
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:
|
action_groups:
|
||||||
helm:
|
helm:
|
||||||
- helm
|
- helm
|
||||||
- helm_info
|
- helm_info
|
||||||
|
- helm_plugin
|
||||||
|
- helm_plugin_info
|
||||||
- helm_repository
|
- helm_repository
|
||||||
k8s:
|
k8s:
|
||||||
- k8s
|
- k8s
|
||||||
- k8s_exec
|
- k8s_cluster_info
|
||||||
- k8s_info
|
|
||||||
- k8s_log
|
|
||||||
- k8s_scale
|
|
||||||
- k8s_service
|
|
||||||
- k8s_cp
|
- k8s_cp
|
||||||
- k8s_drain
|
- k8s_drain
|
||||||
|
- k8s_exec
|
||||||
|
- k8s_info
|
||||||
|
- k8s_json_patch
|
||||||
|
- k8s_log
|
||||||
|
- k8s_rollback
|
||||||
|
- k8s_scale
|
||||||
|
- k8s_service
|
||||||
|
- k8s_taint
|
||||||
|
|
||||||
plugin_routing:
|
plugin_routing:
|
||||||
inventory:
|
inventory:
|
||||||
@@ -22,8 +33,7 @@ plugin_routing:
|
|||||||
redirect: community.okd.openshift
|
redirect: community.okd.openshift
|
||||||
k8s:
|
k8s:
|
||||||
tombstone:
|
tombstone:
|
||||||
# To be replaced with 6.0.0 in release 6.0.0 commit
|
removal_version: 6.0.0
|
||||||
removal_version: 6.0.0-dev0
|
|
||||||
warning_text: >-
|
warning_text: >-
|
||||||
The k8s inventory plugin was slated for deprecation in 3.3.0 and has been removed in release 6.0.0. Use kubernetes.core.k8s_info and ansible.builtin.add_host instead.
|
The k8s inventory plugin was slated for deprecation in 3.3.0 and has been removed in release 6.0.0. Use kubernetes.core.k8s_info and ansible.builtin.add_host instead.
|
||||||
modules:
|
modules:
|
||||||
|
|||||||
@@ -20,9 +20,8 @@ from ansible.errors import (
|
|||||||
AnsibleError,
|
AnsibleError,
|
||||||
AnsibleFileNotFound,
|
AnsibleFileNotFound,
|
||||||
)
|
)
|
||||||
from ansible.module_utils._text import to_bytes, to_native, to_text
|
from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
|
||||||
from ansible.module_utils.parsing.convert_bool import boolean
|
from ansible.module_utils.parsing.convert_bool import boolean
|
||||||
from ansible.module_utils.six import iteritems, string_types
|
|
||||||
from ansible.plugins.action import ActionBase
|
from ansible.plugins.action import ActionBase
|
||||||
|
|
||||||
try:
|
try:
|
||||||
@@ -36,7 +35,11 @@ def _from_yaml_to_definition(buffer):
|
|||||||
import yaml
|
import yaml
|
||||||
except ImportError:
|
except ImportError:
|
||||||
raise AnsibleError("Failed to import the required Python library (PyYAML).")
|
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 ":"
|
ENV_KUBECONFIG_PATH_SEPARATOR = ";" if platform.system() == "Windows" else ":"
|
||||||
@@ -100,7 +103,7 @@ class ActionModule(ActionBase):
|
|||||||
"trim_blocks": True,
|
"trim_blocks": True,
|
||||||
"lstrip_blocks": False,
|
"lstrip_blocks": False,
|
||||||
}
|
}
|
||||||
if isinstance(template, string_types):
|
if isinstance(template, str):
|
||||||
# treat this as raw_params
|
# treat this as raw_params
|
||||||
template_param["path"] = template
|
template_param["path"] = template
|
||||||
elif isinstance(template, dict):
|
elif isinstance(template, dict):
|
||||||
@@ -120,7 +123,7 @@ class ActionModule(ActionBase):
|
|||||||
):
|
):
|
||||||
if s_type in template_args:
|
if s_type in template_args:
|
||||||
value = ensure_type(template_args[s_type], "string")
|
value = ensure_type(template_args[s_type], "string")
|
||||||
if value is not None and not isinstance(value, string_types):
|
if value is not None and not isinstance(value, str):
|
||||||
raise AnsibleActionFail(
|
raise AnsibleActionFail(
|
||||||
"%s is expected to be a string, but got %s instead"
|
"%s is expected to be a string, but got %s instead"
|
||||||
% (s_type, type(value))
|
% (s_type, type(value))
|
||||||
@@ -196,7 +199,7 @@ class ActionModule(ActionBase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
template_params = []
|
template_params = []
|
||||||
if isinstance(template, string_types) or isinstance(template, dict):
|
if isinstance(template, str) or isinstance(template, dict):
|
||||||
template_params.append(self.get_template_args(template))
|
template_params.append(self.get_template_args(template))
|
||||||
elif isinstance(template, list):
|
elif isinstance(template, list):
|
||||||
for element in template:
|
for element in template:
|
||||||
@@ -246,7 +249,7 @@ class ActionModule(ActionBase):
|
|||||||
# add ansible 'template' vars
|
# add ansible 'template' vars
|
||||||
temp_vars = copy.deepcopy(task_vars)
|
temp_vars = copy.deepcopy(task_vars)
|
||||||
overrides = {}
|
overrides = {}
|
||||||
for key, value in iteritems(template_item):
|
for key, value in template_item.items():
|
||||||
if hasattr(self._templar.environment, key):
|
if hasattr(self._templar.environment, key):
|
||||||
if value is not None:
|
if value is not None:
|
||||||
overrides[key] = value
|
overrides[key] = value
|
||||||
@@ -303,7 +306,7 @@ class ActionModule(ActionBase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def get_kubeconfig(self, kubeconfig, remote_transport, new_module_args):
|
def get_kubeconfig(self, kubeconfig, remote_transport, new_module_args):
|
||||||
if isinstance(kubeconfig, string_types):
|
if isinstance(kubeconfig, str):
|
||||||
# find the kubeconfig in the expected search path
|
# find the kubeconfig in the expected search path
|
||||||
if not remote_transport:
|
if not remote_transport:
|
||||||
# kubeconfig is local
|
# kubeconfig is local
|
||||||
@@ -381,10 +384,15 @@ class ActionModule(ActionBase):
|
|||||||
template = self._task.args.get("template", None)
|
template = self._task.args.get("template", None)
|
||||||
if template:
|
if template:
|
||||||
self.load_template(template, new_module_args, task_vars)
|
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")
|
local_path = self._task.args.get("local_path")
|
||||||
state = self._task.args.get("state", None)
|
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)
|
new_module_args["local_path"] = self.get_file_realpath(local_path)
|
||||||
|
|
||||||
# Execute the k8s_* module.
|
# Execute the k8s_* module.
|
||||||
|
|||||||
@@ -196,6 +196,7 @@ EXAMPLES = r"""
|
|||||||
# and requires python to be installed in the image
|
# and requires python to be installed in the image
|
||||||
- name: Run a command in a pod
|
- name: Run a command in a pod
|
||||||
ansible.builtin.command: echo "Hello, World!"
|
ansible.builtin.command: echo "Hello, World!"
|
||||||
|
changed_when: false
|
||||||
|
|
||||||
- name: Run a command in a pod using local kubectl with inventory variables
|
- name: Run a command in a pod using local kubectl with inventory variables
|
||||||
# Example inventory:
|
# Example inventory:
|
||||||
@@ -220,19 +221,20 @@ EXAMPLES = r"""
|
|||||||
# and requires python to be installed in the image
|
# and requires python to be installed in the image
|
||||||
- name: Run a command in a pod
|
- name: Run a command in a pod
|
||||||
ansible.builtin.command: echo "Hello, World!"
|
ansible.builtin.command: echo "Hello, World!"
|
||||||
|
changed_when: false
|
||||||
|
|
||||||
- name: Run a command in a pod using dynamic inventory
|
- name: Run a command in a pod using dynamic inventory
|
||||||
hosts: localhost
|
hosts: localhost
|
||||||
gather_facts: no
|
gather_facts: no
|
||||||
vars:
|
vars:
|
||||||
kubeconfig: /root/.kube/config
|
kubeconfig: /root/.kube/config
|
||||||
namespace: my-namespace
|
k8s_namespace: my-namespace
|
||||||
my_app: my-app
|
my_app: my-app
|
||||||
tasks:
|
tasks:
|
||||||
- name: Get My App pod info based on label
|
- name: Get My App pod info based on label
|
||||||
kubernetes.core.k8s_info:
|
kubernetes.core.k8s_info:
|
||||||
kubeconfig: "{{ kubeconfig }}"
|
kubeconfig: "{{ kubeconfig }}"
|
||||||
namespace: "{{ namespace }}"
|
namespace: "{{ k8s_namespace }}"
|
||||||
kind: Pod
|
kind: Pod
|
||||||
label_selectors: app.kubernetes.io/name = "{{ my_app }}"
|
label_selectors: app.kubernetes.io/name = "{{ my_app }}"
|
||||||
register: my_app_pod
|
register: my_app_pod
|
||||||
@@ -247,12 +249,13 @@ EXAMPLES = r"""
|
|||||||
ansible_connection: kubernetes.core.kubectl
|
ansible_connection: kubernetes.core.kubectl
|
||||||
ansible_kubectl_kubeconfig: "{{ kubeconfig }}"
|
ansible_kubectl_kubeconfig: "{{ kubeconfig }}"
|
||||||
ansible_kubectl_pod: "{{ my_app_pod_name }}"
|
ansible_kubectl_pod: "{{ my_app_pod_name }}"
|
||||||
ansible_kubectl_namespace: "{{ namespace }}"
|
ansible_kubectl_namespace: "{{ k8s_namespace }}"
|
||||||
|
|
||||||
- name: Run a command in My App pod
|
- name: Run a command in My App pod
|
||||||
# be aware that the command is executed as the user that started the container
|
# be aware that the command is executed as the user that started the container
|
||||||
# and requires python to be installed in the image
|
# and requires python to be installed in the image
|
||||||
ansible.builtin.command: echo "Hello, World!"
|
ansible.builtin.command: echo "Hello, World!"
|
||||||
|
changed_when: false
|
||||||
delegate_to: "{{ my_app_pod_name }}"
|
delegate_to: "{{ my_app_pod_name }}"
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -262,10 +265,11 @@ import os.path
|
|||||||
import shutil
|
import shutil
|
||||||
import subprocess
|
import subprocess
|
||||||
import tempfile
|
import tempfile
|
||||||
|
from shlex import quote as shlex_quote
|
||||||
|
|
||||||
from ansible.errors import AnsibleError, AnsibleFileNotFound
|
from ansible.errors import AnsibleError, AnsibleFileNotFound
|
||||||
from ansible.module_utils._text import to_bytes
|
from ansible.module_utils.common.text.converters import to_bytes
|
||||||
from ansible.module_utils.six.moves import shlex_quote
|
from ansible.module_utils.parsing.convert_bool import boolean
|
||||||
from ansible.parsing.yaml.loader import AnsibleLoader
|
from ansible.parsing.yaml.loader import AnsibleLoader
|
||||||
from ansible.plugins.connection import BUFSIZE, ConnectionBase
|
from ansible.plugins.connection import BUFSIZE, ConnectionBase
|
||||||
from ansible.utils.display import Display
|
from ansible.utils.display import Display
|
||||||
@@ -324,9 +328,12 @@ class Connection(ConnectionBase):
|
|||||||
# Build command options based on doc string
|
# Build command options based on doc string
|
||||||
doc_yaml = AnsibleLoader(self.documentation).get_single_data()
|
doc_yaml = AnsibleLoader(self.documentation).get_single_data()
|
||||||
for key in doc_yaml.get("options"):
|
for key in doc_yaml.get("options"):
|
||||||
if key.endswith("verify_ssl") and self.get_option(key) != "":
|
if key == "validate_certs" and self.get_option(key) != "":
|
||||||
# Translate verify_ssl to skip_verify_ssl, and output as string
|
# Translate validate_certs to --insecure-skip-tls-verify flag
|
||||||
skip_verify_ssl = not self.get_option(key)
|
# validate_certs=True means verify certs (don't skip verification)
|
||||||
|
# validate_certs=False means don't verify certs (skip verification)
|
||||||
|
validate_certs_value = boolean(self.get_option(key), strict=False)
|
||||||
|
skip_verify_ssl = not validate_certs_value
|
||||||
local_cmd.append(
|
local_cmd.append(
|
||||||
"{0}={1}".format(
|
"{0}={1}".format(
|
||||||
self.connection_options[key], str(skip_verify_ssl).lower()
|
self.connection_options[key], str(skip_verify_ssl).lower()
|
||||||
|
|||||||
@@ -16,9 +16,8 @@ options:
|
|||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Determines if an object should be created, patched, or deleted. When set to C(present), an object will be
|
- Determines if an object should be created, patched, or deleted. When set to C(present), an object will be
|
||||||
created, if it does not already exist. If set to C(absent), an existing object will be deleted. If set to
|
created if it does not already exist, and an existing object will be patched if its attributes differ from
|
||||||
C(present), an existing object will be patched, if its attributes differ from those specified using
|
those specified using I(resource_definition) or I(src). If set to C(absent), an existing object will be deleted.
|
||||||
I(resource_definition) or I(src).
|
|
||||||
type: str
|
type: str
|
||||||
default: present
|
default: present
|
||||||
choices: [ absent, present ]
|
choices: [ absent, present ]
|
||||||
|
|||||||
+69
-3
@@ -86,14 +86,48 @@ DOCUMENTATION = """
|
|||||||
description:
|
description:
|
||||||
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment
|
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment
|
||||||
variable.
|
variable.
|
||||||
|
no_proxy:
|
||||||
|
description:
|
||||||
|
- The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy.
|
||||||
|
Can also be specified via K8S_AUTH_NO_PROXY environment variable.
|
||||||
|
- Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
|
||||||
|
- This feature requires kubernetes>=19.15.0.
|
||||||
|
When kubernetes library is less than 19.15.0, it fails even if no_proxy is set correctly.
|
||||||
|
type: str
|
||||||
password:
|
password:
|
||||||
description:
|
description:
|
||||||
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment
|
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment
|
||||||
variable.
|
variable.
|
||||||
|
proxy:
|
||||||
|
description:
|
||||||
|
- The URL of an HTTP proxy to use for the connection. Can also be specified via K8S_AUTH_PROXY environment variable.
|
||||||
|
- Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
|
||||||
|
type: str
|
||||||
|
proxy_headers:
|
||||||
|
description:
|
||||||
|
- The Header used for the HTTP proxy.
|
||||||
|
- Documentation can be found here
|
||||||
|
U(https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers).
|
||||||
|
type: dict
|
||||||
|
suboptions:
|
||||||
|
proxy_basic_auth:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Colon-separated username:password for proxy basic authentication header.
|
||||||
|
- Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
|
||||||
|
basic_auth:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- Colon-separated username:password for basic authentication header.
|
||||||
|
- Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
|
||||||
|
user_agent:
|
||||||
|
type: str
|
||||||
|
description:
|
||||||
|
- String representing the user-agent you want, such as foo/1.0.
|
||||||
|
- Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
|
||||||
client_cert:
|
client_cert:
|
||||||
description:
|
description:
|
||||||
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE
|
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment
|
||||||
environment
|
|
||||||
variable.
|
variable.
|
||||||
aliases: [ cert_file ]
|
aliases: [ cert_file ]
|
||||||
client_key:
|
client_key:
|
||||||
@@ -175,28 +209,60 @@ RETURN = """
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
from collections.abc import KeysView
|
||||||
|
|
||||||
from ansible.errors import AnsibleError
|
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.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 (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
||||||
get_api_client,
|
get_api_client,
|
||||||
)
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.resource import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.resource import (
|
||||||
create_definitions,
|
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:
|
try:
|
||||||
enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE"))
|
enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE"))
|
||||||
except TypeError:
|
except TypeError:
|
||||||
enable_turbo_mode = False
|
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:
|
if enable_turbo_mode:
|
||||||
try:
|
try:
|
||||||
from ansible_collections.cloud.common.plugins.plugin_utils.turbo.lookup import (
|
from ansible_collections.cloud.common.plugins.plugin_utils.turbo.lookup import (
|
||||||
TurboLookupBase as LookupBase,
|
TurboLookupBase as LookupBase,
|
||||||
)
|
)
|
||||||
except ImportError:
|
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
|
from ansible.plugins.lookup import LookupBase # noqa: F401
|
||||||
else:
|
else:
|
||||||
from ansible.plugins.lookup import LookupBase # noqa: F401
|
from ansible.plugins.lookup import LookupBase # noqa: F401
|
||||||
|
|||||||
@@ -34,6 +34,13 @@ DOCUMENTATION = """
|
|||||||
description:
|
description:
|
||||||
- Enable the helm chart inflation generator
|
- Enable the helm chart inflation generator
|
||||||
default: "False"
|
default: "False"
|
||||||
|
environment:
|
||||||
|
description:
|
||||||
|
- The environment variables to pass to the kustomize or kubectl command.
|
||||||
|
- This can be a dictionary or a string in the format key=value, multiple pairs separated by space.
|
||||||
|
type: raw
|
||||||
|
default: {}
|
||||||
|
version_added: 6.2.0
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 3.6"
|
- "python >= 3.6"
|
||||||
@@ -55,6 +62,14 @@ EXAMPLES = """
|
|||||||
- name: Create kubernetes resources for lookup output with `--enable-helm` set
|
- name: Create kubernetes resources for lookup output with `--enable-helm` set
|
||||||
kubernetes.core.k8s:
|
kubernetes.core.k8s:
|
||||||
definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization', enable_helm=True) }}"
|
definition: "{{ lookup('kubernetes.core.kustomize', dir='/path/to/kustomization', enable_helm=True) }}"
|
||||||
|
|
||||||
|
- name: Create kubernetes resources for lookup output with environment variables in string format
|
||||||
|
kubernetes.core.k8s:
|
||||||
|
definition: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kubectl', environment='HTTP_PROXY=http://proxy.example.com:3128') }}"
|
||||||
|
|
||||||
|
- name: Create kubernetes resources for lookup output with environment variables in dict format
|
||||||
|
kubernetes.core.k8s:
|
||||||
|
definition: "{{ lookup('kubernetes.core.kustomize', binary_path='/path/to/kubectl', environment={'HTTP_PROXY': 'http://proxy.example.com:3128'}) }}"
|
||||||
"""
|
"""
|
||||||
|
|
||||||
RETURN = """
|
RETURN = """
|
||||||
@@ -72,6 +87,7 @@ RETURN = """
|
|||||||
key1: val1
|
key1: val1
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
from ansible.errors import AnsibleLookupError
|
from ansible.errors import AnsibleLookupError
|
||||||
@@ -92,8 +108,10 @@ def get_binary_from_path(name, opt_dirs=None):
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
def run_command(command):
|
def run_command(command, environ=None):
|
||||||
cmd = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
cmd = subprocess.Popen(
|
||||||
|
command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=environ
|
||||||
|
)
|
||||||
stdout, stderr = cmd.communicate()
|
stdout, stderr = cmd.communicate()
|
||||||
return cmd.returncode, stdout, stderr
|
return cmd.returncode, stdout, stderr
|
||||||
|
|
||||||
@@ -107,6 +125,7 @@ class LookupModule(LookupBase):
|
|||||||
binary_path=None,
|
binary_path=None,
|
||||||
opt_dirs=None,
|
opt_dirs=None,
|
||||||
enable_helm=False,
|
enable_helm=False,
|
||||||
|
environment=None,
|
||||||
**kwargs
|
**kwargs
|
||||||
):
|
):
|
||||||
executable_path = binary_path
|
executable_path = binary_path
|
||||||
@@ -141,7 +160,21 @@ class LookupModule(LookupBase):
|
|||||||
if enable_helm:
|
if enable_helm:
|
||||||
command += ["--enable-helm"]
|
command += ["--enable-helm"]
|
||||||
|
|
||||||
(ret, out, err) = run_command(command)
|
environ = None
|
||||||
|
if environment:
|
||||||
|
environ = os.environ.copy()
|
||||||
|
if isinstance(environment, str):
|
||||||
|
if not all(env.count("=") == 1 for env in environment.split(" ")):
|
||||||
|
raise AnsibleLookupError(
|
||||||
|
"environment should be dict or string in the format key=value, multiple pairs separated by space"
|
||||||
|
)
|
||||||
|
for env in environment.split(" "):
|
||||||
|
key, value = env.split("=")
|
||||||
|
environ[key] = value
|
||||||
|
if isinstance(environment, dict):
|
||||||
|
environ.update(environment)
|
||||||
|
|
||||||
|
(ret, out, err) = run_command(command, environ=environ)
|
||||||
if ret != 0:
|
if ret != 0:
|
||||||
if err:
|
if err:
|
||||||
raise AnsibleLookupError(
|
raise AnsibleLookupError(
|
||||||
|
|||||||
@@ -5,13 +5,39 @@ __metaclass__ = type
|
|||||||
|
|
||||||
import os
|
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.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:
|
try:
|
||||||
enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE"))
|
enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE"))
|
||||||
except TypeError:
|
except TypeError:
|
||||||
enable_turbo_mode = False
|
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:
|
if enable_turbo_mode:
|
||||||
try:
|
try:
|
||||||
from ansible_collections.cloud.common.plugins.module_utils.turbo.module import ( # noqa: F401
|
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"
|
AnsibleModule.collection_name = "kubernetes.core"
|
||||||
except ImportError:
|
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
|
from ansible.module_utils.basic import AnsibleModule # noqa: F401
|
||||||
else:
|
else:
|
||||||
from ansible.module_utils.basic import AnsibleModule # noqa: F401
|
from ansible.module_utils.basic import AnsibleModule # noqa: F401
|
||||||
|
|||||||
@@ -1,16 +1,64 @@
|
|||||||
from __future__ import absolute_import, division, print_function
|
from __future__ import absolute_import, division, print_function
|
||||||
|
|
||||||
from ansible.module_utils.six import string_types
|
|
||||||
|
|
||||||
__metaclass__ = type
|
__metaclass__ = type
|
||||||
|
|
||||||
|
import warnings
|
||||||
|
|
||||||
|
|
||||||
def list_dict_str(value):
|
def list_dict_str(value):
|
||||||
if isinstance(value, (list, dict, string_types)):
|
if isinstance(value, (list, dict, str)):
|
||||||
return value
|
return value
|
||||||
raise TypeError
|
raise TypeError
|
||||||
|
|
||||||
|
|
||||||
|
def extract_sensitive_values_from_kubeconfig(kubeconfig_data):
|
||||||
|
"""
|
||||||
|
Extract only sensitive string values from kubeconfig data for no_log_values.
|
||||||
|
|
||||||
|
:arg kubeconfig_data: Dictionary containing kubeconfig data
|
||||||
|
:returns: Set of sensitive string values to be added to no_log_values
|
||||||
|
"""
|
||||||
|
values = set()
|
||||||
|
sensitive_fields = {
|
||||||
|
"token",
|
||||||
|
"password",
|
||||||
|
"secret",
|
||||||
|
"client-key-data",
|
||||||
|
"client-certificate-data",
|
||||||
|
"certificate-authority-data",
|
||||||
|
"api_key",
|
||||||
|
"access-token",
|
||||||
|
"refresh-token",
|
||||||
|
}
|
||||||
|
|
||||||
|
# Check API version and warn if not v1
|
||||||
|
if isinstance(kubeconfig_data, dict):
|
||||||
|
api_version = kubeconfig_data.get("apiVersion", "v1")
|
||||||
|
if api_version != "v1":
|
||||||
|
warnings.warn(
|
||||||
|
f"Kubeconfig API version '{api_version}' is not 'v1'. "
|
||||||
|
f"Sensitive field redaction is only guaranteed for API version 'v1'. "
|
||||||
|
f"Some sensitive data may not be properly redacted from the logs.",
|
||||||
|
UserWarning,
|
||||||
|
)
|
||||||
|
|
||||||
|
def _extract_recursive(data, current_path=""):
|
||||||
|
if isinstance(data, dict):
|
||||||
|
for key, value in data.items():
|
||||||
|
path = f"{current_path}.{key}" if current_path else key
|
||||||
|
if key in sensitive_fields:
|
||||||
|
if isinstance(value, str):
|
||||||
|
values.add(value)
|
||||||
|
else:
|
||||||
|
_extract_recursive(value, path)
|
||||||
|
elif isinstance(data, list):
|
||||||
|
for i, item in enumerate(data):
|
||||||
|
_extract_recursive(item, f"{current_path}[{i}]")
|
||||||
|
|
||||||
|
_extract_recursive(kubeconfig_data)
|
||||||
|
return values
|
||||||
|
|
||||||
|
|
||||||
AUTH_PROXY_HEADERS_SPEC = dict(
|
AUTH_PROXY_HEADERS_SPEC = dict(
|
||||||
proxy_basic_auth=dict(type="str", no_log=True),
|
proxy_basic_auth=dict(type="str", no_log=True),
|
||||||
basic_auth=dict(type="str", no_log=True),
|
basic_auth=dict(type="str", no_log=True),
|
||||||
@@ -18,7 +66,7 @@ AUTH_PROXY_HEADERS_SPEC = dict(
|
|||||||
)
|
)
|
||||||
|
|
||||||
AUTH_ARG_SPEC = {
|
AUTH_ARG_SPEC = {
|
||||||
"kubeconfig": {"type": "raw", "no_log": True},
|
"kubeconfig": {"type": "raw"},
|
||||||
"context": {},
|
"context": {},
|
||||||
"host": {},
|
"host": {},
|
||||||
"api_key": {"no_log": True},
|
"api_key": {"no_log": True},
|
||||||
@@ -96,3 +144,18 @@ DELETE_OPTS_ARG_SPEC = {
|
|||||||
"options": {"resourceVersion": {"type": "str"}, "uid": {"type": "str"}},
|
"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"
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ import base64
|
|||||||
import os
|
import os
|
||||||
from tempfile import NamedTemporaryFile
|
from tempfile import NamedTemporaryFile
|
||||||
|
|
||||||
from ansible.module_utils._text import to_bytes, to_native, to_text
|
from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
|
||||||
from ansible.module_utils.urls import Request
|
from ansible.module_utils.urls import Request
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
|||||||
+202
-63
@@ -18,12 +18,14 @@ from __future__ import absolute_import, division, print_function
|
|||||||
__metaclass__ = type
|
__metaclass__ = type
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
import shlex
|
||||||
import tarfile
|
import tarfile
|
||||||
|
import time
|
||||||
from abc import ABCMeta, abstractmethod
|
from abc import ABCMeta, abstractmethod
|
||||||
from select import select
|
from select import select
|
||||||
from tempfile import NamedTemporaryFile, TemporaryFile
|
from tempfile import NamedTemporaryFile, TemporaryFile
|
||||||
|
|
||||||
from ansible.module_utils._text import to_native
|
from ansible.module_utils.common.text.converters import to_native
|
||||||
|
|
||||||
# from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import AnsibleModule
|
# from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import AnsibleModule
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
|
||||||
@@ -96,7 +98,7 @@ class K8SCopy(metaclass=ABCMeta):
|
|||||||
return error, stdout, stderr
|
return error, stdout, stderr
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
self.module.fail_json(
|
self.module.fail_json(
|
||||||
msg="Error while running/parsing from pod {1}/{2} command='{0}' : {3}".format(
|
msg="Error while running/parsing from pod {0}/{1} command='{2}' : {3}".format(
|
||||||
self.namespace, self.name, cmd, to_native(e)
|
self.namespace, self.name, cmd, to_native(e)
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
@@ -278,11 +280,15 @@ class K8SCopyFromPod(K8SCopy):
|
|||||||
def run(self):
|
def run(self):
|
||||||
self.files_to_copy = self.list_remote_files()
|
self.files_to_copy = self.list_remote_files()
|
||||||
if self.files_to_copy == []:
|
if self.files_to_copy == []:
|
||||||
|
# Using warn method instead of passing warnings to exit_json as it is
|
||||||
|
# deprecated in ansible-core>=2.19.0
|
||||||
|
self._module.warn(
|
||||||
|
"No file found from directory '{0}' into remote Pod.".format(
|
||||||
|
self.remote_path
|
||||||
|
)
|
||||||
|
)
|
||||||
self.module.exit_json(
|
self.module.exit_json(
|
||||||
changed=False,
|
changed=False,
|
||||||
warning="No file found from directory '{0}' into remote Pod.".format(
|
|
||||||
self.remote_path
|
|
||||||
),
|
|
||||||
)
|
)
|
||||||
self.copy()
|
self.copy()
|
||||||
|
|
||||||
@@ -292,14 +298,156 @@ class K8SCopyToPod(K8SCopy):
|
|||||||
Copy files/directory from local filesystem into remote Pod
|
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):
|
def __init__(self, module, client):
|
||||||
super(K8SCopyToPod, self).__init__(module, client)
|
super(K8SCopyToPod, self).__init__(module, client)
|
||||||
self.files_to_copy = list()
|
self.files_to_copy = list()
|
||||||
|
self.named_temp_file = None
|
||||||
|
self.copy_timeout = module.params.get("copy_timeout")
|
||||||
|
|
||||||
def close_temp_file(self):
|
def close_temp_file(self):
|
||||||
if self.named_temp_file:
|
if self.named_temp_file:
|
||||||
self.named_temp_file.close()
|
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):
|
def run(self):
|
||||||
# remove trailing slash from destination path
|
# remove trailing slash from destination path
|
||||||
dest_file = self.remote_path.rstrip("/")
|
dest_file = self.remote_path.rstrip("/")
|
||||||
@@ -332,65 +480,46 @@ class K8SCopyToPod(K8SCopy):
|
|||||||
dest_file = os.path.join(dest_file, os.path.basename(src_file))
|
dest_file = os.path.join(dest_file, os.path.basename(src_file))
|
||||||
|
|
||||||
if not self.check_mode:
|
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:
|
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:
|
with tarfile.open(fileobj=tar_buffer, mode="w") as tar:
|
||||||
tar.add(src_file, dest_file)
|
tar.add(src_file, dest_file)
|
||||||
|
archive_size = tar_buffer.tell()
|
||||||
tar_buffer.seek(0)
|
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 = [], []
|
command, wait_for_exit = self.remote_command(dest_file, archive_size)
|
||||||
while response.is_open():
|
response = stream(
|
||||||
if response.peek_stdout():
|
self.api_instance.connect_get_namespaced_pod_exec,
|
||||||
stdout.append(response.read_stdout().rstrip("\n"))
|
self.name,
|
||||||
if response.peek_stderr():
|
self.namespace,
|
||||||
stderr.append(response.read_stderr().rstrip("\n"))
|
command=command,
|
||||||
if commands:
|
stderr=True,
|
||||||
cmd = commands.pop(0)
|
stdin=True,
|
||||||
response.write_stdin(cmd)
|
stdout=True,
|
||||||
else:
|
tty=False,
|
||||||
break
|
_preload_content=False,
|
||||||
response.close()
|
**self.container_arg,
|
||||||
if stderr:
|
)
|
||||||
self.close_temp_file()
|
error, stdout, stderr = self._stream_tar_to_pod(
|
||||||
self.module.fail_json(
|
response, tar_buffer, wait_for_exit
|
||||||
command=tar_command,
|
)
|
||||||
msg="Failed to copy local file/directory into Pod due to: {0}".format(
|
|
||||||
"".join(stderr)
|
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()
|
self.close_temp_file()
|
||||||
if self.content:
|
if self.content:
|
||||||
self.module.exit_json(
|
self.module.exit_json(
|
||||||
@@ -435,11 +564,21 @@ def check_pod(svc):
|
|||||||
|
|
||||||
try:
|
try:
|
||||||
result = svc.client.get(resource, name=name, namespace=namespace)
|
result = svc.client.get(resource, name=name, namespace=namespace)
|
||||||
containers = [
|
containers = dict(
|
||||||
c["name"] for c in result.to_dict()["status"]["containerStatuses"]
|
{
|
||||||
]
|
c["name"]: c
|
||||||
if container and container not in containers:
|
for cl in ["initContainerStatuses", "containerStatuses"]
|
||||||
|
for c in result.to_dict()["status"].get(cl, [])
|
||||||
|
}
|
||||||
|
)
|
||||||
|
if container and container not in containers.keys():
|
||||||
module.fail_json(msg="Pod has no container {0}".format(container))
|
module.fail_json(msg="Pod has no container {0}".format(container))
|
||||||
return containers
|
if (
|
||||||
|
container
|
||||||
|
and container in containers
|
||||||
|
and not bool(containers[container].get("started", False))
|
||||||
|
):
|
||||||
|
module.fail_json(msg="Pod container {0} is not started".format(container))
|
||||||
|
return containers.keys()
|
||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
_fail(exc)
|
_fail(exc)
|
||||||
|
|||||||
@@ -15,7 +15,9 @@ import tempfile
|
|||||||
import traceback
|
import traceback
|
||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
||||||
from ansible.module_utils.six import string_types
|
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||||
|
extract_sensitive_values_from_kubeconfig,
|
||||||
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
||||||
LooseVersion,
|
LooseVersion,
|
||||||
)
|
)
|
||||||
@@ -30,6 +32,53 @@ except ImportError:
|
|||||||
HAS_YAML = False
|
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):
|
def parse_helm_plugin_list(output=None):
|
||||||
"""
|
"""
|
||||||
Parse `helm plugin list`, return list of plugins
|
Parse `helm plugin list`, return list of plugins
|
||||||
@@ -38,16 +87,20 @@ def parse_helm_plugin_list(output=None):
|
|||||||
if not output:
|
if not output:
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
|
parsing_grammar = None
|
||||||
for line in output:
|
for line in output:
|
||||||
if line.startswith("NAME"):
|
if line.startswith("NAME"):
|
||||||
|
parsing_grammar = [s.strip().lower() for s in line.split("\t")]
|
||||||
continue
|
continue
|
||||||
name, version, description = line.split("\t", 3)
|
if parsing_grammar is None:
|
||||||
name = name.strip()
|
|
||||||
version = version.strip()
|
|
||||||
description = description.strip()
|
|
||||||
if name == "":
|
|
||||||
continue
|
continue
|
||||||
ret.append((name, version, description))
|
plugin = {
|
||||||
|
parsing_grammar[i]: v.strip()
|
||||||
|
for i, v in enumerate(line.split("\t", len(parsing_grammar)))
|
||||||
|
}
|
||||||
|
if plugin["name"] == "":
|
||||||
|
continue
|
||||||
|
ret.append(plugin)
|
||||||
|
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
@@ -113,12 +166,19 @@ class AnsibleHelmModule(object):
|
|||||||
kubeconfig_content = None
|
kubeconfig_content = None
|
||||||
kubeconfig = self.params.get("kubeconfig")
|
kubeconfig = self.params.get("kubeconfig")
|
||||||
if kubeconfig:
|
if kubeconfig:
|
||||||
if isinstance(kubeconfig, string_types):
|
if isinstance(kubeconfig, str):
|
||||||
with open(os.path.expanduser(kubeconfig)) as fd:
|
with open(os.path.expanduser(kubeconfig)) as fd:
|
||||||
kubeconfig_content = yaml.safe_load(fd)
|
kubeconfig_content = yaml.safe_load(fd)
|
||||||
elif isinstance(kubeconfig, dict):
|
elif isinstance(kubeconfig, dict):
|
||||||
kubeconfig_content = kubeconfig
|
kubeconfig_content = kubeconfig
|
||||||
|
|
||||||
|
# Redact sensitive fields from kubeconfig for logging purposes
|
||||||
|
if kubeconfig_content:
|
||||||
|
# Add original sensitive values to no_log_values to prevent them from appearing in logs
|
||||||
|
self._module.no_log_values.update(
|
||||||
|
extract_sensitive_values_from_kubeconfig(kubeconfig_content)
|
||||||
|
)
|
||||||
|
|
||||||
if self.params.get("ca_cert"):
|
if self.params.get("ca_cert"):
|
||||||
ca_cert = self.params.get("ca_cert")
|
ca_cert = self.params.get("ca_cert")
|
||||||
if LooseVersion(self.get_helm_version()) < LooseVersion("3.5.0"):
|
if LooseVersion(self.get_helm_version()) < LooseVersion("3.5.0"):
|
||||||
@@ -193,6 +253,38 @@ class AnsibleHelmModule(object):
|
|||||||
return m.group(1)
|
return m.group(1)
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
def is_helm_v4(self):
|
||||||
|
helm_version = self.get_helm_version()
|
||||||
|
if helm_version is None:
|
||||||
|
return False
|
||||||
|
return LooseVersion(helm_version) >= LooseVersion("4.0.0")
|
||||||
|
|
||||||
|
def is_helm_version_compatible_with_helm_diff(self, helm_diff_version):
|
||||||
|
"""
|
||||||
|
Return true if the helm version is compatible with the helm diff version
|
||||||
|
Helm v4 requires helm diff v3.14.0
|
||||||
|
"""
|
||||||
|
if not helm_diff_version:
|
||||||
|
return False
|
||||||
|
if self.is_helm_v4():
|
||||||
|
return LooseVersion(helm_diff_version) >= LooseVersion("3.14.0")
|
||||||
|
return True
|
||||||
|
|
||||||
|
def validate_helm_version(self, version="3.0.0"):
|
||||||
|
"""
|
||||||
|
Validate that Helm version is >= version (default version=3.0.0).
|
||||||
|
"""
|
||||||
|
helm_version = self.get_helm_version()
|
||||||
|
if helm_version is None:
|
||||||
|
self.fail_json(msg="Unable to determine Helm version")
|
||||||
|
|
||||||
|
if LooseVersion(helm_version) < LooseVersion(version):
|
||||||
|
self.fail_json(
|
||||||
|
msg="Helm version must be >= {0}, current version is {1}".format(
|
||||||
|
version, helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
def get_values(self, release_name, get_all=False):
|
def get_values(self, release_name, get_all=False):
|
||||||
"""
|
"""
|
||||||
Get Values from deployed release
|
Get Values from deployed release
|
||||||
|
|||||||
@@ -16,7 +16,6 @@ HELM_AUTH_ARG_SPEC = dict(
|
|||||||
type="raw",
|
type="raw",
|
||||||
aliases=["kubeconfig_path"],
|
aliases=["kubeconfig_path"],
|
||||||
fallback=(env_fallback, ["K8S_AUTH_KUBECONFIG"]),
|
fallback=(env_fallback, ["K8S_AUTH_KUBECONFIG"]),
|
||||||
no_log=True,
|
|
||||||
),
|
),
|
||||||
host=dict(type="str", fallback=(env_fallback, ["K8S_AUTH_HOST"])),
|
host=dict(type="str", fallback=(env_fallback, ["K8S_AUTH_HOST"])),
|
||||||
ca_cert=dict(
|
ca_cert=dict(
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ import hashlib
|
|||||||
import os
|
import os
|
||||||
from typing import Any, Dict, List, Optional
|
from typing import Any, Dict, List, Optional
|
||||||
|
|
||||||
from ansible.module_utils.six import iteritems, string_types
|
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||||
AUTH_ARG_MAP,
|
AUTH_ARG_MAP,
|
||||||
AUTH_ARG_SPEC,
|
AUTH_ARG_SPEC,
|
||||||
@@ -115,7 +114,7 @@ def _load_config(auth: Dict) -> None:
|
|||||||
"persist_config": auth.get("persist_config"),
|
"persist_config": auth.get("persist_config"),
|
||||||
}
|
}
|
||||||
if kubeconfig:
|
if kubeconfig:
|
||||||
if isinstance(kubeconfig, string_types):
|
if isinstance(kubeconfig, str):
|
||||||
kubernetes.config.load_kube_config(config_file=kubeconfig, **optional_arg)
|
kubernetes.config.load_kube_config(config_file=kubeconfig, **optional_arg)
|
||||||
elif isinstance(kubeconfig, dict):
|
elif isinstance(kubeconfig, dict):
|
||||||
kubernetes.config.load_kube_config_from_dict(
|
kubernetes.config.load_kube_config_from_dict(
|
||||||
@@ -163,7 +162,7 @@ def _create_configuration(auth: Dict):
|
|||||||
except AttributeError:
|
except AttributeError:
|
||||||
configuration = kubernetes.client.Configuration()
|
configuration = kubernetes.client.Configuration()
|
||||||
|
|
||||||
for key, value in iteritems(auth):
|
for key, value in auth.items():
|
||||||
if key in AUTH_ARG_MAP.keys() and value is not None:
|
if key in AUTH_ARG_MAP.keys() and value is not None:
|
||||||
if key == "api_key":
|
if key == "api_key":
|
||||||
setattr(
|
setattr(
|
||||||
@@ -182,6 +181,7 @@ def _create_headers(module=None, **kwargs):
|
|||||||
header_map = {
|
header_map = {
|
||||||
"impersonate_user": "Impersonate-User",
|
"impersonate_user": "Impersonate-User",
|
||||||
"impersonate_groups": "Impersonate-Group",
|
"impersonate_groups": "Impersonate-Group",
|
||||||
|
"accept": "Accept",
|
||||||
}
|
}
|
||||||
|
|
||||||
headers = {}
|
headers = {}
|
||||||
|
|||||||
@@ -3,6 +3,9 @@ from typing import Optional
|
|||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
||||||
from ansible.module_utils.common.text.converters import to_text
|
from ansible.module_utils.common.text.converters import to_text
|
||||||
|
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||||
|
extract_sensitive_values_from_kubeconfig,
|
||||||
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
||||||
LooseVersion,
|
LooseVersion,
|
||||||
)
|
)
|
||||||
@@ -33,6 +36,15 @@ class AnsibleK8SModule:
|
|||||||
|
|
||||||
self._module = self.settings["module_class"](**kwargs)
|
self._module = self.settings["module_class"](**kwargs)
|
||||||
|
|
||||||
|
# Apply kubeconfig redaction for logging purposes
|
||||||
|
if hasattr(self._module, "params") and hasattr(self._module, "no_log_values"):
|
||||||
|
kubeconfig = self._module.params.get("kubeconfig")
|
||||||
|
if kubeconfig and isinstance(kubeconfig, dict):
|
||||||
|
# Add sensitive values to no_log_values to prevent them from appearing in logs
|
||||||
|
self._module.no_log_values.update(
|
||||||
|
extract_sensitive_values_from_kubeconfig(kubeconfig)
|
||||||
|
)
|
||||||
|
|
||||||
if self.settings["check_k8s"]:
|
if self.settings["check_k8s"]:
|
||||||
self.requires("kubernetes")
|
self.requires("kubernetes")
|
||||||
self.has_at_least("kubernetes", "24.2.0", warn=True)
|
self.has_at_least("kubernetes", "24.2.0", warn=True)
|
||||||
|
|||||||
@@ -4,7 +4,6 @@
|
|||||||
import os
|
import os
|
||||||
from typing import Dict, Iterable, List, Optional, Union, cast
|
from typing import Dict, Iterable, List, Optional, Union, cast
|
||||||
|
|
||||||
from ansible.module_utils.six import string_types
|
|
||||||
from ansible.module_utils.urls import Request
|
from ansible.module_utils.urls import Request
|
||||||
|
|
||||||
try:
|
try:
|
||||||
@@ -78,11 +77,11 @@ def create_definitions(params: Dict) -> List[ResourceDefinition]:
|
|||||||
def from_yaml(definition: Union[str, List, Dict]) -> Iterable[Dict]:
|
def from_yaml(definition: Union[str, List, Dict]) -> Iterable[Dict]:
|
||||||
"""Load resource definitions from a yaml definition."""
|
"""Load resource definitions from a yaml definition."""
|
||||||
definitions: List[Dict] = []
|
definitions: List[Dict] = []
|
||||||
if isinstance(definition, string_types):
|
if isinstance(definition, str):
|
||||||
definitions += yaml.safe_load_all(definition)
|
definitions += yaml.safe_load_all(definition)
|
||||||
elif isinstance(definition, list):
|
elif isinstance(definition, list):
|
||||||
for item in definition:
|
for item in definition:
|
||||||
if isinstance(item, string_types):
|
if isinstance(item, str):
|
||||||
definitions += yaml.safe_load_all(item)
|
definitions += yaml.safe_load_all(item)
|
||||||
else:
|
else:
|
||||||
definitions.append(item)
|
definitions.append(item)
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
|
|
||||||
from typing import Dict
|
from typing import Dict
|
||||||
|
|
||||||
from ansible.module_utils._text import to_native
|
from ansible.module_utils.common.text.converters import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
||||||
get_api_client,
|
get_api_client,
|
||||||
)
|
)
|
||||||
@@ -92,10 +92,10 @@ def run_module(module) -> None:
|
|||||||
|
|
||||||
for definition in definitions:
|
for definition in definitions:
|
||||||
result = {"changed": False, "result": {}}
|
result = {"changed": False, "result": {}}
|
||||||
warnings = []
|
|
||||||
|
|
||||||
if module.params.get("validate") is not None:
|
if module.params.get("validate") is not None:
|
||||||
warnings = validate(client, module, definition)
|
for warning in validate(client, module, definition):
|
||||||
|
module.warn(warning)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
result = perform_action(svc, definition, module.params)
|
result = perform_action(svc, definition, module.params)
|
||||||
@@ -109,16 +109,12 @@ def run_module(module) -> None:
|
|||||||
except AttributeError:
|
except AttributeError:
|
||||||
pass
|
pass
|
||||||
error["msg"] = to_native(e)
|
error["msg"] = to_native(e)
|
||||||
if warnings:
|
|
||||||
error.setdefault("warnings", []).extend(warnings)
|
|
||||||
|
|
||||||
if module.params.get("continue_on_error"):
|
if module.params.get("continue_on_error"):
|
||||||
result["error"] = error
|
result["error"] = error
|
||||||
else:
|
else:
|
||||||
module.fail_json(**error)
|
module.fail_json(**error)
|
||||||
|
|
||||||
if warnings:
|
|
||||||
result.setdefault("warnings", []).extend(warnings)
|
|
||||||
changed |= result["changed"]
|
changed |= result["changed"]
|
||||||
results.append(result)
|
results.append(result)
|
||||||
|
|
||||||
@@ -177,7 +173,7 @@ def perform_action(svc, definition: Dict, params: Dict) -> Dict:
|
|||||||
result["method"] = "apply"
|
result["method"] = "apply"
|
||||||
elif not existing:
|
elif not existing:
|
||||||
if state == "patched":
|
if state == "patched":
|
||||||
result.setdefault("warnings", []).append(
|
svc.module.warn(
|
||||||
"resource 'kind={kind},name={name}' was not found but will not be "
|
"resource 'kind={kind},name={name}' was not found but will not be "
|
||||||
"created as 'state' parameter has been set to '{state}'".format(
|
"created as 'state' parameter has been set to '{state}'".format(
|
||||||
kind=kind, name=definition["metadata"].get("name"), state=state
|
kind=kind, name=definition["metadata"].get("name"), state=state
|
||||||
@@ -194,8 +190,8 @@ def perform_action(svc, definition: Dict, params: Dict) -> Dict:
|
|||||||
instance, warnings = svc.update(resource, definition, existing)
|
instance, warnings = svc.update(resource, definition, existing)
|
||||||
result["method"] = "update"
|
result["method"] = "update"
|
||||||
|
|
||||||
if warnings:
|
for warning in warnings:
|
||||||
result["warnings"] = warnings
|
svc.module.warn(warning)
|
||||||
|
|
||||||
# If needed, wait and/or create diff
|
# If needed, wait and/or create diff
|
||||||
success = True
|
success = True
|
||||||
@@ -217,7 +213,7 @@ def perform_action(svc, definition: Dict, params: Dict) -> Dict:
|
|||||||
existing = {}
|
existing = {}
|
||||||
match, diffs = diff_objects(existing, instance, hidden_fields)
|
match, diffs = diff_objects(existing, instance, hidden_fields)
|
||||||
if match and diffs:
|
if match and diffs:
|
||||||
result.setdefault("warnings", []).append(
|
svc.module.warn(
|
||||||
"No meaningful diff was generated, but the API may not be idempotent "
|
"No meaningful diff was generated, but the API may not be idempotent "
|
||||||
"(only metadata.generation or metadata.resourceVersion were changed)"
|
"(only metadata.generation or metadata.resourceVersion were changed)"
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -498,8 +498,8 @@ def diff_objects(
|
|||||||
if not diff:
|
if not diff:
|
||||||
return True, result
|
return True, result
|
||||||
|
|
||||||
result["before"] = diff[0]
|
result["before"] = hide_fields(diff[0], hidden_fields)
|
||||||
result["after"] = diff[1]
|
result["after"] = hide_fields(diff[1], hidden_fields)
|
||||||
|
|
||||||
if list(result["after"].keys()) == ["metadata"] and list(
|
if list(result["after"].keys()) == ["metadata"] and list(
|
||||||
result["before"].keys()
|
result["before"].keys()
|
||||||
@@ -512,9 +512,6 @@ def diff_objects(
|
|||||||
).issubset(ignored_keys):
|
).issubset(ignored_keys):
|
||||||
return True, result
|
return True, result
|
||||||
|
|
||||||
result["before"] = hide_fields(result["before"], hidden_fields)
|
|
||||||
result["after"] = hide_fields(result["after"], hidden_fields)
|
|
||||||
|
|
||||||
return False, result
|
return False, result
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -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:
|
def daemonset_ready(daemonset: ResourceInstance) -> bool:
|
||||||
return bool(
|
return bool(
|
||||||
daemonset.status
|
daemonset.status
|
||||||
@@ -89,18 +101,18 @@ def custom_condition(condition: Dict, resource: ResourceInstance) -> bool:
|
|||||||
if not matches:
|
if not matches:
|
||||||
return False
|
return False
|
||||||
# There should never be more than one condition of a specific type
|
# There should never be more than one condition of a specific type
|
||||||
match: ResourceField = matches[0]
|
match_condition: ResourceField = matches[0]
|
||||||
if match.status == "Unknown":
|
if match_condition.status == "Unknown":
|
||||||
if match.status == condition["status"]:
|
if match_condition.status == condition["status"]:
|
||||||
if "reason" not in condition:
|
if "reason" not in condition:
|
||||||
return True
|
return True
|
||||||
if condition["reason"]:
|
if condition["reason"]:
|
||||||
return match.reason == condition["reason"]
|
return match_condition.reason == condition["reason"]
|
||||||
return False
|
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 status == boolean(condition["status"], strict=False):
|
||||||
if condition.get("reason"):
|
if condition.get("reason"):
|
||||||
return match.reason == condition["reason"]
|
return match_condition.reason == condition["reason"]
|
||||||
return True
|
return True
|
||||||
return False
|
return False
|
||||||
|
|
||||||
@@ -143,6 +155,7 @@ RESOURCE_PREDICATES = {
|
|||||||
"DaemonSet": daemonset_ready,
|
"DaemonSet": daemonset_ready,
|
||||||
"Deployment": deployment_ready,
|
"Deployment": deployment_ready,
|
||||||
"Pod": pod_ready,
|
"Pod": pod_ready,
|
||||||
|
"Job": job_complete,
|
||||||
"StatefulSet": statefulset_ready,
|
"StatefulSet": statefulset_ready,
|
||||||
"ClusterOperator": cluster_operator_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
|
||||||
@@ -15,4 +15,6 @@ __metaclass__ = type
|
|||||||
#
|
#
|
||||||
# from ansible.module_utils.compat.version import LooseVersion
|
# from ansible.module_utils.compat.version import LooseVersion
|
||||||
|
|
||||||
from ._version import LooseVersion # noqa: F401
|
from ._version import LooseVersion # noqa: F401 # pylint: disable=unused-import
|
||||||
|
|
||||||
|
__all__ = ["LooseVersion"]
|
||||||
|
|||||||
+460
-78
@@ -21,7 +21,7 @@ author:
|
|||||||
- Matthieu Diehr (@d-matt)
|
- Matthieu Diehr (@d-matt)
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "helm (https://github.com/helm/helm/releases)"
|
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
||||||
- "yaml (https://pypi.org/project/PyYAML/)"
|
- "yaml (https://pypi.org/project/PyYAML/)"
|
||||||
|
|
||||||
description:
|
description:
|
||||||
@@ -132,15 +132,19 @@ options:
|
|||||||
version_added: 2.4.0
|
version_added: 2.4.0
|
||||||
reuse_values:
|
reuse_values:
|
||||||
description:
|
description:
|
||||||
- When upgrading package, specifies wether to reuse the last release's values and merge in any overrides from parameters I(release_values),
|
- When upgrading package, specifies whether to reuse the last release's values and merge in any overrides from parameters O(release_values),
|
||||||
I(values_files) or I(set_values).
|
O(values_files) or O(set_values).
|
||||||
- If I(reset_values) is set to C(True), this is ignored.
|
- 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
|
type: bool
|
||||||
required: false
|
required: false
|
||||||
version_added: 3.0.0
|
version_added: 3.0.0
|
||||||
reset_values:
|
reset_values:
|
||||||
description:
|
description:
|
||||||
- When upgrading package, reset the values to the ones built into the chart.
|
- 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
|
type: bool
|
||||||
required: false
|
required: false
|
||||||
default: True
|
default: True
|
||||||
@@ -149,7 +153,10 @@ options:
|
|||||||
description:
|
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
|
- 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).
|
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.
|
- This feature requires helm diff >= 3.9.12.
|
||||||
type: bool
|
type: bool
|
||||||
required: false
|
required: false
|
||||||
@@ -165,6 +172,13 @@ options:
|
|||||||
force:
|
force:
|
||||||
description:
|
description:
|
||||||
- Helm option to force reinstall, ignore on new install.
|
- 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
|
default: False
|
||||||
type: bool
|
type: bool
|
||||||
purge:
|
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.
|
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
|
default: False
|
||||||
type: bool
|
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:
|
wait_timeout:
|
||||||
description:
|
description:
|
||||||
- Timeout when wait option is enabled (helm2 is a number of seconds, helm3 is a duration).
|
- 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
|
type: str
|
||||||
timeout:
|
timeout:
|
||||||
description:
|
description:
|
||||||
@@ -195,8 +218,44 @@ options:
|
|||||||
atomic:
|
atomic:
|
||||||
description:
|
description:
|
||||||
- If set, the installation process deletes the installation on failure.
|
- 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
|
type: bool
|
||||||
default: False
|
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:
|
create_namespace:
|
||||||
description:
|
description:
|
||||||
- Create the release namespace if not present.
|
- Create the release namespace if not present.
|
||||||
@@ -237,6 +296,27 @@ options:
|
|||||||
default: False
|
default: False
|
||||||
aliases: [ skip_tls_certs_check ]
|
aliases: [ skip_tls_certs_check ]
|
||||||
version_added: 5.3.0
|
version_added: 5.3.0
|
||||||
|
plain_http:
|
||||||
|
description:
|
||||||
|
- Use HTTP instead of HTTPS when working with OCI registries
|
||||||
|
- Requires Helm >= 3.13.0
|
||||||
|
type: bool
|
||||||
|
default: False
|
||||||
|
version_added: 6.1.0
|
||||||
|
take_ownership:
|
||||||
|
description:
|
||||||
|
- Helm will ignore the check for helm annotations and take ownership of the existing resources
|
||||||
|
- This feature requires helm >= 3.17.0
|
||||||
|
type: bool
|
||||||
|
default: False
|
||||||
|
version_added: 6.1.0
|
||||||
|
skip_schema_validation:
|
||||||
|
description:
|
||||||
|
- Disables JSON schema validation for Chart and values.
|
||||||
|
- This feature requires helm >= 3.16.0
|
||||||
|
type: bool
|
||||||
|
default: False
|
||||||
|
version_added: 6.2.0
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- kubernetes.core.helm_common_options
|
- kubernetes.core.helm_common_options
|
||||||
"""
|
"""
|
||||||
@@ -319,6 +399,12 @@ EXAMPLES = r"""
|
|||||||
chart_ref: "https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz"
|
chart_ref: "https://github.com/grafana/helm-charts/releases/download/grafana-5.6.0/grafana-5.6.0.tgz"
|
||||||
release_namespace: monitoring
|
release_namespace: monitoring
|
||||||
|
|
||||||
|
- name: Deploy Bitnami's MongoDB latest chart from OCI registry
|
||||||
|
kubernetes.core.helm:
|
||||||
|
name: test
|
||||||
|
chart_ref: "oci://registry-1.docker.io/bitnamicharts/mongodb"
|
||||||
|
release_namespace: database
|
||||||
|
|
||||||
# Using complex Values
|
# Using complex Values
|
||||||
- name: Deploy new-relic client chart
|
- name: Deploy new-relic client chart
|
||||||
kubernetes.core.helm:
|
kubernetes.core.helm:
|
||||||
@@ -327,6 +413,7 @@ EXAMPLES = r"""
|
|||||||
release_namespace: default
|
release_namespace: default
|
||||||
force: True
|
force: True
|
||||||
wait: True
|
wait: True
|
||||||
|
wait_for_jobs: True
|
||||||
replace: True
|
replace: True
|
||||||
update_repo_cache: True
|
update_repo_cache: True
|
||||||
disable_hook: True
|
disable_hook: True
|
||||||
@@ -346,15 +433,30 @@ EXAMPLES = r"""
|
|||||||
enabled: True
|
enabled: True
|
||||||
|
|
||||||
# Deploy latest version
|
# 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
|
- name: Deploy latest version of Grafana chart using reuse_values
|
||||||
kubernetes.core.helm:
|
kubernetes.core.helm:
|
||||||
name: test
|
name: test
|
||||||
chart_ref: stable/grafana
|
chart_ref: stable/grafana
|
||||||
release_namespace: monitoring
|
release_namespace: monitoring
|
||||||
reuse_values: true
|
reuse_values: true
|
||||||
|
reset_values: false
|
||||||
values:
|
values:
|
||||||
replicas: 2
|
replicas: 2
|
||||||
version: 3e8ec0b2dffa40fb97d5342e4af887de95faa8c61a62480dd7f8aa03dffcf533
|
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"""
|
RETURN = r"""
|
||||||
@@ -392,9 +494,18 @@ status:
|
|||||||
returned: always
|
returned: always
|
||||||
description: The Date of last update
|
description: The Date of last update
|
||||||
values:
|
values:
|
||||||
type: str
|
type: dict
|
||||||
returned: always
|
returned: always
|
||||||
description: Dict of Values used to deploy
|
description:
|
||||||
|
- Dict of Values used to deploy.
|
||||||
|
- 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
|
||||||
|
description:
|
||||||
|
- Dict of Values used to deploy.
|
||||||
|
version_added: 6.3.0
|
||||||
stdout:
|
stdout:
|
||||||
type: str
|
type: str
|
||||||
description: Full `helm` command stdout, in case you want to display it or examine the event log
|
description: Full `helm` command stdout, in case you want to display it or examine the event log
|
||||||
@@ -434,6 +545,7 @@ from ansible.module_utils.basic import missing_required_lib
|
|||||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
||||||
AnsibleHelmModule,
|
AnsibleHelmModule,
|
||||||
parse_helm_plugin_list,
|
parse_helm_plugin_list,
|
||||||
|
strip_registry_progress,
|
||||||
)
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common import (
|
||||||
HELM_AUTH_ARG_SPEC,
|
HELM_AUTH_ARG_SPEC,
|
||||||
@@ -464,9 +576,13 @@ def get_release_status(module, release_name, all_status=False):
|
|||||||
"--filter",
|
"--filter",
|
||||||
release_name,
|
release_name,
|
||||||
]
|
]
|
||||||
if all_status:
|
if all_status and not module.is_helm_v4():
|
||||||
|
# --all has been removed from `helm list` command on helm v4
|
||||||
list_command.append("--all")
|
list_command.append("--all")
|
||||||
|
elif not all_status:
|
||||||
|
# The default behavior to display only deployed releases has been removed from
|
||||||
|
# Helm v4
|
||||||
|
list_command.append("--deployed")
|
||||||
rc, out, err = module.run_helm_command(list_command)
|
rc, out, err = module.run_helm_command(list_command)
|
||||||
|
|
||||||
release = get_release(yaml.safe_load(out), release_name)
|
release = get_release(yaml.safe_load(out), release_name)
|
||||||
@@ -474,7 +590,15 @@ def get_release_status(module, release_name, all_status=False):
|
|||||||
if release is None: # not install
|
if release is None: # not install
|
||||||
return None
|
return None
|
||||||
|
|
||||||
release["values"] = module.get_values(release_name)
|
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
|
return release
|
||||||
|
|
||||||
@@ -495,7 +619,9 @@ def run_dep_update(module, chart_ref):
|
|||||||
rc, out, err = module.run_helm_command(dep_update)
|
rc, out, err = module.run_helm_command(dep_update)
|
||||||
|
|
||||||
|
|
||||||
def fetch_chart_info(module, command, chart_ref, insecure_skip_tls_verify=False):
|
def fetch_chart_info(
|
||||||
|
module, command, chart_ref, insecure_skip_tls_verify=False, plain_http=False
|
||||||
|
):
|
||||||
"""
|
"""
|
||||||
Get chart info
|
Get chart info
|
||||||
"""
|
"""
|
||||||
@@ -504,9 +630,65 @@ def fetch_chart_info(module, command, chart_ref, insecure_skip_tls_verify=False)
|
|||||||
if insecure_skip_tls_verify:
|
if insecure_skip_tls_verify:
|
||||||
inspect_command += " --insecure-skip-tls-verify"
|
inspect_command += " --insecure-skip-tls-verify"
|
||||||
|
|
||||||
|
if plain_http:
|
||||||
|
helm_version = module.get_helm_version()
|
||||||
|
if LooseVersion(helm_version) < LooseVersion("3.13.0"):
|
||||||
|
module.fail_json(
|
||||||
|
msg="plain_http requires helm >= 3.13.0, current version is {0}".format(
|
||||||
|
helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
inspect_command += " --plain-http"
|
||||||
|
|
||||||
rc, out, err = module.run_helm_command(inspect_command)
|
rc, out, err = module.run_helm_command(inspect_command)
|
||||||
|
|
||||||
return yaml.safe_load(out)
|
return yaml.safe_load(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(
|
def deploy(
|
||||||
@@ -516,12 +698,14 @@ def deploy(
|
|||||||
release_values,
|
release_values,
|
||||||
chart_name,
|
chart_name,
|
||||||
wait,
|
wait,
|
||||||
|
wait_for_jobs,
|
||||||
wait_timeout,
|
wait_timeout,
|
||||||
disable_hook,
|
disable_hook,
|
||||||
force,
|
force,
|
||||||
values_files,
|
values_files,
|
||||||
history_max,
|
history_max,
|
||||||
atomic=False,
|
atomic=False,
|
||||||
|
cleanup_on_fail=False,
|
||||||
create_namespace=False,
|
create_namespace=False,
|
||||||
replace=False,
|
replace=False,
|
||||||
post_renderer=None,
|
post_renderer=None,
|
||||||
@@ -533,6 +717,11 @@ def deploy(
|
|||||||
reset_values=True,
|
reset_values=True,
|
||||||
reset_then_reuse_values=False,
|
reset_then_reuse_values=False,
|
||||||
insecure_skip_tls_verify=False,
|
insecure_skip_tls_verify=False,
|
||||||
|
plain_http=False,
|
||||||
|
take_ownership=False,
|
||||||
|
skip_schema_validation=False,
|
||||||
|
server_side=None,
|
||||||
|
force_conflicts=False,
|
||||||
):
|
):
|
||||||
"""
|
"""
|
||||||
Install/upgrade/rollback release chart
|
Install/upgrade/rollback release chart
|
||||||
@@ -544,36 +733,99 @@ def deploy(
|
|||||||
deploy_command += " --dependency-update"
|
deploy_command += " --dependency-update"
|
||||||
else:
|
else:
|
||||||
deploy_command = command + " upgrade -i" # install/upgrade
|
deploy_command = command + " upgrade -i" # install/upgrade
|
||||||
|
if take_ownership:
|
||||||
|
deploy_command += " --take-ownership"
|
||||||
|
|
||||||
|
# '--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:
|
if reset_values:
|
||||||
deploy_command += " --reset-values"
|
deploy_command += " --reset-values"
|
||||||
|
|
||||||
if reuse_values is not None:
|
if reuse_values is not None:
|
||||||
deploy_command += " --reuse-values=" + str(reuse_values)
|
deploy_command += " --reuse-values=" + str(reuse_values)
|
||||||
|
|
||||||
if reset_then_reuse_values:
|
if reset_then_reuse_values:
|
||||||
helm_version = module.get_helm_version()
|
helm_version = module.get_helm_version()
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.14.0"):
|
if LooseVersion(helm_version) < LooseVersion("3.14.0"):
|
||||||
module.fail_json(
|
module.fail_json(
|
||||||
msg="reset_then_reuse_values requires helm >= 3.14.0, current version is {0}".format(
|
msg="reset_then_reuse_values requires helm >= 3.14.0, current version is {0}".format(
|
||||||
helm_version
|
helm_version
|
||||||
|
)
|
||||||
)
|
)
|
||||||
)
|
else:
|
||||||
else:
|
deploy_command += " --reset-then-reuse-values"
|
||||||
deploy_command += " --reset-then-reuse-values"
|
|
||||||
|
|
||||||
if wait:
|
if wait:
|
||||||
deploy_command += " --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:
|
if wait_timeout is not None:
|
||||||
deploy_command += " --timeout " + wait_timeout
|
deploy_command += " --timeout " + wait_timeout
|
||||||
|
|
||||||
if atomic:
|
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:
|
if timeout:
|
||||||
deploy_command += " --timeout " + 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:
|
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:
|
if replace:
|
||||||
deploy_command += " --replace"
|
deploy_command += " --replace"
|
||||||
@@ -595,6 +847,9 @@ def deploy(
|
|||||||
else:
|
else:
|
||||||
deploy_command += " --insecure-skip-tls-verify"
|
deploy_command += " --insecure-skip-tls-verify"
|
||||||
|
|
||||||
|
if plain_http:
|
||||||
|
deploy_command += " --plain-http"
|
||||||
|
|
||||||
if values_files:
|
if values_files:
|
||||||
for value_file in values_files:
|
for value_file in values_files:
|
||||||
deploy_command += " --values=" + value_file
|
deploy_command += " --values=" + value_file
|
||||||
@@ -618,6 +873,17 @@ def deploy(
|
|||||||
if set_value_args:
|
if set_value_args:
|
||||||
deploy_command += " " + set_value_args
|
deploy_command += " " + set_value_args
|
||||||
|
|
||||||
|
if skip_schema_validation:
|
||||||
|
helm_version = module.get_helm_version()
|
||||||
|
if LooseVersion(helm_version) < LooseVersion("3.16.0"):
|
||||||
|
module.fail_json(
|
||||||
|
msg="skip_schema_validation requires helm >= 3.16.0, current version is {0}".format(
|
||||||
|
helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
deploy_command += " --skip-schema-validation"
|
||||||
|
|
||||||
deploy_command += " " + release_name + f" '{chart_name}'"
|
deploy_command += " " + release_name + f" '{chart_name}'"
|
||||||
return deploy_command
|
return deploy_command
|
||||||
|
|
||||||
@@ -670,8 +936,8 @@ def get_plugin_version(plugin):
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
for line in out:
|
for line in out:
|
||||||
if line[0] == plugin:
|
if line["name"] == plugin:
|
||||||
return line[1]
|
return line["version"]
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
@@ -690,6 +956,7 @@ def helmdiff_check(
|
|||||||
reset_values=True,
|
reset_values=True,
|
||||||
reset_then_reuse_values=False,
|
reset_then_reuse_values=False,
|
||||||
insecure_skip_tls_verify=False,
|
insecure_skip_tls_verify=False,
|
||||||
|
skip_schema_validation=False,
|
||||||
):
|
):
|
||||||
"""
|
"""
|
||||||
Use helm diff to determine if a release would change by upgrading a chart.
|
Use helm diff to determine if a release would change by upgrading a chart.
|
||||||
@@ -721,10 +988,10 @@ def helmdiff_check(
|
|||||||
if set_value_args:
|
if set_value_args:
|
||||||
cmd += " " + set_value_args
|
cmd += " " + set_value_args
|
||||||
|
|
||||||
if reuse_values:
|
if not replace and reuse_values:
|
||||||
cmd += " --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_diff_version = get_plugin_version("diff")
|
||||||
helm_version = module.get_helm_version()
|
helm_version = module.get_helm_version()
|
||||||
fail_msg = ""
|
fail_msg = ""
|
||||||
@@ -745,6 +1012,17 @@ def helmdiff_check(
|
|||||||
if insecure_skip_tls_verify:
|
if insecure_skip_tls_verify:
|
||||||
cmd += " --insecure-skip-tls-verify"
|
cmd += " --insecure-skip-tls-verify"
|
||||||
|
|
||||||
|
if skip_schema_validation:
|
||||||
|
helm_version = module.get_helm_version()
|
||||||
|
if LooseVersion(helm_version) < LooseVersion("3.16.0"):
|
||||||
|
module.fail_json(
|
||||||
|
msg="skip_schema_validation requires helm >= 3.16.0, current version is {0}".format(
|
||||||
|
helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
cmd += " --skip-schema-validation"
|
||||||
|
|
||||||
rc, out, err = module.run_helm_command(cmd)
|
rc, out, err = module.run_helm_command(cmd)
|
||||||
return (len(out.strip()) > 0, out.strip())
|
return (len(out.strip()) > 0, out.strip())
|
||||||
|
|
||||||
@@ -776,39 +1054,58 @@ def default_check(release_status, chart_info, values=None, values_files=None):
|
|||||||
def argument_spec():
|
def argument_spec():
|
||||||
arg_spec = copy.deepcopy(HELM_AUTH_ARG_SPEC)
|
arg_spec = copy.deepcopy(HELM_AUTH_ARG_SPEC)
|
||||||
arg_spec.update(
|
arg_spec.update(
|
||||||
dict(
|
{
|
||||||
chart_ref=dict(type="path"),
|
"chart_ref": {"type": "path"},
|
||||||
chart_repo_url=dict(type="str"),
|
"chart_repo_url": {"type": "str"},
|
||||||
chart_version=dict(type="str"),
|
"chart_version": {"type": "str"},
|
||||||
dependency_update=dict(type="bool", default=False, aliases=["dep_up"]),
|
"dependency_update": {
|
||||||
release_name=dict(type="str", required=True, aliases=["name"]),
|
"type": "bool",
|
||||||
release_namespace=dict(type="str", required=True, aliases=["namespace"]),
|
"default": False,
|
||||||
release_state=dict(
|
"aliases": ["dep_up"],
|
||||||
default="present", choices=["present", "absent"], aliases=["state"]
|
},
|
||||||
),
|
"release_name": {"type": "str", "required": True, "aliases": ["name"]},
|
||||||
release_values=dict(type="dict", default={}, aliases=["values"]),
|
"release_namespace": {
|
||||||
values_files=dict(type="list", default=[], elements="str"),
|
"type": "str",
|
||||||
update_repo_cache=dict(type="bool", default=False),
|
"required": True,
|
||||||
disable_hook=dict(type="bool", default=False),
|
"aliases": ["namespace"],
|
||||||
force=dict(type="bool", default=False),
|
},
|
||||||
purge=dict(type="bool", default=True),
|
"release_state": {
|
||||||
wait=dict(type="bool", default=False),
|
"default": "present",
|
||||||
wait_timeout=dict(type="str"),
|
"choices": ["present", "absent"],
|
||||||
timeout=dict(type="str"),
|
"aliases": ["state"],
|
||||||
atomic=dict(type="bool", default=False),
|
},
|
||||||
create_namespace=dict(type="bool", default=False),
|
"release_values": {"type": "dict", "default": {}, "aliases": ["values"]},
|
||||||
post_renderer=dict(type="str"),
|
"values_files": {"type": "list", "default": [], "elements": "str"},
|
||||||
replace=dict(type="bool", default=False),
|
"update_repo_cache": {"type": "bool", "default": False},
|
||||||
skip_crds=dict(type="bool", default=False),
|
"disable_hook": {"type": "bool", "default": False},
|
||||||
history_max=dict(type="int"),
|
"force": {"type": "bool", "default": False},
|
||||||
set_values=dict(type="list", elements="dict"),
|
"purge": {"type": "bool", "default": True},
|
||||||
reuse_values=dict(type="bool"),
|
"wait": {"type": "bool", "default": False},
|
||||||
reset_values=dict(type="bool", default=True),
|
"wait_for_jobs": {"type": "bool", "default": False},
|
||||||
reset_then_reuse_values=dict(type="bool", default=False),
|
"wait_timeout": {"type": "str"},
|
||||||
insecure_skip_tls_verify=dict(
|
"timeout": {"type": "str"},
|
||||||
type="bool", default=False, aliases=["skip_tls_certs_check"]
|
"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
|
return arg_spec
|
||||||
|
|
||||||
@@ -825,13 +1122,26 @@ def main():
|
|||||||
("context", "ca_cert"),
|
("context", "ca_cert"),
|
||||||
("replace", "history_max"),
|
("replace", "history_max"),
|
||||||
("wait_timeout", "timeout"),
|
("wait_timeout", "timeout"),
|
||||||
|
("force", "server_side"),
|
||||||
|
("force", "force_conflicts"),
|
||||||
],
|
],
|
||||||
supports_check_mode=True,
|
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:
|
if not IMP_YAML:
|
||||||
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
||||||
|
|
||||||
|
# Validate Helm version >=3.0.0
|
||||||
|
module.validate_helm_version()
|
||||||
|
|
||||||
changed = False
|
changed = False
|
||||||
|
|
||||||
chart_ref = module.params.get("chart_ref")
|
chart_ref = module.params.get("chart_ref")
|
||||||
@@ -849,8 +1159,12 @@ def main():
|
|||||||
force = module.params.get("force")
|
force = module.params.get("force")
|
||||||
purge = module.params.get("purge")
|
purge = module.params.get("purge")
|
||||||
wait = module.params.get("wait")
|
wait = module.params.get("wait")
|
||||||
|
wait_for_jobs = module.params.get("wait_for_jobs")
|
||||||
wait_timeout = module.params.get("wait_timeout")
|
wait_timeout = module.params.get("wait_timeout")
|
||||||
atomic = module.params.get("atomic")
|
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")
|
create_namespace = module.params.get("create_namespace")
|
||||||
post_renderer = module.params.get("post_renderer")
|
post_renderer = module.params.get("post_renderer")
|
||||||
replace = module.params.get("replace")
|
replace = module.params.get("replace")
|
||||||
@@ -862,6 +1176,9 @@ def main():
|
|||||||
reset_values = module.params.get("reset_values")
|
reset_values = module.params.get("reset_values")
|
||||||
reset_then_reuse_values = module.params.get("reset_then_reuse_values")
|
reset_then_reuse_values = module.params.get("reset_then_reuse_values")
|
||||||
insecure_skip_tls_verify = module.params.get("insecure_skip_tls_verify")
|
insecure_skip_tls_verify = module.params.get("insecure_skip_tls_verify")
|
||||||
|
plain_http = module.params.get("plain_http")
|
||||||
|
take_ownership = module.params.get("take_ownership")
|
||||||
|
skip_schema_validation = module.params.get("skip_schema_validation")
|
||||||
|
|
||||||
if update_repo_cache:
|
if update_repo_cache:
|
||||||
run_repo_update(module)
|
run_repo_update(module)
|
||||||
@@ -871,6 +1188,33 @@ def main():
|
|||||||
release_status = get_release_status(module, release_name, all_status=all_status)
|
release_status = get_release_status(module, release_name, all_status=all_status)
|
||||||
|
|
||||||
helm_cmd = module.get_helm_binary()
|
helm_cmd = module.get_helm_binary()
|
||||||
|
|
||||||
|
if plain_http:
|
||||||
|
helm_version = module.get_helm_version()
|
||||||
|
if LooseVersion(helm_version) < LooseVersion("3.13.0"):
|
||||||
|
module.fail_json(
|
||||||
|
msg="plain_http requires helm >= 3.13.0, current version is {0}".format(
|
||||||
|
helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
if take_ownership:
|
||||||
|
helm_version = module.get_helm_version()
|
||||||
|
if LooseVersion(helm_version) < LooseVersion("3.17.0"):
|
||||||
|
module.fail_json(
|
||||||
|
msg="take_ownership requires helm >= 3.17.0, current version is {0}".format(
|
||||||
|
helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
if skip_schema_validation:
|
||||||
|
helm_version = module.get_helm_version()
|
||||||
|
if LooseVersion(helm_version) < LooseVersion("3.16.0"):
|
||||||
|
module.fail_json(
|
||||||
|
msg="skip_schema_validation requires helm >= 3.16.0, current version is {0}".format(
|
||||||
|
helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
opt_result = {}
|
opt_result = {}
|
||||||
if release_state == "absent" and release_status is not None:
|
if release_state == "absent" and release_status is not None:
|
||||||
# skip release statuses 'uninstalled' and 'uninstalling'
|
# skip release statuses 'uninstalled' and 'uninstalling'
|
||||||
@@ -881,8 +1225,7 @@ def main():
|
|||||||
if wait:
|
if wait:
|
||||||
helm_version = module.get_helm_version()
|
helm_version = module.get_helm_version()
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.7.0"):
|
if LooseVersion(helm_version) < LooseVersion("3.7.0"):
|
||||||
opt_result["warnings"] = []
|
module.warn(
|
||||||
opt_result["warnings"].append(
|
|
||||||
"helm uninstall support option --wait for helm release >= 3.7.0"
|
"helm uninstall support option --wait for helm release >= 3.7.0"
|
||||||
)
|
)
|
||||||
wait = False
|
wait = False
|
||||||
@@ -892,6 +1235,10 @@ def main():
|
|||||||
)
|
)
|
||||||
changed = True
|
changed = True
|
||||||
elif release_state == "present":
|
elif release_state == "present":
|
||||||
|
validate_value_options(
|
||||||
|
module, replace, reuse_values, reset_values, reset_then_reuse_values
|
||||||
|
)
|
||||||
|
|
||||||
if chart_version is not None:
|
if chart_version is not None:
|
||||||
helm_cmd += " --version=" + chart_version
|
helm_cmd += " --version=" + chart_version
|
||||||
|
|
||||||
@@ -900,7 +1247,7 @@ def main():
|
|||||||
|
|
||||||
# Fetch chart info to have real version and real name for chart_ref from archive, folder or url
|
# Fetch chart info to have real version and real name for chart_ref from archive, folder or url
|
||||||
chart_info = fetch_chart_info(
|
chart_info = fetch_chart_info(
|
||||||
module, helm_cmd, chart_ref, insecure_skip_tls_verify
|
module, helm_cmd, chart_ref, insecure_skip_tls_verify, plain_http
|
||||||
)
|
)
|
||||||
|
|
||||||
if dependency_update:
|
if dependency_update:
|
||||||
@@ -945,11 +1292,15 @@ def main():
|
|||||||
release_values,
|
release_values,
|
||||||
chart_ref,
|
chart_ref,
|
||||||
wait,
|
wait,
|
||||||
|
wait_for_jobs,
|
||||||
wait_timeout,
|
wait_timeout,
|
||||||
disable_hook,
|
disable_hook,
|
||||||
False,
|
False,
|
||||||
values_files=values_files,
|
values_files=values_files,
|
||||||
atomic=atomic,
|
atomic=atomic,
|
||||||
|
cleanup_on_fail=cleanup_on_fail,
|
||||||
|
server_side=server_side,
|
||||||
|
force_conflicts=force_conflicts,
|
||||||
create_namespace=create_namespace,
|
create_namespace=create_namespace,
|
||||||
post_renderer=post_renderer,
|
post_renderer=post_renderer,
|
||||||
replace=replace,
|
replace=replace,
|
||||||
@@ -962,19 +1313,29 @@ def main():
|
|||||||
reset_values=reset_values,
|
reset_values=reset_values,
|
||||||
reset_then_reuse_values=reset_then_reuse_values,
|
reset_then_reuse_values=reset_then_reuse_values,
|
||||||
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
||||||
|
plain_http=plain_http,
|
||||||
|
take_ownership=take_ownership,
|
||||||
|
skip_schema_validation=skip_schema_validation,
|
||||||
)
|
)
|
||||||
changed = True
|
changed = True
|
||||||
|
|
||||||
else:
|
else:
|
||||||
helm_diff_version = get_plugin_version("diff")
|
helm_diff_version = get_plugin_version("diff")
|
||||||
if helm_diff_version and (
|
helm_version_compatible = module.is_helm_version_compatible_with_helm_diff(
|
||||||
not chart_repo_url
|
helm_diff_version
|
||||||
or (
|
)
|
||||||
chart_repo_url
|
if (
|
||||||
and LooseVersion(helm_diff_version) >= LooseVersion("3.4.1")
|
helm_diff_version
|
||||||
|
and helm_version_compatible
|
||||||
|
and (
|
||||||
|
not chart_repo_url
|
||||||
|
or (
|
||||||
|
chart_repo_url
|
||||||
|
and LooseVersion(helm_diff_version) >= LooseVersion("3.4.1")
|
||||||
|
)
|
||||||
)
|
)
|
||||||
):
|
):
|
||||||
(would_change, prepared) = helmdiff_check(
|
would_change, prepared = helmdiff_check(
|
||||||
module,
|
module,
|
||||||
release_name,
|
release_name,
|
||||||
chart_ref,
|
chart_ref,
|
||||||
@@ -989,14 +1350,23 @@ def main():
|
|||||||
reset_values=reset_values,
|
reset_values=reset_values,
|
||||||
reset_then_reuse_values=reset_then_reuse_values,
|
reset_then_reuse_values=reset_then_reuse_values,
|
||||||
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
||||||
|
skip_schema_validation=skip_schema_validation,
|
||||||
)
|
)
|
||||||
if would_change and module._diff:
|
if would_change and module._diff:
|
||||||
opt_result["diff"] = {"prepared": prepared}
|
opt_result["diff"] = {"prepared": prepared}
|
||||||
else:
|
else:
|
||||||
module.warn(
|
if helm_diff_version and not helm_version_compatible:
|
||||||
"The default idempotency check can fail to report changes in certain cases. "
|
module.warn(
|
||||||
"Install helm diff >= 3.4.1 for better results."
|
"Idempotency checks are currently disabled due to a version mismatch."
|
||||||
)
|
f" Helm version {module.get_helm_version()} requires helm-diff >= 3.14.0,"
|
||||||
|
f" but the environment is currently running {helm_diff_version}."
|
||||||
|
" Please align the plugin versions to restore standard behavior."
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
module.warn(
|
||||||
|
"The default idempotency check can fail to report changes in certain cases. "
|
||||||
|
"Install helm diff >= 3.4.1 for better results."
|
||||||
|
)
|
||||||
would_change = default_check(
|
would_change = default_check(
|
||||||
release_status, chart_info, release_values, values_files
|
release_status, chart_info, release_values, values_files
|
||||||
)
|
)
|
||||||
@@ -1009,11 +1379,15 @@ def main():
|
|||||||
release_values,
|
release_values,
|
||||||
chart_ref,
|
chart_ref,
|
||||||
wait,
|
wait,
|
||||||
|
wait_for_jobs,
|
||||||
wait_timeout,
|
wait_timeout,
|
||||||
disable_hook,
|
disable_hook,
|
||||||
force,
|
force,
|
||||||
values_files=values_files,
|
values_files=values_files,
|
||||||
atomic=atomic,
|
atomic=atomic,
|
||||||
|
cleanup_on_fail=cleanup_on_fail,
|
||||||
|
server_side=server_side,
|
||||||
|
force_conflicts=force_conflicts,
|
||||||
create_namespace=create_namespace,
|
create_namespace=create_namespace,
|
||||||
post_renderer=post_renderer,
|
post_renderer=post_renderer,
|
||||||
replace=replace,
|
replace=replace,
|
||||||
@@ -1026,14 +1400,22 @@ def main():
|
|||||||
reset_values=reset_values,
|
reset_values=reset_values,
|
||||||
reset_then_reuse_values=reset_then_reuse_values,
|
reset_then_reuse_values=reset_then_reuse_values,
|
||||||
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
insecure_skip_tls_verify=insecure_skip_tls_verify,
|
||||||
|
plain_http=plain_http,
|
||||||
|
take_ownership=take_ownership,
|
||||||
|
skip_schema_validation=skip_schema_validation,
|
||||||
)
|
)
|
||||||
changed = True
|
changed = True
|
||||||
|
|
||||||
if module.check_mode:
|
if module.check_mode:
|
||||||
check_status = {"values": {"current": {}, "declared": {}}}
|
check_status = {
|
||||||
|
"values": {"current": {}, "declared": {}},
|
||||||
|
"release_values": {"current": {}, "declared": {}},
|
||||||
|
}
|
||||||
if release_status:
|
if release_status:
|
||||||
check_status["values"]["current"] = release_status["values"]
|
check_status["values"]["current"] = release_status["release_values"]
|
||||||
check_status["values"]["declared"] = release_status
|
check_status["values"]["declared"] = release_status
|
||||||
|
check_status["release_values"]["current"] = release_status["release_values"]
|
||||||
|
check_status["release_values"]["declared"] = release_status
|
||||||
|
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
changed=changed,
|
changed=changed,
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ author:
|
|||||||
- Lucas Boisserie (@LucasBoisserie)
|
- Lucas Boisserie (@LucasBoisserie)
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "helm (https://github.com/helm/helm/releases)"
|
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
||||||
- "yaml (https://pypi.org/project/PyYAML/)"
|
- "yaml (https://pypi.org/project/PyYAML/)"
|
||||||
|
|
||||||
description:
|
description:
|
||||||
@@ -115,9 +115,18 @@ status:
|
|||||||
returned: always
|
returned: always
|
||||||
description: The Date of last update
|
description: The Date of last update
|
||||||
values:
|
values:
|
||||||
type: str
|
type: dict
|
||||||
returned: always
|
returned: always
|
||||||
description: Dict of Values used to deploy
|
description:
|
||||||
|
- Dict of Values used to deploy
|
||||||
|
- 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
|
||||||
|
description:
|
||||||
|
- Dict of Values used to deploy.
|
||||||
|
version_added: 6.3.0
|
||||||
hooks:
|
hooks:
|
||||||
type: list
|
type: list
|
||||||
elements: dict
|
elements: dict
|
||||||
@@ -202,7 +211,16 @@ def get_release_status(module, release_name, release_state, get_all_values=False
|
|||||||
if release is None: # not install
|
if release is None: # not install
|
||||||
return None
|
return None
|
||||||
|
|
||||||
release["values"] = module.get_values(release_name, get_all_values)
|
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["manifest"] = module.get_manifest(release_name)
|
||||||
release["notes"] = module.get_notes(release_name)
|
release["notes"] = module.get_notes(release_name)
|
||||||
release["hooks"] = module.get_hooks(release_name)
|
release["hooks"] = module.get_hooks(release_name)
|
||||||
@@ -235,6 +253,9 @@ def main():
|
|||||||
if not IMP_YAML:
|
if not IMP_YAML:
|
||||||
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
||||||
|
|
||||||
|
# Validate Helm version >=3.0.0
|
||||||
|
module.validate_helm_version()
|
||||||
|
|
||||||
release_name = module.params.get("release_name")
|
release_name = module.params.get("release_name")
|
||||||
release_state = module.params.get("release_state")
|
release_state = module.params.get("release_state")
|
||||||
get_all_values = module.params.get("get_all_values")
|
get_all_values = module.params.get("get_all_values")
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ version_added: 1.0.0
|
|||||||
author:
|
author:
|
||||||
- Abhijeet Kasurde (@Akasurde)
|
- Abhijeet Kasurde (@Akasurde)
|
||||||
requirements:
|
requirements:
|
||||||
- "helm (https://github.com/helm/helm/releases)"
|
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
||||||
description:
|
description:
|
||||||
- Manages Helm plugins.
|
- Manages Helm plugins.
|
||||||
options:
|
options:
|
||||||
@@ -48,6 +48,22 @@ options:
|
|||||||
required: false
|
required: false
|
||||||
type: str
|
type: str
|
||||||
version_added: 2.3.0
|
version_added: 2.3.0
|
||||||
|
verify:
|
||||||
|
description:
|
||||||
|
- Verify the plugin signature before installing.
|
||||||
|
- This option requires helm version >= 4.0.0
|
||||||
|
- Used with I(state=present).
|
||||||
|
type: bool
|
||||||
|
default: true
|
||||||
|
version_added: 6.4.0
|
||||||
|
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:
|
extends_documentation_fragment:
|
||||||
- kubernetes.core.helm_common_options
|
- kubernetes.core.helm_common_options
|
||||||
"""
|
"""
|
||||||
@@ -118,6 +134,9 @@ from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common i
|
|||||||
HELM_AUTH_ARG_SPEC,
|
HELM_AUTH_ARG_SPEC,
|
||||||
HELM_AUTH_MUTUALLY_EXCLUSIVE,
|
HELM_AUTH_MUTUALLY_EXCLUSIVE,
|
||||||
)
|
)
|
||||||
|
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
||||||
|
LooseVersion,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def argument_spec():
|
def argument_spec():
|
||||||
@@ -138,6 +157,14 @@ def argument_spec():
|
|||||||
default="present",
|
default="present",
|
||||||
choices=["present", "absent", "latest"],
|
choices=["present", "absent", "latest"],
|
||||||
),
|
),
|
||||||
|
verify=dict(
|
||||||
|
type="bool",
|
||||||
|
default=True,
|
||||||
|
),
|
||||||
|
keyring=dict(
|
||||||
|
type="path",
|
||||||
|
required=False,
|
||||||
|
),
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
return arg_spec
|
return arg_spec
|
||||||
@@ -161,15 +188,50 @@ def main():
|
|||||||
mutually_exclusive=mutually_exclusive(),
|
mutually_exclusive=mutually_exclusive(),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Validate helm version >= 3.0.0
|
||||||
|
module.validate_helm_version()
|
||||||
|
|
||||||
state = module.params.get("state")
|
state = module.params.get("state")
|
||||||
|
|
||||||
|
# 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"
|
helm_cmd_common = module.get_helm_binary() + " plugin"
|
||||||
|
|
||||||
if state == "present":
|
if state == "present":
|
||||||
helm_cmd_common += " install %s" % module.params.get("plugin_path")
|
helm_cmd_common += " install %s" % module.params.get("plugin_path")
|
||||||
plugin_version = module.params.get("plugin_version")
|
plugin_version = module.params.get("plugin_version")
|
||||||
|
verify = module.params.get("verify")
|
||||||
|
keyring = module.params.get("keyring")
|
||||||
if plugin_version is not None:
|
if plugin_version is not None:
|
||||||
helm_cmd_common += " --version=%s" % plugin_version
|
helm_cmd_common += " --version=%s" % plugin_version
|
||||||
|
if not verify 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(
|
||||||
|
helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
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:
|
if not module.check_mode:
|
||||||
rc, out, err = module.run_helm_command(
|
rc, out, err = module.run_helm_command(
|
||||||
helm_cmd_common, fails_on_error=False
|
helm_cmd_common, fails_on_error=False
|
||||||
@@ -208,9 +270,9 @@ def main():
|
|||||||
elif state == "absent":
|
elif state == "absent":
|
||||||
plugin_name = module.params.get("plugin_name")
|
plugin_name = module.params.get("plugin_name")
|
||||||
rc, output, err, command = module.get_helm_plugin_list()
|
rc, output, err, command = module.get_helm_plugin_list()
|
||||||
out = parse_helm_plugin_list(output=output.splitlines())
|
plugins = parse_helm_plugin_list(output=output.splitlines())
|
||||||
|
|
||||||
if not out:
|
if not plugins:
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
failed=False,
|
failed=False,
|
||||||
changed=False,
|
changed=False,
|
||||||
@@ -221,12 +283,7 @@ def main():
|
|||||||
rc=rc,
|
rc=rc,
|
||||||
)
|
)
|
||||||
|
|
||||||
found = False
|
if all(plugin["name"] != plugin_name for plugin in plugins):
|
||||||
for line in out:
|
|
||||||
if line[0] == plugin_name:
|
|
||||||
found = True
|
|
||||||
break
|
|
||||||
if not found:
|
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
failed=False,
|
failed=False,
|
||||||
changed=False,
|
changed=False,
|
||||||
@@ -264,9 +321,9 @@ def main():
|
|||||||
elif state == "latest":
|
elif state == "latest":
|
||||||
plugin_name = module.params.get("plugin_name")
|
plugin_name = module.params.get("plugin_name")
|
||||||
rc, output, err, command = module.get_helm_plugin_list()
|
rc, output, err, command = module.get_helm_plugin_list()
|
||||||
out = parse_helm_plugin_list(output=output.splitlines())
|
plugins = parse_helm_plugin_list(output=output.splitlines())
|
||||||
|
|
||||||
if not out:
|
if not plugins:
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
failed=False,
|
failed=False,
|
||||||
changed=False,
|
changed=False,
|
||||||
@@ -277,12 +334,7 @@ def main():
|
|||||||
rc=rc,
|
rc=rc,
|
||||||
)
|
)
|
||||||
|
|
||||||
found = False
|
if all(plugin["name"] != plugin_name for plugin in plugins):
|
||||||
for line in out:
|
|
||||||
if line[0] == plugin_name:
|
|
||||||
found = True
|
|
||||||
break
|
|
||||||
if not found:
|
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
failed=False,
|
failed=False,
|
||||||
changed=False,
|
changed=False,
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ version_added: 1.0.0
|
|||||||
author:
|
author:
|
||||||
- Abhijeet Kasurde (@Akasurde)
|
- Abhijeet Kasurde (@Akasurde)
|
||||||
requirements:
|
requirements:
|
||||||
- "helm (https://github.com/helm/helm/releases)"
|
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
||||||
description:
|
description:
|
||||||
- Gather information about Helm plugins installed in namespace.
|
- Gather information about Helm plugins installed in namespace.
|
||||||
options:
|
options:
|
||||||
@@ -98,26 +98,16 @@ def main():
|
|||||||
supports_check_mode=True,
|
supports_check_mode=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
plugin_name = module.params.get("plugin_name")
|
# Validate helm version >= 3.0.0
|
||||||
|
module.validate_helm_version()
|
||||||
|
|
||||||
plugin_list = []
|
plugin_name = module.params.get("plugin_name")
|
||||||
|
|
||||||
rc, output, err, command = module.get_helm_plugin_list()
|
rc, output, err, command = module.get_helm_plugin_list()
|
||||||
|
|
||||||
out = parse_helm_plugin_list(output=output.splitlines())
|
plugins = parse_helm_plugin_list(output=output.splitlines())
|
||||||
|
if plugin_name is not None:
|
||||||
for line in out:
|
plugins = [plugin for plugin in plugins if plugin.get("name") == plugin_name]
|
||||||
if plugin_name is None:
|
|
||||||
plugin_list.append(
|
|
||||||
{"name": line[0], "version": line[1], "description": line[2]}
|
|
||||||
)
|
|
||||||
continue
|
|
||||||
|
|
||||||
if plugin_name == line[0]:
|
|
||||||
plugin_list.append(
|
|
||||||
{"name": line[0], "version": line[1], "description": line[2]}
|
|
||||||
)
|
|
||||||
break
|
|
||||||
|
|
||||||
module.exit_json(
|
module.exit_json(
|
||||||
changed=True,
|
changed=True,
|
||||||
@@ -125,7 +115,7 @@ def main():
|
|||||||
stdout=output,
|
stdout=output,
|
||||||
stderr=err,
|
stderr=err,
|
||||||
rc=rc,
|
rc=rc,
|
||||||
plugin_list=plugin_list,
|
plugin_list=plugins,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ description:
|
|||||||
- There are options for unpacking the chart after download.
|
- There are options for unpacking the chart after download.
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "helm >= 3.0 (https://github.com/helm/helm/releases)"
|
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
||||||
|
|
||||||
options:
|
options:
|
||||||
chart_ref:
|
chart_ref:
|
||||||
@@ -89,6 +89,14 @@ options:
|
|||||||
- if set to true, will untar the chart after downloading it.
|
- if set to true, will untar the chart after downloading it.
|
||||||
type: bool
|
type: bool
|
||||||
default: False
|
default: False
|
||||||
|
force:
|
||||||
|
description:
|
||||||
|
- Force download of the chart even if it already exists in the destination directory.
|
||||||
|
- By default, the module will skip downloading if the chart with the same version already exists for idempotency.
|
||||||
|
- When used with O(untar_chart=true), will remove any existing chart directory before extracting.
|
||||||
|
type: bool
|
||||||
|
default: False
|
||||||
|
version_added: 6.3.0
|
||||||
destination:
|
destination:
|
||||||
description:
|
description:
|
||||||
- location to write the chart.
|
- location to write the chart.
|
||||||
@@ -114,6 +122,13 @@ options:
|
|||||||
- The path of a helm binary to use.
|
- The path of a helm binary to use.
|
||||||
required: false
|
required: false
|
||||||
type: path
|
type: path
|
||||||
|
plain_http:
|
||||||
|
description:
|
||||||
|
- Use HTTP instead of HTTPS when working with OCI registries
|
||||||
|
- Requires Helm >= 3.13.0
|
||||||
|
type: bool
|
||||||
|
default: False
|
||||||
|
version_added: 6.1.0
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = r"""
|
EXAMPLES = r"""
|
||||||
@@ -145,6 +160,23 @@ EXAMPLES = r"""
|
|||||||
destination: /path/to/chart
|
destination: /path/to/chart
|
||||||
username: myuser
|
username: myuser
|
||||||
password: mypassword123
|
password: mypassword123
|
||||||
|
|
||||||
|
- name: Download Chart (force re-download even if exists)
|
||||||
|
kubernetes.core.helm_pull:
|
||||||
|
chart_ref: redis
|
||||||
|
repo_url: https://charts.bitnami.com/bitnami
|
||||||
|
chart_version: '17.0.0'
|
||||||
|
destination: /path/to/chart
|
||||||
|
force: yes
|
||||||
|
|
||||||
|
- name: Download and untar chart (force re-extraction even if directory exists)
|
||||||
|
kubernetes.core.helm_pull:
|
||||||
|
chart_ref: redis
|
||||||
|
repo_url: https://charts.bitnami.com/bitnami
|
||||||
|
chart_version: '17.0.0'
|
||||||
|
destination: /path/to/chart
|
||||||
|
untar_chart: yes
|
||||||
|
force: yes
|
||||||
"""
|
"""
|
||||||
|
|
||||||
RETURN = r"""
|
RETURN = r"""
|
||||||
@@ -163,6 +195,11 @@ command:
|
|||||||
description: Full `helm pull` command built by this module, in case you want to re-run the command outside the module or debug a problem.
|
description: Full `helm pull` command built by this module, in case you want to re-run the command outside the module or debug a problem.
|
||||||
returned: always
|
returned: always
|
||||||
sample: helm pull --repo test ...
|
sample: helm pull --repo test ...
|
||||||
|
msg:
|
||||||
|
type: str
|
||||||
|
description: A message indicating the result of the operation.
|
||||||
|
returned: when chart already exists
|
||||||
|
sample: Chart redis version 17.0.0 already exists in destination directory
|
||||||
rc:
|
rc:
|
||||||
type: int
|
type: int
|
||||||
description: Helm pull command return code
|
description: Helm pull command return code
|
||||||
@@ -170,6 +207,18 @@ rc:
|
|||||||
sample: 1
|
sample: 1
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
import tarfile
|
||||||
|
import uuid
|
||||||
|
|
||||||
|
try:
|
||||||
|
import yaml
|
||||||
|
|
||||||
|
HAS_YAML = True
|
||||||
|
except ImportError:
|
||||||
|
HAS_YAML = False
|
||||||
|
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
||||||
AnsibleHelmModule,
|
AnsibleHelmModule,
|
||||||
)
|
)
|
||||||
@@ -178,6 +227,115 @@ from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def extract_chart_name(chart_ref):
|
||||||
|
"""
|
||||||
|
Extract chart name from chart reference.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
chart_ref (str): Chart reference (name, URL, or OCI reference)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
str: Extracted chart name
|
||||||
|
"""
|
||||||
|
chart_name = chart_ref.split("/")[-1]
|
||||||
|
# Remove any query parameters or fragments from URL-based refs
|
||||||
|
if "?" in chart_name:
|
||||||
|
chart_name = chart_name.split("?")[0]
|
||||||
|
if "#" in chart_name:
|
||||||
|
chart_name = chart_name.split("#")[0]
|
||||||
|
# Remove .tgz extension if present
|
||||||
|
if chart_name.endswith(".tgz"):
|
||||||
|
chart_name = chart_name[:-4]
|
||||||
|
return chart_name
|
||||||
|
|
||||||
|
|
||||||
|
def chart_exists(destination, chart_ref, chart_version, untar_chart):
|
||||||
|
"""
|
||||||
|
Check if the chart already exists in the destination directory.
|
||||||
|
|
||||||
|
For untarred charts: check if directory exists with Chart.yaml matching version
|
||||||
|
For tarred charts: check if .tgz file exists and contains matching version
|
||||||
|
|
||||||
|
Args:
|
||||||
|
destination (str): Destination directory path
|
||||||
|
chart_ref (str): Chart reference (name or URL)
|
||||||
|
chart_version (str): Chart version to check for
|
||||||
|
untar_chart (bool): Whether to check for untarred or tarred chart
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
bool: True if chart with matching version exists, False otherwise
|
||||||
|
"""
|
||||||
|
# YAML is required for version checking
|
||||||
|
if not HAS_YAML:
|
||||||
|
return False
|
||||||
|
|
||||||
|
# Without version, we can't reliably check
|
||||||
|
if not chart_version:
|
||||||
|
return False
|
||||||
|
|
||||||
|
# Extract chart name from chart_ref using shared helper
|
||||||
|
chart_name = extract_chart_name(chart_ref)
|
||||||
|
|
||||||
|
if untar_chart:
|
||||||
|
# Check for extracted directory
|
||||||
|
chart_dir = os.path.join(destination, chart_name)
|
||||||
|
chart_yaml_path = os.path.join(chart_dir, "Chart.yaml")
|
||||||
|
|
||||||
|
if os.path.isdir(chart_dir) and os.path.isfile(chart_yaml_path):
|
||||||
|
try:
|
||||||
|
with open(chart_yaml_path, "r", encoding="utf-8") as chart_file:
|
||||||
|
chart_metadata = yaml.safe_load(chart_file)
|
||||||
|
# Ensure chart_metadata is a dict and has a version that matches
|
||||||
|
if (
|
||||||
|
chart_metadata
|
||||||
|
and isinstance(chart_metadata, dict)
|
||||||
|
and chart_metadata.get("version") == chart_version
|
||||||
|
and chart_metadata.get("name") == chart_name
|
||||||
|
):
|
||||||
|
return True
|
||||||
|
except (yaml.YAMLError, IOError, OSError, TypeError):
|
||||||
|
# If we can't read or parse the file, treat as non-existent
|
||||||
|
pass
|
||||||
|
else:
|
||||||
|
# Check for .tgz file
|
||||||
|
chart_file = os.path.join(destination, f"{chart_name}-{chart_version}.tgz")
|
||||||
|
|
||||||
|
if os.path.isfile(chart_file):
|
||||||
|
try:
|
||||||
|
# Verify it's a valid tarball with matching version
|
||||||
|
with tarfile.open(chart_file, "r:gz") as tar:
|
||||||
|
# Try to extract Chart.yaml to verify version
|
||||||
|
# Look for Chart.yaml at the expected path: <chart-name>/Chart.yaml
|
||||||
|
expected_chart_yaml = f"{chart_name}/Chart.yaml"
|
||||||
|
try:
|
||||||
|
member = tar.getmember(expected_chart_yaml)
|
||||||
|
chart_yaml_file = tar.extractfile(member)
|
||||||
|
if chart_yaml_file:
|
||||||
|
try:
|
||||||
|
chart_metadata = yaml.safe_load(chart_yaml_file)
|
||||||
|
# Ensure chart_metadata is a dict and has a version that matches
|
||||||
|
if (
|
||||||
|
chart_metadata
|
||||||
|
and isinstance(chart_metadata, dict)
|
||||||
|
and chart_metadata.get("version") == chart_version
|
||||||
|
and chart_metadata.get("name") == chart_name
|
||||||
|
):
|
||||||
|
return True
|
||||||
|
except (yaml.YAMLError, TypeError):
|
||||||
|
# If we can't parse the YAML, treat as non-existent
|
||||||
|
pass
|
||||||
|
finally:
|
||||||
|
chart_yaml_file.close()
|
||||||
|
except KeyError:
|
||||||
|
# Chart.yaml not found at expected path
|
||||||
|
pass
|
||||||
|
except (tarfile.TarError, yaml.YAMLError, IOError, OSError, TypeError):
|
||||||
|
# If we can't read or parse the tarball, treat as non-existent
|
||||||
|
pass
|
||||||
|
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
argspec = dict(
|
argspec = dict(
|
||||||
chart_ref=dict(type="str", required=True),
|
chart_ref=dict(type="str", required=True),
|
||||||
@@ -196,11 +354,13 @@ def main():
|
|||||||
),
|
),
|
||||||
chart_devel=dict(type="bool"),
|
chart_devel=dict(type="bool"),
|
||||||
untar_chart=dict(type="bool", default=False),
|
untar_chart=dict(type="bool", default=False),
|
||||||
|
force=dict(type="bool", default=False),
|
||||||
destination=dict(type="path", required=True),
|
destination=dict(type="path", required=True),
|
||||||
chart_ca_cert=dict(type="path"),
|
chart_ca_cert=dict(type="path"),
|
||||||
chart_ssl_cert_file=dict(type="path"),
|
chart_ssl_cert_file=dict(type="path"),
|
||||||
chart_ssl_key_file=dict(type="path"),
|
chart_ssl_key_file=dict(type="path"),
|
||||||
binary_path=dict(type="path"),
|
binary_path=dict(type="path"),
|
||||||
|
plain_http=dict(type="bool", default=False),
|
||||||
)
|
)
|
||||||
module = AnsibleHelmModule(
|
module = AnsibleHelmModule(
|
||||||
argument_spec=argspec,
|
argument_spec=argspec,
|
||||||
@@ -212,19 +372,17 @@ def main():
|
|||||||
mutually_exclusive=[("chart_version", "chart_devel")],
|
mutually_exclusive=[("chart_version", "chart_devel")],
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Validate Helm version >=3.0.0
|
||||||
|
module.validate_helm_version()
|
||||||
|
|
||||||
helm_version = module.get_helm_version()
|
helm_version = module.get_helm_version()
|
||||||
if LooseVersion(helm_version) < LooseVersion("3.0.0"):
|
|
||||||
module.fail_json(
|
|
||||||
msg="This module requires helm >= 3.0.0, current version is {0}".format(
|
|
||||||
helm_version
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
helm_pull_opt_versionning = dict(
|
helm_pull_opt_versionning = dict(
|
||||||
skip_tls_certs_check="3.3.0",
|
skip_tls_certs_check="3.3.0",
|
||||||
chart_ca_cert="3.1.0",
|
chart_ca_cert="3.1.0",
|
||||||
chart_ssl_cert_file="3.1.0",
|
chart_ssl_cert_file="3.1.0",
|
||||||
chart_ssl_key_file="3.1.0",
|
chart_ssl_key_file="3.1.0",
|
||||||
|
plain_http="3.13.0",
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_version_requirement(opt):
|
def test_version_requirement(opt):
|
||||||
@@ -264,6 +422,7 @@ def main():
|
|||||||
skip_tls_certs_check=dict(key="insecure-skip-tls-verify"),
|
skip_tls_certs_check=dict(key="insecure-skip-tls-verify"),
|
||||||
chart_devel=dict(key="devel"),
|
chart_devel=dict(key="devel"),
|
||||||
untar_chart=dict(key="untar"),
|
untar_chart=dict(key="untar"),
|
||||||
|
plain_http=dict(key="plain-http"),
|
||||||
)
|
)
|
||||||
|
|
||||||
for k, v in helm_flag_args.items():
|
for k, v in helm_flag_args.items():
|
||||||
@@ -276,8 +435,72 @@ def main():
|
|||||||
module.params.get("chart_ref"),
|
module.params.get("chart_ref"),
|
||||||
" ".join(helm_pull_opts),
|
" ".join(helm_pull_opts),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Check if chart already exists (idempotency)
|
||||||
|
if module.params.get("chart_version") and not module.params.get("force"):
|
||||||
|
chart_exists_locally = chart_exists(
|
||||||
|
module.params.get("destination"),
|
||||||
|
module.params.get("chart_ref"),
|
||||||
|
module.params.get("chart_version"),
|
||||||
|
module.params.get("untar_chart"),
|
||||||
|
)
|
||||||
|
|
||||||
|
if chart_exists_locally:
|
||||||
|
module.exit_json(
|
||||||
|
failed=False,
|
||||||
|
changed=False,
|
||||||
|
msg="Chart {0} version {1} already exists in destination directory".format(
|
||||||
|
module.params.get("chart_ref"), module.params.get("chart_version")
|
||||||
|
),
|
||||||
|
command="",
|
||||||
|
stdout="",
|
||||||
|
stderr="",
|
||||||
|
rc=0,
|
||||||
|
)
|
||||||
|
|
||||||
|
# When both untar_chart and force are enabled, we need to remove the existing chart directory
|
||||||
|
# BEFORE running helm pull to prevent helm's "directory already exists" error.
|
||||||
|
# We do this by:
|
||||||
|
# 1. Renaming the existing directory to a temporary name (if it exists)
|
||||||
|
# 2. Running helm pull
|
||||||
|
# 3. On success: remove the temporary directory
|
||||||
|
# 4. On failure: restore the temporary directory and report the error
|
||||||
|
chart_dir_renamed = False
|
||||||
|
chart_dir = None
|
||||||
|
chart_dir_backup = None
|
||||||
|
|
||||||
|
if module.params.get("untar_chart") and module.params.get("force"):
|
||||||
|
chart_name = extract_chart_name(module.params.get("chart_ref"))
|
||||||
|
chart_dir = os.path.join(module.params.get("destination"), chart_name)
|
||||||
|
|
||||||
|
# Check if directory exists and contains a Chart.yaml (to be safe)
|
||||||
|
if os.path.isdir(chart_dir):
|
||||||
|
chart_yaml_path = os.path.join(chart_dir, "Chart.yaml")
|
||||||
|
# Only rename if it looks like a Helm chart directory (have Chart.yaml)
|
||||||
|
if os.path.isfile(chart_yaml_path):
|
||||||
|
if not module.check_mode:
|
||||||
|
# Rename to temporary backup name using uuid for uniqueness
|
||||||
|
backup_suffix = uuid.uuid4().hex[:8]
|
||||||
|
chart_dir_backup = os.path.join(
|
||||||
|
module.params.get("destination"),
|
||||||
|
f".{chart_name}_backup_{backup_suffix}",
|
||||||
|
)
|
||||||
|
os.rename(chart_dir, chart_dir_backup)
|
||||||
|
chart_dir_renamed = True
|
||||||
|
|
||||||
if not module.check_mode:
|
if not module.check_mode:
|
||||||
rc, out, err = module.run_helm_command(helm_cmd_common, fails_on_error=False)
|
rc, out, err = module.run_helm_command(helm_cmd_common, fails_on_error=False)
|
||||||
|
|
||||||
|
# Handle cleanup/restore based on helm command result
|
||||||
|
if chart_dir_renamed:
|
||||||
|
if rc == 0:
|
||||||
|
# Success: remove the backup directory
|
||||||
|
if os.path.isdir(chart_dir_backup):
|
||||||
|
shutil.rmtree(chart_dir_backup)
|
||||||
|
else:
|
||||||
|
# Failure: restore the backup directory
|
||||||
|
if os.path.isdir(chart_dir_backup) and not os.path.exists(chart_dir):
|
||||||
|
os.rename(chart_dir_backup, chart_dir)
|
||||||
else:
|
else:
|
||||||
rc, out, err = (0, "", "")
|
rc, out, err = (0, "", "")
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ author:
|
|||||||
- Yuriy Novostavskiy (@yurnov)
|
- Yuriy Novostavskiy (@yurnov)
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "helm (https://github.com/helm/helm/releases) => 3.8.0"
|
- "helm (https://github.com/helm/helm/releases) >= 3.8.0"
|
||||||
|
|
||||||
description:
|
description:
|
||||||
- Helm registry authentication module allows you to login C(helm registry login) and logout C(helm registry logout) from a Helm registry.
|
- Helm registry authentication module allows you to login C(helm registry login) and logout C(helm registry logout) from a Helm registry.
|
||||||
@@ -31,6 +31,7 @@ options:
|
|||||||
- Desired state of the registry.
|
- Desired state of the registry.
|
||||||
- If set to V(present) attempt to log in to the remote registry server using the URL specified in O(host).
|
- If set to V(present) attempt to log in to the remote registry server using the URL specified in O(host).
|
||||||
- If set to V(absent) attempt to log out from the remote registry server using the URL specified in O(host).
|
- If set to V(absent) attempt to log out from the remote registry server using the URL specified in O(host).
|
||||||
|
- As helm >= 3.18.0 reports successful logout even if the user is not logged in, this module will report a change regardless of the current state.
|
||||||
required: false
|
required: false
|
||||||
default: present
|
default: present
|
||||||
choices: ['present', 'absent']
|
choices: ['present', 'absent']
|
||||||
@@ -74,6 +75,14 @@ options:
|
|||||||
- Path to the CA certificate SSL file for verify registry server certificate.
|
- Path to the CA certificate SSL file for verify registry server certificate.
|
||||||
required: false
|
required: false
|
||||||
type: path
|
type: path
|
||||||
|
plain_http:
|
||||||
|
description:
|
||||||
|
- Use insecure HTTP connections for C(helm registry login).
|
||||||
|
- Requires Helm >= 3.18.0
|
||||||
|
required: false
|
||||||
|
type: bool
|
||||||
|
default: False
|
||||||
|
version_added: 6.4.0
|
||||||
binary_path:
|
binary_path:
|
||||||
description:
|
description:
|
||||||
- The path of a helm binary to use.
|
- The path of a helm binary to use.
|
||||||
@@ -97,17 +106,23 @@ EXAMPLES = r"""
|
|||||||
RETURN = r"""
|
RETURN = r"""
|
||||||
stdout:
|
stdout:
|
||||||
type: str
|
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
|
returned: always
|
||||||
stout_lines:
|
sample: 'Login Succeeded\n'
|
||||||
|
stdout_lines:
|
||||||
type: list
|
type: list
|
||||||
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
|
||||||
returned: always
|
returned: always
|
||||||
stderr:
|
stderr:
|
||||||
type: str
|
type: str
|
||||||
description: >-
|
description:
|
||||||
Full C(helm) command stderr, in case you want to display it or examine the event log.
|
- 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.
|
- 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
|
returned: always
|
||||||
sample: 'Login Succeeded\n'
|
sample: 'Login Succeeded\n'
|
||||||
stderr_lines:
|
stderr_lines:
|
||||||
@@ -129,6 +144,9 @@ failed:
|
|||||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
||||||
AnsibleHelmModule,
|
AnsibleHelmModule,
|
||||||
)
|
)
|
||||||
|
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
||||||
|
LooseVersion,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def arg_spec():
|
def arg_spec():
|
||||||
@@ -144,6 +162,7 @@ def arg_spec():
|
|||||||
key_file=dict(type="path", required=False),
|
key_file=dict(type="path", required=False),
|
||||||
cert_file=dict(type="path", required=False),
|
cert_file=dict(type="path", required=False),
|
||||||
ca_file=dict(type="path", required=False),
|
ca_file=dict(type="path", required=False),
|
||||||
|
plain_http=dict(type="bool", default=False),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -156,6 +175,7 @@ def login(
|
|||||||
key_file,
|
key_file,
|
||||||
cert_file,
|
cert_file,
|
||||||
ca_file,
|
ca_file,
|
||||||
|
plain_http,
|
||||||
):
|
):
|
||||||
login_command = command + " registry login " + host
|
login_command = command + " registry login " + host
|
||||||
|
|
||||||
@@ -173,6 +193,8 @@ def login(
|
|||||||
|
|
||||||
if ca_file is not None:
|
if ca_file is not None:
|
||||||
login_command += " --ca-file=" + ca_file
|
login_command += " --ca-file=" + ca_file
|
||||||
|
if plain_http:
|
||||||
|
login_command += " --plain-http"
|
||||||
|
|
||||||
return login_command
|
return login_command
|
||||||
|
|
||||||
@@ -190,6 +212,9 @@ def main():
|
|||||||
supports_check_mode=True,
|
supports_check_mode=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Validate Helm version >=3.8.0
|
||||||
|
module.validate_helm_version(version="3.8.0")
|
||||||
|
|
||||||
changed = False
|
changed = False
|
||||||
|
|
||||||
host = module.params.get("host")
|
host = module.params.get("host")
|
||||||
@@ -200,6 +225,19 @@ def main():
|
|||||||
key_file = module.params.get("key_file")
|
key_file = module.params.get("key_file")
|
||||||
cert_file = module.params.get("cert_file")
|
cert_file = module.params.get("cert_file")
|
||||||
ca_file = module.params.get("ca_file")
|
ca_file = module.params.get("ca_file")
|
||||||
|
plain_http = module.params.get("plain_http")
|
||||||
|
|
||||||
|
helm_version = module.get_helm_version()
|
||||||
|
|
||||||
|
if plain_http:
|
||||||
|
if LooseVersion(helm_version) < LooseVersion("3.18.0"):
|
||||||
|
module.warn(
|
||||||
|
"plain_http option requires helm >= 3.18.0, current version is {0}".format(
|
||||||
|
helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
# reset option
|
||||||
|
plain_http = False
|
||||||
|
|
||||||
helm_cmd = module.get_helm_binary()
|
helm_cmd = module.get_helm_binary()
|
||||||
|
|
||||||
@@ -208,7 +246,15 @@ def main():
|
|||||||
changed = True
|
changed = True
|
||||||
elif state == "present":
|
elif state == "present":
|
||||||
helm_cmd = login(
|
helm_cmd = login(
|
||||||
helm_cmd, host, insecure, username, password, key_file, cert_file, ca_file
|
helm_cmd,
|
||||||
|
host,
|
||||||
|
insecure,
|
||||||
|
username,
|
||||||
|
password,
|
||||||
|
key_file,
|
||||||
|
cert_file,
|
||||||
|
ca_file,
|
||||||
|
plain_http,
|
||||||
)
|
)
|
||||||
changed = True
|
changed = True
|
||||||
|
|
||||||
@@ -231,6 +277,12 @@ def main():
|
|||||||
command=helm_cmd,
|
command=helm_cmd,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if LooseVersion(helm_version) >= LooseVersion("3.18.0") and state == "absent":
|
||||||
|
# https://github.com/ansible-collections/kubernetes.core/issues/944
|
||||||
|
module.warn(
|
||||||
|
"The helm_registry_auth is not idempotent with helm >= 3.18.0, always report a change."
|
||||||
|
)
|
||||||
|
|
||||||
module.exit_json(changed=changed, stdout=out, stderr=err, command=helm_cmd)
|
module.exit_json(changed=changed, stdout=out, stderr=err, command=helm_cmd)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ author:
|
|||||||
- Lucas Boisserie (@LucasBoisserie)
|
- Lucas Boisserie (@LucasBoisserie)
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "helm (https://github.com/helm/helm/releases)"
|
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
||||||
- "yaml (https://pypi.org/project/PyYAML/)"
|
- "yaml (https://pypi.org/project/PyYAML/)"
|
||||||
|
|
||||||
description:
|
description:
|
||||||
@@ -295,10 +295,15 @@ def main():
|
|||||||
if not IMP_YAML:
|
if not IMP_YAML:
|
||||||
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
||||||
|
|
||||||
|
# Validate Helm version >= 3.0.0
|
||||||
|
module.validate_helm_version()
|
||||||
|
|
||||||
changed = False
|
changed = False
|
||||||
|
|
||||||
repo_name = module.params.get("repo_name")
|
repo_name = module.params.get("repo_name")
|
||||||
repo_url = module.params.get("repo_url")
|
repo_url = module.params.get("repo_url")
|
||||||
|
if repo_url:
|
||||||
|
repo_url = repo_url.rstrip("/")
|
||||||
repo_username = module.params.get("repo_username")
|
repo_username = module.params.get("repo_username")
|
||||||
repo_password = module.params.get("repo_password")
|
repo_password = module.params.get("repo_password")
|
||||||
repo_state = module.params.get("repo_state")
|
repo_state = module.params.get("repo_state")
|
||||||
@@ -326,7 +331,7 @@ def main():
|
|||||||
insecure_skip_tls_verify,
|
insecure_skip_tls_verify,
|
||||||
)
|
)
|
||||||
changed = True
|
changed = True
|
||||||
elif repository_status["url"] != repo_url:
|
elif repository_status["url"].rstrip("/") != repo_url:
|
||||||
module.fail_json(
|
module.fail_json(
|
||||||
msg="Repository already have a repository named {0}".format(repo_name)
|
msg="Repository already have a repository named {0}".format(repo_name)
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -21,6 +21,10 @@ author:
|
|||||||
description:
|
description:
|
||||||
- Render chart templates to an output directory or as text of concatenated yaml documents.
|
- Render chart templates to an output directory or as text of concatenated yaml documents.
|
||||||
|
|
||||||
|
requirements:
|
||||||
|
- "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
|
||||||
|
- "yaml (https://pypi.org/project/PyYAML/)"
|
||||||
|
|
||||||
options:
|
options:
|
||||||
binary_path:
|
binary_path:
|
||||||
description:
|
description:
|
||||||
@@ -147,6 +151,13 @@ options:
|
|||||||
- json
|
- json
|
||||||
- file
|
- file
|
||||||
version_added: 2.4.0
|
version_added: 2.4.0
|
||||||
|
plain_http:
|
||||||
|
description:
|
||||||
|
- Use HTTP instead of HTTPS when working with OCI registries
|
||||||
|
- Requires Helm >= 3.13.0
|
||||||
|
type: bool
|
||||||
|
default: False
|
||||||
|
version_added: 6.1.0
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = r"""
|
EXAMPLES = r"""
|
||||||
@@ -217,6 +228,10 @@ except ImportError:
|
|||||||
from ansible.module_utils.basic import missing_required_lib
|
from ansible.module_utils.basic import missing_required_lib
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
|
||||||
AnsibleHelmModule,
|
AnsibleHelmModule,
|
||||||
|
strip_registry_progress,
|
||||||
|
)
|
||||||
|
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
|
||||||
|
LooseVersion,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@@ -236,6 +251,7 @@ def template(
|
|||||||
values_files=None,
|
values_files=None,
|
||||||
include_crds=False,
|
include_crds=False,
|
||||||
set_values=None,
|
set_values=None,
|
||||||
|
plain_http=False,
|
||||||
):
|
):
|
||||||
cmd += " template "
|
cmd += " template "
|
||||||
|
|
||||||
@@ -262,6 +278,9 @@ def template(
|
|||||||
if insecure_registry:
|
if insecure_registry:
|
||||||
cmd += " --insecure-skip-tls-verify"
|
cmd += " --insecure-skip-tls-verify"
|
||||||
|
|
||||||
|
if plain_http:
|
||||||
|
cmd += " --plain-http"
|
||||||
|
|
||||||
if show_only:
|
if show_only:
|
||||||
for template in show_only:
|
for template in show_only:
|
||||||
cmd += " -s " + template
|
cmd += " -s " + template
|
||||||
@@ -307,6 +326,7 @@ def main():
|
|||||||
values_files=dict(type="list", default=[], elements="str"),
|
values_files=dict(type="list", default=[], elements="str"),
|
||||||
update_repo_cache=dict(type="bool", default=False),
|
update_repo_cache=dict(type="bool", default=False),
|
||||||
set_values=dict(type="list", elements="dict"),
|
set_values=dict(type="list", elements="dict"),
|
||||||
|
plain_http=dict(type="bool", default=False),
|
||||||
),
|
),
|
||||||
supports_check_mode=True,
|
supports_check_mode=True,
|
||||||
)
|
)
|
||||||
@@ -327,12 +347,25 @@ def main():
|
|||||||
values_files = module.params.get("values_files")
|
values_files = module.params.get("values_files")
|
||||||
update_repo_cache = module.params.get("update_repo_cache")
|
update_repo_cache = module.params.get("update_repo_cache")
|
||||||
set_values = module.params.get("set_values")
|
set_values = module.params.get("set_values")
|
||||||
|
plain_http = module.params.get("plain_http")
|
||||||
|
|
||||||
if not IMP_YAML:
|
if not IMP_YAML:
|
||||||
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
|
||||||
|
|
||||||
|
# Validate Helm version >=3.0.0
|
||||||
|
module.validate_helm_version()
|
||||||
|
|
||||||
helm_cmd = module.get_helm_binary()
|
helm_cmd = module.get_helm_binary()
|
||||||
|
|
||||||
|
if plain_http:
|
||||||
|
helm_version = module.get_helm_version()
|
||||||
|
if LooseVersion(helm_version) < LooseVersion("3.13.0"):
|
||||||
|
module.fail_json(
|
||||||
|
msg="plain_http requires helm >= 3.13.0, current version is {0}".format(
|
||||||
|
helm_version
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
if update_repo_cache:
|
if update_repo_cache:
|
||||||
update_cmd = helm_cmd + " repo update"
|
update_cmd = helm_cmd + " repo update"
|
||||||
module.run_helm_command(update_cmd)
|
module.run_helm_command(update_cmd)
|
||||||
@@ -357,10 +390,14 @@ def main():
|
|||||||
values_files=values_files,
|
values_files=values_files,
|
||||||
include_crds=include_crds,
|
include_crds=include_crds,
|
||||||
set_values=set_values_args,
|
set_values=set_values_args,
|
||||||
|
plain_http=plain_http,
|
||||||
)
|
)
|
||||||
|
|
||||||
if not check_mode:
|
if not check_mode:
|
||||||
rc, out, err = module.run_helm_command(tmpl_cmd)
|
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:
|
else:
|
||||||
out = err = ""
|
out = err = ""
|
||||||
rc = 0
|
rc = 0
|
||||||
|
|||||||
+47
-12
@@ -40,9 +40,8 @@ options:
|
|||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Determines if an object should be created, patched, or deleted. When set to C(present), an object will be
|
- Determines if an object should be created, patched, or deleted. When set to C(present), an object will be
|
||||||
created, if it does not already exist. If set to C(absent), an existing object will be deleted. If set to
|
created if it does not already exist, and an existing object will be patched if its attributes differ from
|
||||||
C(present), an existing object will be patched, if its attributes differ from those specified using
|
those specified using I(resource_definition) or I(src). If set to C(absent), an existing object will be deleted.
|
||||||
I(resource_definition) or I(src).
|
|
||||||
- C(patched) state is an existing resource that has a given patch applied. If the resource doesn't exist, silently skip it (do not raise an error).
|
- C(patched) state is an existing resource that has a given patch applied. If the resource doesn't exist, silently skip it (do not raise an error).
|
||||||
type: str
|
type: str
|
||||||
default: present
|
default: present
|
||||||
@@ -383,28 +382,24 @@ result:
|
|||||||
contains:
|
contains:
|
||||||
api_version:
|
api_version:
|
||||||
description: The versioned schema of this representation of an object.
|
description: The versioned schema of this representation of an object.
|
||||||
returned: success
|
returned: when O(resource_definition) or O(src) contains a single object.
|
||||||
type: str
|
type: str
|
||||||
kind:
|
kind:
|
||||||
description: Represents the REST resource this object represents.
|
description: Represents the REST resource this object represents.
|
||||||
returned: success
|
returned: when O(resource_definition) or O(src) contains a single object.
|
||||||
type: str
|
type: str
|
||||||
metadata:
|
metadata:
|
||||||
description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
|
description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
|
||||||
returned: success
|
returned: when O(resource_definition) or O(src) contains a single object.
|
||||||
type: complex
|
type: complex
|
||||||
spec:
|
spec:
|
||||||
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
|
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
|
||||||
returned: success
|
returned: when O(resource_definition) or O(src) contains a single object.
|
||||||
type: complex
|
type: complex
|
||||||
status:
|
status:
|
||||||
description: Current status details for the object.
|
description: Current status details for the object.
|
||||||
returned: success
|
returned: when O(resource_definition) or O(src) contains a single object.
|
||||||
type: complex
|
type: complex
|
||||||
items:
|
|
||||||
description: Returned only when multiple yaml documents are passed to src or resource_definition
|
|
||||||
returned: when resource_definition or src contains list of objects
|
|
||||||
type: list
|
|
||||||
duration:
|
duration:
|
||||||
description: elapsed time of task in seconds
|
description: elapsed time of task in seconds
|
||||||
returned: when C(wait) is true
|
returned: when C(wait) is true
|
||||||
@@ -414,6 +409,46 @@ result:
|
|||||||
description: error while trying to create/delete the object.
|
description: error while trying to create/delete the object.
|
||||||
returned: error
|
returned: error
|
||||||
type: complex
|
type: complex
|
||||||
|
results:
|
||||||
|
description: An array of created, patched, or otherwise present objects.
|
||||||
|
returned: when O(resource_definition) or O(src) contains a list of objects.
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
api_version:
|
||||||
|
description: The versioned schema of this representation of an object.
|
||||||
|
returned: when O(resource_definition) or O(src) contains a single object.
|
||||||
|
type: str
|
||||||
|
kind:
|
||||||
|
description: Represents the REST resource this object represents.
|
||||||
|
returned: when O(resource_definition) or O(src) contains a single object.
|
||||||
|
type: str
|
||||||
|
metadata:
|
||||||
|
description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
|
||||||
|
returned: when O(resource_definition) or O(src) contains a single object.
|
||||||
|
type: complex
|
||||||
|
spec:
|
||||||
|
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
|
||||||
|
returned: when O(resource_definition) or O(src) contains a single object.
|
||||||
|
type: complex
|
||||||
|
status:
|
||||||
|
description: Current status details for the object.
|
||||||
|
returned: when O(resource_definition) or O(src) contains a single object.
|
||||||
|
type: complex
|
||||||
|
duration:
|
||||||
|
description: elapsed time of task in seconds
|
||||||
|
returned: when C(wait) is true
|
||||||
|
type: int
|
||||||
|
sample: 48
|
||||||
|
error:
|
||||||
|
description: error while trying to create/delete the object.
|
||||||
|
returned: error
|
||||||
|
type: complex
|
||||||
|
method:
|
||||||
|
description:
|
||||||
|
- The method used to deploy the resource.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
sample: create
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import copy
|
import copy
|
||||||
|
|||||||
@@ -76,9 +76,22 @@ options:
|
|||||||
- This option is ignored when I(content) is set or when I(state) is set to C(from_pod).
|
- This option is ignored when I(content) is set or when I(state) is set to C(from_pod).
|
||||||
type: bool
|
type: bool
|
||||||
default: False
|
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:
|
notes:
|
||||||
- the tar binary is required on the container when copying from local filesystem to pod.
|
- the tar binary is required on the container when copying from local filesystem to pod.
|
||||||
|
- 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.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = r"""
|
EXAMPLES = r"""
|
||||||
@@ -139,7 +152,7 @@ result:
|
|||||||
|
|
||||||
import copy
|
import copy
|
||||||
|
|
||||||
from ansible.module_utils._text import to_native
|
from ansible.module_utils.common.text.converters import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
@@ -179,6 +192,7 @@ def argspec():
|
|||||||
"choices": ["to_pod", "from_pod"],
|
"choices": ["to_pod", "from_pod"],
|
||||||
}
|
}
|
||||||
argument_spec["no_preserve"] = {"type": "bool", "default": False}
|
argument_spec["no_preserve"] = {"type": "bool", "default": False}
|
||||||
|
argument_spec["copy_timeout"] = {"type": "int", "default": 300}
|
||||||
return argument_spec
|
return argument_spec
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -149,7 +149,7 @@ import time
|
|||||||
import traceback
|
import traceback
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
|
|
||||||
from ansible.module_utils._text import to_native
|
from ansible.module_utils.common.text.converters import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
@@ -214,23 +214,23 @@ def filter_pods(pods, force, ignore_daemonset, delete_emptydir_data):
|
|||||||
to_delete.append((pod.metadata.namespace, pod.metadata.name))
|
to_delete.append((pod.metadata.namespace, pod.metadata.name))
|
||||||
continue
|
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
|
# Check replicated Pod
|
||||||
owner_ref = pod.metadata.owner_references
|
owner_ref = pod.metadata.owner_references or []
|
||||||
if not owner_ref:
|
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))
|
unmanaged.append((pod.metadata.namespace, pod.metadata.name))
|
||||||
else:
|
else:
|
||||||
for owner in owner_ref:
|
to_delete.append((pod.metadata.namespace, pod.metadata.name))
|
||||||
if owner.kind == "DaemonSet":
|
|
||||||
daemonSet.append((pod.metadata.namespace, pod.metadata.name))
|
|
||||||
else:
|
|
||||||
to_delete.append((pod.metadata.namespace, pod.metadata.name))
|
|
||||||
|
|
||||||
warnings, errors = [], []
|
warnings, errors, info = [], [], []
|
||||||
if unmanaged:
|
if unmanaged:
|
||||||
pod_names = ",".join([pod[0] + "/" + pod[1] for pod in unmanaged])
|
pod_names = ",".join([pod[0] + "/" + pod[1] for pod in unmanaged])
|
||||||
if not force:
|
if not force:
|
||||||
@@ -242,7 +242,7 @@ def filter_pods(pods, force, ignore_daemonset, delete_emptydir_data):
|
|||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
# Pod not managed will be deleted as 'force' is true
|
# Pod not managed will be deleted as 'force' is true
|
||||||
warnings.append(
|
info.append(
|
||||||
"Deleting Pods not managed by ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet: {0}.".format(
|
"Deleting Pods not managed by ReplicationController, ReplicaSet, Job, DaemonSet or StatefulSet: {0}.".format(
|
||||||
pod_names
|
pod_names
|
||||||
)
|
)
|
||||||
@@ -264,7 +264,7 @@ def filter_pods(pods, force, ignore_daemonset, delete_emptydir_data):
|
|||||||
"cannot delete Pods with local storage: {0}.".format(pod_names)
|
"cannot delete Pods with local storage: {0}.".format(pod_names)
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
warnings.append("Deleting Pods with local storage: {0}.".format(pod_names))
|
info.append("Deleting Pods with local storage: {0}.".format(pod_names))
|
||||||
for pod in localStorage:
|
for pod in localStorage:
|
||||||
to_delete.append((pod[0], pod[1]))
|
to_delete.append((pod[0], pod[1]))
|
||||||
|
|
||||||
@@ -278,8 +278,8 @@ def filter_pods(pods, force, ignore_daemonset, delete_emptydir_data):
|
|||||||
)
|
)
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
warnings.append("Ignoring DaemonSet-managed Pods: {0}.".format(pod_names))
|
info.append("Ignoring DaemonSet-managed Pods: {0}.".format(pod_names))
|
||||||
return to_delete, warnings, errors
|
return to_delete, warnings, errors, info
|
||||||
|
|
||||||
|
|
||||||
class K8sDrainAnsible(object):
|
class K8sDrainAnsible(object):
|
||||||
@@ -334,18 +334,19 @@ class K8sDrainAnsible(object):
|
|||||||
def evict_pods(self, pods):
|
def evict_pods(self, pods):
|
||||||
for namespace, name in pods:
|
for namespace, name in pods:
|
||||||
try:
|
try:
|
||||||
if self._drain_options.get("disable_eviction"):
|
if not self._module.check_mode:
|
||||||
self._api_instance.delete_namespaced_pod(
|
if self._drain_options.get("disable_eviction"):
|
||||||
name=name, namespace=namespace, body=self._delete_options
|
self._api_instance.delete_namespaced_pod(
|
||||||
)
|
name=name, namespace=namespace, body=self._delete_options
|
||||||
else:
|
)
|
||||||
body = v1_eviction(
|
else:
|
||||||
delete_options=self._delete_options,
|
body = v1_eviction(
|
||||||
metadata=V1ObjectMeta(name=name, namespace=namespace),
|
delete_options=self._delete_options,
|
||||||
)
|
metadata=V1ObjectMeta(name=name, namespace=namespace),
|
||||||
self._api_instance.create_namespaced_pod_eviction(
|
)
|
||||||
name=name, namespace=namespace, body=body
|
self._api_instance.create_namespaced_pod_eviction(
|
||||||
)
|
name=name, namespace=namespace, body=body
|
||||||
|
)
|
||||||
self._changed = True
|
self._changed = True
|
||||||
except ApiException as exc:
|
except ApiException as exc:
|
||||||
if exc.reason != "Not Found":
|
if exc.reason != "Not Found":
|
||||||
@@ -362,11 +363,7 @@ class K8sDrainAnsible(object):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def list_pods(self):
|
def list_pods(self):
|
||||||
params = {
|
params = {"field_selector": "spec.nodeName=" + self._module.params.get("name")}
|
||||||
"field_selector": "spec.nodeName={name}".format(
|
|
||||||
name=self._module.params.get("name")
|
|
||||||
)
|
|
||||||
}
|
|
||||||
pod_selectors = self._module.params.get("pod_selectors")
|
pod_selectors = self._module.params.get("pod_selectors")
|
||||||
if pod_selectors:
|
if pod_selectors:
|
||||||
params["label_selector"] = ",".join(pod_selectors)
|
params["label_selector"] = ",".join(pod_selectors)
|
||||||
@@ -376,7 +373,8 @@ class K8sDrainAnsible(object):
|
|||||||
# Mark node as unschedulable
|
# Mark node as unschedulable
|
||||||
result = []
|
result = []
|
||||||
if not node_unschedulable:
|
if not node_unschedulable:
|
||||||
self.patch_node(unschedulable=True)
|
if not self._module.check_mode:
|
||||||
|
self.patch_node(unschedulable=True)
|
||||||
result.append(
|
result.append(
|
||||||
"node {0} marked unschedulable.".format(self._module.params.get("name"))
|
"node {0} marked unschedulable.".format(self._module.params.get("name"))
|
||||||
)
|
)
|
||||||
@@ -391,7 +389,8 @@ class K8sDrainAnsible(object):
|
|||||||
def _revert_node_patch():
|
def _revert_node_patch():
|
||||||
if self._changed:
|
if self._changed:
|
||||||
self._changed = False
|
self._changed = False
|
||||||
self.patch_node(unschedulable=False)
|
if not self._module.check_mode:
|
||||||
|
self.patch_node(unschedulable=False)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
pod_list = self.list_pods()
|
pod_list = self.list_pods()
|
||||||
@@ -401,7 +400,7 @@ class K8sDrainAnsible(object):
|
|||||||
delete_emptydir_data = self._drain_options.get(
|
delete_emptydir_data = self._drain_options.get(
|
||||||
"delete_emptydir_data", False
|
"delete_emptydir_data", False
|
||||||
)
|
)
|
||||||
pods, warnings, errors = filter_pods(
|
pods, warnings, errors, info = filter_pods(
|
||||||
pod_list.items, force, ignore_daemonset, delete_emptydir_data
|
pod_list.items, force, ignore_daemonset, delete_emptydir_data
|
||||||
)
|
)
|
||||||
if errors:
|
if errors:
|
||||||
@@ -431,17 +430,25 @@ class K8sDrainAnsible(object):
|
|||||||
if pods:
|
if pods:
|
||||||
self.evict_pods(pods)
|
self.evict_pods(pods)
|
||||||
number_pod = len(pods)
|
number_pod = len(pods)
|
||||||
if self._drain_options.get("wait_timeout") is not None:
|
if self._module.check_mode:
|
||||||
warn = self.wait_for_pod_deletion(
|
result.append(
|
||||||
pods,
|
"Would have deleted {0} Pod(s) from node if not in check mode.".format(
|
||||||
self._drain_options.get("wait_timeout"),
|
number_pod
|
||||||
self._drain_options.get("wait_sleep"),
|
)
|
||||||
)
|
)
|
||||||
if warn:
|
else:
|
||||||
warnings.append(warn)
|
wait_timeout = self._drain_options.get("wait_timeout")
|
||||||
result.append("{0} Pod(s) deleted from node.".format(number_pod))
|
wait_sleep = self._drain_options.get("wait_sleep")
|
||||||
|
if wait_timeout is not None:
|
||||||
|
warn = self.wait_for_pod_deletion(pods, wait_timeout, wait_sleep)
|
||||||
|
if warn:
|
||||||
|
warnings.append(warn)
|
||||||
|
result.append("{0} Pod(s) deleted from node.".format(number_pod))
|
||||||
if warnings:
|
if warnings:
|
||||||
return dict(result=" ".join(result), warnings=warnings)
|
for warning in warnings:
|
||||||
|
self._module.warn(warning)
|
||||||
|
for line in info:
|
||||||
|
self._module.debug(line)
|
||||||
return dict(result=" ".join(result))
|
return dict(result=" ".join(result))
|
||||||
|
|
||||||
def patch_node(self, unschedulable):
|
def patch_node(self, unschedulable):
|
||||||
@@ -482,7 +489,8 @@ class K8sDrainAnsible(object):
|
|||||||
self._module.exit_json(
|
self._module.exit_json(
|
||||||
result="node {0} already marked unschedulable.".format(name)
|
result="node {0} already marked unschedulable.".format(name)
|
||||||
)
|
)
|
||||||
self.patch_node(unschedulable=True)
|
if not self._module.check_mode:
|
||||||
|
self.patch_node(unschedulable=True)
|
||||||
result["result"] = "node {0} marked unschedulable.".format(name)
|
result["result"] = "node {0} marked unschedulable.".format(name)
|
||||||
self._changed = True
|
self._changed = True
|
||||||
|
|
||||||
@@ -491,7 +499,8 @@ class K8sDrainAnsible(object):
|
|||||||
self._module.exit_json(
|
self._module.exit_json(
|
||||||
result="node {0} already marked schedulable.".format(name)
|
result="node {0} already marked schedulable.".format(name)
|
||||||
)
|
)
|
||||||
self.patch_node(unschedulable=False)
|
if not self._module.check_mode:
|
||||||
|
self.patch_node(unschedulable=False)
|
||||||
result["result"] = "node {0} marked schedulable.".format(name)
|
result["result"] = "node {0} marked schedulable.".format(name)
|
||||||
self._changed = True
|
self._changed = True
|
||||||
|
|
||||||
@@ -534,7 +543,9 @@ def argspec():
|
|||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
module = AnsibleK8SModule(module_class=AnsibleModule, argument_spec=argspec())
|
module = AnsibleK8SModule(
|
||||||
|
module_class=AnsibleModule, argument_spec=argspec(), supports_check_mode=True
|
||||||
|
)
|
||||||
|
|
||||||
if not HAS_EVICTION_API:
|
if not HAS_EVICTION_API:
|
||||||
module.fail_json(
|
module.fail_json(
|
||||||
|
|||||||
@@ -118,7 +118,7 @@ result:
|
|||||||
type: int
|
type: int
|
||||||
version_added: 2.2.0
|
version_added: 2.2.0
|
||||||
return_code:
|
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
|
type: int
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -131,7 +131,7 @@ except ImportError:
|
|||||||
# ImportError are managed by the common module already.
|
# ImportError are managed by the common module already.
|
||||||
pass
|
pass
|
||||||
|
|
||||||
from ansible.module_utils._text import to_native
|
from ansible.module_utils.common.text.converters import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
@@ -219,6 +219,13 @@ def execute_module(module, client):
|
|||||||
else:
|
else:
|
||||||
rc = int(err["details"]["causes"][0]["message"])
|
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(
|
module.exit_json(
|
||||||
# Some command might change environment, but ultimately failing at end
|
# Some command might change environment, but ultimately failing at end
|
||||||
changed=True,
|
changed=True,
|
||||||
|
|||||||
+55
-10
@@ -53,6 +53,15 @@ options:
|
|||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
version_added: 3.0.0
|
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:
|
extends_documentation_fragment:
|
||||||
- kubernetes.core.k8s_auth_options
|
- kubernetes.core.k8s_auth_options
|
||||||
@@ -120,6 +129,27 @@ 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
|
||||||
|
|
||||||
|
- name: Get a list of all pods metadata only
|
||||||
|
kubernetes.core.k8s_info:
|
||||||
|
kind: Pod
|
||||||
|
metadata_only: true
|
||||||
|
register: pod_metadata_list
|
||||||
"""
|
"""
|
||||||
|
|
||||||
RETURN = r"""
|
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 (
|
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||||
AUTH_ARG_SPEC,
|
AUTH_ARG_SPEC,
|
||||||
|
METADATA_ONLY_HEADER_VALUES,
|
||||||
|
METADATA_ONLY_HEADERS_SPEC,
|
||||||
WAIT_ARG_SPEC,
|
WAIT_ARG_SPEC,
|
||||||
)
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
||||||
@@ -201,15 +233,16 @@ def argspec():
|
|||||||
args = copy.deepcopy(AUTH_ARG_SPEC)
|
args = copy.deepcopy(AUTH_ARG_SPEC)
|
||||||
args.update(WAIT_ARG_SPEC)
|
args.update(WAIT_ARG_SPEC)
|
||||||
args.update(
|
args.update(
|
||||||
dict(
|
{
|
||||||
kind=dict(required=True),
|
"kind": {"required": True},
|
||||||
api_version=dict(default="v1", aliases=["api", "version"]),
|
"api_version": {"default": "v1", "aliases": ["api", "version"]},
|
||||||
name=dict(),
|
"name": {},
|
||||||
namespace=dict(),
|
"namespace": {},
|
||||||
label_selectors=dict(type="list", elements="str", default=[]),
|
"label_selectors": {"type": "list", "elements": "str", "default": []},
|
||||||
field_selectors=dict(type="list", elements="str", default=[]),
|
"field_selectors": {"type": "list", "elements": "str", "default": []},
|
||||||
hidden_fields=dict(type="list", elements="str"),
|
"hidden_fields": {"type": "list", "elements": "str"},
|
||||||
)
|
"metadata_only": {"type": "bool", "default": False},
|
||||||
|
}
|
||||||
)
|
)
|
||||||
return args
|
return args
|
||||||
|
|
||||||
@@ -218,8 +251,20 @@ def main():
|
|||||||
module = AnsibleK8SModule(
|
module = AnsibleK8SModule(
|
||||||
module_class=AnsibleModule, argument_spec=argspec(), supports_check_mode=True
|
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:
|
try:
|
||||||
client = get_api_client(module)
|
client = get_api_client(module, **metadata_only_headers)
|
||||||
svc = K8sService(client, module)
|
svc = K8sService(client, module)
|
||||||
execute_module(module, svc)
|
execute_module(module, svc)
|
||||||
except CoreException as e:
|
except CoreException as e:
|
||||||
|
|||||||
@@ -33,6 +33,14 @@ options:
|
|||||||
aliases:
|
aliases:
|
||||||
- api
|
- api
|
||||||
- version
|
- version
|
||||||
|
hidden_fields:
|
||||||
|
description:
|
||||||
|
- List of fields to hide from the diff output.
|
||||||
|
- This is useful for fields that are not relevant to the patch operation, such as `metadata.managedFields`.
|
||||||
|
type: list
|
||||||
|
elements: str
|
||||||
|
default: []
|
||||||
|
version_added: 6.1.0
|
||||||
kind:
|
kind:
|
||||||
description:
|
description:
|
||||||
- Use to specify an object model.
|
- Use to specify an object model.
|
||||||
@@ -127,8 +135,8 @@ error:
|
|||||||
import copy
|
import copy
|
||||||
import traceback
|
import traceback
|
||||||
|
|
||||||
from ansible.module_utils._text import to_native
|
|
||||||
from ansible.module_utils.basic import missing_required_lib
|
from ansible.module_utils.basic import missing_required_lib
|
||||||
|
from ansible.module_utils.common.text.converters import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
@@ -147,6 +155,7 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions imp
|
|||||||
)
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.service import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.service import (
|
||||||
diff_objects,
|
diff_objects,
|
||||||
|
hide_fields,
|
||||||
)
|
)
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.waiter import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.waiter import (
|
||||||
get_waiter,
|
get_waiter,
|
||||||
@@ -174,6 +183,7 @@ JSON_PATCH_ARGS = {
|
|||||||
"namespace": {"type": "str"},
|
"namespace": {"type": "str"},
|
||||||
"name": {"type": "str", "required": True},
|
"name": {"type": "str", "required": True},
|
||||||
"patch": {"type": "list", "required": True, "elements": "dict"},
|
"patch": {"type": "list", "required": True, "elements": "dict"},
|
||||||
|
"hidden_fields": {"type": "list", "elements": "str", "default": []},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@@ -203,6 +213,7 @@ def execute_module(module, client):
|
|||||||
namespace = module.params.get("namespace")
|
namespace = module.params.get("namespace")
|
||||||
patch = module.params.get("patch")
|
patch = module.params.get("patch")
|
||||||
|
|
||||||
|
hidden_fields = module.params.get("hidden_fields")
|
||||||
wait = module.params.get("wait")
|
wait = module.params.get("wait")
|
||||||
wait_sleep = module.params.get("wait_sleep")
|
wait_sleep = module.params.get("wait_sleep")
|
||||||
wait_timeout = module.params.get("wait_timeout")
|
wait_timeout = module.params.get("wait_timeout")
|
||||||
@@ -260,13 +271,13 @@ def execute_module(module, client):
|
|||||||
module.fail_json(msg=msg, error=to_native(exc), status="", reason="")
|
module.fail_json(msg=msg, error=to_native(exc), status="", reason="")
|
||||||
|
|
||||||
success = True
|
success = True
|
||||||
result = {"result": obj}
|
result = {"result": hide_fields(obj, hidden_fields)}
|
||||||
if wait and not module.check_mode:
|
if wait and not module.check_mode:
|
||||||
waiter = get_waiter(client, resource, condition=wait_condition)
|
waiter = get_waiter(client, resource, condition=wait_condition)
|
||||||
success, result["result"], result["duration"] = waiter.wait(
|
success, result["result"], result["duration"] = waiter.wait(
|
||||||
wait_timeout, wait_sleep, name, namespace
|
wait_timeout, wait_sleep, name, namespace
|
||||||
)
|
)
|
||||||
match, diffs = diff_objects(existing.to_dict(), obj)
|
match, diffs = diff_objects(existing.to_dict(), obj, hidden_fields)
|
||||||
result["changed"] = not match
|
result["changed"] = not match
|
||||||
if module._diff:
|
if module._diff:
|
||||||
result["diff"] = diffs
|
result["diff"] = diffs
|
||||||
|
|||||||
@@ -168,7 +168,9 @@ def perform_action(svc, resource):
|
|||||||
module.params["kind"],
|
module.params["kind"],
|
||||||
resource["metadata"]["name"],
|
resource["metadata"]["name"],
|
||||||
)
|
)
|
||||||
result = {"changed": False, "warnings": [warn]}
|
if warn:
|
||||||
|
module.warn(warn)
|
||||||
|
result = {"changed": False}
|
||||||
return result
|
return result
|
||||||
|
|
||||||
if module.params["kind"] == "Deployment":
|
if module.params["kind"] == "Deployment":
|
||||||
|
|||||||
@@ -149,7 +149,7 @@ except ImportError:
|
|||||||
# Handled in module setup
|
# Handled in module setup
|
||||||
pass
|
pass
|
||||||
|
|
||||||
from ansible.module_utils._text import to_native
|
from ansible.module_utils.common.text.converters import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
@@ -243,10 +243,12 @@ def execute_module(client, module):
|
|||||||
module.fail_json(msg=error, **return_attributes)
|
module.fail_json(msg=error, **return_attributes)
|
||||||
|
|
||||||
def _continue_or_exit(warn):
|
def _continue_or_exit(warn):
|
||||||
|
if warn:
|
||||||
|
module.warn(warn)
|
||||||
if multiple_scale:
|
if multiple_scale:
|
||||||
return_attributes["results"].append({"warning": warn, "changed": False})
|
return_attributes["results"].append({"changed": False})
|
||||||
else:
|
else:
|
||||||
module.exit_json(warning=warn, **return_attributes)
|
module.exit_json(**return_attributes)
|
||||||
|
|
||||||
for existing in existing_items:
|
for existing in existing_items:
|
||||||
if kind.lower() == "job":
|
if kind.lower() == "job":
|
||||||
|
|||||||
@@ -36,6 +36,7 @@ options:
|
|||||||
- If more than one C(merge_type) is given, the merge_types will be tried in order
|
- 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
|
- 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.
|
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:
|
choices:
|
||||||
- json
|
- json
|
||||||
- merge
|
- merge
|
||||||
@@ -251,6 +252,15 @@ def main():
|
|||||||
supports_check_mode=True,
|
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:
|
try:
|
||||||
client = get_api_client(module=module)
|
client = get_api_client(module=module)
|
||||||
svc = K8sService(client, module)
|
svc = K8sService(client, module)
|
||||||
|
|||||||
@@ -126,7 +126,7 @@ result:
|
|||||||
|
|
||||||
import copy
|
import copy
|
||||||
|
|
||||||
from ansible.module_utils._text import to_native
|
from ansible.module_utils.common.text.converters import to_native
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import (
|
||||||
AnsibleModule,
|
AnsibleModule,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -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,68 @@
|
|||||||
|
# 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/**
|
||||||
|
|
||||||
|
# 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,e4,e5
|
||||||
|
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
|
||||||
|
|
||||||
|
# Workflows across this repo install ansible-core from a GitHub source
|
||||||
|
# archive (required for devel/milestone builds, which have no published
|
||||||
|
# wheel) and install this collection's shared test-requirements.txt /
|
||||||
|
# requirements.txt. Suppress githubactions:S8541 ("omitting --only-binary
|
||||||
|
# :all:") repo-wide for workflow files: forcing wheel-only installs would
|
||||||
|
# break the ansible-core source install and fails outright on the
|
||||||
|
# test-requirements.txt pin coverage==4.5.4, which has no Python 3.13 wheel.
|
||||||
|
# Scoped the same way as e3 above, since a filename-only resourceKey (as
|
||||||
|
# originally used here) does not reliably suppress issues already raised
|
||||||
|
# against this project.
|
||||||
|
sonar.issue.ignore.multicriteria.e4.ruleKey=githubactions:S8541
|
||||||
|
sonar.issue.ignore.multicriteria.e4.resourceKey=.github/workflows/**/*.yaml
|
||||||
|
|
||||||
|
# Same shared test-requirements.txt / requirements.txt as above are not
|
||||||
|
# hash-locked; that is a repo-wide dependency-management concern affecting
|
||||||
|
# every existing workflow. Suppress githubactions:S8544 ("dependencies
|
||||||
|
# without locking resolved versions") repo-wide for workflow files rather
|
||||||
|
# than diverging from established practice.
|
||||||
|
sonar.issue.ignore.multicriteria.e5.ruleKey=githubactions:S8544
|
||||||
|
sonar.issue.ignore.multicriteria.e5.resourceKey=.github/workflows/**/*.yaml
|
||||||
+1
-1
@@ -1,2 +1,2 @@
|
|||||||
modules:
|
modules:
|
||||||
python_requires: ">=3.6"
|
python_requires: ">=3.9"
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
# Running Helm Integration Tests Locally
|
||||||
|
|
||||||
|
This guide explains how to run the `helm*` integration test targets locally using `ansible-test`.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- `ansible-test` available in your environment (installed with `ansible-core`)
|
||||||
|
- A Kubernetes cluster accessible via `kubectl` (for targets that interact with a cluster)
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Create an `integration_config.yml` file under `tests/integration/` with the following variables:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
setup_helm_version: vx.x.x # e.g v4.2.1
|
||||||
|
helm_install_path: /path/to/helm/directory
|
||||||
|
```
|
||||||
|
|
||||||
|
### Variables
|
||||||
|
|
||||||
|
| Variable | Description |
|
||||||
|
|---|---|
|
||||||
|
| `setup_helm_version` | The Helm version to install (e.g. `v4.2.1`). The `v` prefix is optional and will be added automatically if omitted. |
|
||||||
|
| `helm_install_path` | Path to a directory that either already contains a `helm` executable matching the version set in `setup_helm_version`, or an empty/non-existent directory where Helm will be downloaded and installed. |
|
||||||
|
|
||||||
|
If a `helm` binary already exists at `<helm_install_path>/helm`, the setup will skip the download and use the existing binary directly.
|
||||||
|
|
||||||
|
## Running Tests
|
||||||
|
|
||||||
|
Run a specific Helm test target with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ansible-test integration --python <version> -v --no-temp-workdir <target>
|
||||||
|
```
|
||||||
|
|
||||||
|
For example, to run the `helm` target with Python 3.12:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ansible-test integration --python 3.12 -v --no-temp-workdir helm
|
||||||
|
```
|
||||||
|
|
||||||
|
You can run multiple targets in a single command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ansible-test integration --python 3.12 -v --no-temp-workdir helm helm_diff helm_plugin
|
||||||
|
```
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
time=100
|
helm
|
||||||
helm_info
|
helm_info
|
||||||
helm_repository
|
helm_plugin
|
||||||
helm_template
|
helm_template
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
helm_default_archive_name: "helm-{{ helm_version }}-{{ ansible_system | lower }}-amd64.tar.gz"
|
helm_binary: "helm"
|
||||||
helm_binary: "/tmp/helm/{{ ansible_system | lower }}-amd64/helm"
|
setup_helm_version_binary_path: "{{ helm_binary }}"
|
||||||
|
|
||||||
chart_test: "ingress-nginx"
|
chart_test: "ingress-nginx"
|
||||||
chart_test_oci: "oci://registry-1.docker.io/bitnamicharts/redis"
|
chart_test_oci: "oci://registry-1.docker.io/bitnamicharts/redis"
|
||||||
@@ -9,23 +9,26 @@ chart_test_version: 4.2.4
|
|||||||
chart_test_version_local_path: 1.32.0
|
chart_test_version_local_path: 1.32.0
|
||||||
chart_test_version_upgrade: 4.2.5
|
chart_test_version_upgrade: 4.2.5
|
||||||
chart_test_version_upgrade_local_path: 1.33.0
|
chart_test_version_upgrade_local_path: 1.33.0
|
||||||
chart_test_repo: "https://kubernetes.github.io/ingress-nginx"
|
chart_test_repo: "https://stenic.github.io/k8status/"
|
||||||
chart_test_git_repo: "http://github.com/helm/charts.git"
|
chart_test_git_repo: "http://github.com/helm/charts.git"
|
||||||
chart_test_values:
|
chart_test_values:
|
||||||
revisionHistoryLimit: 0
|
revisionHistoryLimit: 0
|
||||||
myValue: "changed"
|
myValue: "changed"
|
||||||
|
|
||||||
test_namespace:
|
test_namespace:
|
||||||
- "helm-test-crds"
|
- "helm-test-crds-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-uninstall"
|
- "helm-uninstall-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-read-envvars"
|
- "helm-read-envvars-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-dep-update"
|
- "helm-dep-update-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-local-path-001"
|
- "helm-local-path-001-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-local-path-002"
|
- "helm-local-path-002-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-local-path-003"
|
- "helm-local-path-003-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-from-repository"
|
- "helm-from-repository-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-from-url"
|
- "helm-from-url-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-reuse-values"
|
- "helm-reuse-values-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-chart-with-space-into-name"
|
- "helm-chart-with-space-into-name-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-reset-then-reuse-values"
|
- "helm-reset-then-reuse-values-{{ helm_version | replace('.', '-') }}"
|
||||||
- "helm-insecure"
|
- "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"
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user