diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 254bf53..1f79512 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,24 @@ OKD Collection Release Notes .. contents:: Topics +v4.0.0 +====== + +Release Summary +--------------- + +In this major release we have removed support for ``ansible-core<2.15``. + +Minor Changes +------------- + +- connection/oc - added support of local enviroment variable that will be used for ``oc`` and may be requried for establishing connections ifself (https://github.com/openshift/community.okd/pull/225). +- inventory/openshift.py - Defer removal of k8s inventory plugin to version 5.0.0 (https://github.com/openshift/community.okd/pull/224). + +Removed Features (previously deprecated) +---------------------------------------- + +- k8s - Support for ``merge_type=json`` has been removed in version 4.0.0. Please use ``kubernetes.core.k8s_json_patch`` instead (https://github.com/openshift/community.okd/pull/226). v3.0.1 ====== @@ -13,7 +31,6 @@ Release Summary This patch release fixes an issue in building the downstream collection. - v3.0.0 ====== diff --git a/Makefile b/Makefile index b897aed..4d35180 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ .PHONY: molecule # Also needs to be updated in galaxy.yml -VERSION = 3.0.1 +VERSION = 4.0.0 SANITY_TEST_ARGS ?= --docker --color UNITS_TEST_ARGS ?= --docker --color diff --git a/README.md b/README.md index 4f6ba61..824a68a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The collection includes a variety of Ansible content to help automate the manage ## Ansible version compatibility -This collection has been tested against following Ansible versions: **>=2.14.0**. +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. @@ -76,7 +76,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible --- collections: - name: community.okd - version: 3.0.1 + version: 4.0.0 ``` ### Installing the Kubernetes Python Library diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 82cd00a..7768706 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -224,3 +224,20 @@ releases: - downstream-gitignore.yml - release_summary.yml release_date: '2023-11-30' + 4.0.0: + changes: + minor_changes: + - connection/oc - added support of local enviroment variable that will be used + for ``oc`` and may be requried for establishing connections ifself (https://github.com/openshift/community.okd/pull/225). + - inventory/openshift.py - Defer removal of k8s inventory plugin to version + 5.0.0 (https://github.com/openshift/community.okd/pull/224). + release_summary: In this major release we have removed support for ``ansible-core<2.15``. + removed_features: + - k8s - Support for ``merge_type=json`` has been removed in version 4.0.0. Please + use ``kubernetes.core.k8s_json_patch`` instead (https://github.com/openshift/community.okd/pull/226). + fragments: + - 20240523-connection-oc-add-support-for-local-env-vars.yml + - 4.0.0.yaml + - defer_removal_of_inventory_plugin.yaml + - k8s-merge_type=json-removed.yml + release_date: '2024-05-29' diff --git a/changelogs/fragments/20240523-connection-oc-add-support-for-local-env-vars.yml b/changelogs/fragments/20240523-connection-oc-add-support-for-local-env-vars.yml deleted file mode 100644 index f415684..0000000 --- a/changelogs/fragments/20240523-connection-oc-add-support-for-local-env-vars.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - connection/oc - added support of local enviroment variable that will be used for ``oc`` and may be requried for establishing connections ifself (https://github.com/openshift/community.okd/pull/225). diff --git a/changelogs/fragments/defer_removal_of_inventory_plugin.yaml b/changelogs/fragments/defer_removal_of_inventory_plugin.yaml deleted file mode 100644 index 769c23e..0000000 --- a/changelogs/fragments/defer_removal_of_inventory_plugin.yaml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - inventory/openshift.py - Defer removal of k8s inventory plugin to version 5.0.0 (https://github.com/openshift/community.okd/pull/224). diff --git a/changelogs/fragments/k8s-merge_type=json-removed.yml b/changelogs/fragments/k8s-merge_type=json-removed.yml deleted file mode 100644 index b1fe8d2..0000000 --- a/changelogs/fragments/k8s-merge_type=json-removed.yml +++ /dev/null @@ -1,2 +0,0 @@ -removed_features: - - k8s - Support for ``merge_type=json`` has been removed in version 4.0.0. Please use ``kubernetes.core.k8s_json_patch`` instead (https://github.com/openshift/community.okd/pull/226). diff --git a/ci/downstream.sh b/ci/downstream.sh index 749534f..0e6d0df 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="3.0.1" +DOWNSTREAM_VERSION="4.0.0" 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 9a14c44..519b752 100644 --- a/docs/community.okd.k8s_module.rst +++ b/docs/community.okd.k8s_module.rst @@ -433,7 +433,6 @@ Parameters @@ -445,7 +444,7 @@ Parameters
If more than one merge_type is given, the merge_types will be tried in order
Defaults to ['strategic-merge', 'merge'], which is ideal for using the same parameters on resource kinds that combine Custom Resources and built-in resources.
mutually exclusive with apply
-
merge_type=json is deprecated and will be removed in version 3.0.0. Please use kubernetes.core.k8s_json_patch instead.
+
merge_type=json has been removed in version 4.0.0. Please use kubernetes.core.k8s_json_patch instead.
@@ -970,6 +969,15 @@ Examples .. code-block:: yaml + - name: Create an OCP project + community.okd.k8s: + state: present + resource_definition: + apiVersion: project.openshift.io/v1 + kind: Project + metadata: + name: testing + - name: Create a k8s namespace community.okd.k8s: name: testing diff --git a/docs/community.okd.oc_connection.rst b/docs/community.okd.oc_connection.rst index 12869df..1c18e1e 100644 --- a/docs/community.okd.oc_connection.rst +++ b/docs/community.okd.oc_connection.rst @@ -208,6 +208,27 @@ Parameters
Path to a oc config file. Defaults to ~/.kube/config
+ + +
+ oc_local_env_vars + +
+ dictionary +
+
added in 4.0.0
+ + + Default:
{}
+ + +
var: ansible_oc_local_env_vars
+ + +
Local environment variable to be passed locally to the oc command line.
+
Please be aware that this passes information directly on the command line and it could expose sensitive data.
+ +
diff --git a/docs/community.okd.openshift_inventory.rst b/docs/community.okd.openshift_inventory.rst index 9015fb0..124ea9b 100644 --- a/docs/community.okd.openshift_inventory.rst +++ b/docs/community.okd.openshift_inventory.rst @@ -17,7 +17,7 @@ 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. +remove the openshift inventory plugin in release 5.0.0. :Alternative: Use :ref:`kubernetes.core.k8s_info ` and :ref:`ansible.builtin.add_host ` instead. @@ -355,7 +355,7 @@ Status ------ -- This inventory will be removed in version 4.0.0. *[deprecated]* +- This inventory will be removed in version 5.0.0. *[deprecated]* - For more information see `DEPRECATED`_. diff --git a/galaxy.yml b/galaxy.yml index 04db698..3914e6e 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: '>=3.0.0' + kubernetes.core: '>=5.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: 3.0.1 +version: 4.0.0 diff --git a/meta/runtime.yml b/meta/runtime.yml index 8c7dcba..322ebd3 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -1,5 +1,5 @@ --- -requires_ansible: '>=2.14.0' +requires_ansible: '>=2.15.0' action_groups: okd: - k8s