diff --git a/CHANGELOG.rst b/CHANGELOG.rst index e6b4254..3e7c881 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,31 @@ OKD Collection Release Notes .. contents:: Topics +v2.0.0 +====== + +Major Changes +------------- + +- 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``. + +Breaking Changes / Porting Guide +-------------------------------- + +- 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). + v1.1.2 ====== diff --git a/Makefile b/Makefile index 3ab36ce..723bf3d 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ .PHONY: molecule # Also needs to be updated in galaxy.yml -VERSION = 1.1.2 +VERSION = 2.0.0 SANITY_TEST_ARGS ?= --docker --color PYTHON_VERSION ?= `python3 -c 'import platform; print("{0}.{1}".format(platform.python_version_tuple()[0], platform.python_version_tuple()[1]))'` diff --git a/README.md b/README.md index 411902d..eb6ae7f 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.9**. +This collection has been tested against following Ansible versions: **>=2.9.17**. Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. @@ -27,6 +27,11 @@ Name | Description --- | --- [community.okd.oc](https://github.com/ansible-collections/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/ansible-collections/community.okd/blob/main/docs/community.okd.openshift_inventory.rst)|OpenShift inventory source + ### Modules Name | Description --- | --- @@ -35,11 +40,6 @@ Name | Description [community.okd.openshift_process](https://github.com/ansible-collections/community.okd/blob/main/docs/community.okd.openshift_process_module.rst)|Process an OpenShift template.openshift.io/v1 Template [community.okd.openshift_route](https://github.com/ansible-collections/community.okd/blob/main/docs/community.okd.openshift_route_module.rst)|Expose a Service as an OpenShift Route. -### Inventory plugins -Name | Description ---- | --- -[community.okd.openshift](https://github.com/ansible-collections/community.okd/blob/main/docs/community.okd.openshift_inventory.rst)|OpenShift inventory source - @@ -58,7 +58,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible --- collections: - name: community.okd - version: 1.1.2 + version: 2.0.0 ``` ### Installing the Kubernetes Python Library diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index f3d44ec..e002399 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -109,3 +109,23 @@ releases: fragments: - 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). + 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). + major_changes: + - 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``. + 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 + release_date: '2021-06-22' diff --git a/changelogs/fragments/66-restrict-kubernetes-core-version.yaml b/changelogs/fragments/66-restrict-kubernetes-core-version.yaml deleted file mode 100644 index f214077..0000000 --- a/changelogs/fragments/66-restrict-kubernetes-core-version.yaml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - restrict the version of kubernetes.core dependency (https://github.com/ansible-collections/community.okd/pull/66). diff --git a/changelogs/fragments/71-bump-kubernetes-core-version.yaml b/changelogs/fragments/71-bump-kubernetes-core-version.yaml deleted file mode 100644 index f192fd5..0000000 --- a/changelogs/fragments/71-bump-kubernetes-core-version.yaml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - increase the kubernetes.core dependency version number (https://github.com/ansible-collections/community.okd/pull/71). diff --git a/changelogs/fragments/77-fix-ci-failure.yaml b/changelogs/fragments/77-fix-ci-failure.yaml deleted file mode 100644 index 27c7fea..0000000 --- a/changelogs/fragments/77-fix-ci-failure.yaml +++ /dev/null @@ -1,3 +0,0 @@ -bugfixes: - - restrict molecule version to <3.3.0 to address breaking change (https://github.com/ansible-collections/community.okd/pull/77). - - 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). diff --git a/changelogs/fragments/78-add-requirements-file.yaml b/changelogs/fragments/78-add-requirements-file.yaml deleted file mode 100644 index 12e7887..0000000 --- a/changelogs/fragments/78-add-requirements-file.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - add missing requirements.txt file needed for execution environments (https://github.com/ansible-collections/community.okd/pull/78). diff --git a/changelogs/fragments/80-update-ci.yaml b/changelogs/fragments/80-update-ci.yaml deleted file mode 100644 index 0c64f3a..0000000 --- a/changelogs/fragments/80-update-ci.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - update CI to work with ansible 2.11 (https://github.com/ansible-collections/community.okd/pull/80). diff --git a/changelogs/fragments/81-include-requirements.yaml b/changelogs/fragments/81-include-requirements.yaml deleted file mode 100644 index dd838f6..0000000 --- a/changelogs/fragments/81-include-requirements.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - include requirements.txt in downstream build process (https://github.com/ansible-collections/community.okd/pull/81). diff --git a/changelogs/fragments/87-openshift_process-fix-template-without-message.yaml b/changelogs/fragments/87-openshift_process-fix-template-without-message.yaml deleted file mode 100644 index 033237f..0000000 --- a/changelogs/fragments/87-openshift_process-fix-template-without-message.yaml +++ /dev/null @@ -1,2 +0,0 @@ -bugfixes: - - openshift_process - fix module execution when template does not include a message (https://github.com/ansible-collections/community.okd/pull/87). diff --git a/changelogs/fragments/89-clean-up-ci.yaml b/changelogs/fragments/89-clean-up-ci.yaml deleted file mode 100644 index d6a1442..0000000 --- a/changelogs/fragments/89-clean-up-ci.yaml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - fixes test suite to use correct versions of python and dependencies (https://github.com/ansible-collections/community.okd/pull/89). diff --git a/changelogs/fragments/93-update-to-k8s-2.yaml b/changelogs/fragments/93-update-to-k8s-2.yaml deleted file mode 100644 index 23b419e..0000000 --- a/changelogs/fragments/93-update-to-k8s-2.yaml +++ /dev/null @@ -1,5 +0,0 @@ ---- -breaking_changes: - - drop python 2 support (https://github.com/openshift/community.okd/pull/93). -major_changes: - - update to use kubernetes.core 2.0 (https://github.com/openshift/community.okd/pull/93). diff --git a/changelogs/fragments/add_docs.yml b/changelogs/fragments/add_docs.yml deleted file mode 100644 index 247a10a..0000000 --- a/changelogs/fragments/add_docs.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: -- Added documentation for the ``community.okd`` collection. diff --git a/changelogs/fragments/fqcn_inventory.yml b/changelogs/fragments/fqcn_inventory.yml deleted file mode 100644 index 6282aec..0000000 --- a/changelogs/fragments/fqcn_inventory.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: -- openshift - inventory plugin supports FQCN ``redhat.openshift``. diff --git a/ci/downstream.sh b/ci/downstream.sh index 49a3f47..2918406 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="1.1.2" +DOWNSTREAM_VERSION="2.0.0" KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}" _build_dir="" diff --git a/docs/community.okd.k8s_module.rst b/docs/community.okd.k8s_module.rst index cc23d06..5b84fce 100644 --- a/docs/community.okd.k8s_module.rst +++ b/docs/community.okd.k8s_module.rst @@ -16,13 +16,13 @@ community.okd.k8s Synopsis -------- -- Use the OpenShift Python client to perform CRUD operations on K8s objects. +- Use the Kubernetes Python client to perform CRUD operations on K8s objects. - Pass the object definition from a source file or inline. See examples for reading files and using Jinja templates or vault-encrypted files. - Access to the full range of K8s APIs. -- Use the :ref:`k8s_info ` module to obtain a list of items about an object of type ``kind`` +- Use the :ref:`kubernetes.core.k8s_info ` module to obtain a list of items about an object of type ``kind``. - Authenticate using either a config file, certificates, password or token. - Supports check mode. -- Optimized for OKD/OpenShift Kubernetes flavors +- Optimized for OKD/OpenShift Kubernetes flavors. @@ -30,8 +30,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.7 -- openshift >= 0.6 +- python >= 3.6 +- kubernetes >= 12.0.0 - PyYAML >= 3.11 @@ -42,12 +42,12 @@ Parameters - + - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + + + - - - - - - - - - - - -
ParameterParameter Choices/Defaults Comments
+
api_key @@ -62,7 +62,7 @@ Parameters
+
api_version @@ -82,7 +82,7 @@ Parameters
+
append_hash @@ -104,7 +104,7 @@ Parameters
+
apply @@ -125,7 +125,7 @@ Parameters
+
ca_cert @@ -141,7 +141,7 @@ Parameters
+
client_cert @@ -157,7 +157,7 @@ Parameters
+
client_key @@ -173,7 +173,7 @@ Parameters
+
context @@ -188,7 +188,137 @@ Parameters
+
+ continue_on_error + +
+ boolean +
+
added in 2.0.0
+ 		+
    Choices: +
  • no ←
    • +
  • yes
    • +
+ 		+
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 validate.fail_on_error parameter.
+
+
+ delete_options + +
+ dictionary +
+
added in 1.2.0
+ 		+ +
Configure behavior when deleting an object.
+
Only used when state=absent.
+
+
+ gracePeriodSeconds + +
+ integer +
+ 		+ +
Specify how many seconds to wait before forcefully terminating.
+
Only implemented for Pod resources.
+
If not specified, the default grace period for the object type will be used.
+
+
+ preconditions + +
+ dictionary +
+ 		+ +
Specify condition that must be met for delete to proceed.
+
+
+ resourceVersion + +
+ string +
+ 		+ +
Specify the resource version of the target object.
+
+
+ uid + +
+ string +
+ 		+ +
Specify the UID of the target object.
+
+
+ propagationPolicy + +
+ string +
+ 		+
    Choices: +
  • Foreground
    • +
  • Background
    • +
  • Orphan
    • +
+ 		+
Use to control how dependent objects are deleted.
+
If not specified, the default policy for the object type will be used. This may vary across object types.
+
force @@ -207,7 +337,7 @@ Parameters
+
host @@ -222,7 +352,7 @@ Parameters
+
kind @@ -240,7 +370,7 @@ Parameters
+
kubeconfig @@ -251,11 +381,11 @@ Parameters 		-
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+
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.
+
merge_type @@ -275,14 +405,14 @@ Parameters
Whether to override the default patch merge approach with a specific type. By default, the strategic merge will typically be used.
For example, Custom Resource Definitions typically aren't updatable by the usual strategic merge. You may want to use merge if you see "strategic merge patch format is not supported"
-
Requires openshift >= 0.6.2
If more than one merge_type is given, the merge_types will be tried in order
-
If openshift >= 0.6.2, this defaults to ['strategic-merge', 'merge'], which is ideal for using the same parameters on resource kinds that combine Custom Resources and built-in resources. For openshift < 0.6.2, the default is simply strategic-merge.
+
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.
+
name @@ -300,7 +430,7 @@ Parameters
+
namespace @@ -318,7 +448,7 @@ Parameters
+
password @@ -334,7 +464,7 @@ Parameters
+
persist_config @@ -357,7 +487,7 @@ Parameters
+
proxy @@ -373,7 +503,76 @@ Parameters
+
+ proxy_headers + +
+ dictionary +
+
added in 2.0.0
+ 		+ +
The Header used for the HTTP proxy.
+ +
+
+ basic_auth + +
+ string +
+ 		+ +
Colon-separated username:password for basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
+
+
+ proxy_basic_auth + +
+ string +
+ 		+ +
Colon-separated username:password for proxy basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
+
+
+ user_agent + +
+ string +
+ 		+ +
String representing the user-agent you want, such as foo/1.0.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
+
resource_definition @@ -390,7 +589,7 @@ Parameters
+
src @@ -407,7 +606,7 @@ Parameters
+
state @@ -419,14 +618,44 @@ Parameters
    Choices:
  • absent
  • present ←
    • +
  • patched
Determines if an object should be created, patched, or deleted. When set to present, an object will be created, if it does not already exist. If set to absent, an existing object will be deleted. If set to present, an existing object will be patched, if its attributes differ from those specified using resource_definition or src.
+
patched state is an existing resource that has a given patch applied. If the resource doesn't exist, silently skip it (do not raise an error).
+ +
+ template + +
+ raw +
+
added in 2.0.0
+ 		+ +
Provide a valid YAML template definition file for an object when creating or updating.
+
Value can be provided as string or dictionary.
+
Mutually exclusive with src and resource_definition.
+
Template files needs to be present on the Ansible Controller's file system.
+
Additional parameters can be specified using dictionary.
+
Valid additional parameters -
+
newline_sequence (str): Specify the newline sequence to use for templating files. valid choices are "\n", "\r", "\r\n". Default value "\n".
+
block_start_string (str): The string marking the beginning of a block. Default value "{%".
+
block_end_string (str): The string marking the end of a block. Default value "%}".
+
variable_start_string (str): The string marking the beginning of a print statement. Default value "{{".
+
variable_end_string (str): The string marking the end of a print statement. Default value "}}".
+
trim_blocks (bool): Determine when newlines should be removed from blocks. When set to yes the first newline after a block is removed (block, not variable tag!). Default value is true.
+
lstrip_blocks (bool): Determine when leading spaces and tabs should be stripped. When set to yes leading spaces and tabs are stripped from the start of a line to a block. This functionality requires Jinja 2.7 or newer. Default value is false.
+
username @@ -442,7 +671,7 @@ Parameters
+
validate @@ -458,7 +687,7 @@ Parameters
+
fail_on_error @@ -478,7 +707,7 @@ Parameters
+
strict @@ -498,7 +727,7 @@ Parameters
+
version @@ -514,7 +743,7 @@ Parameters
+
validate_certs @@ -534,7 +763,7 @@ Parameters
+
wait @@ -549,13 +778,14 @@ Parameters 		-
Whether to wait for certain resource kinds to end up in the desired state. By default the module exits once Kubernetes has received the request
+
Whether to wait for certain resource kinds to end up in the desired state.
+
By default the module exits once Kubernetes has received the request.
Implemented for state=present for Deployment, DaemonSet and Pod, and for state=absent for all resource kinds.
For resource kinds without an implementation, wait returns immediately unless wait_condition is set.
+
wait_condition @@ -566,12 +796,13 @@ Parameters 		-
Specifies a custom condition on the status to wait for. Ignored if wait is not set or is set to False.
+
Specifies a custom condition on the status to wait for.
+
Ignored if wait is not set or is set to False.
+
reason @@ -584,12 +815,13 @@ Parameters
The value of the reason field in your desired condition
For example, if a Deployment is paused, The Progressing type will have the DeploymentPaused reason.
-
The possible reasons in a condition are specific to each resource type in Kubernetes. See the API documentation of the status field for a given resource to see possible choices.
+
The possible reasons in a condition are specific to each resource type in Kubernetes.
+
See the API documentation of the status field for a given resource to see possible choices.
+
status @@ -599,11 +831,10 @@ Parameters
    Choices: -
  • yes
    • -
  • no
    • +
  • True ←
    • +
  • False
  • Unknown
- Default:
"True"
The value of the status field in your desired condition.
@@ -612,7 +843,7 @@ Parameters
+
type @@ -623,14 +854,17 @@ Parameters 		-
The type of condition to wait for. For example, the Pod resource will set the Ready condition (among others)
-
Required if you are specifying a wait_condition. If left empty, the wait_condition field will be ignored.
-
The possible types for a condition are specific to each resource type in Kubernetes. See the API documentation of the status field for a given resource to see possible choices.
+
The type of condition to wait for.
+
For example, the Pod resource will set the Ready condition (among others).
+
Required if you are specifying a wait_condition.
+
If left empty, the wait_condition field will be ignored.
+
The possible types for a condition are specific to each resource type in Kubernetes.
+
See the API documentation of the status field for a given resource to see possible choices.
+
wait_sleep @@ -646,7 +880,7 @@ Parameters
+
wait_timeout @@ -658,7 +892,8 @@ Parameters Default:
120
 -
How long in seconds to wait for the resource to end up in the desired state. Ignored if wait is not set.
+
How long in seconds to wait for the resource to end up in the desired state.
+
Ignored if wait is not set.
@@ -669,8 +904,6 @@ Notes ----- .. note:: - - If your OpenShift Python library is not 0.9.0 or newer and you are trying to remove an item from an associative array/dictionary, for example a label or an annotation, you will need to explicitly set the value of the item to be removed to `null`. Simply deleting the entry in the dictionary will not remove it from openshift or kubernetes. - - The OpenShift Python client wraps the K8s Python client, providing full access to all of the APIS and models available on both platforms. For API version details and additional information visit https://github.com/openshift/openshift-restclient-python - To avoid SSL certificate validation errors when ``validate_certs`` is *True*, the full certificate chain for the API server must be provided via ``ca_cert`` or in the kubeconfig file. @@ -678,7 +911,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create a k8s namespace community.okd.k8s: @@ -814,6 +1047,22 @@ Common return values are documented `here 48 + +   + +
+ error + +
+ complex +
+ + error + +
error while trying to create/delete the object.
+
+ +   diff --git a/docs/community.okd.openshift_auth_module.rst b/docs/community.okd.openshift_auth_module.rst index 3b761a7..3619940 100644 --- a/docs/community.okd.openshift_auth_module.rst +++ b/docs/community.okd.openshift_auth_module.rst @@ -26,7 +26,7 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.7 +- python >= 3.6 - urllib3 - requests - requests-oauthlib @@ -169,7 +169,7 @@ Parameters Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - hosts: localhost module_defaults: diff --git a/docs/community.okd.openshift_inventory.rst b/docs/community.okd.openshift_inventory.rst index 54506df..57527f4 100644 --- a/docs/community.okd.openshift_inventory.rst +++ b/docs/community.okd.openshift_inventory.rst @@ -26,8 +26,8 @@ Requirements ------------ The below requirements are needed on the local Ansible controller node that executes this inventory. -- python >= 2.7 -- openshift >= 0.6 +- python >= 3.6 +- kubernetes >= 12.0.0 - PyYAML >= 3.11 @@ -186,7 +186,7 @@ Parameters -
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the OpenShift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+
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.
@@ -298,6 +298,7 @@ Parameters
    Choices:
  • openshift
    • +
  • community.okd.openshift
@@ -315,7 +316,7 @@ Parameters Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml # File must be named openshift.yaml or openshift.yml diff --git a/docs/community.okd.openshift_process_module.rst b/docs/community.okd.openshift_process_module.rst index d4e4106..c1bbd5e 100644 --- a/docs/community.okd.openshift_process_module.rst +++ b/docs/community.okd.openshift_process_module.rst @@ -28,8 +28,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.7 -- openshift >= 0.11.0 +- python >= 3.6 +- kubernetes >= 12.0.0 - PyYAML >= 3.11 @@ -149,7 +149,7 @@ Parameters -
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+
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.
@@ -288,6 +288,75 @@ Parameters
Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
+ + +
+ proxy_headers + +
+ dictionary +
+
added in 2.0.0
+ + + + +
The Header used for the HTTP proxy.
+
Documentation can be found here https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers.
+ + + + + +
+ basic_auth + +
+ string +
+ + + + +
Colon-separated username:password for basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
+ + + + + +
+ proxy_basic_auth + +
+ string +
+ + + + +
Colon-separated username:password for proxy basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
+ + + + + +
+ user_agent + +
+ string +
+ + + + +
String representing the user-agent you want, such as foo/1.0.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
+ + +
@@ -523,7 +592,6 @@ Notes ----- .. note:: - - The OpenShift Python client wraps the K8s Python client, providing full access to all of the APIS and models available on both platforms. For API version details and additional information visit https://github.com/openshift/openshift-restclient-python - To avoid SSL certificate validation errors when ``validate_certs`` is *True*, the full certificate chain for the API server must be provided via ``ca_cert`` or in the kubeconfig file. @@ -531,7 +599,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Process a template in the cluster community.okd.openshift_process: diff --git a/docs/community.okd.openshift_route_module.rst b/docs/community.okd.openshift_route_module.rst index a28057b..c3be683 100644 --- a/docs/community.okd.openshift_route_module.rst +++ b/docs/community.okd.openshift_route_module.rst @@ -27,8 +27,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python >= 2.7 -- openshift >= 0.11.0 +- python >= 3.6 +- kubernetes >= 12.0.0 - PyYAML >= 3.11 @@ -182,7 +182,7 @@ Parameters -
Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the openshift client will attempt to load the default configuration file from ~/.kube/config.json. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.
+
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.
@@ -319,6 +319,75 @@ Parameters
Please note that this module does not pick up typical proxy settings from the environment (e.g. HTTP_PROXY).
+ + +
+ proxy_headers + +
+ dictionary +
+
added in 2.0.0
+ + + + +
The Header used for the HTTP proxy.
+
Documentation can be found here https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers.
+ + + + + +
+ basic_auth + +
+ string +
+ + + + +
Colon-separated username:password for basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_BASIC_AUTH environment.
+ + + + + +
+ proxy_basic_auth + +
+ string +
+ + + + +
Colon-separated username:password for proxy basic authentication header.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH environment.
+ + + + + +
+ user_agent + +
+ string +
+ + + + +
String representing the user-agent you want, such as foo/1.0.
+
Can also be specified via K8S_AUTH_PROXY_HEADERS_USER_AGENT environment.
+ + +
@@ -686,7 +755,6 @@ Notes ----- .. note:: - - The OpenShift Python client wraps the K8s Python client, providing full access to all of the APIS and models available on both platforms. For API version details and additional information visit https://github.com/openshift/openshift-restclient-python - To avoid SSL certificate validation errors when ``validate_certs`` is *True*, the full certificate chain for the API server must be provided via ``ca_cert`` or in the kubeconfig file. @@ -694,7 +762,7 @@ Notes Examples -------- -.. code-block:: yaml+jinja +.. code-block:: yaml - name: Create hello-world deployment community.okd.k8s: diff --git a/galaxy.yml b/galaxy.yml index fb3ac50..e92e29f 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -24,4 +24,4 @@ tags: - okd - cluster # Also needs to be updated in the Makefile -version: 1.1.2 +version: 2.0.0 diff --git a/meta/runtime.yml b/meta/runtime.yml index 893f82f..fd6bf1b 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -1,5 +1,5 @@ --- -requires_ansible: '>=2.9.10' +requires_ansible: '>=2.9.17' plugin_routing: modules: k8s_auth: