mirror of
https://github.com/openshift/community.okd.git
synced 2026-11-22 15:10:29 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2f329cd11d | ||
|
|
eb7745a5fd | ||
|
|
8bc7a413c7 | ||
|
|
23cd931707 | ||
|
|
278886dfad | ||
|
|
85041157bc | ||
|
|
fd328e619f | ||
|
|
f54fee9a30 | ||
|
|
1313ca4eb1 | ||
|
|
d8d077b754 | ||
|
|
2d2d27ec74 | ||
|
|
a16e726d3d | ||
|
|
cc3e4f1a8d | ||
|
|
75b91d1853 | ||
|
|
af9fb5a730 | ||
|
|
b7e5970831 | ||
|
|
fe082a5730 | ||
|
|
74155f021e | ||
|
|
d30a349e2f | ||
|
|
c2f1d722dc | ||
|
|
cfd6ee1f9b | ||
|
|
d2346e4c8f | ||
|
|
140da75c0f | ||
|
|
f54297c2ac | ||
|
|
69bcd79b92 | ||
|
|
93746f2392 | ||
|
|
a3c3a69bbf | ||
|
|
d1788bed2d | ||
|
|
c1683e6dcc | ||
|
|
0bc2515809 | ||
|
|
a76c07c27a | ||
|
|
0a266a6716 | ||
|
|
ec8d7e8299 | ||
|
|
075c143e40 | ||
|
|
adfb5ee140 | ||
|
|
59e78926ec | ||
|
|
a3704021d3 | ||
|
|
3e37a4cf62 |
@@ -0,0 +1,9 @@
|
||||
.venv
|
||||
.git
|
||||
.idea
|
||||
.cache/
|
||||
__pycache__/
|
||||
*.tar.gz
|
||||
changelogs/.plugin-cache.yaml
|
||||
tests/output
|
||||
tests/integration/cloud-config-*
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
name: Run collection certification checks
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
branches: [main]
|
||||
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@v4.1.0 # zizmor: ignore[unpinned-uses]
|
||||
with:
|
||||
collection-deps: "kubernetes.core"
|
||||
@@ -25,5 +25,5 @@ jobs:
|
||||
steps:
|
||||
- uses: ansible-network/github_actions/.github/actions/checkout_dependency@main
|
||||
|
||||
- name: Run ansible-lint
|
||||
uses: ansible/ansible-lint@v6.21.0
|
||||
- name: run-ansible-lint
|
||||
uses: ansible/ansible-lint@v25.1.2
|
||||
|
||||
@@ -16,6 +16,3 @@ changelogs/.plugin-cache.yaml
|
||||
# Temporary test files.
|
||||
tests/output
|
||||
tests/integration/cloud-config-*
|
||||
|
||||
# Ignore the ansible_collections that the Makefile generates.
|
||||
ansible_collections
|
||||
|
||||
+51
-3
@@ -4,6 +4,49 @@ OKD Collection Release Notes
|
||||
|
||||
.. 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
|
||||
======
|
||||
|
||||
@@ -15,10 +58,15 @@ This patch updates the k8s dependency version to the 5.x range and modifies test
|
||||
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
|
||||
======
|
||||
|
||||
@@ -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,7 +1,7 @@
|
||||
.PHONY: molecule
|
||||
|
||||
# Also needs to be updated in galaxy.yml
|
||||
VERSION = 4.0.2
|
||||
VERSION = 7.0.0-dev0
|
||||
|
||||
SANITY_TEST_ARGS ?= --docker --color
|
||||
UNITS_TEST_ARGS ?= --docker --color
|
||||
|
||||
+10
-2
@@ -1,11 +1,19 @@
|
||||
aliases:
|
||||
community.okd-approvers:
|
||||
- gravesm
|
||||
- jillr
|
||||
- GomathiselviS
|
||||
- alinabuzachis
|
||||
- abikouo
|
||||
- beeankha
|
||||
- mandar242
|
||||
- oraNod
|
||||
- brahmanim
|
||||
community.okd-reviewers:
|
||||
- gravesm
|
||||
- jillr
|
||||
- GomathiselviS
|
||||
- alinabuzachis
|
||||
- abikouo
|
||||
- beeankha
|
||||
- mandar242
|
||||
- oraNod
|
||||
- brahmanim
|
||||
|
||||
@@ -1,47 +1,47 @@
|
||||
# OKD Collection for Ansible
|
||||
|
||||
This repo hosts the `community.okd` Ansible Collection.
|
||||
|
||||
## Description
|
||||
|
||||
The collection includes a variety of Ansible content to help automate the management of applications in OKD clusters, as well as the provisioning and maintenance of clusters themselves.
|
||||
|
||||
<!--- STARTREMOVE --->
|
||||
[](https://github.com/ansible-collections/community.okd/actions) [](https://codecov.io/gh/ansible-collections/community.okd)
|
||||
|
||||
This repo hosts the `community.okd` Ansible Collection.
|
||||
## Communication
|
||||
|
||||
The collection includes a variety of Ansible content to help automate the management of applications in OKD clusters, as well as the provisioning and maintenance of clusters themselves.
|
||||
* Join the Ansible forum:
|
||||
* [Get Help](https://forum.ansible.com/c/help/6): get help or help others.
|
||||
* [POSTS TAGGED WITH 'YOUR TAG'](https://forum.ansible.com/tag/YOUR_TAG): subscribe to participate in collection-related conversations.
|
||||
* [REFER TO YOUR FORUM GROUP HERE IF EXISTS](https://forum.ansible.com/g/): by joining the team you will automatically get subscribed to the posts tagged with [your group forum tag here](https://forum.ansible.com/tags).
|
||||
* [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.
|
||||
|
||||
<!--start requires_ansible-->
|
||||
## Ansible version compatibility
|
||||
* The Ansible [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
|
||||
|
||||
This collection has been tested against following Ansible versions: **>=2.15.0**.
|
||||
|
||||
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.
|
||||
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+
|
||||
|
||||
## Kubernetes Version Support
|
||||
|
||||
This collection supports Kubernetes versions >=1.24.
|
||||
For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
|
||||
|
||||
## Included content
|
||||
|
||||
Click on the name of a plugin or module to view that content's documentation:
|
||||
|
||||
<!--start collection content-->
|
||||
|
||||
### Connection plugins
|
||||
|
||||
Name | Description
|
||||
--- | ---
|
||||
[community.okd.oc](https://github.com/openshift/community.okd/blob/main/docs/community.okd.oc_connection.rst)|Execute tasks in pods running on OpenShift.
|
||||
|
||||
### Inventory plugins
|
||||
|
||||
Name | Description
|
||||
--- | ---
|
||||
[community.okd.openshift](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_inventory.rst)|OpenShift inventory source
|
||||
|
||||
### Modules
|
||||
|
||||
Name | Description
|
||||
--- | ---
|
||||
[community.okd.k8s](https://github.com/openshift/community.okd/blob/main/docs/community.okd.k8s_module.rst)|Manage OpenShift objects
|
||||
@@ -62,13 +62,49 @@ Name | Description
|
||||
|
||||
<!--- ENDREMOVE --->
|
||||
|
||||
## Installation and Usage
|
||||
## Requirements
|
||||
|
||||
<!--start requires_ansible-->
|
||||
|
||||
### Ansible version compatibility
|
||||
|
||||
This collection has been tested against 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-->
|
||||
|
||||
### Python version compatibility
|
||||
|
||||
This collection requires Python 3.9 or later.
|
||||
|
||||
### Python dependencies
|
||||
|
||||
The following Python packages are required:
|
||||
|
||||
* [kubernetes](https://pypi.org/project/kubernetes/) >= 12.0.0
|
||||
* [requests-oauthlib](https://pypi.org/project/requests-oauthlib/)
|
||||
|
||||
### Kubernetes version compatibility
|
||||
|
||||
This collection supports Kubernetes versions >= 1.24.
|
||||
|
||||
### Collection dependencies
|
||||
|
||||
This collection requires the following Ansible collections:
|
||||
|
||||
* [kubernetes.core](https://galaxy.ansible.com/ui/repo/published/kubernetes/core/) >= 3.0.0
|
||||
|
||||
## Installation
|
||||
|
||||
### Installing the Collection from Ansible Galaxy
|
||||
|
||||
Before using the OKD collection, you need to install it with the Ansible Galaxy CLI:
|
||||
|
||||
ansible-galaxy collection install community.okd
|
||||
```bash
|
||||
ansible-galaxy collection install community.okd
|
||||
```
|
||||
|
||||
You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml`, using the format:
|
||||
|
||||
@@ -76,66 +112,78 @@ You can also include it in a `requirements.yml` file and install it via `ansible
|
||||
---
|
||||
collections:
|
||||
- name: community.okd
|
||||
version: 4.0.2
|
||||
version: 6.0.0
|
||||
```
|
||||
|
||||
### Installing the Kubernetes Python Library
|
||||
|
||||
Content in this collection requires the [Kubernetes Python client](https://pypi.org/project/kubernetes/) to interact with Kubernetes' APIs. You can install it with:
|
||||
|
||||
pip3 install kubernetes
|
||||
```bash
|
||||
pip3 install kubernetes
|
||||
```
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Using modules from the OKD Collection in your playbooks
|
||||
|
||||
It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example `community.okd.openshift`:
|
||||
It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example `community.okd.openshift_route`:
|
||||
|
||||
```yaml
|
||||
---
|
||||
plugin: community.okd.openshift
|
||||
connections:
|
||||
- namespaces:
|
||||
- testing
|
||||
- hosts: localhost
|
||||
tasks:
|
||||
- name: Expose a Service as an OpenShift Route
|
||||
community.okd.openshift_route:
|
||||
service: frontend
|
||||
namespace: testing
|
||||
state: present
|
||||
```
|
||||
|
||||
For documentation on how to use individual plugins included in this collection, please see the links in the 'Included content' section earlier in this README.
|
||||
|
||||
## Ansible Turbo mode Tech Preview
|
||||
### Ansible Turbo mode Tech Preview
|
||||
|
||||
The `community.okd` collection supports Ansible Turbo mode as a tech preview via the `cloud.common` collection. By default, this feature is disabled. To enable Turbo mode, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. For example:
|
||||
|
||||
The ``community.okd`` collection supports Ansible Turbo mode as a tech preview via the ``cloud.common`` collection. By default, this feature is disabled. To enable Turbo mode, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. For example:
|
||||
```yaml
|
||||
---
|
||||
- hosts: remote
|
||||
environment:
|
||||
ENABLE_TURBO_MODE: 1
|
||||
tasks:
|
||||
...
|
||||
```
|
||||
|
||||
```yaml
|
||||
---
|
||||
- hosts: remote
|
||||
environment:
|
||||
ENABLE_TURBO_MODE: 1
|
||||
tasks:
|
||||
...
|
||||
```
|
||||
|
||||
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/community.okd/blob/main/docs/ansible_turbo_mode.rst).
|
||||
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/community.okd/blob/main/docs/ansible_turbo_mode.rst).
|
||||
|
||||
<!--- STARTREMOVE --->
|
||||
## Testing and Development
|
||||
|
||||
## Contributing to the 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 community.okd](CONTRIBUTING.md).
|
||||
|
||||
## Testing
|
||||
|
||||
The `tests` directory contains configuration for running sanity tests using [`ansible-test`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html).
|
||||
|
||||
You can run the `ansible-test` sanity tests with the command:
|
||||
|
||||
make test-sanity
|
||||
```bash
|
||||
make test-sanity
|
||||
```
|
||||
|
||||
The `molecule` directory contains configuration for running integration tests using [`molecule`](https://molecule.readthedocs.io/).
|
||||
|
||||
You can run the `molecule` integration tests with the command:
|
||||
|
||||
make test-integration
|
||||
|
||||
These commands will create a directory called `ansible_collections` which should not be committed or added to the `.gitignore` (Tracking issue: https://github.com/ansible/ansible/issues/68499)
|
||||
```bash
|
||||
make test-integration
|
||||
```
|
||||
|
||||
These commands will create a directory called `ansible_collections` which should not be committed or added to the `.gitignore` (Tracking issue: <https://github.com/ansible/ansible/issues/68499>)
|
||||
|
||||
### Prow
|
||||
|
||||
@@ -145,13 +193,17 @@ The configuration for the CI jobs that this repository runs can be found in the
|
||||
The [Prow CI integration test job](https://github.com/openshift/release/blob/master/ci-operator/config/openshift/community.okd/openshift-community.okd-main.yaml#L40-L43)
|
||||
runs the command:
|
||||
|
||||
make test-integration-incluster
|
||||
```bash
|
||||
make test-integration-incluster
|
||||
```
|
||||
|
||||
which will create a job that runs the normal `make integration` target. In order to mimic the Prow CI job, you must
|
||||
first build the test image using the Dockerfile in [`ci/Dockerfile`](ci/Dockerfile). Then, push the image
|
||||
somewhere that it will be accessible to the cluster, and run
|
||||
|
||||
IMAGE_FORMAT=<your image> make test-integration-incluser
|
||||
```bash
|
||||
IMAGE_FORMAT=<your image> make test-integration-incluser
|
||||
```
|
||||
|
||||
where the `IMAGE_FORMAT` environment variable is the full reference to your container (ie, `IMAGE_FORMAT=quay.io/example/molecule-test-runner`)
|
||||
|
||||
@@ -159,28 +211,55 @@ where the `IMAGE_FORMAT` environment variable is the full reference to your cont
|
||||
|
||||
Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:
|
||||
|
||||
1. Update the version in the following places:
|
||||
* a. The `version` in `galaxy.yml`
|
||||
* b. This README's `requirements.yml` example
|
||||
* c. The `DOWNSTREAM_VERSION` in `ci/downstream.sh`
|
||||
* d. The `VERSION` in `Makefile`
|
||||
* e. The version in `requirements.yml`
|
||||
2. Update the CHANGELOG:
|
||||
* 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`.
|
||||
* 3. Run `antsibull-changelog release`.
|
||||
3. Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
|
||||
4. Tag the version in Git and push to GitHub.
|
||||
1. Update the version in the following places:
|
||||
* The `version` in `galaxy.yml`
|
||||
* This README's `requirements.yml` example
|
||||
* The `DOWNSTREAM_VERSION` in `ci/downstream.sh`
|
||||
* The `VERSION` in `Makefile`
|
||||
* The version in `requirements.yml`
|
||||
2. Update the CHANGELOG:
|
||||
* Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
|
||||
* Make sure there are fragments for all known changes in `changelogs/fragments`.
|
||||
* Run `antsibull-changelog release`.
|
||||
3. Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
|
||||
4. Tag the version in Git and push to GitHub.
|
||||
|
||||
After the version is published, verify it exists on the [OKD Collection Galaxy page](https://galaxy.ansible.com/community/okd).
|
||||
<!--- ENDREMOVE --->
|
||||
|
||||
## Support
|
||||
|
||||
This collection is maintained by Red Hat.
|
||||
|
||||
As Red Hat Ansible Certified Content, this collection is entitled to support through 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/).
|
||||
|
||||
<!--List available communication channels. In addition to channels specific to your collection, we also recommend to use the following ones.-->
|
||||
|
||||
We announce releases and important changes through Ansible's [Bullhorn newsletter](https://forum.ansible.com/c/news/bullhorn/17).
|
||||
|
||||
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 report bugs, request features, or ask questions by opening an issue in the [GitHub repository](https://github.com/openshift/community.okd/).
|
||||
|
||||
## Release notes
|
||||
|
||||
See the [raw generated changelog](https://github.com/openshift/community.okd/blob/main/CHANGELOG.rst).
|
||||
|
||||
## More Information
|
||||
|
||||
For more information about Ansible's Kubernetes and OpenShift integrations, join the `#ansible-kubernetes` channel on [libera.chat](https://libera.chat/) IRC, and browse the resources in the [Kubernetes Working Group](https://github.com/ansible/community/wiki/Kubernetes) Community wiki page.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project.
|
||||
|
||||
If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint.
|
||||
|
||||
## License
|
||||
|
||||
GNU General Public License v3.0 or later
|
||||
|
||||
See LICENCE to see the full text.
|
||||
See LICENSE to see the full text.
|
||||
|
||||
@@ -244,8 +244,8 @@ releases:
|
||||
4.0.1:
|
||||
changes:
|
||||
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).
|
||||
- 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).
|
||||
release_summary: This is a bug fix release
|
||||
fragments:
|
||||
- 242-fix-failed-token-deletion.yml
|
||||
@@ -256,4 +256,49 @@ releases:
|
||||
and modifies tests to handle the manual creation of service account tokens.
|
||||
fragments:
|
||||
- 4.0.2.yml
|
||||
release_date: '2025-05-21'
|
||||
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-12'
|
||||
|
||||
+7
-2
@@ -9,7 +9,7 @@
|
||||
# - All functions are prefixed with f_ so it's obvious where they come
|
||||
# from when in use throughout the script
|
||||
|
||||
DOWNSTREAM_VERSION="4.0.2"
|
||||
DOWNSTREAM_VERSION="7.0.0-dev0"
|
||||
KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}"
|
||||
INSTALL_DOWNSTREAM_COLLECTION_PATH="${INSTALL_DOWNSTREAM_COLLECTION_PATH:-}"
|
||||
_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/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/namespace\:.*$/namespace: redhat/" "${_build_dir}/galaxy.yml"
|
||||
sed -i.bak "s/Kubernetes/OpenShift/g" "${_build_dir}/galaxy.yml"
|
||||
@@ -51,6 +51,11 @@ f_text_sub()
|
||||
|
||||
find "${_build_dir}" -type f ! -name galaxy.yml -exec sed -i.bak "s/community\.okd/redhat\.openshift/g" {} \;
|
||||
find "${_build_dir}" -type f ! -name galaxy.yml -exec sed -i.bak "s/group\/redhat\.openshift\.okd/redhat\.openshift\.openshift/g" {} \;
|
||||
|
||||
# Restore GitHub repository URLs in the README
|
||||
sed -i.bak "s|github\.com/openshift/redhat\.openshift|github.com/openshift/community.okd|g" "${_build_dir}/README.md"
|
||||
sed -i.bak "s|github\.com/ansible-collections/redhat\.openshift|github.com/ansible-collections/community.okd|g" "${_build_dir}/README.md"
|
||||
|
||||
find "${_build_dir}" -type f -name "*.bak" -delete
|
||||
}
|
||||
|
||||
|
||||
+3
-2
@@ -5,7 +5,7 @@ authors:
|
||||
- willthames (https://github.com/willthames)
|
||||
- Akasurde (https://github.com/akasurde)
|
||||
dependencies:
|
||||
kubernetes.core: '>=5.0.0,<6.0.0'
|
||||
kubernetes.core: '>=6.0.0'
|
||||
description: OKD Collection for Ansible.
|
||||
documentation: ''
|
||||
homepage: ''
|
||||
@@ -14,6 +14,7 @@ license_file: LICENSE
|
||||
name: okd
|
||||
namespace: community
|
||||
readme: README.md
|
||||
# The downstream redhat.openshift collection is built from the community.okd repository.
|
||||
repository: https://github.com/openshift/community.okd
|
||||
tags:
|
||||
- kubernetes
|
||||
@@ -24,4 +25,4 @@ tags:
|
||||
- okd
|
||||
- cluster
|
||||
# Also needs to be updated in the Makefile
|
||||
version: 4.0.2
|
||||
version: 7.0.0-dev0
|
||||
|
||||
+3
-4
@@ -1,5 +1,5 @@
|
||||
---
|
||||
requires_ansible: '>=2.15.0'
|
||||
requires_ansible: '>=2.16.0'
|
||||
action_groups:
|
||||
okd:
|
||||
- k8s
|
||||
@@ -19,11 +19,10 @@ plugin_routing:
|
||||
redirect: community.okd.openshift_auth
|
||||
inventory:
|
||||
openshift:
|
||||
deprecation:
|
||||
tombstone:
|
||||
removal_version: 5.0.0
|
||||
warning_text: >-
|
||||
The openshift inventory plugin has been deprecated and
|
||||
will be removed in release 5.0.0.
|
||||
Use kubernetes.core.k8s_info and ansible.builtin.add_host instead.
|
||||
action:
|
||||
k8s:
|
||||
redirect: kubernetes.core.k8s_info
|
||||
|
||||
@@ -14,12 +14,7 @@ provisioner:
|
||||
log: true
|
||||
options:
|
||||
vvv: True
|
||||
config_options:
|
||||
inventory:
|
||||
enable_plugins: community.okd.openshift
|
||||
inventory:
|
||||
hosts:
|
||||
plugin: community.okd.openshift
|
||||
host_vars:
|
||||
localhost:
|
||||
virtualenv: ${MOLECULE_EPHEMERAL_DIRECTORY}/virtualenv
|
||||
|
||||
@@ -1,9 +1,31 @@
|
||||
---
|
||||
- name: Verify inventory and connection plugins
|
||||
# This group is created by the openshift_inventory plugin
|
||||
# It is automatically configured to use the `oc` connection plugin
|
||||
- name: Create inventory of pods
|
||||
# We need to manually create the inventory of pods now that the inventory plugin has been removed
|
||||
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
|
||||
gather_facts: no
|
||||
connection: community.okd.oc
|
||||
vars:
|
||||
file_content: |
|
||||
Hello world
|
||||
@@ -43,17 +65,16 @@
|
||||
ansible_python_interpreter: '{{ virtualenv_interpreter }}'
|
||||
|
||||
tasks:
|
||||
# No explicit `virtualenv:` param is necessary with the following pip tasks.
|
||||
# prepare.yml creates the venv and ansible_python_interpreter sets it.
|
||||
- pip:
|
||||
name: kubernetes-validate==1.34.1
|
||||
name: kubernetes-validate==1.35.0
|
||||
|
||||
- import_tasks: tasks/validate_installed.yml
|
||||
|
||||
- pip:
|
||||
name: kubernetes-validate
|
||||
state: absent
|
||||
virtualenv: "{{ virtualenv }}"
|
||||
virtualenv_command: "{{ virtualenv_command }}"
|
||||
virtualenv_site_packages: no
|
||||
|
||||
- import_tasks: tasks/validate_not_installed.yml
|
||||
|
||||
|
||||
@@ -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))
|
||||
@@ -21,7 +21,7 @@ try:
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
from ansible.module_utils._text import to_native
|
||||
from ansible.module_utils.common.text.converters import to_native
|
||||
|
||||
try:
|
||||
from kubernetes.dynamic.exceptions import (
|
||||
|
||||
@@ -4,7 +4,7 @@ from __future__ import absolute_import, division, print_function
|
||||
|
||||
__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 (
|
||||
AnsibleOpenshiftModule,
|
||||
|
||||
@@ -6,7 +6,7 @@ __metaclass__ = type
|
||||
|
||||
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 (
|
||||
AnsibleOpenshiftModule,
|
||||
|
||||
@@ -7,9 +7,8 @@ __metaclass__ = type
|
||||
from datetime import datetime, timezone, timedelta
|
||||
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.six import iteritems
|
||||
|
||||
from ansible_collections.community.okd.plugins.module_utils.openshift_common import (
|
||||
AnsibleOpenshiftModule,
|
||||
@@ -106,7 +105,7 @@ class OpenShiftAdmPruneImages(AnsibleOpenshiftModule):
|
||||
|
||||
def list_objects(self):
|
||||
result = {}
|
||||
for kind, version in iteritems(ApiConfiguration):
|
||||
for kind, version in ApiConfiguration.items():
|
||||
namespace = None
|
||||
if self.params.get("namespace") and kind.lower() == "imagestream":
|
||||
namespace = self.params.get("namespace")
|
||||
|
||||
@@ -7,7 +7,7 @@ __metaclass__ = type
|
||||
from datetime import datetime, timezone, timedelta
|
||||
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 (
|
||||
AnsibleOpenshiftModule,
|
||||
|
||||
@@ -7,7 +7,7 @@ __metaclass__ = type
|
||||
import traceback
|
||||
from abc import abstractmethod
|
||||
|
||||
from ansible.module_utils._text import to_native
|
||||
from ansible.module_utils.common.text.converters import to_native
|
||||
|
||||
try:
|
||||
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
|
||||
|
||||
@@ -11,7 +11,7 @@ __metaclass__ = type
|
||||
from datetime import datetime
|
||||
|
||||
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_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 (
|
||||
parse_docker_image_ref,
|
||||
)
|
||||
from ansible.module_utils.six import iteritems
|
||||
|
||||
|
||||
def get_image_blobs(image):
|
||||
@@ -119,7 +118,7 @@ class OpenShiftAnalyzeImageStream(object):
|
||||
"CronJob",
|
||||
)
|
||||
|
||||
for k, objects in iteritems(resources):
|
||||
for k, objects in resources.items():
|
||||
if k not in keys:
|
||||
continue
|
||||
for obj in objects:
|
||||
@@ -222,7 +221,7 @@ class OpenShiftAnalyzeImageStream(object):
|
||||
def analyze_refs_from_build_strategy(self, resources):
|
||||
# Json Path is always spec.strategy
|
||||
keys = ("BuildConfig", "Build")
|
||||
for k, objects in iteritems(resources):
|
||||
for k, objects in resources.items():
|
||||
if k not in keys:
|
||||
continue
|
||||
for obj in objects:
|
||||
|
||||
@@ -7,7 +7,6 @@ __metaclass__ = type
|
||||
import copy
|
||||
|
||||
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 (
|
||||
AnsibleOpenshiftModule,
|
||||
@@ -370,7 +369,7 @@ class OpenShiftImportImage(AnsibleOpenshiftModule):
|
||||
def execute_module(self):
|
||||
names = []
|
||||
name = self.params.get("name")
|
||||
if isinstance(name, string_types):
|
||||
if isinstance(name, str):
|
||||
names.append(name)
|
||||
elif isinstance(name, list):
|
||||
names = name
|
||||
|
||||
@@ -12,7 +12,6 @@ import os
|
||||
import copy
|
||||
|
||||
from ansible.module_utils.parsing.convert_bool import boolean
|
||||
from ansible.module_utils.six import iteritems
|
||||
|
||||
try:
|
||||
import ldap
|
||||
@@ -46,7 +45,7 @@ def validate_ldap_sync_config(config):
|
||||
return "could not read ca file: {0}.".format(ca_file)
|
||||
|
||||
nameMapping = config.get("groupUIDNameMapping", {})
|
||||
for k, v in iteritems(nameMapping):
|
||||
for k, v in nameMapping.items():
|
||||
if len(k) == 0 or len(v) == 0:
|
||||
return "groupUIDNameMapping has empty key or value"
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ __metaclass__ = type
|
||||
|
||||
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 (
|
||||
AnsibleOpenshiftModule,
|
||||
|
||||
@@ -83,7 +83,7 @@ options:
|
||||
type: str
|
||||
strict:
|
||||
description: whether to fail when passing unexpected properties
|
||||
default: True
|
||||
default: true
|
||||
type: bool
|
||||
type: dict
|
||||
append_hash:
|
||||
@@ -134,7 +134,7 @@ options:
|
||||
- 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.
|
||||
type: bool
|
||||
default: False
|
||||
default: false
|
||||
version_added: 2.0.0
|
||||
|
||||
requirements:
|
||||
|
||||
@@ -51,7 +51,7 @@ options:
|
||||
aliases:
|
||||
- config
|
||||
- src
|
||||
required: True
|
||||
required: true
|
||||
deny_groups:
|
||||
description:
|
||||
- Denied groups, could be openshift group name or LDAP group dn value.
|
||||
|
||||
@@ -233,7 +233,7 @@ result:
|
||||
"""
|
||||
# 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 (
|
||||
AnsibleOpenshiftModule,
|
||||
|
||||
@@ -37,7 +37,7 @@ options:
|
||||
- users
|
||||
- groups
|
||||
type: str
|
||||
required: True
|
||||
required: true
|
||||
name:
|
||||
description:
|
||||
- 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
|
||||
complete, failed, error, or cancelled.
|
||||
type: bool
|
||||
default: False
|
||||
default: false
|
||||
|
||||
requirements:
|
||||
- python >= 3.6
|
||||
|
||||
@@ -41,7 +41,7 @@ options:
|
||||
- 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).
|
||||
type: bool
|
||||
default: False
|
||||
default: false
|
||||
|
||||
requirements:
|
||||
- python >= 3.6
|
||||
|
||||
@@ -40,7 +40,7 @@ options:
|
||||
- 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.
|
||||
type: bool
|
||||
default: True
|
||||
default: true
|
||||
keep_younger_than:
|
||||
description:
|
||||
- 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,
|
||||
should be considered for pruning.
|
||||
type: bool
|
||||
default: False
|
||||
default: false
|
||||
registry_url:
|
||||
description:
|
||||
- The address to use when contacting the registry, instead of using the default value.
|
||||
@@ -70,17 +70,17 @@ options:
|
||||
type: bool
|
||||
prune_registry:
|
||||
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.
|
||||
type: bool
|
||||
default: True
|
||||
default: true
|
||||
ignore_invalid_refs:
|
||||
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.
|
||||
- As a result an image may be incorrectly deleted as unused.
|
||||
type: bool
|
||||
default: False
|
||||
default: false
|
||||
requirements:
|
||||
- python >= 3.6
|
||||
- kubernetes >= 12.0.0
|
||||
|
||||
@@ -174,8 +174,7 @@ k8s_auth:
|
||||
import traceback
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.six.moves.urllib_parse import urlparse, parse_qs, urlencode
|
||||
from urllib.parse import urljoin
|
||||
from urllib.parse import urlparse, parse_qs, urlencode, urljoin
|
||||
|
||||
from base64 import urlsafe_b64encode
|
||||
import hashlib
|
||||
|
||||
@@ -55,7 +55,7 @@ options:
|
||||
description:
|
||||
- Specify the namespace for the build or the build config.
|
||||
type: str
|
||||
required: True
|
||||
required: true
|
||||
build_args:
|
||||
description:
|
||||
- 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
|
||||
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.
|
||||
default: False
|
||||
default: false
|
||||
type: bool
|
||||
wait_sleep:
|
||||
description:
|
||||
|
||||
@@ -36,18 +36,18 @@ options:
|
||||
description:
|
||||
- Use to specify namespace for image stream to create/update.
|
||||
type: str
|
||||
required: True
|
||||
required: true
|
||||
name:
|
||||
description:
|
||||
- Image stream to import tag into.
|
||||
- This can be provided as a list of images streams or a single value.
|
||||
type: raw
|
||||
required: True
|
||||
required: true
|
||||
all:
|
||||
description:
|
||||
- If set to I(true), import all tags from the provided source on creation or if C(source) is specified.
|
||||
type: bool
|
||||
default: False
|
||||
default: false
|
||||
validate_registry_certs:
|
||||
description:
|
||||
- If set to I(true), allow importing from registries that have invalid HTTPS certificates.
|
||||
@@ -65,7 +65,7 @@ options:
|
||||
description:
|
||||
- Set each imported Docker image to be periodically imported from a remote repository.
|
||||
type: bool
|
||||
default: False
|
||||
default: false
|
||||
source:
|
||||
description:
|
||||
- A Docker image repository to import images from.
|
||||
|
||||
@@ -35,7 +35,7 @@ options:
|
||||
description:
|
||||
- Attempt to contact the integrated registry using local client.
|
||||
type: bool
|
||||
default: False
|
||||
default: false
|
||||
|
||||
requirements:
|
||||
- python >= 3.6
|
||||
|
||||
@@ -308,7 +308,7 @@ duration:
|
||||
|
||||
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 (
|
||||
AnsibleOpenshiftModule,
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
Reference in New Issue
Block a user