diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index b86a7c4..254bf53 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -5,6 +5,34 @@ OKD Collection Release Notes
.. contents:: Topics
+v3.0.1
+======
+
+Release Summary
+---------------
+
+This patch release fixes an issue in building the downstream collection.
+
+
+v3.0.0
+======
+
+Release Summary
+---------------
+
+This major release drops support for ansible-core versions lower than 2.14 and Python versions lower than 3.9. It also deprecates ``openshift`` inventory plugin.
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- Bump minimum Python suupported version to 3.9 (https://github.com/openshift/community.okd/pull/202).
+- Remove support for ansible-core < 2.14 (https://github.com/openshift/community.okd/pull/202).
+
+Deprecated Features
+-------------------
+
+- openshift - the ``openshift`` inventory plugin has been deprecated and will be removed in release 4.0.0 (https://github.com/ansible-collections/kubernetes.core/issues/31).
+
v2.3.0
======
diff --git a/Makefile b/Makefile
index bb67bcc..4cbdd29 100644
--- a/Makefile
+++ b/Makefile
@@ -1,31 +1,34 @@
.PHONY: molecule
# Also needs to be updated in galaxy.yml
-VERSION = 2.3.0
+VERSION = 3.0.1
SANITY_TEST_ARGS ?= --docker --color
UNITS_TEST_ARGS ?= --docker --color
PYTHON_VERSION ?= `python3 -c 'import platform; print("{0}.{1}".format(platform.python_version_tuple()[0], platform.python_version_tuple()[1]))'`
+# this expression compute the install path once for all the execution
+# See: https://stackoverflow.com/questions/44114466/how-to-declare-a-deferred-variable-that-is-computed-only-once-for-all
+INSTALL_PATH ?= $(eval INSTALL_PATH := $(shell mktemp -d))$(INSTALL_PATH)
clean:
rm -f community-okd-$(VERSION).tar.gz
rm -f redhat-openshift-$(VERSION).tar.gz
- rm -rf ansible_collections
+ rm -rf $(INSTALL_PATH)
build: clean
ansible-galaxy collection build
install: build
- ansible-galaxy collection install --force -p ansible_collections community-okd-$(VERSION).tar.gz
+ ansible-galaxy collection install --force -p $(INSTALL_PATH) community-okd-$(VERSION).tar.gz
sanity: install
- cd ansible_collections/community/okd && ansible-test sanity -v --python $(PYTHON_VERSION) $(SANITY_TEST_ARGS)
+ cd $(INSTALL_PATH)/ansible_collections/community/okd && ansible-test sanity -v --python $(PYTHON_VERSION) $(SANITY_TEST_ARGS) && rm -rf $(INSTALL_PATH)
units: install
- cd ansible_collections/community/okd && ansible-test units -v --python $(PYTHON_VERSION) $(UNITS_TEST_ARGS)
+ cd $(INSTALL_PATH)/ansible_collections/community/okd && ansible-test units -v --python $(PYTHON_VERSION) $(UNITS_TEST_ARGS) && rm -rf $(INSTALL_PATH)
molecule: install
- molecule test
+ cd $(INSTALL_PATH)/ansible_collections/community/okd && molecule test && rm -rf $(INSTALL_PATH)
test-integration: upstream-test-integration downstream-test-integration
diff --git a/README.md b/README.md
index 45b63e9..4f6ba61 100644
--- a/README.md
+++ b/README.md
@@ -12,15 +12,19 @@ The collection includes a variety of Ansible content to help automate the manage
This collection has been tested against following Ansible versions: **>=2.14.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.
## Python Support
-* Collection supports 3.6+
+* Collection supports 3.9+
## Kubernetes Version Support
-This collection supports Kubernetes versions >=1.19.
+This collection supports Kubernetes versions >=1.24.
## Included content
@@ -72,7 +76,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible
---
collections:
- name: community.okd
- version: 2.3.0
+ version: 3.0.1
```
### Installing the Kubernetes Python Library
@@ -156,17 +160,17 @@ 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`
- 1. Update the CHANGELOG:
- 1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
- 1. Make sure there are fragments for all known changes in `changelogs/fragments`.
- 1. Run `antsibull-changelog release`.
- 1. Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
- 1. Tag the version in Git and push to GitHub.
+ * 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.
After the version is published, verify it exists on the [OKD Collection Galaxy page](https://galaxy.ansible.com/community/okd).
diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
index cc99b46..82cd00a 100644
--- a/changelogs/changelog.yaml
+++ b/changelogs/changelog.yaml
@@ -1,202 +1,226 @@
----
ancestor: null
releases:
0.1.0:
changes:
major_changes:
- - Add custom k8s module, integrate better Molecule tests (https://github.com/ansible-collections/community.okd/pull/7).
- - Add downstream build scripts to build redhat.openshift (https://github.com/ansible-collections/community.okd/pull/20).
- - Add openshift connection plugin, update inventory plugin to use it (https://github.com/ansible-collections/community.okd/pull/18).
- - Initial content migration from community.kubernetes (https://github.com/ansible-collections/community.okd/pull/3).
+ - Add custom k8s module, integrate better Molecule tests (https://github.com/ansible-collections/community.okd/pull/7).
+ - Add downstream build scripts to build redhat.openshift (https://github.com/ansible-collections/community.okd/pull/20).
+ - Add openshift connection plugin, update inventory plugin to use it (https://github.com/ansible-collections/community.okd/pull/18).
+ - Initial content migration from community.kubernetes (https://github.com/ansible-collections/community.okd/pull/3).
minor_changes:
- - Add incluster Makefile target for CI (https://github.com/ansible-collections/community.okd/pull/13).
- - Add tests for inventory plugin (https://github.com/ansible-collections/community.okd/pull/16).
- - CI Documentation for working with Prow (https://github.com/ansible-collections/community.okd/pull/15).
- - Docker container can run as an arbitrary user (https://github.com/ansible-collections/community.okd/pull/12).
- - Dockerfile now is properly set up to run tests in a rootless container (https://github.com/ansible-collections/community.okd/pull/11).
- - Integrate stale bot for issue queue maintenance (https://github.com/ansible-collections/community.okd/pull/14).
+ - Add incluster Makefile target for CI (https://github.com/ansible-collections/community.okd/pull/13).
+ - Add tests for inventory plugin (https://github.com/ansible-collections/community.okd/pull/16).
+ - CI Documentation for working with Prow (https://github.com/ansible-collections/community.okd/pull/15).
+ - Docker container can run as an arbitrary user (https://github.com/ansible-collections/community.okd/pull/12).
+ - Dockerfile now is properly set up to run tests in a rootless container (https://github.com/ansible-collections/community.okd/pull/11).
+ - Integrate stale bot for issue queue maintenance (https://github.com/ansible-collections/community.okd/pull/14).
fragments:
- - 1-initial-content.yml
- - 11-dockerfile-tests.yml
- - 12-dockerfile-tests.yml
- - 13-makefile-tests.yml
- - 15-ci-documentation.yml
- - 16-inventory-plugin-tests.yml
- - 18-openshift-connection-plugin.yml
- - 20-downstream-build-scripts.yml
- - 7-molecule-tests.yml
- - 8-stale-bot.yml
+ - 1-initial-content.yml
+ - 11-dockerfile-tests.yml
+ - 12-dockerfile-tests.yml
+ - 13-makefile-tests.yml
+ - 15-ci-documentation.yml
+ - 16-inventory-plugin-tests.yml
+ - 18-openshift-connection-plugin.yml
+ - 20-downstream-build-scripts.yml
+ - 7-molecule-tests.yml
+ - 8-stale-bot.yml
release_date: '2020-09-04'
0.2.0:
changes:
major_changes:
- - openshift_auth - new module (migrated from k8s_auth in community.kubernetes)
- (https://github.com/ansible-collections/community.okd/pull/33).
+ - openshift_auth - new module (migrated from k8s_auth in community.kubernetes)
+ (https://github.com/ansible-collections/community.okd/pull/33).
minor_changes:
- - Add a contribution guide (https://github.com/ansible-collections/community.okd/pull/37).
- - Use the API Group APIVersion for the `Route` object (https://github.com/ansible-collections/community.okd/pull/27).
+ - Add a contribution guide (https://github.com/ansible-collections/community.okd/pull/37).
+ - Use the API Group APIVersion for the `Route` object (https://github.com/ansible-collections/community.okd/pull/27).
fragments:
- - 27-route-api-group.yml
- - 33-add-k8s_auth.yml
- - 36-contribution-guide.yml
+ - 27-route-api-group.yml
+ - 33-add-k8s_auth.yml
+ - 36-contribution-guide.yml
modules:
- - description: Authenticate to OpenShift clusters which require an explicit login
- step
- name: openshift_auth
- namespace: ''
+ - description: Authenticate to OpenShift clusters which require an explicit login
+ step
+ name: openshift_auth
+ namespace: ''
release_date: '2020-09-24'
0.3.0:
changes:
major_changes:
- - Add openshift_process module for template rendering and optional application
- of rendered resources (https://github.com/ansible-collections/community.okd/pull/44).
- - Add openshift_route module for creating routes from services (https://github.com/ansible-collections/community.okd/pull/40).
+ - Add openshift_process module for template rendering and optional application
+ of rendered resources (https://github.com/ansible-collections/community.okd/pull/44).
+ - Add openshift_route module for creating routes from services (https://github.com/ansible-collections/community.okd/pull/40).
fragments:
- - 40-openshift_route.yml
- - 44-openshift_process.yml
+ - 40-openshift_route.yml
+ - 44-openshift_process.yml
modules:
- - description: Process an OpenShift template.openshift.io/v1 Template
- name: openshift_process
- namespace: ''
- - description: Expose a Service as an OpenShift Route.
- name: openshift_route
- namespace: ''
+ - description: Process an OpenShift template.openshift.io/v1 Template
+ name: openshift_process
+ namespace: ''
+ - description: Expose a Service as an OpenShift Route.
+ name: openshift_route
+ namespace: ''
release_date: '2020-10-12'
1.0.0:
changes:
minor_changes:
- - Released version 1 to Automation Hub as redhat.openshift (https://github.com/ansible-collections/community.okd/issues/51).
+ - Released version 1 to Automation Hub as redhat.openshift (https://github.com/ansible-collections/community.okd/issues/51).
fragments:
- - 51-redhat-openshift-ah-release.yml
+ - 51-redhat-openshift-ah-release.yml
release_date: '2020-11-12'
1.0.1:
changes:
bugfixes:
- - Generate downstream redhat.openshift documentation (https://github.com/ansible-collections/community.okd/pull/59).
+ - Generate downstream redhat.openshift documentation (https://github.com/ansible-collections/community.okd/pull/59).
fragments:
- - 59-downstream-docs.yml
+ - 59-downstream-docs.yml
release_date: '2020-11-17'
1.0.2:
changes:
minor_changes:
- - restrict the version of kubernetes.core dependency (https://github.com/ansible-collections/community.okd/pull/66).
+ - restrict the version of kubernetes.core dependency (https://github.com/ansible-collections/community.okd/pull/66).
fragments:
- - 66-restrict-kubernetes-core-version.yaml
+ - 66-restrict-kubernetes-core-version.yaml
release_date: '2021-02-19'
1.1.0:
changes:
minor_changes:
- - increase the kubernetes.core dependency version number (https://github.com/ansible-collections/community.okd/pull/71).
+ - increase the kubernetes.core dependency version number (https://github.com/ansible-collections/community.okd/pull/71).
fragments:
- - 71-bump-kubernetes-core-version.yaml
+ - 71-bump-kubernetes-core-version.yaml
release_date: '2021-02-23'
1.1.1:
changes:
bugfixes:
- - add missing requirements.txt file needed for execution environments (https://github.com/ansible-collections/community.okd/pull/78).
- - openshift_route - default to ``no_log=False`` for the ``key`` parameter in
- TLS configuration to fix sanity failures (https://github.com/ansible-collections/community.okd/pull/77).
- - restrict molecule version to <3.3.0 to address breaking change (https://github.com/ansible-collections/community.okd/pull/77).
- - update CI to work with ansible 2.11 (https://github.com/ansible-collections/community.okd/pull/80).
+ - add missing requirements.txt file needed for execution environments (https://github.com/ansible-collections/community.okd/pull/78).
+ - openshift_route - default to ``no_log=False`` for the ``key`` parameter in
+ TLS configuration to fix sanity failures (https://github.com/ansible-collections/community.okd/pull/77).
+ - restrict molecule version to <3.3.0 to address breaking change (https://github.com/ansible-collections/community.okd/pull/77).
+ - update CI to work with ansible 2.11 (https://github.com/ansible-collections/community.okd/pull/80).
fragments:
- - 77-fix-ci-failure.yaml
- - 78-add-requirements-file.yaml
- - 80-update-ci.yaml
+ - 77-fix-ci-failure.yaml
+ - 78-add-requirements-file.yaml
+ - 80-update-ci.yaml
release_date: '2021-04-06'
1.1.2:
changes:
bugfixes:
- - include requirements.txt in downstream build process (https://github.com/ansible-collections/community.okd/pull/81).
+ - include requirements.txt in downstream build process (https://github.com/ansible-collections/community.okd/pull/81).
fragments:
- - 81-include-requirements.yaml
+ - 81-include-requirements.yaml
release_date: '2021-04-08'
2.0.0:
changes:
breaking_changes:
- - drop python 2 support (https://github.com/openshift/community.okd/pull/93).
+ - drop python 2 support (https://github.com/openshift/community.okd/pull/93).
bugfixes:
- - fixes test suite to use correct versions of python and dependencies (https://github.com/ansible-collections/community.okd/pull/89).
- - openshift_process - fix module execution when template does not include a
- message (https://github.com/ansible-collections/community.okd/pull/87).
+ - fixes test suite to use correct versions of python and dependencies (https://github.com/ansible-collections/community.okd/pull/89).
+ - openshift_process - fix module execution when template does not include a
+ message (https://github.com/ansible-collections/community.okd/pull/87).
major_changes:
- - update to use kubernetes.core 2.0 (https://github.com/openshift/community.okd/pull/93).
+ - update to use kubernetes.core 2.0 (https://github.com/openshift/community.okd/pull/93).
minor_changes:
- - Added documentation for the ``community.okd`` collection.
- - openshift - inventory plugin supports FQCN ``redhat.openshift``.
+ - Added documentation for the ``community.okd`` collection.
+ - openshift - inventory plugin supports FQCN ``redhat.openshift``.
fragments:
- - 87-openshift_process-fix-template-without-message.yaml
- - 89-clean-up-ci.yaml
- - 93-update-to-k8s-2.yaml
- - add_docs.yml
- - fqcn_inventory.yml
+ - 87-openshift_process-fix-template-without-message.yaml
+ - 89-clean-up-ci.yaml
+ - 93-update-to-k8s-2.yaml
+ - add_docs.yml
+ - fqcn_inventory.yml
release_date: '2021-06-22'
2.0.1:
changes:
minor_changes:
- - increase kubernetes.core dependency version (https://github.com/openshift/community.okd/pull/97).
+ - increase kubernetes.core dependency version (https://github.com/openshift/community.okd/pull/97).
fragments:
- - 97-bump-k8s-version.yaml
+ - 97-bump-k8s-version.yaml
release_date: '2021-06-24'
2.1.0:
changes:
bugfixes:
- - fix broken links in Automation Hub for redhat.openshift (https://github.com/openshift/community.okd/issues/100).
+ - fix broken links in Automation Hub for redhat.openshift (https://github.com/openshift/community.okd/issues/100).
minor_changes:
- - add support for turbo mode (https://github.com/openshift/community.okd/pull/102).
- - openshift_route - Add support for Route annotations (https://github.com/ansible-collections/community.okd/pull/99).
+ - add support for turbo mode (https://github.com/openshift/community.okd/pull/102).
+ - openshift_route - Add support for Route annotations (https://github.com/ansible-collections/community.okd/pull/99).
fragments:
- - 0-copy_ignore_txt.yml
- - 100-fix-broken-links.yml
- - 102-support-turbo-mode.yaml
- - 99-openshift_route-add-support-for-annotations.yml
+ - 0-copy_ignore_txt.yml
+ - 100-fix-broken-links.yml
+ - 102-support-turbo-mode.yaml
+ - 99-openshift_route-add-support-for-annotations.yml
release_date: '2021-10-20'
2.2.0:
changes:
bugfixes:
- - fix ocp auth failing against cluster api url with trailing slash (https://github.com/openshift/community.okd/issues/139)
+ - fix ocp auth failing against cluster api url with trailing slash (https://github.com/openshift/community.okd/issues/139)
minor_changes:
- - add action groups to runtime.yml (https://github.com/openshift/community.okd/issues/41).
+ - add action groups to runtime.yml (https://github.com/openshift/community.okd/issues/41).
fragments:
- - 152-add-action-groups.yml
- - auth-against-api-with-trailing-slash.yaml
+ - 152-add-action-groups.yml
+ - auth-against-api-with-trailing-slash.yaml
modules:
- - description: Update TemplateInstances to point to the latest group-version-kinds
- name: openshift_adm_migrate_template_instances
- namespace: ''
- - description: Removes references to the specified roles, clusterroles, users,
- and groups
- name: openshift_adm_prune_auth
- namespace: ''
- - description: Remove old completed and failed deployment configs
- name: openshift_adm_prune_deployments
- namespace: ''
- - description: Remove unreferenced images
- name: openshift_adm_prune_images
- namespace: ''
- - description: Import the latest image information from a tag in a container image
- registry.
- name: openshift_import_image
- namespace: ''
- - description: Display information about the integrated registry.
- name: openshift_registry_info
- namespace: ''
+ - description: Update TemplateInstances to point to the latest group-version-kinds
+ name: openshift_adm_migrate_template_instances
+ namespace: ''
+ - description: Removes references to the specified roles, clusterroles, users,
+ and groups
+ name: openshift_adm_prune_auth
+ namespace: ''
+ - description: Remove old completed and failed deployment configs
+ name: openshift_adm_prune_deployments
+ namespace: ''
+ - description: Remove unreferenced images
+ name: openshift_adm_prune_images
+ namespace: ''
+ - description: Import the latest image information from a tag in a container image
+ registry.
+ name: openshift_import_image
+ namespace: ''
+ - description: Display information about the integrated registry.
+ name: openshift_registry_info
+ namespace: ''
release_date: '2022-05-05'
2.3.0:
changes:
bugfixes:
- - openshift_adm_groups_sync - initialize OpenshiftGroupSync attributes early
- to avoid Attribute error (https://github.com/openshift/community.okd/issues/155).
- - openshift_auth - Review the way the discard process is working, add openshift
- algorithm to convert token to resource object name (https://github.com/openshift/community.okd/issues/176).
+ - openshift_adm_groups_sync - initialize OpenshiftGroupSync attributes early
+ to avoid Attribute error (https://github.com/openshift/community.okd/issues/155).
+ - openshift_auth - Review the way the discard process is working, add openshift
+ algorithm to convert token to resource object name (https://github.com/openshift/community.okd/issues/176).
fragments:
- - 165-initialize-attributes-early.yml
- - 178-openshift_auth-fix-revoke-token.yml
- - 180-default-values-doc.yml
+ - 165-initialize-attributes-early.yml
+ - 178-openshift_auth-fix-revoke-token.yml
+ - 180-default-values-doc.yml
modules:
- - description: Prune old completed and failed builds
- name: openshift_adm_prune_builds
- namespace: ''
- - description: Start a new build or Cancel running, pending, or new builds.
- name: openshift_build
- namespace: ''
+ - description: Prune old completed and failed builds
+ name: openshift_adm_prune_builds
+ namespace: ''
+ - description: Start a new build or Cancel running, pending, or new builds.
+ name: openshift_build
+ namespace: ''
release_date: '2023-02-03'
+ 3.0.0:
+ changes:
+ breaking_changes:
+ - Bump minimum Python suupported version to 3.9 (https://github.com/openshift/community.okd/pull/202).
+ - Remove support for ansible-core < 2.14 (https://github.com/openshift/community.okd/pull/202).
+ deprecated_features:
+ - openshift - the ``openshift`` inventory plugin has been deprecated and will
+ be removed in release 4.0.0 (https://github.com/ansible-collections/kubernetes.core/issues/31).
+ release_summary: This major release drops support for ansible-core versions
+ lower than 2.14 and Python versions lower than 3.9. It also deprecates ``openshift``
+ inventory plugin.
+ fragments:
+ - 20230206-deprecate-openshift-inventory.yml
+ - 20231107-move-sanity-and-units-to-gha.yml
+ release_date: '2023-11-20'
+ 3.0.1:
+ changes:
+ release_summary: 'This patch release fixes an issue in building the downstream
+ collection.
+
+ '
+ fragments:
+ - downstream-gitignore.yml
+ - release_summary.yml
+ release_date: '2023-11-30'
diff --git a/changelogs/fragments/20230206-deprecate-openshift-inventory.yml b/changelogs/fragments/20230206-deprecate-openshift-inventory.yml
deleted file mode 100644
index 4e41020..0000000
--- a/changelogs/fragments/20230206-deprecate-openshift-inventory.yml
+++ /dev/null
@@ -1,4 +0,0 @@
----
-deprecated_features:
- - openshift - the ``openshift`` inventory plugin has been deprecated and will be removed in release 4.0.0
- (https://github.com/ansible-collections/kubernetes.core/issues/31).
diff --git a/changelogs/fragments/20231107-move-sanity-and-units-to-gha.yml b/changelogs/fragments/20231107-move-sanity-and-units-to-gha.yml
deleted file mode 100644
index 29eaa48..0000000
--- a/changelogs/fragments/20231107-move-sanity-and-units-to-gha.yml
+++ /dev/null
@@ -1,6 +0,0 @@
----
-trivial:
- - "Move unit and sanity tests from zuul to GitHub Actions (https://github.com/openshift/community.okd/pull/202)."
-breaking_changes:
- - "Remove support for ansible-core < 2.14 (https://github.com/openshift/community.okd/pull/202)."
- - "Bump minimum Python suupported version to 3.9 (https://github.com/openshift/community.okd/pull/202)."
diff --git a/ci/downstream.sh b/ci/downstream.sh
index cfcc8f9..c75398b 100755
--- a/ci/downstream.sh
+++ b/ci/downstream.sh
@@ -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="2.3.0"
+DOWNSTREAM_VERSION="3.0.1"
KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}"
INSTALL_DOWNSTREAM_COLLECTION_PATH="${INSTALL_DOWNSTREAM_COLLECTION_PATH:-}"
_build_dir=""
diff --git a/docs/community.okd.k8s_module.rst b/docs/community.okd.k8s_module.rst
index 8d0e0f9..9a14c44 100644
--- a/docs/community.okd.k8s_module.rst
+++ b/docs/community.okd.k8s_module.rst
@@ -351,6 +351,41 @@ Parameters
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
+
error |
- error while trying to create/delete the object.
+ Error while trying to create/delete the object.
|
diff --git a/docs/community.okd.oc_connection.rst b/docs/community.okd.oc_connection.rst
index 14f2477..12869df 100644
--- a/docs/community.okd.oc_connection.rst
+++ b/docs/community.okd.oc_connection.rst
@@ -308,7 +308,7 @@ Status
Authors
~~~~~~~
-- xuxinkun
+- xuxinkun (@xuxinkun)
.. hint::
diff --git a/docs/community.okd.openshift_adm_groups_sync_module.rst b/docs/community.okd.openshift_adm_groups_sync_module.rst
index e16aa4d..7d319a4 100644
--- a/docs/community.okd.openshift_adm_groups_sync_module.rst
+++ b/docs/community.okd.openshift_adm_groups_sync_module.rst
@@ -55,6 +55,7 @@ Parameters
+ Default:
[]
|
Allowed groups, could be openshift group name or LDAP group dn value.
@@ -150,6 +151,7 @@ Parameters
|
+ Default:
[]
|
Denied groups, could be openshift group name or LDAP group dn value.
@@ -172,6 +174,41 @@ Parameters
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
+
+ |
+
+ impersonate_groups
+
+
+ list
+ / elements=string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Group(s) to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+ |
+
+
+ |
+
+ impersonate_user
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Username to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+ |
+
|
@@ -185,9 +222,29 @@ Parameters
|
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 ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+ Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
|
+
+ |
+
+ no_proxy
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+ Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+ This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+ example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+ |
+
|
@@ -439,31 +496,31 @@ Examples
- name: Sync all groups from an LDAP server
openshift_adm_groups_sync:
src:
- kind: LDAPSyncConfig
- apiVersion: v1
- url: ldap://localhost:1390
- insecure: true
- bindDN: cn=admin,dc=example,dc=org
- bindPassword: adminpassword
- rfc2307:
- groupsQuery:
- baseDN: "cn=admins,ou=groups,dc=example,dc=org"
- scope: sub
- derefAliases: never
- filter: (objectClass=*)
- pageSize: 0
- groupUIDAttribute: dn
- groupNameAttributes: [ cn ]
- groupMembershipAttributes: [ member ]
- usersQuery:
- baseDN: "ou=users,dc=example,dc=org"
- scope: sub
- derefAliases: never
- pageSize: 0
- userUIDAttribute: dn
- userNameAttributes: [ mail ]
- tolerateMemberNotFoundErrors: true
- tolerateMemberOutOfScopeErrors: true
+ kind: LDAPSyncConfig
+ apiVersion: v1
+ url: ldap://localhost:1390
+ insecure: true
+ bindDN: cn=admin,dc=example,dc=org
+ bindPassword: adminpassword
+ rfc2307:
+ groupsQuery:
+ baseDN: "cn=admins,ou=groups,dc=example,dc=org"
+ scope: sub
+ derefAliases: never
+ filter: (objectClass=*)
+ pageSize: 0
+ groupUIDAttribute: dn
+ groupNameAttributes: [cn]
+ groupMembershipAttributes: [member]
+ usersQuery:
+ baseDN: "ou=users,dc=example,dc=org"
+ scope: sub
+ derefAliases: never
+ pageSize: 0
+ userUIDAttribute: dn
+ userNameAttributes: [mail]
+ tolerateMemberNotFoundErrors: true
+ tolerateMemberOutOfScopeErrors: true
# Sync all groups except the ones from the deny_groups from an LDAP server
- name: Sync all groups from an LDAP server using deny_groups
diff --git a/docs/community.okd.openshift_adm_migrate_template_instances_module.rst b/docs/community.okd.openshift_adm_migrate_template_instances_module.rst
index a7940ca..c1d54dc 100644
--- a/docs/community.okd.openshift_adm_migrate_template_instances_module.rst
+++ b/docs/community.okd.openshift_adm_migrate_template_instances_module.rst
@@ -134,6 +134,41 @@ Parameters
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
+
+ |
+
+ impersonate_groups
+
+
+ list
+ / elements=string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Group(s) to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+ |
+
+
+ |
+
+ impersonate_user
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Username to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+ |
+
|
@@ -147,6 +182,7 @@ Parameters
|
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 ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+ Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
|
@@ -166,6 +202,25 @@ Parameters
If no namespace if specified, migrate objects in all namespaces.
+
+ |
+
+ no_proxy
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+ Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+ This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+ example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+ |
+
|
@@ -478,13 +533,13 @@ Examples
.. code-block:: yaml
- name: Migrate TemplateInstances in namespace=test
- community.okd.openshift_adm_migrate_template_instances:
- namespace: test
- register: _result
+ community.okd.openshift_adm_migrate_template_instances:
+ namespace: test
+ register: _result
- - name: Migrate TemplateInstances in all namespaces
- community.okd.openshift_adm_migrate_template_instances:
- register: _result
+ - name: Migrate TemplateInstances in all namespaces
+ community.okd.openshift_adm_migrate_template_instances:
+ register: _result
diff --git a/docs/community.okd.openshift_adm_prune_auth_module.rst b/docs/community.okd.openshift_adm_prune_auth_module.rst
index b4b11c2..4e8e1dd 100644
--- a/docs/community.okd.openshift_adm_prune_auth_module.rst
+++ b/docs/community.okd.openshift_adm_prune_auth_module.rst
@@ -134,6 +134,41 @@ Parameters
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
+
+ |
+
+ impersonate_groups
+
+
+ list
+ / elements=string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Group(s) to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+ |
+
+
+ |
+
+ impersonate_user
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Username to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+ |
+
|
@@ -147,6 +182,7 @@ Parameters
|
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 ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+ Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
|
@@ -200,6 +236,25 @@ Parameters
Ignored when resource is set to clusterroles.
+
+ |
+
+ no_proxy
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+ Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+ This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+ example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+ |
+
|
diff --git a/docs/community.okd.openshift_adm_prune_builds_module.rst b/docs/community.okd.openshift_adm_prune_builds_module.rst
index 6fb9443..ccffb8d 100644
--- a/docs/community.okd.openshift_adm_prune_builds_module.rst
+++ b/docs/community.okd.openshift_adm_prune_builds_module.rst
@@ -435,7 +435,7 @@ Examples
# all builds whose associated BuildConfig no longer exists
- name: Run delete orphan Builds
community.okd.openshift_adm_prune_builds:
- orphans: True
+ orphans: true
# Run deleting older completed and failed builds keep younger than 2hours
- name: Run delete builds, keep younger than 2h
diff --git a/docs/community.okd.openshift_adm_prune_deployments_module.rst b/docs/community.okd.openshift_adm_prune_deployments_module.rst
index 16e0ded..0c73845 100644
--- a/docs/community.okd.openshift_adm_prune_deployments_module.rst
+++ b/docs/community.okd.openshift_adm_prune_deployments_module.rst
@@ -134,6 +134,41 @@ Parameters
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
+
+ |
+
+ impersonate_groups
+
+
+ list
+ / elements=string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Group(s) to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+ |
+
+
+ |
+
+ impersonate_user
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Username to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+ |
+
|
@@ -162,6 +197,7 @@ Parameters
|
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 ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+ Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
|
@@ -180,6 +216,25 @@ Parameters
Use to specify namespace for deployments to be deleted.
+
+ |
+
+ no_proxy
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+ Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+ This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+ example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+ |
+
|
@@ -382,7 +437,7 @@ Examples
- name: Prune orphans deployments, keep younger than 2hours
community.okd.openshift_adm_prune_deployments:
- orphans: True
+ orphans: true
keep_younger_than: 120
diff --git a/docs/community.okd.openshift_adm_prune_images_module.rst b/docs/community.okd.openshift_adm_prune_images_module.rst
index 08fd357..9978b96 100644
--- a/docs/community.okd.openshift_adm_prune_images_module.rst
+++ b/docs/community.okd.openshift_adm_prune_images_module.rst
@@ -177,6 +177,41 @@ Parameters
As a result an image may be incorrectly deleted as unused.
|
+
+ |
+
+ impersonate_groups
+
+
+ list
+ / elements=string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Group(s) to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+ |
+
+
+ |
+
+ impersonate_user
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Username to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+ |
+
|
@@ -205,6 +240,7 @@ Parameters
|
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 ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+ Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
|
@@ -223,6 +259,25 @@ Parameters
Use to specify namespace for objects.
+
+ |
+
+ no_proxy
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+ Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+ This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+ example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+ |
+
|
diff --git a/docs/community.okd.openshift_auth_module.rst b/docs/community.okd.openshift_auth_module.rst
index 3619940..a6e7703 100644
--- a/docs/community.okd.openshift_auth_module.rst
+++ b/docs/community.okd.openshift_auth_module.rst
@@ -171,37 +171,40 @@ Examples
.. code-block:: yaml
- - hosts: localhost
+ - name: Example Playbook
+ hosts: localhost
module_defaults:
- group/k8s:
+ group/community.okd.okd:
host: https://k8s.example.com/
ca_cert: ca.pem
tasks:
- - block:
- # It's good practice to store login credentials in a secure vault and not
- # directly in playbooks.
- - include_vars: openshift_passwords.yml
+ - name: Authenticate to OpenShift cluster and gell a list of all pods from any namespace
+ block:
+ # It's good practice to store login credentials in a secure vault and not
+ # directly in playbooks.
+ - name: Include 'openshift_passwords.yml'
+ ansible.builtin.include_vars: openshift_passwords.yml
- - name: Log in (obtain access token)
- community.okd.openshift_auth:
- username: admin
- password: "{{ openshift_admin_password }}"
- register: openshift_auth_results
+ - name: Log in (obtain access token)
+ community.okd.openshift_auth:
+ username: admin
+ password: "{{ openshift_admin_password }}"
+ register: openshift_auth_results
- # Previous task provides the token/api_key, while all other parameters
- # are taken from module_defaults
- - name: Get a list of all pods from any namespace
- kubernetes.core.k8s_info:
- api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
- kind: Pod
- register: pod_list
+ # Previous task provides the token/api_key, while all other parameters
+ # are taken from module_defaults
+ - name: Get a list of all pods from any namespace
+ kubernetes.core.k8s_info:
+ api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
+ kind: Pod
+ register: pod_list
- always:
- - name: If login succeeded, try to log out (revoke access token)
- when: openshift_auth_results.openshift_auth.api_key is defined
- community.okd.openshift_auth:
- state: absent
- api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
+ always:
+ - name: If login succeeded, try to log out (revoke access token)
+ when: openshift_auth_results.openshift_auth.api_key is defined
+ community.okd.openshift_auth:
+ state: absent
+ api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
diff --git a/docs/community.okd.openshift_import_image_module.rst b/docs/community.okd.openshift_import_image_module.rst
index 920c840..c1bafd1 100644
--- a/docs/community.okd.openshift_import_image_module.rst
+++ b/docs/community.okd.openshift_import_image_module.rst
@@ -157,6 +157,41 @@ Parameters
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
+
+ |
+
+ impersonate_groups
+
+
+ list
+ / elements=string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Group(s) to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+ |
+
+
+ |
+
+ impersonate_user
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Username to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+ |
+
|
@@ -170,6 +205,7 @@ Parameters
|
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 ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+ Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
|
@@ -206,6 +242,25 @@ Parameters
Use to specify namespace for image stream to create/update.
+
+ |
+
+ no_proxy
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+ Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+ This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+ example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+ |
+
|
diff --git a/docs/community.okd.openshift_inventory.rst b/docs/community.okd.openshift_inventory.rst
index 57527f4..9015fb0 100644
--- a/docs/community.okd.openshift_inventory.rst
+++ b/docs/community.okd.openshift_inventory.rst
@@ -13,6 +13,15 @@ community.okd.openshift
:local:
:depth: 1
+DEPRECATED
+----------
+:Removed in collection release after
+:Why: As discussed in https://github.com/ansible-collections/kubernetes.core/issues/31, we decided to
+remove the openshift inventory plugin in release 4.0.0.
+
+:Alternative: Use :ref:`kubernetes.core.k8s_info ` and :ref:`ansible.builtin.add_host ` instead.
+
+
Synopsis
--------
@@ -320,24 +329,24 @@ Examples
# File must be named openshift.yaml or openshift.yml
- # 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: 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
- # 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 default config (~/.kube/config) file and active context, and return objects for a specific namespace
+ plugin: community.okd.openshift
+ connections:
+ - namespaces:
+ - testing
- # 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'
+ - 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'
@@ -346,10 +355,14 @@ Status
------
+- This inventory will be removed in version 4.0.0. *[deprecated]*
+- For more information see `DEPRECATED`_.
+
+
Authors
~~~~~~~
-- Chris Houseknecht <@chouseknecht>
+- Chris Houseknecht (@chouseknecht)
.. hint::
diff --git a/docs/community.okd.openshift_process_module.rst b/docs/community.okd.openshift_process_module.rst
index 7de7e8c..9ccc702 100644
--- a/docs/community.okd.openshift_process_module.rst
+++ b/docs/community.okd.openshift_process_module.rst
@@ -137,6 +137,41 @@ Parameters
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
+
+ |
+
+ impersonate_groups
+
+
+ list
+ / elements=string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Group(s) to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+ |
+
+
+ |
+
+ impersonate_user
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Username to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+ |
+
|
@@ -150,6 +185,7 @@ Parameters
|
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 ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+ Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
|
@@ -192,7 +228,7 @@ Parameters
namespace_target
- -
+ string
@@ -202,6 +238,25 @@ Parameters
Only used when state is present or absent.
|
+
+ |
+
+ no_proxy
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+ Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+ This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+ example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+ |
+
|
@@ -389,6 +444,7 @@ Parameters
|
Provide a path to a file containing a valid YAML definition of an object or objects to be created or updated. Mutually exclusive with resource_definition. NOTE: kind, api_version, name, and namespace will be overwritten by corresponding values found in the configuration read in from the src file.
Reads from the local file system. To read from the Ansible controller's file system, including vaulted files, use the file lookup plugin or template lookup plugin, combined with the from_yaml filter, and pass the result to resource_definition. See Examples below.
+ The URL to manifest files that can be used to create the resource. Added in version 2.4.0.
Mutually exclusive with template in case of kubernetes.core.k8s module.
|
@@ -616,8 +672,8 @@ Examples
community.okd.k8s:
namespace: default
definition: '{{ item }}'
- wait: yes
- apply: yes
+ wait: true
+ apply: true
loop: '{{ result.resources }}'
- name: Process a template with parameters from an env file and create the resources
@@ -627,7 +683,7 @@ Examples
namespace_target: default
parameter_file: 'files/nginx.env'
state: present
- wait: yes
+ wait: true
- name: Process a local template and create the resources
community.okd.openshift_process:
@@ -642,7 +698,7 @@ Examples
parameter_file: files/example.env
namespace_target: default
state: absent
- wait: yes
+ wait: true
diff --git a/docs/community.okd.openshift_registry_info_module.rst b/docs/community.okd.openshift_registry_info_module.rst
index f556d0f..5636785 100644
--- a/docs/community.okd.openshift_registry_info_module.rst
+++ b/docs/community.okd.openshift_registry_info_module.rst
@@ -156,6 +156,41 @@ Parameters
Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
+
+ |
+
+ impersonate_groups
+
+
+ list
+ / elements=string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Group(s) to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+ |
+
+
+ |
+
+ impersonate_user
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Username to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+ |
+
|
@@ -169,9 +204,29 @@ Parameters
|
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 ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+ Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
|
+
+ |
+
+ no_proxy
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+ Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+ This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+ example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+ |
+
|
@@ -356,7 +411,7 @@ Examples
# Read registry integrated information and attempt to contact using local client.
- name: Attempt to contact integrated registry using local client
community.okd.openshift_registry_info:
- check: yes
+ check: true
diff --git a/docs/community.okd.openshift_route_module.rst b/docs/community.okd.openshift_route_module.rst
index fc62623..4e939df 100644
--- a/docs/community.okd.openshift_route_module.rst
+++ b/docs/community.okd.openshift_route_module.rst
@@ -187,6 +187,41 @@ Parameters
The hostname for the Route.
|
+
+ |
+
+ impersonate_groups
+
+
+ list
+ / elements=string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Group(s) to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_GROUPS environment. Example: Group1,Group2
+ |
+
+
+ |
+
+ impersonate_user
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ Username to impersonate for the operation.
+ Can also be specified via K8S_AUTH_IMPERSONATE_USER environment.
+ |
+
|
@@ -200,6 +235,7 @@ Parameters
|
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 ~/.kube/config. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+ Multiple Kubernetes config file can be provided using separator ';' for Windows platform or ':' for others platforms.
The kubernetes configuration can be provided as dictionary. This feature requires a python kubernetes client version >= 17.17.0. Added in version 2.2.0.
|
@@ -252,6 +288,25 @@ Parameters
The Route will be created in this namespace as well.
+
+ |
+
+ no_proxy
+
+
+ string
+
+ added in 2.3.0
+ |
+
+ |
+
+ The comma separated list of hosts/domains/IP/CIDR that shouldn't go through proxy. Can also be specified via K8S_AUTH_NO_PROXY environment variable.
+ Please note that this module does not pick up typical proxy settings from the environment (e.g. NO_PROXY).
+ This feature requires kubernetes>=19.15.0. When kubernetes library is less than 19.15.0, it fails even no_proxy set in correct.
+ example value is "localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
+ |
+
|
@@ -801,10 +856,10 @@ Examples
app: hello-kubernetes
spec:
containers:
- - name: hello-kubernetes
- image: paulbouwer/hello-kubernetes:1.8
- ports:
- - containerPort: 8080
+ - name: hello-kubernetes
+ image: paulbouwer/hello-kubernetes:1.8
+ ports:
+ - containerPort: 8080
- name: Create Service for the hello-world deployment
community.okd.k8s:
@@ -816,8 +871,8 @@ Examples
namespace: default
spec:
ports:
- - port: 80
- targetPort: 8080
+ - port: 80
+ targetPort: 8080
selector:
app: hello-kubernetes
diff --git a/galaxy.yml b/galaxy.yml
index f3ea49d..04db698 100644
--- a/galaxy.yml
+++ b/galaxy.yml
@@ -5,7 +5,7 @@ authors:
- willthames (https://github.com/willthames)
- Akasurde (https://github.com/akasurde)
dependencies:
- kubernetes.core: '>=2.4.0'
+ kubernetes.core: '>=3.0.0'
description: OKD Collection for Ansible.
documentation: ''
homepage: ''
@@ -24,4 +24,4 @@ tags:
- okd
- cluster
# Also needs to be updated in the Makefile
-version: 2.3.0
+version: 3.0.1
diff --git a/requirements.yml b/requirements.yml
index 3c7976a..ac7b465 100644
--- a/requirements.yml
+++ b/requirements.yml
@@ -1,4 +1,4 @@
---
collections:
- name: kubernetes.core
- version: '>=2.4.0'
+ version: '>=3.0.0'
|