Compare commits

...
25 Commits
Author SHA1 Message Date
c5ee8f254d fix(changelog): update 6.0.0 release date to 2026-08-17 (#304)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-08-17 20:56:45 +00:00
Don NaroandGitHub 47d8bdf08f chore: update ansible-lint config (#301) 2026-08-17 10:32:29 +00:00
278886dfad Release community.okd 6.0.0 (#296)
* Release community.okd 6.0.0

- Update galaxy.yml and Makefile version to 6.0.0
- Generate CHANGELOG.rst from changelog fragments
- Remove consumed changelog fragments

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix(ci): update DOWNSTREAM_VERSION to 6.0.0

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-08-13 20:48:12 +00:00
Don NaroandGitHub 85041157bc fix(downstream.sh): fix sed expression to match VERSION in makefile (#297) 2026-08-13 16:34:38 +00:00
Don NaroandGitHub fd328e619f chore(dockerignore): ignore certain files from the container image (#293) 2026-08-10 21:02:31 +00:00
Don NaroandGitHub f54fee9a30 test: bump kubernetes validate version (#294) 2026-08-10 16:59:35 +00:00
1313ca4eb1 Updating minimum required version of ansible-core from 2.15.0 to 2.16.0 (#292)
* Updating minimum required version of ansible-core from 2.15.0 to 2.16.0

* Update changelogs/fragments/bump-min-ansible-core.yml

Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>

* Applying comments: renaming changelog fragment and updating Ansible Version in README

---------

Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>
2026-08-10 12:36:02 +00:00
Don NaroandGitHub d8d077b754 test(molecule): remove redundant virtualenv params from verify cleanup task (#281) 2026-08-07 20:21:21 +00:00
Chyna SandersandGitHub 2d2d27ec74 chore(OWNERS_ALIASES): add all senior software engineers and leadership to ownership file (#295) 2026-08-07 18:22:00 +00:00
Chyna SandersandGitHub a16e726d3d Replace ansible.module_utils.six.moves.urllib_parse with stdlib urllibparse (#291)
* Replace ansible.module_utils.six.moves.urllib_parse with stdlib urllib.parse

* added changelog
2026-08-04 11:07:04 +00:00
Don NaroandGitHub cc3e4f1a8d Use lowercase true/false for boolean values in module documentation (#280)
* docs: use true false for all booleans in docs

* docs: add changelog fragment
2026-08-03 16:48:34 +00:00
Romi AsadandGitHub 75b91d1853 Fix deprecated imports (#284)
* Imports replaced

* Added changelog fragment

* Changing chanelog fragment category to minor_changes
2026-08-03 15:08:40 +00:00
Chyna SandersandGitHub af9fb5a730 Added changelogs for PR #286 (#290) 2026-08-03 07:49:25 +00:00
Chyna SandersandGitHub b7e5970831 Replace ansible.module_utils.six imports with Python 3 stdlib and add sanity ignore files for ansible-core 2.20/2.21 (#286) 2026-07-31 14:36:44 +00:00
Don NaroandGitHub fe082a5730 fix(gitignore): remove ansible_collections path from gitignore (#288) 2026-07-31 11:51:46 +00:00
Matthew JohnsonandGitHub 74155f021e ACA-2437: added a new CI file (#273)
* added a new CI file, migrated testing information to it, and enhanced the README

* simplify CI.md to match kubernetes.core format

* rewrite CI file to reflect zuul and prow testing
2026-04-10 15:04:53 +00:00
Alina BuzachisandGitHub d30a349e2f Add .ansible-lint (#272)
* Add .ansible-lint

Signed-off-by: Alina Buzachis <abuzachis@redhat.com>

* Update

Signed-off-by: Alina Buzachis <abuzachis@redhat.com>

* Update

Signed-off-by: Alina Buzachis <abuzachis@redhat.com>

---------

Signed-off-by: Alina Buzachis <abuzachis@redhat.com>
2026-03-26 11:47:54 +00:00
Mike GravesandGitHub c2f1d722dc Update ldap image in tests (#274)
* Update ldap image in tests

The bitnami openldap image we had been using is no longer being support
by them. It has been moved over to a bitnamilegacy namespace, but it's
not clear how long that will remain. We should find a better solution at
some point.

* Update versions in Dockerfile

The dockerfile was built around python3.9 which forced the use of
ansible 2.15. This updates the base image to ubi10 which uses python3.12
by default. The version of the oc/kubectl client package was updated to
4.20 as well.

* Try and make it work

* Remove backslash

* debug

* try and force 3.12

* use ubi9

* debug

* try adding packaging

* debug

* Lots of changes

* Add check for none

* Fix python version
2026-03-23 14:01:08 +00:00
Mandar KulkarniandGitHub cfd6ee1f9b Push 5.0.0 changes to main branch (#270)
* prepare release 5.0.0 (#269)

* prepare release 5.0.0

* update changelog to include inventory plugin removal

* update changelog to include inventory plugin removal

* update changlogs

* update version to 6.0.0-dev0

* update version current to 5.0.0
2025-06-13 15:23:54 +00:00
Bianca HendersonandGitHub d2346e4c8f Update k8s dependency upper bounds (#257) 2025-06-05 16:37:49 +00:00
Mandar KulkarniandGitHub 140da75c0f prepare release 4.0.2 (#262) (#263)
(cherry picked from commit 55ccaf3394)
2025-05-29 14:53:51 +00:00
Mike GravesandGitHub f54297c2ac Add ansible-lint to tox linters (#258)
* Add ansible-lint to tox linters

* Bump black

* Black formatting

* fix linting
2025-05-19 19:53:38 +00:00
69bcd79b92 Bump the ansible-lint version to 25.1.2 (#255)
* Bump the ansible-lint version to 25.1.2

* Update changelogs/fragments/ansible-lint-update.yml

Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>

---------

Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>
2025-05-16 16:20:49 +00:00
Mike GravesandGitHub 93746f2392 Remove openshift inventory plugin (#252)
* Remove openshift inventory plugin

This removes the openshift inventory plugin which has been deprecated
since version 3.0.0. The tests have been updated to retain coverage of
the connection plugin, which is still supported.

* Update version in Makefile

* CI fixes

* Update version info in build scripts

* Set ansible remote directory

The security policy on the pod is preventing ansible from writing to /.
Set it to /tmp which should be writable.
2025-05-05 15:55:22 +00:00
Mike GravesandGitHub a3c3a69bbf Update tests for newer version of openshift (#254)
* Update tests for newer version of openshift

More recent versions of ocp no longer automatically create tokens for
service accounts. This updates the tests to manually create the tokens.

* Update nginx template version

The old image was EOL and the deployment was failing to deploy.

* Fix nginx version for all tasks

* Add missing var
2025-05-02 08:30:38 +00:00
60 changed files with 376 additions and 421 deletions
+15
View File
@@ -0,0 +1,15 @@
---
profile: production
exclude_paths:
- tests/unit
- tests/sanity
- molecule
- changelogs
- docs
- .ansible
- .github
warn_list:
- no-log-password
-5
View File
@@ -1,5 +0,0 @@
---
profile: production
exclude_paths:
- molecule
- tests/sanity
+9
View File
@@ -0,0 +1,9 @@
.venv
.git
.idea
.cache/
__pycache__/
*.tar.gz
changelogs/.plugin-cache.yaml
tests/output
tests/integration/cloud-config-*
+1 -1
View File
@@ -26,4 +26,4 @@ jobs:
- uses: ansible-network/github_actions/.github/actions/checkout_dependency@main - uses: ansible-network/github_actions/.github/actions/checkout_dependency@main
- name: run-ansible-lint - name: run-ansible-lint
uses: ansible/ansible-lint@v24.7.0 uses: ansible/ansible-lint@v25.1.2
-3
View File
@@ -16,6 +16,3 @@ changelogs/.plugin-cache.yaml
# Temporary test files. # Temporary test files.
tests/output tests/output
tests/integration/cloud-config-* tests/integration/cloud-config-*
# Ignore the ansible_collections that the Makefile generates.
ansible_collections
+59 -3
View File
@@ -4,13 +4,69 @@ OKD Collection Release Notes
.. contents:: Topics .. contents:: Topics
v6.0.0
======
Release Summary
---------------
This major release drops support for ansible-core versions below 2.16,
replaces all ``ansible.module_utils.six`` imports with Python 3 stdlib equivalents,
and fixes deprecated ``ansible.module_utils._text`` imports for compatibility
with ansible-core 2.24+.
Minor Changes
-------------
- Add sanity test ignore files for ansible-core 2.20 and 2.21 (https://github.com/openshift/community.okd/pull/286).
- Replace ``ansible.module_utils.six.moves.urllib_parse`` import with Python 3 ``urllib.parse`` in ``openshift_auth`` module (https://github.com/openshift/community.okd/pull/291).
- Replace ``ansible.module_utils.six`` imports (``iteritems``, ``string_types``) with Python 3 stdlib equivalents (https://github.com/openshift/community.okd/pull/286).
- Replace deprecated ``ansible.module_utils._text`` imports with ``ansible.module_utils.common.text.converters`` to fix compatibility with ansible-core 2.24+ (https://github.com/openshift/community.okd/issues/275).
Breaking Changes / Porting Guide
--------------------------------
- Minimum supported version of ansible-core is now 2.16 (https://github.com/openshift/community.okd/pull/292).
v5.0.0
======
Release Summary
---------------
This release drops support for ansible-lint < 25.1.2 and removes deprecated openshift inventory plugin.
Minor Changes
-------------
- Bump version of ansible-lint to 25.1.2 (https://github.com/openshift/community.okd/pull/255).
- Bump version of ansible-lint to minimum 24.7.0 (https://github.com/openshift/community.okd/pull/240).
Breaking Changes / Porting Guide
--------------------------------
- Remove openshift inventory plugin deprecated in 3.0.0 (https://github.com/openshift/community.okd/pull/252).
v4.0.2
======
Release Summary
---------------
This patch updates the k8s dependency version to the 5.x range and modifies tests to handle the manual creation of service account tokens.
v4.0.1 v4.0.1
====== ======
Bugfixes Release Summary
-------- ---------------
- openshift_auth - fix issue where openshift_auth module sometimes does not delete the auth token (https://github.com/openshift/community.okd/pull/242) This is a bug fix release
Minor Changes
-------------
- openshift_auth - fix issue where openshift_auth module sometimes does not delete the auth token. Based on stale PR (https://github.com/openshift/community.okd/pull/194).
v4.0.0 v4.0.0
====== ======
+64
View File
@@ -0,0 +1,64 @@
# Continuous Integration (CI)
This collection uses two CI systems: **Zuul** for PR validation checks and **Prow** for integration testing.
## Zuul - PR Validation
Zuul runs automated tests on every pull request. The Zuul configuration for this collection is defined in the [ansible/ansible-zuul-jobs](https://github.com/ansible/ansible-zuul-jobs/blob/main/zuul.d/project-templates.yaml) repository under the `ansible-collections-community-okd` template.
### Jobs Run by Zuul
The following jobs run in the `third-party-check` pipeline on every PR:
| Job | Description |
| --- | ----------- |
| `build-ansible-collection` | Builds the collection tarball |
| `ansible-galaxy-importer` | Validates collection structure for Galaxy (non-voting) |
| `ansible-tox-linters` | Runs `black`, `flake8`, and `ansible-lint` via `tox -e linters` (see [tox.ini](tox.ini)) |
| `ansible-test-units-community-okd-python39` | Executes unit tests with Python 3.9 |
**Upstream Sanity Tests:**
- `ansible-test-sanity-docker-devel`
- `ansible-test-sanity-docker-milestone`
- `ansible-test-sanity-docker-stable-2.16`
- `ansible-test-sanity-docker-stable-2.17`
- `ansible-test-sanity-docker-stable-2.18`
**Downstream Sanity Tests** (test the `redhat.openshift` variant):
- `ansible-test-sanity-okd-downstream-devel`
- `ansible-test-sanity-okd-downstream-milestone`
- `ansible-test-sanity-okd-downstream-stable-2.16`
- `ansible-test-sanity-okd-downstream-stable-2.17`
- `ansible-test-sanity-okd-downstream-stable-2.18`
## OpenShift Prow - Integration Testing
Integration tests for community.okd are executed via [OpenShift Prow](https://github.com/kubernetes/test-infra/blob/master/prow/README.md), OpenShift's CI/CD system for testing against live clusters.
### Prow Configuration
The Prow configuration for this collection is maintained in the [openshift/release](https://github.com/openshift/release) repository at `ci-operator/config/openshift/community.okd/openshift-community.okd-main.yaml`.
### Integration Test Workflow
The integration test workflow follows these steps:
1. **Prow builds the test runner image** defined in [ci/Dockerfile](ci/Dockerfile)
- Based on `registry.access.redhat.com/ubi9/ubi`
- Includes Python 3.12, ansible-core, molecule, kubernetes client, and OKD CLI tools
2. **Prow executes `make test-integration-incluster`**
- This runs [ci/incluster_integration.sh](ci/incluster_integration.sh)
3. **The script spawns a Kubernetes Job** that runs `make test-integration` using the previously built image
- Job runs with cluster-admin permissions
- 30-minute timeout
- Backoff limit of 2 retries
4. **`make test-integration` runs both upstream and downstream tests:**
- **Upstream tests** (`upstream-test-integration`): Runs molecule tests for `community.okd` collection
- **Downstream tests** (`downstream-test-integration`): Runs `ci/downstream.sh -i` to convert the collection to `redhat.openshift` and test the downstream variant
### Test Framework
Integration tests use the Molecule framework and require a live OpenShift or Kubernetes cluster (>=1.24). Tests are located in the `molecule/default/` directory and cover check mode, creation, idempotency, modification, and deletion scenarios.
+1 -1
View File
@@ -1,7 +1,7 @@
.PHONY: molecule .PHONY: molecule
# Also needs to be updated in galaxy.yml # Also needs to be updated in galaxy.yml
VERSION = 4.0.1 VERSION = 6.0.0
SANITY_TEST_ARGS ?= --docker --color SANITY_TEST_ARGS ?= --docker --color
UNITS_TEST_ARGS ?= --docker --color UNITS_TEST_ARGS ?= --docker --color
+10 -2
View File
@@ -1,11 +1,19 @@
aliases: aliases:
community.okd-approvers: community.okd-approvers:
- gravesm
- jillr - jillr
- GomathiselviS
- alinabuzachis - alinabuzachis
- abikouo - abikouo
- beeankha
- mandar242
- oraNod
- brahmanim
community.okd-reviewers: community.okd-reviewers:
- gravesm
- jillr - jillr
- GomathiselviS
- alinabuzachis - alinabuzachis
- abikouo - abikouo
- beeankha
- mandar242
- oraNod
- brahmanim
+2 -2
View File
@@ -26,7 +26,7 @@ For more information about communication, see the [Ansible communication guide](
<!--start requires_ansible--> <!--start requires_ansible-->
### Ansible version compatibility ### Ansible version compatibility
This collection has been tested against following Ansible versions: **>=2.15.0**. This collection has been tested against following Ansible versions: **>=2.16.0**.
Please ensure to update the `network_os` to use the fully qualified collection name (for example, `cisco.ios.ios`). Please ensure to update the `network_os` to use the fully qualified collection name (for example, `cisco.ios.ios`).
Plugins and modules within a collection may be tested with only specific Ansible versions. Plugins and modules within a collection may be tested with only specific Ansible versions.
@@ -92,7 +92,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible
--- ---
collections: collections:
- name: community.okd - name: community.okd
version: 4.0.1 version: 5.0.0
``` ```
### Installing the Kubernetes Python Library ### Installing the Kubernetes Python Library
+54 -2
View File
@@ -244,9 +244,61 @@ releases:
4.0.1: 4.0.1:
changes: changes:
minor_changes: minor_changes:
- openshift_auth - fix issue where openshift_auth module sometimes does not delete the auth - openshift_auth - fix issue where openshift_auth module sometimes does not
token. Based on stale PR (https://github.com/openshift/community.okd/pull/194). delete the auth token. Based on stale PR (https://github.com/openshift/community.okd/pull/194).
release_summary: This is a bug fix release release_summary: This is a bug fix release
fragments: fragments:
- 242-fix-failed-token-deletion.yml - 242-fix-failed-token-deletion.yml
release_date: '2024-12-03' release_date: '2024-12-03'
4.0.2:
changes:
release_summary: This patch updates the k8s dependency version to the 5.x range
and modifies tests to handle the manual creation of service account tokens.
fragments:
- 4.0.2.yml
release_date: '2025-05-28'
5.0.0:
changes:
breaking_changes:
- Remove openshift inventory plugin deprecated in 3.0.0 (https://github.com/openshift/community.okd/pull/252).
minor_changes:
- Bump version of ansible-lint to 25.1.2 (https://github.com/openshift/community.okd/pull/255).
- Bump version of ansible-lint to minimum 24.7.0 (https://github.com/openshift/community.okd/pull/240).
release_summary: This release drops support for ansible-lint < 25.1.2 and removes
deprecated openshift inventory plugin.
fragments:
- 240-bump-ansible-lint-version.yml
- 5.0.0.yml
- ansible-lint-update.yml
- readme_template_update.yml
release_date: '2025-06-10'
6.0.0:
changes:
breaking_changes:
- Minimum supported version of ansible-core is now 2.16 (https://github.com/openshift/community.okd/pull/292).
minor_changes:
- Add sanity test ignore files for ansible-core 2.20 and 2.21 (https://github.com/openshift/community.okd/pull/286).
- Replace ``ansible.module_utils.six.moves.urllib_parse`` import with Python
3 ``urllib.parse`` in ``openshift_auth`` module (https://github.com/openshift/community.okd/pull/291).
- Replace ``ansible.module_utils.six`` imports (``iteritems``, ``string_types``)
with Python 3 stdlib equivalents (https://github.com/openshift/community.okd/pull/286).
- Replace deprecated ``ansible.module_utils._text`` imports with ``ansible.module_utils.common.text.converters``
to fix compatibility with ansible-core 2.24+ (https://github.com/openshift/community.okd/issues/275).
release_summary: 'This major release drops support for ansible-core versions
below 2.16,
replaces all ``ansible.module_utils.six`` imports with Python 3 stdlib equivalents,
and fixes deprecated ``ansible.module_utils._text`` imports for compatibility
with ansible-core 2.24+.
'
fragments:
- 187-lowercase-booleans.yml
- 286-replace-six-imports.yml
- 292-bump-min-ansible-core.yml
- fix-deprecated-text-imports.yml
- replace-six-urllib-parse.yml
- v6.0.0-release-summary.yml
release_date: '2026-08-17'
@@ -1,3 +0,0 @@
---
minor_changes:
- Bump version of ansible-lint to minimum 24.7.0 (https://github.com/openshift/community.okd/pull/240).
@@ -1,2 +0,0 @@
bugfixes:
- openshift_auth - fix issue where openshift_auth module sometimes does not delete the auth token. Based on stale PR (https://github.com/openshift/community.okd/pull/194).
@@ -1,3 +0,0 @@
---
trivial:
- Update the README doc to match https://access.redhat.com/articles/7068606.
+8 -8
View File
@@ -5,26 +5,26 @@ ENV OPERATOR=/usr/local/bin/ansible-operator \
USER_NAME=ansible-operator\ USER_NAME=ansible-operator\
HOME=/opt/ansible \ HOME=/opt/ansible \
ANSIBLE_LOCAL_TMP=/opt/ansible/tmp \ ANSIBLE_LOCAL_TMP=/opt/ansible/tmp \
DOWNSTREAM_BUILD_PYTHON=python3.9 DOWNSTREAM_BUILD_PYTHON=python3.12
RUN yum install -y \ RUN yum install -y \
glibc-langpack-en \ glibc-langpack-en \
git \ git \
make \ make \
python3 \ python3.12 \
python3-devel \ python3.12-devel \
python3-pip \ python3.12-pip \
python3-setuptools \ python3.12-setuptools \
gcc \ gcc \
openldap-devel \ openldap-devel \
&& python3.9 -m pip install --no-cache-dir --upgrade setuptools pip \ && python3.12 -m pip install --no-cache-dir --upgrade setuptools pip \
&& python3.9 -m pip install --no-cache-dir \ && python3.12 -m pip install --no-cache-dir \
kubernetes \ kubernetes \
"ansible-core" \ "ansible-core" \
"molecule" \ "molecule" \
&& yum clean all \ && yum clean all \
&& rm -rf $HOME/.cache \ && rm -rf $HOME/.cache \
&& curl -L https://github.com/openshift/okd/releases/download/4.12.0-0.okd-2023-04-16-041331/openshift-client-linux-4.12.0-0.okd-2023-04-16-041331.tar.gz | tar -xz -C /usr/local/bin && curl -L https://github.com/okd-project/okd/releases/download/4.20.0-okd-scos.17/openshift-client-linux-amd64-rhel9-4.20.0-okd-scos.17.tar.gz | tar -xz -C /usr/local/bin
# TODO: Is there a better way to install this client in ubi8? # TODO: Is there a better way to install this client in ubi8?
COPY . /opt/ansible COPY . /opt/ansible
+3 -3
View File
@@ -9,7 +9,7 @@
# - All functions are prefixed with f_ so it's obvious where they come # - All functions are prefixed with f_ so it's obvious where they come
# from when in use throughout the script # from when in use throughout the script
DOWNSTREAM_VERSION="4.0.1" DOWNSTREAM_VERSION="6.0.0"
KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}" KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}"
INSTALL_DOWNSTREAM_COLLECTION_PATH="${INSTALL_DOWNSTREAM_COLLECTION_PATH:-}" INSTALL_DOWNSTREAM_COLLECTION_PATH="${INSTALL_DOWNSTREAM_COLLECTION_PATH:-}"
_build_dir="" _build_dir=""
@@ -41,7 +41,7 @@ f_text_sub()
sed -i.bak "s/Ansible Galaxy/Automation Hub/" "${_build_dir}/README.md" sed -i.bak "s/Ansible Galaxy/Automation Hub/" "${_build_dir}/README.md"
sed -i.bak "s/community-okd/redhat-openshift/" "${_build_dir}/Makefile" sed -i.bak "s/community-okd/redhat-openshift/" "${_build_dir}/Makefile"
sed -i.bak "s/community\/okd/redhat\/openshift/" "${_build_dir}/Makefile" sed -i.bak "s/community\/okd/redhat\/openshift/" "${_build_dir}/Makefile"
sed -i.bak "s/^VERSION\:/VERSION: ${DOWNSTREAM_VERSION}/" "${_build_dir}/Makefile" sed -i.bak "s/^VERSION = .*$/VERSION = ${DOWNSTREAM_VERSION}/" "${_build_dir}/Makefile"
sed -i.bak "s/name\:.*$/name: openshift/" "${_build_dir}/galaxy.yml" sed -i.bak "s/name\:.*$/name: openshift/" "${_build_dir}/galaxy.yml"
sed -i.bak "s/namespace\:.*$/namespace: redhat/" "${_build_dir}/galaxy.yml" sed -i.bak "s/namespace\:.*$/namespace: redhat/" "${_build_dir}/galaxy.yml"
sed -i.bak "s/Kubernetes/OpenShift/g" "${_build_dir}/galaxy.yml" sed -i.bak "s/Kubernetes/OpenShift/g" "${_build_dir}/galaxy.yml"
@@ -64,6 +64,7 @@ f_prep()
# Files to copy downstream (relative repo root dir path) # Files to copy downstream (relative repo root dir path)
_file_manifest=( _file_manifest=(
.gitignore .gitignore
.ansible-lint
CHANGELOG.rst CHANGELOG.rst
galaxy.yml galaxy.yml
LICENSE LICENSE
@@ -77,7 +78,6 @@ f_prep()
# Directories to recursively copy downstream (relative repo root dir path) # Directories to recursively copy downstream (relative repo root dir path)
_dir_manifest=( _dir_manifest=(
.config
changelogs changelogs
ci ci
meta meta
+2 -2
View File
@@ -5,7 +5,7 @@ authors:
- willthames (https://github.com/willthames) - willthames (https://github.com/willthames)
- Akasurde (https://github.com/akasurde) - Akasurde (https://github.com/akasurde)
dependencies: dependencies:
kubernetes.core: '>=5.0.0' kubernetes.core: '>=6.0.0'
description: OKD Collection for Ansible. description: OKD Collection for Ansible.
documentation: '' documentation: ''
homepage: '' homepage: ''
@@ -24,4 +24,4 @@ tags:
- okd - okd
- cluster - cluster
# Also needs to be updated in the Makefile # Also needs to be updated in the Makefile
version: 4.0.1 version: 6.0.0
+3 -4
View File
@@ -1,5 +1,5 @@
--- ---
requires_ansible: '>=2.15.0' requires_ansible: '>=2.16.0'
action_groups: action_groups:
okd: okd:
- k8s - k8s
@@ -19,11 +19,10 @@ plugin_routing:
redirect: community.okd.openshift_auth redirect: community.okd.openshift_auth
inventory: inventory:
openshift: openshift:
deprecation: tombstone:
removal_version: 5.0.0 removal_version: 5.0.0
warning_text: >- warning_text: >-
The openshift inventory plugin has been deprecated and Use kubernetes.core.k8s_info and ansible.builtin.add_host instead.
will be removed in release 5.0.0.
action: action:
k8s: k8s:
redirect: kubernetes.core.k8s_info redirect: kubernetes.core.k8s_info
+1
View File
@@ -1,6 +1,7 @@
# Want to make sure comments don't break it # Want to make sure comments don't break it
export NAME=test123 export NAME=test123
NAMESPACE=openshift NAMESPACE=openshift
NGINX_VERSION=1.22-ubi8
+2 -7
View File
@@ -14,17 +14,12 @@ provisioner:
log: true log: true
options: options:
vvv: True vvv: True
config_options:
inventory: inventory:
enable_plugins: community.okd.openshift
inventory:
hosts:
plugin: community.okd.openshift
host_vars: host_vars:
localhost: localhost:
virtualenv: ${MOLECULE_EPHEMERAL_DIRECTORY}/virtualenv virtualenv: ${MOLECULE_EPHEMERAL_DIRECTORY}/virtualenv
virtualenv_command: '{{ ansible_playbook_python }} -m virtualenv' virtualenv_command: '{{ ansible_playbook_python }} -m venv'
virtualenv_interpreter: '{{ virtualenv }}/bin/python' virtualenv_interpreter: '{{ virtualenv }}/bin/python3'
playbook_namespace: molecule-tests playbook_namespace: molecule-tests
env: env:
ANSIBLE_FORCE_COLOR: 'true' ANSIBLE_FORCE_COLOR: 'true'
+1
View File
@@ -13,6 +13,7 @@
- kubernetes>=12.0.0 - kubernetes>=12.0.0
- coverage - coverage
- python-ldap - python-ldap
- packaging
virtualenv: "{{ virtualenv }}" virtualenv: "{{ virtualenv }}"
virtualenv_command: "{{ virtualenv_command }}" virtualenv_command: "{{ virtualenv_command }}"
virtualenv_site_packages: no virtualenv_site_packages: no
@@ -47,8 +47,8 @@
assert: assert:
that: that:
- result is changed - result is changed
- admins_group - admins_group | length > 0
- devs_group - devs_group | length > 0
- '"jane.smith@ansible.org" in admins_group.users' - '"jane.smith@ansible.org" in admins_group.users'
- '"jim.adams@ansible.org" in admins_group.users' - '"jim.adams@ansible.org" in admins_group.users'
- '"jordanbulls@ansible.org" in devs_group.users' - '"jordanbulls@ansible.org" in devs_group.users'
@@ -47,8 +47,8 @@
assert: assert:
that: that:
- result is changed - result is changed
- banking_group - banking_group | length > 0
- insurance_group - insurance_group | length > 0
- '"james-allan@ansible.org" in banking_group.users' - '"james-allan@ansible.org" in banking_group.users'
- '"gordon-kane@ansible.org" in banking_group.users' - '"gordon-kane@ansible.org" in banking_group.users'
- '"alice-courtney@ansible.org" in insurance_group.users' - '"alice-courtney@ansible.org" in insurance_group.users'
@@ -17,7 +17,8 @@
spec: spec:
containers: containers:
- name: ldap - name: ldap
image: bitnami/openldap # bitnami is no longer supporting this image. we should probably find a replacement
image: docker.io/bitnamilegacy/openldap:latest
env: env:
- name: LDAP_ADMIN_USERNAME - name: LDAP_ADMIN_USERNAME
value: "{{ ldap_admin_user }}" value: "{{ ldap_admin_user }}"
@@ -13,10 +13,8 @@
- pip: - pip:
name: name:
- kubernetes - python-ldap
virtualenv: "{{ venv }}" state: absent
virtualenv_command: "{{ virtualenv_command }}"
virtualenv_site_packages: false
- name: Load test configurations - name: Load test configurations
set_fact: set_fact:
@@ -27,8 +25,6 @@
config: "{{ configs.simple }}" config: "{{ configs.simple }}"
register: result register: result
ignore_errors: true ignore_errors: true
vars:
ansible_python_interpreter: "{{ venv }}/bin/python"
- name: Check that module failed gracefully - name: Check that module failed gracefully
assert: assert:
@@ -36,6 +32,9 @@
- '"Failed to import the required Python library (python-ldap)" in result.msg' - '"Failed to import the required Python library (python-ldap)" in result.msg'
always: always:
- pip:
name:
- python-ldap
- name: Remove temp directory - name: Remove temp directory
file: file:
path: "{{ test_dir }}" path: "{{ test_dir }}"
@@ -68,8 +68,8 @@
assert: assert:
that: that:
- result is changed - result is changed
- admins_group - admins_group | length > 0
- devs_group - devs_group | length > 0
- '"jane.smith@ansible.org" in admins_group.users' - '"jane.smith@ansible.org" in admins_group.users'
- '"jim.adams@ansible.org" in devs_group.users' - '"jim.adams@ansible.org" in devs_group.users'
- '"jordanbulls@ansible.org" in devs_group.users' - '"jordanbulls@ansible.org" in devs_group.users'
@@ -89,8 +89,8 @@
assert: assert:
that: that:
- result is changed - result is changed
- admins_group - admins_group | length > 0
- devs_group - devs_group | length > 0
- '"jane.smith@ansible.org" in admins_group.users' - '"jane.smith@ansible.org" in admins_group.users'
- '"jim.adams@ansible.org" in devs_group.users' - '"jim.adams@ansible.org" in devs_group.users'
- '"jordanbulls@ansible.org" in devs_group.users' - '"jordanbulls@ansible.org" in devs_group.users'
@@ -110,8 +110,8 @@
assert: assert:
that: that:
- result is changed - result is changed
- admins_group - admins_group | length > 0
- devs_group - devs_group | length > 0
- '"cn=Jane,ou=people,ou=rfc2307,"+ldap_root in admins_group.users' - '"cn=Jane,ou=people,ou=rfc2307,"+ldap_root in admins_group.users'
- '"cn=Jim,ou=people,ou=rfc2307,"+ldap_root in devs_group.users' - '"cn=Jim,ou=people,ou=rfc2307,"+ldap_root in devs_group.users'
- '"cn=Jordan,ou=people,ou=rfc2307,"+ldap_root in devs_group.users' - '"cn=Jordan,ou=people,ou=rfc2307,"+ldap_root in devs_group.users'
@@ -131,8 +131,8 @@
assert: assert:
that: that:
- result is changed - result is changed
- admins_group - admins_group | length > 0
- devs_group - devs_group | length > 0
- '"jane.smith@ansible.org" in admins_group.users' - '"jane.smith@ansible.org" in admins_group.users'
- '"jim.adams@ansible.org" in devs_group.users' - '"jim.adams@ansible.org" in devs_group.users'
- '"jordanbulls@ansible.org" in devs_group.users' - '"jordanbulls@ansible.org" in devs_group.users'
@@ -3,6 +3,7 @@
- set_fact: - set_fact:
test_sa: "clusterrole-sa" test_sa: "clusterrole-sa"
test_ns: "clusterrole-ns" test_ns: "clusterrole-ns"
test_tn: "clusterrole-tn"
- name: Ensure namespace - name: Ensure namespace
kubernetes.core.k8s: kubernetes.core.k8s:
@@ -26,34 +27,27 @@
name: "{{ test_sa }}" name: "{{ test_sa }}"
namespace: "{{ test_ns }}" namespace: "{{ test_ns }}"
- name: Read Service Account - name: Create SA token
kubernetes.core.k8s_info: kubernetes.core.k8s:
kind: ServiceAccount definition:
apiVersion: v1
kind: Secret
metadata:
name: "{{ test_tn }}"
namespace: "{{ test_ns }}" namespace: "{{ test_ns }}"
name: "{{ test_sa }}" annotations:
register: result kubernetes.io/service-account.name: "{{ test_sa }}"
type: kubernetes.io/service-account-token
- set_fact:
secret_token: "{{ result.resources[0]['secrets'][0]['name'] }}"
- name: Get secret details - name: Get secret details
kubernetes.core.k8s_info: kubernetes.core.k8s_info:
kind: Secret kind: Secret
namespace: '{{ test_ns }}' namespace: "{{ test_ns }}"
name: '{{ secret_token }}' name: "{{ test_tn }}"
register: _secret register: _secret
retries: 10
delay: 10
until:
- ("'openshift.io/token-secret.value' in _secret.resources[0]['metadata']['annotations']") or ("'token' in _secret.resources[0]['data']")
- set_fact:
api_token: "{{ _secret.resources[0]['metadata']['annotations']['openshift.io/token-secret.value'] }}"
when: "'openshift.io/token-secret.value' in _secret.resources[0]['metadata']['annotations']"
- set_fact: - set_fact:
api_token: "{{ _secret.resources[0]['data']['token'] | b64decode }}" api_token: "{{ _secret.resources[0]['data']['token'] | b64decode }}"
when: "'token' in _secret.resources[0]['data']"
- name: list Node should failed (forbidden user) - name: list Node should failed (forbidden user)
kubernetes.core.k8s_info: kubernetes.core.k8s_info:
@@ -4,6 +4,7 @@
test_ns: "prune-roles" test_ns: "prune-roles"
sa_name: "roles-sa" sa_name: "roles-sa"
pod_name: "pod-prune" pod_name: "pod-prune"
tn_name: "roles-sa-token"
role_definition: role_definition:
- name: pod-list - name: pod-list
labels: labels:
@@ -50,34 +51,27 @@
name: '{{ sa_name }}' name: '{{ sa_name }}'
namespace: '{{ test_ns }}' namespace: '{{ test_ns }}'
- name: Read Service Account - name: Create SA secret
kubernetes.core.k8s_info: kubernetes.core.k8s:
kind: ServiceAccount definition:
namespace: '{{ test_ns }}' apiVersion: v1
name: '{{ sa_name }}' kind: Secret
register: sa_out metadata:
name: "{{ tn_name }}"
- set_fact: namespace: "{{ test_ns }}"
secret_token: "{{ sa_out.resources[0]['secrets'][0]['name'] }}" annotations:
kubernetes.io/service-account.name: "{{ sa_name }}"
type: kubernetes.io/service-account-token
- name: Get secret details - name: Get secret details
kubernetes.core.k8s_info: kubernetes.core.k8s_info:
kind: Secret kind: Secret
namespace: '{{ test_ns }}' namespace: '{{ test_ns }}'
name: '{{ secret_token }}' name: '{{ tn_name }}'
register: r_secret register: r_secret
retries: 10
delay: 10
until:
- ("'openshift.io/token-secret.value' in r_secret.resources[0]['metadata']['annotations']") or ("'token' in r_secret.resources[0]['data']")
- set_fact:
api_token: "{{ r_secret.resources[0]['metadata']['annotations']['openshift.io/token-secret.value'] }}"
when: "'openshift.io/token-secret.value' in r_secret.resources[0]['metadata']['annotations']"
- set_fact: - set_fact:
api_token: "{{ r_secret.resources[0]['data']['token'] | b64decode }}" api_token: "{{ r_secret.resources[0]['data']['token'] | b64decode }}"
when: "'token' in r_secret.resources[0]['data']"
- name: list resources using service account - name: list resources using service account
kubernetes.core.k8s_info: kubernetes.core.k8s_info:
@@ -7,6 +7,7 @@
parameters: parameters:
NAMESPACE: openshift NAMESPACE: openshift
NAME: test123 NAME: test123
NGINX_VERSION: "{{ nginx_version }}"
register: result register: result
- name: Create the rendered resources - name: Create the rendered resources
@@ -32,6 +33,7 @@
parameters: parameters:
NAMESPACE: openshift NAMESPACE: openshift
NAME: test123 NAME: test123
NGINX_VERSION: "{{ nginx_version }}"
state: present state: present
namespace_target: process-test namespace_target: process-test
register: result register: result
@@ -44,6 +46,7 @@
NAMESPACE: openshift NAMESPACE: openshift
NAME: test123 NAME: test123
MEMORY_LIMIT: 1Gi MEMORY_LIMIT: 1Gi
NGINX_VERSION: "{{ nginx_version }}"
state: present state: present
namespace_target: process-test namespace_target: process-test
register: result register: result
@@ -55,6 +58,7 @@
parameters: parameters:
NAMESPACE: openshift NAMESPACE: openshift
NAME: test123 NAME: test123
NGINX_VERSION: "{{ nginx_version }}"
state: absent state: absent
namespace_target: process-test namespace_target: process-test
register: result register: result
@@ -213,5 +213,6 @@
ignore_errors: true ignore_errors: true
when: when:
- registry.public_hostname - registry.public_hostname is not none
- registry.public_hostname | length > 0
- registry.check.reached - registry.check.reached
+29 -10
View File
@@ -1,9 +1,31 @@
--- ---
- name: Verify inventory and connection plugins - name: Create inventory of pods
# This group is created by the openshift_inventory plugin # We need to manually create the inventory of pods now that the inventory plugin has been removed
# It is automatically configured to use the `oc` connection plugin gather_facts: false
hosts: localhost
connection: local
tasks:
- name: Get pods
kubernetes.core.k8s_info:
kind: Pod
namespace: testing
register: pods
- name: Add pods to inventory
ansible.builtin.add_host:
name: "{{ item.metadata.name }}"
groups:
- namespace_testing_pods
ansible_oc_pod: "{{ item.metadata.name }}"
ansible_oc_namespace: "{{ item.metadata.namespace }}"
pod_phase: "{{ item.status.phase }}"
ansible_remote_tmp: /tmp/.ansible
loop: "{{ pods.resources }}"
- name: Verify connection plugin
hosts: namespace_testing_pods hosts: namespace_testing_pods
gather_facts: no gather_facts: no
connection: community.okd.oc
vars: vars:
file_content: | file_content: |
Hello world Hello world
@@ -43,20 +65,16 @@
ansible_python_interpreter: '{{ virtualenv_interpreter }}' ansible_python_interpreter: '{{ virtualenv_interpreter }}'
tasks: tasks:
# No explicit `virtualenv:` param is necessary with the following pip tasks.
# prepare.yml creates the venv and ansible_python_interpreter sets it.
- pip: - pip:
name: kubernetes-validate==1.12.0 name: kubernetes-validate==1.35.0
virtualenv: "{{ virtualenv }}"
virtualenv_command: "{{ virtualenv_command }}"
virtualenv_site_packages: no
- import_tasks: tasks/validate_installed.yml - import_tasks: tasks/validate_installed.yml
- pip: - pip:
name: kubernetes-validate name: kubernetes-validate
state: absent state: absent
virtualenv: "{{ virtualenv }}"
virtualenv_command: "{{ virtualenv_command }}"
virtualenv_site_packages: no
- import_tasks: tasks/validate_not_installed.yml - import_tasks: tasks/validate_not_installed.yml
@@ -77,6 +95,7 @@
- import_tasks: tasks/openshift_process.yml - import_tasks: tasks/openshift_process.yml
vars: vars:
files_dir: '{{ playbook_dir }}/files' files_dir: '{{ playbook_dir }}/files'
nginx_version: 1.22-ubi8
always: always:
- name: Delete namespace - name: Delete namespace
community.okd.k8s: community.okd.k8s:
-252
View File
@@ -1,252 +0,0 @@
# Copyright (c) 2018 Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
name: openshift
author:
- Chris Houseknecht (@chouseknecht)
short_description: OpenShift inventory source
description:
- Fetch containers, services and routes for one or more clusters
- Groups by cluster name, namespace, namespace_services, namespace_pods, namespace_routes, and labels
- Uses openshift.(yml|yaml) YAML configuration file to set parameter values.
deprecated:
removed_in: 5.0.0
why: |
As discussed in U(https://github.com/ansible-collections/kubernetes.core/issues/31), we decided to
remove the openshift inventory plugin in release 5.0.0.
alternative: "Use M(kubernetes.core.k8s_info) and M(ansible.builtin.add_host) instead."
options:
plugin:
description: token that ensures this is a source file for the 'openshift' plugin.
required: True
choices: ['openshift', 'community.okd.openshift']
connections:
description:
- Optional list of cluster connection settings. If no connections are provided, the default
I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces
the active user is authorized to access.
suboptions:
name:
description:
- Optional name to assign to the cluster. If not provided, a name is constructed from the server
and port.
kubeconfig:
description:
- Path to an existing Kubernetes config file. If not provided, and no other connection
options are provided, the Kubernetes client will attempt to load the default
configuration file from I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG
environment variable.
context:
description:
- The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment
variable.
host:
description:
- Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
api_key:
description:
- Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment
variable.
username:
description:
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME
environment variable.
password:
description:
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD
environment variable.
client_cert:
description:
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE
environment variable.
aliases: [ cert_file ]
client_key:
description:
- Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE
environment variable.
aliases: [ key_file ]
ca_cert:
description:
- Path to a CA certificate used to authenticate with the API. Can also be specified via
K8S_AUTH_SSL_CA_CERT environment variable.
aliases: [ ssl_ca_cert ]
validate_certs:
description:
- "Whether or not to verify the API server's SSL certificates. Can also be specified via
K8S_AUTH_VERIFY_SSL environment variable."
type: bool
aliases: [ verify_ssl ]
namespaces:
description:
- List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized
to access.
requirements:
- "python >= 3.6"
- "kubernetes >= 12.0.0"
- "PyYAML >= 3.11"
"""
EXAMPLES = """
# File must be named openshift.yaml or openshift.yml
- name: Authenticate with token, and return all pods and services for all namespaces
plugin: community.okd.openshift
connections:
- host: https://192.168.64.4:8443
api_key: xxxxxxxxxxxxxxxx
verify_ssl: false
- name: Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
plugin: community.okd.openshift
connections:
- namespaces:
- testing
- name: Use a custom config file, and a specific context.
plugin: community.okd.openshift
connections:
- kubeconfig: /path/to/config
context: 'awx/192-168-64-4:8443/developer'
"""
try:
from ansible_collections.kubernetes.core.plugins.inventory.k8s import (
K8sInventoryException,
InventoryModule as K8sInventoryModule,
format_dynamic_api_exc,
)
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
get_api_client,
)
HAS_KUBERNETES_COLLECTION = True
except ImportError as e:
HAS_KUBERNETES_COLLECTION = False
try:
from kubernetes.dynamic.exceptions import DynamicApiError
except ImportError:
pass
class InventoryModule(K8sInventoryModule):
NAME = "community.okd.openshift"
connection_plugin = "community.okd.oc"
transport = "oc"
def check_kubernetes_collection(self):
if not HAS_KUBERNETES_COLLECTION:
raise K8sInventoryException(
"The kubernetes.core collection must be installed"
)
def fetch_objects(self, connections):
self.check_kubernetes_collection()
super(InventoryModule, self).fetch_objects(connections)
self.display.deprecated(
"The 'openshift' inventory plugin has been deprecated and will be removed in release 5.0.0",
version="5.0.0",
collection_name="community.okd",
)
if connections:
if not isinstance(connections, list):
raise K8sInventoryException("Expecting connections to be a list.")
for connection in connections:
client = get_api_client(**connection)
name = connection.get(
"name", self.get_default_host_name(client.configuration.host)
)
if connection.get("namespaces"):
namespaces = connection["namespaces"]
else:
namespaces = self.get_available_namespaces(client)
for namespace in namespaces:
self.get_routes_for_namespace(client, name, namespace)
else:
client = get_api_client()
name = self.get_default_host_name(client.configuration.host)
namespaces = self.get_available_namespaces(client)
for namespace in namespaces:
self.get_routes_for_namespace(client, name, namespace)
def get_routes_for_namespace(self, client, name, namespace):
self.check_kubernetes_collection()
v1_route = client.resources.get(
api_version="route.openshift.io/v1", kind="Route"
)
try:
obj = v1_route.get(namespace=namespace)
except DynamicApiError as exc:
self.display.debug(exc)
raise K8sInventoryException(
"Error fetching Routes list: %s" % format_dynamic_api_exc(exc)
)
namespace_group = "namespace_{0}".format(namespace)
namespace_routes_group = "{0}_routes".format(namespace_group)
self.inventory.add_group(name)
self.inventory.add_group(namespace_group)
self.inventory.add_child(name, namespace_group)
self.inventory.add_group(namespace_routes_group)
self.inventory.add_child(namespace_group, namespace_routes_group)
for route in obj.items:
route_name = route.metadata.name
route_annotations = (
{}
if not route.metadata.annotations
else dict(route.metadata.annotations)
)
self.inventory.add_host(route_name)
if route.metadata.labels:
# create a group for each label_value
for key, value in route.metadata.labels:
group_name = "label_{0}_{1}".format(key, value)
self.inventory.add_group(group_name)
self.inventory.add_child(group_name, route_name)
route_labels = dict(route.metadata.labels)
else:
route_labels = {}
self.inventory.add_child(namespace_routes_group, route_name)
# add hostvars
self.inventory.set_variable(route_name, "labels", route_labels)
self.inventory.set_variable(route_name, "annotations", route_annotations)
self.inventory.set_variable(
route_name, "cluster_name", route.metadata.clusterName
)
self.inventory.set_variable(route_name, "object_type", "route")
self.inventory.set_variable(
route_name, "self_link", route.metadata.selfLink
)
self.inventory.set_variable(
route_name, "resource_version", route.metadata.resourceVersion
)
self.inventory.set_variable(route_name, "uid", route.metadata.uid)
if route.spec.host:
self.inventory.set_variable(route_name, "host", route.spec.host)
if route.spec.path:
self.inventory.set_variable(route_name, "path", route.spec.path)
if hasattr(route.spec.port, "targetPort") and route.spec.port.targetPort:
self.inventory.set_variable(route_name, "port", dict(route.spec.port))
+1 -1
View File
@@ -21,7 +21,7 @@ try:
except ImportError: except ImportError:
pass pass
from ansible.module_utils._text import to_native from ansible.module_utils.common.text.converters import to_native
try: try:
from kubernetes.dynamic.exceptions import ( from kubernetes.dynamic.exceptions import (
@@ -4,7 +4,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type __metaclass__ = type
from ansible.module_utils._text import to_native from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.okd.plugins.module_utils.openshift_common import ( from ansible_collections.community.okd.plugins.module_utils.openshift_common import (
AnsibleOpenshiftModule, AnsibleOpenshiftModule,
@@ -6,7 +6,7 @@ __metaclass__ = type
from datetime import datetime, timezone from datetime import datetime, timezone
from ansible.module_utils._text import to_native from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.okd.plugins.module_utils.openshift_common import ( from ansible_collections.community.okd.plugins.module_utils.openshift_common import (
AnsibleOpenshiftModule, AnsibleOpenshiftModule,
@@ -7,9 +7,8 @@ __metaclass__ = type
from datetime import datetime, timezone, timedelta from datetime import datetime, timezone, timedelta
import copy import copy
from ansible.module_utils._text import to_native from ansible.module_utils.common.text.converters import to_native
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
from ansible_collections.community.okd.plugins.module_utils.openshift_common import ( from ansible_collections.community.okd.plugins.module_utils.openshift_common import (
AnsibleOpenshiftModule, AnsibleOpenshiftModule,
@@ -106,7 +105,7 @@ class OpenShiftAdmPruneImages(AnsibleOpenshiftModule):
def list_objects(self): def list_objects(self):
result = {} result = {}
for kind, version in iteritems(ApiConfiguration): for kind, version in ApiConfiguration.items():
namespace = None namespace = None
if self.params.get("namespace") and kind.lower() == "imagestream": if self.params.get("namespace") and kind.lower() == "imagestream":
namespace = self.params.get("namespace") namespace = self.params.get("namespace")
+1 -1
View File
@@ -7,7 +7,7 @@ __metaclass__ = type
from datetime import datetime, timezone, timedelta from datetime import datetime, timezone, timedelta
import time import time
from ansible.module_utils._text import to_native from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.okd.plugins.module_utils.openshift_common import ( from ansible_collections.community.okd.plugins.module_utils.openshift_common import (
AnsibleOpenshiftModule, AnsibleOpenshiftModule,
+1 -1
View File
@@ -7,7 +7,7 @@ __metaclass__ = type
import traceback import traceback
from abc import abstractmethod from abc import abstractmethod
from ansible.module_utils._text import to_native from ansible.module_utils.common.text.converters import to_native
try: try:
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import ( from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
+1 -1
View File
@@ -11,7 +11,7 @@ __metaclass__ = type
from datetime import datetime from datetime import datetime
from ansible.module_utils.parsing.convert_bool import boolean from ansible.module_utils.parsing.convert_bool import boolean
from ansible.module_utils._text import to_native from ansible.module_utils.common.text.converters import to_native
from ansible.module_utils.basic import missing_required_lib from ansible.module_utils.basic import missing_required_lib
from ansible_collections.community.okd.plugins.module_utils.openshift_ldap import ( from ansible_collections.community.okd.plugins.module_utils.openshift_ldap import (
@@ -8,7 +8,6 @@ from datetime import datetime
from ansible_collections.community.okd.plugins.module_utils.openshift_docker_image import ( from ansible_collections.community.okd.plugins.module_utils.openshift_docker_image import (
parse_docker_image_ref, parse_docker_image_ref,
) )
from ansible.module_utils.six import iteritems
def get_image_blobs(image): def get_image_blobs(image):
@@ -119,7 +118,7 @@ class OpenShiftAnalyzeImageStream(object):
"CronJob", "CronJob",
) )
for k, objects in iteritems(resources): for k, objects in resources.items():
if k not in keys: if k not in keys:
continue continue
for obj in objects: for obj in objects:
@@ -222,7 +221,7 @@ class OpenShiftAnalyzeImageStream(object):
def analyze_refs_from_build_strategy(self, resources): def analyze_refs_from_build_strategy(self, resources):
# Json Path is always spec.strategy # Json Path is always spec.strategy
keys = ("BuildConfig", "Build") keys = ("BuildConfig", "Build")
for k, objects in iteritems(resources): for k, objects in resources.items():
if k not in keys: if k not in keys:
continue continue
for obj in objects: for obj in objects:
@@ -7,7 +7,6 @@ __metaclass__ = type
import copy import copy
from ansible.module_utils.parsing.convert_bool import boolean from ansible.module_utils.parsing.convert_bool import boolean
from ansible.module_utils.six import string_types
from ansible_collections.community.okd.plugins.module_utils.openshift_common import ( from ansible_collections.community.okd.plugins.module_utils.openshift_common import (
AnsibleOpenshiftModule, AnsibleOpenshiftModule,
@@ -370,7 +369,7 @@ class OpenShiftImportImage(AnsibleOpenshiftModule):
def execute_module(self): def execute_module(self):
names = [] names = []
name = self.params.get("name") name = self.params.get("name")
if isinstance(name, string_types): if isinstance(name, str):
names.append(name) names.append(name)
elif isinstance(name, list): elif isinstance(name, list):
names = name names = name
+1 -2
View File
@@ -12,7 +12,6 @@ import os
import copy import copy
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
try: try:
import ldap import ldap
@@ -46,7 +45,7 @@ def validate_ldap_sync_config(config):
return "could not read ca file: {0}.".format(ca_file) return "could not read ca file: {0}.".format(ca_file)
nameMapping = config.get("groupUIDNameMapping", {}) nameMapping = config.get("groupUIDNameMapping", {})
for k, v in iteritems(nameMapping): for k, v in nameMapping.items():
if len(k) == 0 or len(v) == 0: if len(k) == 0 or len(v) == 0:
return "groupUIDNameMapping has empty key or value" return "groupUIDNameMapping has empty key or value"
+1 -1
View File
@@ -6,7 +6,7 @@ __metaclass__ = type
import os import os
from ansible.module_utils._text import to_native from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.okd.plugins.module_utils.openshift_common import ( from ansible_collections.community.okd.plugins.module_utils.openshift_common import (
AnsibleOpenshiftModule, AnsibleOpenshiftModule,
+2 -2
View File
@@ -83,7 +83,7 @@ options:
type: str type: str
strict: strict:
description: whether to fail when passing unexpected properties description: whether to fail when passing unexpected properties
default: True default: true
type: bool type: bool
type: dict type: dict
append_hash: append_hash:
@@ -134,7 +134,7 @@ options:
- Whether to continue on creation/deletion errors when multiple resources are defined. - Whether to continue on creation/deletion errors when multiple resources are defined.
- This has no effect on the validation step which is controlled by the C(validate.fail_on_error) parameter. - This has no effect on the validation step which is controlled by the C(validate.fail_on_error) parameter.
type: bool type: bool
default: False default: false
version_added: 2.0.0 version_added: 2.0.0
requirements: requirements:
+1 -1
View File
@@ -51,7 +51,7 @@ options:
aliases: aliases:
- config - config
- src - src
required: True required: true
deny_groups: deny_groups:
description: description:
- Denied groups, could be openshift group name or LDAP group dn value. - Denied groups, could be openshift group name or LDAP group dn value.
@@ -233,7 +233,7 @@ result:
""" """
# ENDREMOVE (downstream) # ENDREMOVE (downstream)
from ansible.module_utils._text import to_native from ansible.module_utils.common.text.converters import to_native
from ansible_collections.community.okd.plugins.module_utils.openshift_common import ( from ansible_collections.community.okd.plugins.module_utils.openshift_common import (
AnsibleOpenshiftModule, AnsibleOpenshiftModule,
@@ -295,9 +295,9 @@ class OpenShiftMigrateTemplateInstances(AnsibleOpenshiftModule):
object_type in transforms.keys() object_type in transforms.keys()
and obj["ref"].get("apiVersion") != transforms[object_type] and obj["ref"].get("apiVersion") != transforms[object_type]
): ):
ti_elem["status"]["objects"][i]["ref"][ ti_elem["status"]["objects"][i]["ref"]["apiVersion"] = (
"apiVersion" transforms[object_type]
] = transforms[object_type] )
ti_to_be_migrated.append(ti_elem) ti_to_be_migrated.append(ti_elem)
return ti_to_be_migrated return ti_to_be_migrated
+1 -1
View File
@@ -37,7 +37,7 @@ options:
- users - users
- groups - groups
type: str type: str
required: True required: true
name: name:
description: description:
- Use to specify an object name to remove. - Use to specify an object name to remove.
@@ -41,7 +41,7 @@ options:
- If C(true), prune all builds whose associated BuildConfig no longer exists and whose status is - If C(true), prune all builds whose associated BuildConfig no longer exists and whose status is
complete, failed, error, or cancelled. complete, failed, error, or cancelled.
type: bool type: bool
default: False default: false
requirements: requirements:
- python >= 3.6 - python >= 3.6
@@ -41,7 +41,7 @@ options:
- If C(true), prune all deployments where the associated DeploymentConfig no longer exists, - If C(true), prune all deployments where the associated DeploymentConfig no longer exists,
the status is complete or failed, and the replica size is C(0). the status is complete or failed, and the replica size is C(0).
type: bool type: bool
default: False default: false
requirements: requirements:
- python >= 3.6 - python >= 3.6
@@ -40,7 +40,7 @@ options:
- Include images that were imported from external registries as candidates for pruning. - Include images that were imported from external registries as candidates for pruning.
- If pruned, all the mirrored objects associated with them will also be removed from the integrated registry. - If pruned, all the mirrored objects associated with them will also be removed from the integrated registry.
type: bool type: bool
default: True default: true
keep_younger_than: keep_younger_than:
description: description:
- Specify the minimum age (in minutes) of an image and its referrers for it to be considered a candidate for pruning. - Specify the minimum age (in minutes) of an image and its referrers for it to be considered a candidate for pruning.
@@ -50,7 +50,7 @@ options:
- Specify if images which are exceeding LimitRanges specified in the same namespace, - Specify if images which are exceeding LimitRanges specified in the same namespace,
should be considered for pruning. should be considered for pruning.
type: bool type: bool
default: False default: false
registry_url: registry_url:
description: description:
- The address to use when contacting the registry, instead of using the default value. - The address to use when contacting the registry, instead of using the default value.
@@ -70,17 +70,17 @@ options:
type: bool type: bool
prune_registry: prune_registry:
description: description:
- If set to I(False), the prune operation will clean up image API objects, but - If set to I(false), the prune operation will clean up image API objects, but
none of the associated content in the registry is removed. none of the associated content in the registry is removed.
type: bool type: bool
default: True default: true
ignore_invalid_refs: ignore_invalid_refs:
description: description:
- If set to I(True), the pruning process will ignore all errors while parsing image references. - If set to I(true), the pruning process will ignore all errors while parsing image references.
- This means that the pruning process will ignore the intended connection between the object and the referenced image. - This means that the pruning process will ignore the intended connection between the object and the referenced image.
- As a result an image may be incorrectly deleted as unused. - As a result an image may be incorrectly deleted as unused.
type: bool type: bool
default: False default: false
requirements: requirements:
- python >= 3.6 - python >= 3.6
- kubernetes >= 12.0.0 - kubernetes >= 12.0.0
+2 -3
View File
@@ -174,8 +174,7 @@ k8s_auth:
import traceback import traceback
from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.six.moves.urllib_parse import urlparse, parse_qs, urlencode from urllib.parse import urlparse, parse_qs, urlencode, urljoin
from urllib.parse import urljoin
from base64 import urlsafe_b64encode from base64 import urlsafe_b64encode
import hashlib import hashlib
@@ -225,7 +224,7 @@ def get_oauthaccesstoken_objectname_from_token(token_name):
sha256Prefix = "sha256~" sha256Prefix = "sha256~"
if token_name.startswith(sha256Prefix): if token_name.startswith(sha256Prefix):
content = token_name[len(sha256Prefix):] content = token_name[len(sha256Prefix) :]
else: else:
content = token_name content = token_name
b64encoded = urlsafe_b64encode(hashlib.sha256(content.encode()).digest()).rstrip( b64encoded = urlsafe_b64encode(hashlib.sha256(content.encode()).digest()).rstrip(
+2 -2
View File
@@ -55,7 +55,7 @@ options:
description: description:
- Specify the namespace for the build or the build config. - Specify the namespace for the build or the build config.
type: str type: str
required: True required: true
build_args: build_args:
description: description:
- Specify a list of key-value pair to pass to Docker during the build. - Specify a list of key-value pair to pass to Docker during the build.
@@ -106,7 +106,7 @@ options:
- When C(state=started), specify whether to wait for a build to complete - When C(state=started), specify whether to wait for a build to complete
and exit with a non-zero return code if the build fails. and exit with a non-zero return code if the build fails.
- When I(state=cancelled), specify whether to wait for a build phase to be Cancelled. - When I(state=cancelled), specify whether to wait for a build phase to be Cancelled.
default: False default: false
type: bool type: bool
wait_sleep: wait_sleep:
description: description:
+4 -4
View File
@@ -36,18 +36,18 @@ options:
description: description:
- Use to specify namespace for image stream to create/update. - Use to specify namespace for image stream to create/update.
type: str type: str
required: True required: true
name: name:
description: description:
- Image stream to import tag into. - Image stream to import tag into.
- This can be provided as a list of images streams or a single value. - This can be provided as a list of images streams or a single value.
type: raw type: raw
required: True required: true
all: all:
description: description:
- If set to I(true), import all tags from the provided source on creation or if C(source) is specified. - If set to I(true), import all tags from the provided source on creation or if C(source) is specified.
type: bool type: bool
default: False default: false
validate_registry_certs: validate_registry_certs:
description: description:
- If set to I(true), allow importing from registries that have invalid HTTPS certificates. - If set to I(true), allow importing from registries that have invalid HTTPS certificates.
@@ -65,7 +65,7 @@ options:
description: description:
- Set each imported Docker image to be periodically imported from a remote repository. - Set each imported Docker image to be periodically imported from a remote repository.
type: bool type: bool
default: False default: false
source: source:
description: description:
- A Docker image repository to import images from. - A Docker image repository to import images from.
+1 -1
View File
@@ -35,7 +35,7 @@ options:
description: description:
- Attempt to contact the integrated registry using local client. - Attempt to contact the integrated registry using local client.
type: bool type: bool
default: False default: false
requirements: requirements:
- python >= 3.6 - python >= 3.6
+4 -4
View File
@@ -308,7 +308,7 @@ duration:
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.community.okd.plugins.module_utils.openshift_common import ( from ansible_collections.community.okd.plugins.module_utils.openshift_common import (
AnsibleOpenshiftModule, AnsibleOpenshiftModule,
@@ -421,9 +421,9 @@ class OpenShiftRoute(AnsibleOpenshiftModule):
if tls_insecure_policy == "disallow": if tls_insecure_policy == "disallow":
tls_insecure_policy = None tls_insecure_policy = None
else: else:
tls_ca_cert = ( tls_ca_cert = tls_cert = tls_dest_ca_cert = tls_key = (
tls_cert tls_insecure_policy
) = tls_dest_ca_cert = tls_key = tls_insecure_policy = None ) = None
route = { route = {
"apiVersion": "route.openshift.io/v1", "apiVersion": "route.openshift.io/v1",
+3
View File
@@ -0,0 +1,3 @@
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
plugins/modules/k8s.py validate-modules:return-syntax-error
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
+3
View File
@@ -0,0 +1,3 @@
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
plugins/modules/k8s.py validate-modules:return-syntax-error
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
+3
View File
@@ -0,0 +1,3 @@
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
plugins/modules/k8s.py validate-modules:return-syntax-error
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
+5
View File
@@ -0,0 +1,5 @@
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
plugins/modules/k8s.py validate-modules:return-syntax-error
plugins/modules/k8s.py validate-modules:bad-return-value-key
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
plugins/modules/openshift_process.py validate-modules:bad-return-value-key
+4 -2
View File
@@ -8,14 +8,14 @@ install_command = pip install {opts} {packages}
[testenv:black] [testenv:black]
deps = deps =
black >= 23.0, < 24.0 black >= 25.0, < 26.0
commands = commands =
black {toxinidir}/plugins {toxinidir}/tests black {toxinidir}/plugins {toxinidir}/tests
[testenv:ansible-lint] [testenv:ansible-lint]
deps = deps =
ansible-lint >= 24.7.0 ansible-lint >= 25.1.2
changedir = {toxinidir} changedir = {toxinidir}
commands = commands =
ansible-lint ansible-lint
@@ -24,10 +24,12 @@ commands =
deps = deps =
flake8 flake8
{[testenv:black]deps} {[testenv:black]deps}
{[testenv:ansible-lint]deps}
commands = commands =
black -v --check --diff {toxinidir}/plugins {toxinidir}/tests black -v --check --diff {toxinidir}/plugins {toxinidir}/tests
flake8 {toxinidir} flake8 {toxinidir}
ansible-lint
[flake8] [flake8]
# E123, E125 skipped as they are invalid PEP-8. # E123, E125 skipped as they are invalid PEP-8.