mirror of
https://github.com/openshift/community.okd.git
synced 2026-11-22 07:00:26 +00:00
Compare commits
19
Commits
2.0.0
..
stable-2.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2530e51825 | ||
|
|
d154967c88 | ||
|
|
e0c6713926 | ||
|
|
11314f8280 | ||
|
|
c737d44413 | ||
|
|
c340ff6582 | ||
|
|
9bea36be5c | ||
|
|
7bb52051da | ||
|
|
ffe6025fe9 | ||
|
|
f095a4d238 | ||
|
|
b0638ad2a4 | ||
|
|
bfb2c8904f | ||
|
|
3d0dfc1ae2 | ||
|
|
c72d17b6ba | ||
|
|
0838ee48d2 | ||
|
|
e9f8c41ac4 | ||
|
|
faba4a0812 | ||
|
|
6b2f06a157 | ||
|
|
bffadb5a55 |
@@ -16,3 +16,6 @@ changelogs/.plugin-cache.yaml
|
|||||||
# Temporary test files.
|
# Temporary test files.
|
||||||
tests/output
|
tests/output
|
||||||
tests/integration/cloud-config-*
|
tests/integration/cloud-config-*
|
||||||
|
|
||||||
|
# Ignore the ansible_collections that the Makefile generates.
|
||||||
|
ansible_collections
|
||||||
|
|||||||
@@ -5,6 +5,28 @@ OKD Collection Release Notes
|
|||||||
.. contents:: Topics
|
.. contents:: Topics
|
||||||
|
|
||||||
|
|
||||||
|
v2.1.0
|
||||||
|
======
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- fix broken links in Automation Hub for redhat.openshift (https://github.com/openshift/community.okd/issues/100).
|
||||||
|
|
||||||
|
v2.0.1
|
||||||
|
======
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- increase kubernetes.core dependency version (https://github.com/openshift/community.okd/pull/97).
|
||||||
|
|
||||||
v2.0.0
|
v2.0.0
|
||||||
======
|
======
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
.PHONY: molecule
|
.PHONY: molecule
|
||||||
|
|
||||||
# Also needs to be updated in galaxy.yml
|
# Also needs to be updated in galaxy.yml
|
||||||
VERSION = 2.0.0
|
VERSION = 2.1.0
|
||||||
|
|
||||||
SANITY_TEST_ARGS ?= --docker --color
|
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]))'`
|
PYTHON_VERSION ?= `python3 -c 'import platform; print("{0}.{1}".format(platform.python_version_tuple()[0], platform.python_version_tuple()[1]))'`
|
||||||
|
|||||||
@@ -1,10 +1,6 @@
|
|||||||
|
# This file just uses aliases defined in OWNERS_ALIASES.
|
||||||
|
|
||||||
approvers:
|
approvers:
|
||||||
- gravesm
|
- community.okd-approvers
|
||||||
- akasurde
|
|
||||||
- fabianvf
|
|
||||||
- tima
|
|
||||||
reviewers:
|
reviewers:
|
||||||
- gravesm
|
- community.okd-reviewers
|
||||||
- akasurde
|
|
||||||
- fabianvf
|
|
||||||
- tima
|
|
||||||
|
|||||||
@@ -0,0 +1,19 @@
|
|||||||
|
aliases:
|
||||||
|
community.okd-approvers:
|
||||||
|
- gravesm
|
||||||
|
- akasurde
|
||||||
|
- fabianvf
|
||||||
|
- tima
|
||||||
|
- goneri
|
||||||
|
- jillr
|
||||||
|
- alinabuzachis
|
||||||
|
- abikouo
|
||||||
|
community.okd-reviewers:
|
||||||
|
- gravesm
|
||||||
|
- akasurde
|
||||||
|
- fabianvf
|
||||||
|
- tima
|
||||||
|
- goneri
|
||||||
|
- jillr
|
||||||
|
- alinabuzachis
|
||||||
|
- abikouo
|
||||||
@@ -58,7 +58,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible
|
|||||||
---
|
---
|
||||||
collections:
|
collections:
|
||||||
- name: community.okd
|
- name: community.okd
|
||||||
version: 2.0.0
|
version: 2.1.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### Installing the Kubernetes Python Library
|
### Installing the Kubernetes Python Library
|
||||||
@@ -81,6 +81,22 @@ connections:
|
|||||||
|
|
||||||
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.
|
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
|
||||||
|
|
||||||
|
|
||||||
|
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:
|
||||||
|
...
|
||||||
|
```
|
||||||
|
|
||||||
|
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/community.okd/blob/main/docs/ansible_turbo_mode.rst).
|
||||||
|
|
||||||
<!--- STARTREMOVE --->
|
<!--- STARTREMOVE --->
|
||||||
## Testing and Development
|
## Testing and Development
|
||||||
|
|
||||||
@@ -106,9 +122,9 @@ These commands will create a directory called `ansible_collections` which should
|
|||||||
### Prow
|
### Prow
|
||||||
|
|
||||||
This repository uses the OpenShift [Prow](https://github.com/kubernetes/test-infra/blob/master/prow/README.md) instance for testing against live OpenShift clusters.
|
This repository uses the OpenShift [Prow](https://github.com/kubernetes/test-infra/blob/master/prow/README.md) instance for testing against live OpenShift clusters.
|
||||||
The configuration for the CI jobs that this repository runs can be found in the [`openshift/release repository`](https://github.com/openshift/release/blob/master/ci-operator/config/ansible-collections/community.okd/ansible-collections-community.okd-main.yaml).
|
The configuration for the CI jobs that this repository runs can be found in the [`openshift/release repository`](https://github.com/openshift/release/blob/master/ci-operator/config/openshift/community.okd/openshift-community.okd-main.yaml).
|
||||||
|
|
||||||
The [Prow CI integration test job](https://github.com/openshift/release/blob/master/ci-operator/config/ansible-collections/community.okd/ansible-collections-community.okd-main.yaml#L35-L38)
|
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:
|
runs the command:
|
||||||
|
|
||||||
make test-integration-incluster
|
make test-integration-incluster
|
||||||
|
|||||||
@@ -129,3 +129,23 @@ releases:
|
|||||||
- add_docs.yml
|
- add_docs.yml
|
||||||
- fqcn_inventory.yml
|
- fqcn_inventory.yml
|
||||||
release_date: '2021-06-22'
|
release_date: '2021-06-22'
|
||||||
|
2.0.1:
|
||||||
|
changes:
|
||||||
|
minor_changes:
|
||||||
|
- increase kubernetes.core dependency version (https://github.com/openshift/community.okd/pull/97).
|
||||||
|
fragments:
|
||||||
|
- 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).
|
||||||
|
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).
|
||||||
|
fragments:
|
||||||
|
- 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
@@ -9,7 +9,7 @@
|
|||||||
# - All functions are prefixed with f_ so it's obvious where they come
|
# - All functions are prefixed with f_ so it's obvious where they come
|
||||||
# from when in use throughout the script
|
# from when in use throughout the script
|
||||||
|
|
||||||
DOWNSTREAM_VERSION="2.0.0"
|
DOWNSTREAM_VERSION="2.1.0"
|
||||||
KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}"
|
KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}"
|
||||||
_build_dir=""
|
_build_dir=""
|
||||||
|
|
||||||
@@ -46,7 +46,7 @@ f_text_sub()
|
|||||||
sed -i.bak "s/^version\:.*$/version: ${DOWNSTREAM_VERSION}/" "${_build_dir}/galaxy.yml"
|
sed -i.bak "s/^version\:.*$/version: ${DOWNSTREAM_VERSION}/" "${_build_dir}/galaxy.yml"
|
||||||
sed -i.bak "/STARTREMOVE/,/ENDREMOVE/d" "${_build_dir}/README.md"
|
sed -i.bak "/STARTREMOVE/,/ENDREMOVE/d" "${_build_dir}/README.md"
|
||||||
|
|
||||||
find "${_build_dir}" -type f -exec sed -i.bak "s/community\.okd/redhat\.openshift/g" {} \;
|
find "${_build_dir}" -type f ! -name galaxy.yml -exec sed -i.bak "s/community\.okd/redhat\.openshift/g" {} \;
|
||||||
find "${_build_dir}" -type f -name "*.bak" -delete
|
find "${_build_dir}" -type f -name "*.bak" -delete
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,11 @@ NAMESPACE=${NAMESPACE:-default}
|
|||||||
# would resolve to quay.io/mynamespace/molecule-test-runner
|
# would resolve to quay.io/mynamespace/molecule-test-runner
|
||||||
# shellcheck disable=SC2034
|
# shellcheck disable=SC2034
|
||||||
component='molecule-test-runner'
|
component='molecule-test-runner'
|
||||||
eval IMAGE="$IMAGE_FORMAT"
|
if [[ -n "${MOLECULE_IMAGE}" ]]; then
|
||||||
|
IMAGE="${MOLECULE_IMAGE}"
|
||||||
|
else
|
||||||
|
IMAGE="${IMAGE_FORMAT}"
|
||||||
|
fi
|
||||||
|
|
||||||
PULL_POLICY=${PULL_POLICY:-IfNotPresent}
|
PULL_POLICY=${PULL_POLICY:-IfNotPresent}
|
||||||
|
|
||||||
@@ -84,4 +88,5 @@ do
|
|||||||
sleep 10
|
sleep 10
|
||||||
done
|
done
|
||||||
|
|
||||||
|
oc logs job/molecule-integration-test
|
||||||
exit 1
|
exit 1
|
||||||
|
|||||||
@@ -0,0 +1,147 @@
|
|||||||
|
.. _ansible_turbo_mode:
|
||||||
|
|
||||||
|
|
||||||
|
******************
|
||||||
|
Ansible Turbo mode
|
||||||
|
******************
|
||||||
|
|
||||||
|
Following document provides overview of Ansible Turbo mode in ``community.okd`` collection.
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
:local:
|
||||||
|
:depth: 1
|
||||||
|
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
--------
|
||||||
|
- A brief introduction about Ansible Turbo mode in ``community.okd`` collection.
|
||||||
|
- Ansible Turbo mode is an optional performance optimization. It can be enabled by installing the cloud.common collection and setting the ``ENABLE_TURBO_MODE`` environment variable.
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
|
||||||
|
The following requirement is needed on the host that executes this module.
|
||||||
|
|
||||||
|
- The ``cloud.common`` collection (https://github.com/ansible-collections/cloud.common)
|
||||||
|
|
||||||
|
You will also need to set the environment variable ``ENABLE_TURBO_MODE=1`` on the managed host. This can be done in the same ways you would usually do so, for example::
|
||||||
|
|
||||||
|
---
|
||||||
|
- hosts: remote
|
||||||
|
environment:
|
||||||
|
ENABLE_TURBO_MODE: 1
|
||||||
|
tasks:
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
You can install ``cloud.common`` collection using following command::
|
||||||
|
|
||||||
|
# ansible-galaxy collection install cloud.common
|
||||||
|
|
||||||
|
|
||||||
|
Current situation without Ansible Turbo mode
|
||||||
|
============================================
|
||||||
|
|
||||||
|
The traditional execution flow of an Ansible module includes the following steps:
|
||||||
|
|
||||||
|
- Upload of a ZIP archive with the module and its dependencies
|
||||||
|
- Execution of the module
|
||||||
|
- Ansible collects the results once the script is finished
|
||||||
|
|
||||||
|
These steps happen for each task of a playbook, and on every host.
|
||||||
|
|
||||||
|
Most of the time, the execution of a module is fast enough for
|
||||||
|
the user. However, sometime the module requires significant amount of time,
|
||||||
|
just to initialize itself. This is a common situation with the API based modules.
|
||||||
|
|
||||||
|
A classic initialization involves the following steps:
|
||||||
|
|
||||||
|
- Load a Python library to access the remote resource (via SDK)
|
||||||
|
- Open a client
|
||||||
|
- Load a bunch of Python modules.
|
||||||
|
- Request a new TCP connection.
|
||||||
|
- Create a session.
|
||||||
|
- Authenticate the client.
|
||||||
|
|
||||||
|
All these steps are time consuming and the same operations will be running again and again.
|
||||||
|
|
||||||
|
For instance, here:
|
||||||
|
|
||||||
|
- ``import openstack``: takes 0.569s
|
||||||
|
- ``client = openstack.connect()``: takes 0.065s
|
||||||
|
- ``client.authorize()``: takes 1.360s,
|
||||||
|
|
||||||
|
These numbers are from test running against VexxHost public cloud.
|
||||||
|
|
||||||
|
In this case, it's a 2s-ish overhead per task. If the playbook
|
||||||
|
comes with 10 tasks, the execution time cannot go below 20s.
|
||||||
|
|
||||||
|
How Ansible Turbo Module improve the situation
|
||||||
|
==============================================
|
||||||
|
|
||||||
|
``AnsibleTurboModule`` is actually a class that inherites from
|
||||||
|
the standard ``AnsibleModule`` class that your modules probably
|
||||||
|
already use.
|
||||||
|
The big difference is that when a module starts, it also spawns
|
||||||
|
a little Python daemon. If a daemon already exists, it will just
|
||||||
|
reuse it.
|
||||||
|
All the module logic is run inside this Python daemon. This means:
|
||||||
|
|
||||||
|
- Python modules are actually loaded one time
|
||||||
|
- Ansible module can reuse an existing authenticated session.
|
||||||
|
|
||||||
|
The background service
|
||||||
|
======================
|
||||||
|
|
||||||
|
The daemon kills itself after 15s, and communication are done
|
||||||
|
through an Unix socket.
|
||||||
|
It runs in one single process and uses ``asyncio`` internally.
|
||||||
|
Consequently you can use the ``async`` keyword in your Ansible module.
|
||||||
|
This will be handy if you interact with a lot of remote systems
|
||||||
|
at the same time.
|
||||||
|
|
||||||
|
Security impact
|
||||||
|
===============
|
||||||
|
|
||||||
|
``ansible_module.turbo`` open an Unix socket to interact with the background service.
|
||||||
|
We use this service to open the connection toward the different target systems.
|
||||||
|
|
||||||
|
This is similar to what SSH does with the sockets.
|
||||||
|
|
||||||
|
Keep in mind that:
|
||||||
|
|
||||||
|
- All the modules can access the same cache. Soon an isolation will be done at the collection level (https://github.com/ansible-collections/cloud.common/pull/17)
|
||||||
|
- A task can load a different version of a library and impact the next tasks.
|
||||||
|
- If the same user runs two ``ansible-playbook`` at the same time, they will have access to the same cache.
|
||||||
|
|
||||||
|
When a module stores a session in a cache, it's a good idea to use a hash of the authentication information to identify the session.
|
||||||
|
|
||||||
|
Error management
|
||||||
|
================
|
||||||
|
|
||||||
|
``ansible_module.turbo`` uses exceptions to communicate a result back to the module.
|
||||||
|
|
||||||
|
- ``EmbeddedModuleFailure`` is raised when ``json_fail()`` is called.
|
||||||
|
- ``EmbeddedModuleSuccess`` is raised in case of success and returns the result to the origin module process.
|
||||||
|
|
||||||
|
These exceptions are defined in ``ansible_collections.cloud.common.plugins.module_utils.turbo.exceptions``.
|
||||||
|
You can raise ``EmbeddedModuleFailure`` exception yourself, for instance from a module in ``module_utils``.
|
||||||
|
|
||||||
|
.. note:: Be careful with the ``except Exception:`` blocks.
|
||||||
|
Not only they are bad practice, but also may interface with this
|
||||||
|
mechanism.
|
||||||
|
|
||||||
|
|
||||||
|
Troubleshooting
|
||||||
|
===============
|
||||||
|
|
||||||
|
You may want to manually start the server. This can be done with the following command:
|
||||||
|
|
||||||
|
.. code-block:: shell
|
||||||
|
|
||||||
|
PYTHONPATH=$HOME/.ansible/collections python -m ansible_collections.cloud.common.plugins.module_utils.turbo.server --socket-path $HOME/.ansible/tmp/turbo_mode.kubernetes.core.socket
|
||||||
|
|
||||||
|
You can use the ``--help`` argument to get a list of the optional parameters.
|
||||||
+4
-4
@@ -5,16 +5,16 @@ authors:
|
|||||||
- willthames (https://github.com/willthames)
|
- willthames (https://github.com/willthames)
|
||||||
- Akasurde (https://github.com/akasurde)
|
- Akasurde (https://github.com/akasurde)
|
||||||
dependencies:
|
dependencies:
|
||||||
kubernetes.core: '>=2.0.0,<2.1.0'
|
kubernetes.core: '>=2.1.0,<2.3.0'
|
||||||
description: OKD Collection for Ansible.
|
description: OKD Collection for Ansible.
|
||||||
documentation: ''
|
documentation: ''
|
||||||
homepage: ''
|
homepage: ''
|
||||||
issues: https://github.com/ansible-collections/community.okd/issues
|
issues: https://github.com/openshift/community.okd/issues
|
||||||
license_file: LICENSE
|
license_file: LICENSE
|
||||||
name: okd
|
name: okd
|
||||||
namespace: community
|
namespace: community
|
||||||
readme: README.md
|
readme: README.md
|
||||||
repository: https://github.com/ansible-collections/community.okd
|
repository: https://github.com/openshift/community.okd
|
||||||
tags:
|
tags:
|
||||||
- kubernetes
|
- kubernetes
|
||||||
- k8s
|
- k8s
|
||||||
@@ -24,4 +24,4 @@ tags:
|
|||||||
- okd
|
- okd
|
||||||
- cluster
|
- cluster
|
||||||
# Also needs to be updated in the Makefile
|
# Also needs to be updated in the Makefile
|
||||||
version: 2.0.0
|
version: 2.1.0
|
||||||
|
|||||||
@@ -51,7 +51,7 @@
|
|||||||
url: 'http://{{ route.result.spec.host }}'
|
url: 'http://{{ route.result.spec.host }}'
|
||||||
return_content: yes
|
return_content: yes
|
||||||
until: result is successful
|
until: result is successful
|
||||||
retries: 10
|
retries: 20
|
||||||
register: result
|
register: result
|
||||||
|
|
||||||
- name: Assert the page content is as expected
|
- name: Assert the page content is as expected
|
||||||
@@ -87,6 +87,8 @@
|
|||||||
uri:
|
uri:
|
||||||
url: 'http://{{ route.result.spec.host }}'
|
url: 'http://{{ route.result.spec.host }}'
|
||||||
return_content: yes
|
return_content: yes
|
||||||
|
until: result is successful
|
||||||
|
retries: 20
|
||||||
register: result
|
register: result
|
||||||
|
|
||||||
- name: Assert the page content is as expected
|
- name: Assert the page content is as expected
|
||||||
@@ -118,7 +120,7 @@
|
|||||||
url: 'http://{{ route.result.spec.host }}'
|
url: 'http://{{ route.result.spec.host }}'
|
||||||
return_content: yes
|
return_content: yes
|
||||||
until: result is successful
|
until: result is successful
|
||||||
retries: 10
|
retries: 20
|
||||||
register: result
|
register: result
|
||||||
|
|
||||||
- name: Assert the page content is as expected
|
- name: Assert the page content is as expected
|
||||||
@@ -178,7 +180,7 @@
|
|||||||
validate_certs: no
|
validate_certs: no
|
||||||
return_content: yes
|
return_content: yes
|
||||||
until: result is successful
|
until: result is successful
|
||||||
retries: 10
|
retries: 20
|
||||||
register: result
|
register: result
|
||||||
|
|
||||||
- name: Assert the page content is as expected
|
- name: Assert the page content is as expected
|
||||||
@@ -206,7 +208,7 @@
|
|||||||
validate_certs: no
|
validate_certs: no
|
||||||
return_content: yes
|
return_content: yes
|
||||||
until: result is successful
|
until: result is successful
|
||||||
retries: 10
|
retries: 20
|
||||||
register: result
|
register: result
|
||||||
|
|
||||||
- name: Assert the page content is as expected
|
- name: Assert the page content is as expected
|
||||||
@@ -221,7 +223,7 @@
|
|||||||
url: 'http://{{ route.result.spec.host }}'
|
url: 'http://{{ route.result.spec.host }}'
|
||||||
status_code: 503
|
status_code: 503
|
||||||
until: result is successful
|
until: result is successful
|
||||||
retries: 10
|
retries: 20
|
||||||
register: result
|
register: result
|
||||||
|
|
||||||
- debug: var=result
|
- debug: var=result
|
||||||
@@ -238,3 +240,36 @@
|
|||||||
namespace: default
|
namespace: default
|
||||||
state: absent
|
state: absent
|
||||||
wait: yes
|
wait: yes
|
||||||
|
|
||||||
|
# Route with labels and annotations
|
||||||
|
- name: Create route with labels and annotations
|
||||||
|
community.okd.openshift_route:
|
||||||
|
service: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
name: route-label-annotation
|
||||||
|
labels:
|
||||||
|
ansible: test
|
||||||
|
annotations:
|
||||||
|
haproxy.router.openshift.io/balance: roundrobin
|
||||||
|
|
||||||
|
- name: Get route information
|
||||||
|
kubernetes.core.k8s_info:
|
||||||
|
api_version: route.openshift.io/v1
|
||||||
|
kind: Route
|
||||||
|
name: route-label-annotation
|
||||||
|
namespace: default
|
||||||
|
register: route
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- route.resources[0].metadata.annotations is defined
|
||||||
|
- '"haproxy.router.openshift.io/balance" in route.resources[0].metadata.annotations'
|
||||||
|
- route.resources[0].metadata.labels is defined
|
||||||
|
- '"ansible" in route.resources[0].metadata.labels'
|
||||||
|
|
||||||
|
- name: Delete route
|
||||||
|
community.okd.openshift_route:
|
||||||
|
name: route-label-annotation
|
||||||
|
namespace: default
|
||||||
|
state: absent
|
||||||
|
wait: yes
|
||||||
|
|||||||
@@ -0,0 +1,186 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
import re
|
||||||
|
import operator
|
||||||
|
from functools import reduce
|
||||||
|
import traceback
|
||||||
|
from ansible_collections.kubernetes.core.plugins.module_utils.common import (
|
||||||
|
K8sAnsibleMixin,
|
||||||
|
get_api_client,
|
||||||
|
)
|
||||||
|
from ansible.module_utils._text import to_native
|
||||||
|
|
||||||
|
|
||||||
|
try:
|
||||||
|
from kubernetes.dynamic.exceptions import DynamicApiError, NotFoundError, ForbiddenError
|
||||||
|
HAS_KUBERNETES_COLLECTION = True
|
||||||
|
except ImportError as e:
|
||||||
|
HAS_KUBERNETES_COLLECTION = False
|
||||||
|
k8s_collection_import_exception = e
|
||||||
|
K8S_COLLECTION_ERROR = traceback.format_exc()
|
||||||
|
|
||||||
|
|
||||||
|
TRIGGER_ANNOTATION = 'image.openshift.io/triggers'
|
||||||
|
TRIGGER_CONTAINER = re.compile(r"(?P<path>.*)\[((?P<index>[0-9]+)|\?\(@\.name==[\"'\\]*(?P<name>[a-z0-9]([-a-z0-9]*[a-z0-9])?))")
|
||||||
|
|
||||||
|
|
||||||
|
class OKDRawModule(K8sAnsibleMixin):
|
||||||
|
|
||||||
|
def __init__(self, module, k8s_kind=None, *args, **kwargs):
|
||||||
|
self.module = module
|
||||||
|
self.client = get_api_client(module=module)
|
||||||
|
self.check_mode = self.module.check_mode
|
||||||
|
self.params = self.module.params
|
||||||
|
self.fail_json = self.module.fail_json
|
||||||
|
self.fail = self.module.fail_json
|
||||||
|
self.exit_json = self.module.exit_json
|
||||||
|
|
||||||
|
super(OKDRawModule, self).__init__(module, *args, **kwargs)
|
||||||
|
|
||||||
|
self.warnings = []
|
||||||
|
|
||||||
|
self.kind = k8s_kind or self.params.get('kind')
|
||||||
|
self.api_version = self.params.get('api_version')
|
||||||
|
self.name = self.params.get('name')
|
||||||
|
self.namespace = self.params.get('namespace')
|
||||||
|
|
||||||
|
self.check_library_version()
|
||||||
|
self.set_resource_definitions(module)
|
||||||
|
|
||||||
|
def perform_action(self, resource, definition):
|
||||||
|
state = self.params.get('state', None)
|
||||||
|
name = definition['metadata'].get('name')
|
||||||
|
namespace = definition['metadata'].get('namespace')
|
||||||
|
|
||||||
|
if state != 'absent':
|
||||||
|
|
||||||
|
if resource.kind in ['Project', 'ProjectRequest']:
|
||||||
|
try:
|
||||||
|
resource.get(name, namespace)
|
||||||
|
except (NotFoundError, ForbiddenError):
|
||||||
|
return self.create_project_request(definition)
|
||||||
|
except DynamicApiError as exc:
|
||||||
|
self.fail_json(msg='Failed to retrieve requested object: {0}'.format(exc.body),
|
||||||
|
error=exc.status, status=exc.status, reason=exc.reason)
|
||||||
|
|
||||||
|
try:
|
||||||
|
existing = resource.get(name=name, namespace=namespace).to_dict()
|
||||||
|
except Exception:
|
||||||
|
existing = None
|
||||||
|
|
||||||
|
if existing:
|
||||||
|
if resource.kind == 'DeploymentConfig':
|
||||||
|
if definition.get('spec', {}).get('triggers'):
|
||||||
|
definition = self.resolve_imagestream_triggers(existing, definition)
|
||||||
|
elif existing['metadata'].get('annotations', {}).get(TRIGGER_ANNOTATION):
|
||||||
|
definition = self.resolve_imagestream_trigger_annotation(existing, definition)
|
||||||
|
|
||||||
|
return super(OKDRawModule, self).perform_action(resource, definition)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def get_index(desired, objects, keys):
|
||||||
|
""" Iterates over keys, returns the first object from objects where the value of the key
|
||||||
|
matches the value in desired
|
||||||
|
"""
|
||||||
|
# pylint: disable=use-a-generator
|
||||||
|
# Use a generator instead 'all(desired.get(key, True) == item.get(key, False) for key in keys)'
|
||||||
|
for i, item in enumerate(objects):
|
||||||
|
if item and all([desired.get(key, True) == item.get(key, False) for key in keys]):
|
||||||
|
return i
|
||||||
|
|
||||||
|
def resolve_imagestream_trigger_annotation(self, existing, definition):
|
||||||
|
import yaml
|
||||||
|
|
||||||
|
def get_from_fields(d, fields):
|
||||||
|
try:
|
||||||
|
return reduce(operator.getitem, fields, d)
|
||||||
|
except Exception:
|
||||||
|
return None
|
||||||
|
|
||||||
|
def set_from_fields(d, fields, value):
|
||||||
|
get_from_fields(d, fields[:-1])[fields[-1]] = value
|
||||||
|
|
||||||
|
if TRIGGER_ANNOTATION in definition['metadata'].get('annotations', {}).keys():
|
||||||
|
triggers = yaml.safe_load(definition['metadata']['annotations'][TRIGGER_ANNOTATION] or '[]')
|
||||||
|
else:
|
||||||
|
triggers = yaml.safe_load(existing['metadata'].get('annotations', '{}').get(TRIGGER_ANNOTATION, '[]'))
|
||||||
|
|
||||||
|
if not isinstance(triggers, list):
|
||||||
|
return definition
|
||||||
|
|
||||||
|
for trigger in triggers:
|
||||||
|
if trigger.get('fieldPath'):
|
||||||
|
parsed = self.parse_trigger_fieldpath(trigger['fieldPath'])
|
||||||
|
path = parsed.get('path', '').split('.')
|
||||||
|
if path:
|
||||||
|
existing_containers = get_from_fields(existing, path)
|
||||||
|
new_containers = get_from_fields(definition, path)
|
||||||
|
if parsed.get('name'):
|
||||||
|
existing_index = self.get_index({'name': parsed['name']}, existing_containers, ['name'])
|
||||||
|
new_index = self.get_index({'name': parsed['name']}, new_containers, ['name'])
|
||||||
|
elif parsed.get('index') is not None:
|
||||||
|
existing_index = new_index = int(parsed['index'])
|
||||||
|
else:
|
||||||
|
existing_index = new_index = None
|
||||||
|
if existing_index is not None and new_index is not None:
|
||||||
|
if existing_index < len(existing_containers) and new_index < len(new_containers):
|
||||||
|
set_from_fields(definition, path + [new_index, 'image'], get_from_fields(existing, path + [existing_index, 'image']))
|
||||||
|
return definition
|
||||||
|
|
||||||
|
def resolve_imagestream_triggers(self, existing, definition):
|
||||||
|
|
||||||
|
existing_triggers = existing.get('spec', {}).get('triggers')
|
||||||
|
new_triggers = definition['spec']['triggers']
|
||||||
|
existing_containers = existing.get('spec', {}).get('template', {}).get('spec', {}).get('containers', [])
|
||||||
|
new_containers = definition.get('spec', {}).get('template', {}).get('spec', {}).get('containers', [])
|
||||||
|
for i, trigger in enumerate(new_triggers):
|
||||||
|
if trigger.get('type') == 'ImageChange' and trigger.get('imageChangeParams'):
|
||||||
|
names = trigger['imageChangeParams'].get('containerNames', [])
|
||||||
|
for name in names:
|
||||||
|
old_container_index = self.get_index({'name': name}, existing_containers, ['name'])
|
||||||
|
new_container_index = self.get_index({'name': name}, new_containers, ['name'])
|
||||||
|
if old_container_index is not None and new_container_index is not None:
|
||||||
|
image = existing['spec']['template']['spec']['containers'][old_container_index]['image']
|
||||||
|
definition['spec']['template']['spec']['containers'][new_container_index]['image'] = image
|
||||||
|
|
||||||
|
existing_index = self.get_index(trigger['imageChangeParams'],
|
||||||
|
[x.get('imageChangeParams') for x in existing_triggers],
|
||||||
|
['containerNames'])
|
||||||
|
if existing_index is not None:
|
||||||
|
existing_image = existing_triggers[existing_index].get('imageChangeParams', {}).get('lastTriggeredImage')
|
||||||
|
if existing_image:
|
||||||
|
definition['spec']['triggers'][i]['imageChangeParams']['lastTriggeredImage'] = existing_image
|
||||||
|
existing_from = existing_triggers[existing_index].get('imageChangeParams', {}).get('from', {})
|
||||||
|
new_from = trigger['imageChangeParams'].get('from', {})
|
||||||
|
existing_namespace = existing_from.get('namespace')
|
||||||
|
existing_name = existing_from.get('name', False)
|
||||||
|
new_name = new_from.get('name', True)
|
||||||
|
add_namespace = existing_namespace and 'namespace' not in new_from.keys() and existing_name == new_name
|
||||||
|
if add_namespace:
|
||||||
|
definition['spec']['triggers'][i]['imageChangeParams']['from']['namespace'] = existing_from['namespace']
|
||||||
|
|
||||||
|
return definition
|
||||||
|
|
||||||
|
def parse_trigger_fieldpath(self, expression):
|
||||||
|
parsed = TRIGGER_CONTAINER.search(expression).groupdict()
|
||||||
|
if parsed.get('index'):
|
||||||
|
parsed['index'] = int(parsed['index'])
|
||||||
|
return parsed
|
||||||
|
|
||||||
|
def create_project_request(self, definition):
|
||||||
|
definition['kind'] = 'ProjectRequest'
|
||||||
|
result = {'changed': False, 'result': {}}
|
||||||
|
resource = self.find_resource('ProjectRequest', definition['apiVersion'], fail=True)
|
||||||
|
if not self.check_mode:
|
||||||
|
try:
|
||||||
|
k8s_obj = resource.create(definition)
|
||||||
|
result['result'] = k8s_obj.to_dict()
|
||||||
|
except DynamicApiError as exc:
|
||||||
|
self.fail_json(msg="Failed to create object: {0}".format(exc.body),
|
||||||
|
error=exc.status, status=exc.status, reason=exc.reason)
|
||||||
|
result['changed'] = True
|
||||||
|
result['method'] = 'create'
|
||||||
|
return result
|
||||||
@@ -0,0 +1,199 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
import os
|
||||||
|
import traceback
|
||||||
|
|
||||||
|
from ansible_collections.kubernetes.core.plugins.module_utils.common import (
|
||||||
|
K8sAnsibleMixin,
|
||||||
|
get_api_client,
|
||||||
|
)
|
||||||
|
from ansible.module_utils._text import to_native
|
||||||
|
|
||||||
|
|
||||||
|
try:
|
||||||
|
from kubernetes.dynamic.exceptions import DynamicApiError, NotFoundError
|
||||||
|
HAS_KUBERNETES_COLLECTION = True
|
||||||
|
except ImportError as e:
|
||||||
|
HAS_KUBERNETES_COLLECTION = False
|
||||||
|
k8s_collection_import_exception = e
|
||||||
|
K8S_COLLECTION_ERROR = traceback.format_exc()
|
||||||
|
|
||||||
|
try:
|
||||||
|
from kubernetes.dynamic.exceptions import DynamicApiError, NotFoundError
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class OpenShiftProcess(K8sAnsibleMixin):
|
||||||
|
def __init__(self, module):
|
||||||
|
self.module = module
|
||||||
|
self.fail_json = self.module.fail_json
|
||||||
|
self.exit_json = self.module.exit_json
|
||||||
|
|
||||||
|
if not HAS_KUBERNETES_COLLECTION:
|
||||||
|
self.module.fail_json(
|
||||||
|
msg="The kubernetes.core collection must be installed",
|
||||||
|
exception=K8S_COLLECTION_ERROR,
|
||||||
|
error=to_native(k8s_collection_import_exception),
|
||||||
|
)
|
||||||
|
|
||||||
|
super(OpenShiftProcess, self).__init__(self.module)
|
||||||
|
|
||||||
|
self.params = self.module.params
|
||||||
|
self.check_mode = self.module.check_mode
|
||||||
|
self.client = get_api_client(self.module)
|
||||||
|
|
||||||
|
def execute_module(self):
|
||||||
|
v1_templates = self.find_resource(
|
||||||
|
"templates", "template.openshift.io/v1", fail=True
|
||||||
|
)
|
||||||
|
v1_processed_templates = self.find_resource(
|
||||||
|
"processedtemplates", "template.openshift.io/v1", fail=True
|
||||||
|
)
|
||||||
|
|
||||||
|
name = self.params.get("name")
|
||||||
|
namespace = self.params.get("namespace")
|
||||||
|
namespace_target = self.params.get("namespace_target")
|
||||||
|
definition = self.params.get("resource_definition")
|
||||||
|
src = self.params.get("src")
|
||||||
|
|
||||||
|
state = self.params.get("state")
|
||||||
|
|
||||||
|
parameters = self.params.get("parameters") or {}
|
||||||
|
parameter_file = self.params.get("parameter_file")
|
||||||
|
|
||||||
|
if (name and definition) or (name and src) or (src and definition):
|
||||||
|
self.fail_json("Only one of src, name, or definition may be provided")
|
||||||
|
|
||||||
|
if name and not namespace:
|
||||||
|
self.fail_json("namespace is required when name is set")
|
||||||
|
|
||||||
|
template = None
|
||||||
|
|
||||||
|
if src or definition:
|
||||||
|
self.set_resource_definitions(self.module)
|
||||||
|
if len(self.resource_definitions) < 1:
|
||||||
|
self.fail_json(
|
||||||
|
"Unable to load a Template resource from src or resource_definition"
|
||||||
|
)
|
||||||
|
elif len(self.resource_definitions) > 1:
|
||||||
|
self.fail_json(
|
||||||
|
"Multiple Template resources found in src or resource_definition, only one Template may be processed at a time"
|
||||||
|
)
|
||||||
|
template = self.resource_definitions[0]
|
||||||
|
template_namespace = template.get("metadata", {}).get("namespace")
|
||||||
|
namespace = template_namespace or namespace or namespace_target or "default"
|
||||||
|
elif name and namespace:
|
||||||
|
try:
|
||||||
|
template = v1_templates.get(name=name, namespace=namespace).to_dict()
|
||||||
|
except DynamicApiError as exc:
|
||||||
|
self.fail_json(
|
||||||
|
msg="Failed to retrieve Template with name '{0}' in namespace '{1}': {2}".format(
|
||||||
|
name, namespace, exc.body
|
||||||
|
),
|
||||||
|
error=exc.status,
|
||||||
|
status=exc.status,
|
||||||
|
reason=exc.reason,
|
||||||
|
)
|
||||||
|
except Exception as exc:
|
||||||
|
self.module.fail_json(
|
||||||
|
msg="Failed to retrieve Template with name '{0}' in namespace '{1}': {2}".format(
|
||||||
|
name, namespace, to_native(exc)
|
||||||
|
),
|
||||||
|
error="",
|
||||||
|
status="",
|
||||||
|
reason="",
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
self.fail_json(
|
||||||
|
"One of resource_definition, src, or name and namespace must be provided"
|
||||||
|
)
|
||||||
|
|
||||||
|
if parameter_file:
|
||||||
|
parameters = self.parse_dotenv_and_merge(parameters, parameter_file)
|
||||||
|
|
||||||
|
for k, v in parameters.items():
|
||||||
|
template = self.update_template_param(template, k, v)
|
||||||
|
|
||||||
|
result = {"changed": False}
|
||||||
|
|
||||||
|
try:
|
||||||
|
response = v1_processed_templates.create(
|
||||||
|
body=template, namespace=namespace
|
||||||
|
).to_dict()
|
||||||
|
except DynamicApiError as exc:
|
||||||
|
self.fail_json(
|
||||||
|
msg="Server failed to render the Template: {0}".format(exc.body),
|
||||||
|
error=exc.status,
|
||||||
|
status=exc.status,
|
||||||
|
reason=exc.reason,
|
||||||
|
)
|
||||||
|
except Exception as exc:
|
||||||
|
self.module.fail_json(
|
||||||
|
msg="Server failed to render the Template: {0}".format(to_native(exc)),
|
||||||
|
error="",
|
||||||
|
status="",
|
||||||
|
reason="",
|
||||||
|
)
|
||||||
|
result["message"] = ""
|
||||||
|
if "message" in response:
|
||||||
|
result["message"] = response["message"]
|
||||||
|
result["resources"] = response["objects"]
|
||||||
|
|
||||||
|
if state != "rendered":
|
||||||
|
self.resource_definitions = response["objects"]
|
||||||
|
self.kind = self.api_version = self.name = None
|
||||||
|
self.namespace = self.params.get("namespace_target")
|
||||||
|
self.append_hash = False
|
||||||
|
self.apply = False
|
||||||
|
self.params["validate"] = None
|
||||||
|
self.params["merge_type"] = None
|
||||||
|
super(OpenShiftProcess, self).execute_module()
|
||||||
|
|
||||||
|
self.module.exit_json(**result)
|
||||||
|
|
||||||
|
def update_template_param(self, template, k, v):
|
||||||
|
for i, param in enumerate(template["parameters"]):
|
||||||
|
if param["name"] == k:
|
||||||
|
template["parameters"][i]["value"] = v
|
||||||
|
return template
|
||||||
|
return template
|
||||||
|
|
||||||
|
def parse_dotenv_and_merge(self, parameters, parameter_file):
|
||||||
|
import re
|
||||||
|
|
||||||
|
DOTENV_PARSER = re.compile(
|
||||||
|
r"(?x)^(\s*(\#.*|\s*|(export\s+)?(?P<key>[A-z_][A-z0-9_.]*)=(?P<value>.+?)?)\s*)[\r\n]*$"
|
||||||
|
)
|
||||||
|
path = os.path.normpath(parameter_file)
|
||||||
|
if not os.path.exists(path):
|
||||||
|
self.fail(msg="Error accessing {0}. Does the file exist?".format(path))
|
||||||
|
try:
|
||||||
|
with open(path, "r") as f:
|
||||||
|
multiline = ""
|
||||||
|
for line in f.readlines():
|
||||||
|
line = line.strip()
|
||||||
|
if line.endswith("\\"):
|
||||||
|
multiline += " ".join(line.rsplit("\\", 1))
|
||||||
|
continue
|
||||||
|
if multiline:
|
||||||
|
line = multiline + line
|
||||||
|
multiline = ""
|
||||||
|
match = DOTENV_PARSER.search(line)
|
||||||
|
if not match:
|
||||||
|
continue
|
||||||
|
match = match.groupdict()
|
||||||
|
if match.get("key"):
|
||||||
|
if match["key"] in parameters:
|
||||||
|
self.fail_json(
|
||||||
|
msg="Duplicate value for '{0}' detected in parameter file".format(
|
||||||
|
match["key"]
|
||||||
|
)
|
||||||
|
)
|
||||||
|
parameters[match["key"]] = match["value"]
|
||||||
|
except IOError as exc:
|
||||||
|
self.fail(msg="Error loading parameter file: {0}".format(exc))
|
||||||
|
return parameters
|
||||||
+42
-223
@@ -260,239 +260,58 @@ result:
|
|||||||
'''
|
'''
|
||||||
# ENDREMOVE (downstream)
|
# ENDREMOVE (downstream)
|
||||||
|
|
||||||
import copy
|
|
||||||
import re
|
|
||||||
import operator
|
|
||||||
import traceback
|
|
||||||
from functools import reduce
|
|
||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
|
||||||
from ansible.module_utils._text import to_native
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.common import get_api_client, K8sAnsibleMixin
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import AnsibleModule
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
|
||||||
NAME_ARG_SPEC, RESOURCE_ARG_SPEC, AUTH_ARG_SPEC, WAIT_ARG_SPEC, DELETE_OPTS_ARG_SPEC)
|
|
||||||
HAS_KUBERNETES_COLLECTION = True
|
|
||||||
except ImportError as e:
|
|
||||||
HAS_KUBERNETES_COLLECTION = False
|
|
||||||
k8s_collection_import_exception = e
|
|
||||||
K8S_COLLECTION_ERROR = traceback.format_exc()
|
|
||||||
|
|
||||||
try:
|
|
||||||
import yaml
|
|
||||||
from kubernetes.dynamic.exceptions import DynamicApiError, NotFoundError, ForbiddenError
|
|
||||||
except ImportError:
|
except ImportError:
|
||||||
# Exceptions handled in common
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
pass
|
|
||||||
|
|
||||||
TRIGGER_ANNOTATION = 'image.openshift.io/triggers'
|
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||||
TRIGGER_CONTAINER = re.compile(r"(?P<path>.*)\[((?P<index>[0-9]+)|\?\(@\.name==[\"'\\]*(?P<name>[a-z0-9]([-a-z0-9]*[a-z0-9])?))")
|
NAME_ARG_SPEC, RESOURCE_ARG_SPEC, AUTH_ARG_SPEC, WAIT_ARG_SPEC, DELETE_OPTS_ARG_SPEC)
|
||||||
|
|
||||||
|
|
||||||
class OKDRawModule(K8sAnsibleMixin):
|
def validate_spec():
|
||||||
|
return dict(
|
||||||
|
fail_on_error=dict(type='bool'),
|
||||||
|
version=dict(),
|
||||||
|
strict=dict(type='bool', default=True)
|
||||||
|
)
|
||||||
|
|
||||||
def __init__(self, k8s_kind=None, *args, **kwargs):
|
|
||||||
mutually_exclusive = [
|
|
||||||
('resource_definition', 'src'),
|
|
||||||
('merge_type', 'apply'),
|
|
||||||
('template', 'resource_definition'),
|
|
||||||
('template', 'src'),
|
|
||||||
]
|
|
||||||
|
|
||||||
module = AnsibleModule(
|
def argspec():
|
||||||
argument_spec=self.argspec,
|
argument_spec = {}
|
||||||
mutually_exclusive=mutually_exclusive,
|
argument_spec.update(NAME_ARG_SPEC)
|
||||||
supports_check_mode=True,
|
argument_spec.update(RESOURCE_ARG_SPEC)
|
||||||
)
|
argument_spec.update(AUTH_ARG_SPEC)
|
||||||
|
argument_spec.update(WAIT_ARG_SPEC)
|
||||||
self.module = module
|
argument_spec['merge_type'] = dict(type='list', elements='str', choices=['json', 'merge', 'strategic-merge'])
|
||||||
self.check_mode = self.module.check_mode
|
argument_spec['validate'] = dict(type='dict', default=None, options=validate_spec())
|
||||||
self.params = self.module.params
|
argument_spec['append_hash'] = dict(type='bool', default=False)
|
||||||
self.fail_json = self.module.fail_json
|
argument_spec['apply'] = dict(type='bool', default=False)
|
||||||
self.fail = self.module.fail_json
|
argument_spec['template'] = dict(type='raw', default=None)
|
||||||
self.exit_json = self.module.exit_json
|
argument_spec['delete_options'] = dict(type='dict', default=None, options=DELETE_OPTS_ARG_SPEC)
|
||||||
|
argument_spec['continue_on_error'] = dict(type='bool', default=False)
|
||||||
if not HAS_KUBERNETES_COLLECTION:
|
argument_spec['state'] = dict(default='present', choices=['present', 'absent', 'patched'])
|
||||||
self.fail_json(
|
argument_spec['force'] = dict(type='bool', default=False)
|
||||||
msg="The kubernetes.core collection must be installed",
|
return argument_spec
|
||||||
exception=K8S_COLLECTION_ERROR,
|
|
||||||
error=to_native(k8s_collection_import_exception)
|
|
||||||
)
|
|
||||||
|
|
||||||
super(OKDRawModule, self).__init__(module, *args, **kwargs)
|
|
||||||
|
|
||||||
self.client = get_api_client(module)
|
|
||||||
self.warnings = []
|
|
||||||
|
|
||||||
self.kind = k8s_kind or self.params.get('kind')
|
|
||||||
self.api_version = self.params.get('api_version')
|
|
||||||
self.name = self.params.get('name')
|
|
||||||
self.namespace = self.params.get('namespace')
|
|
||||||
|
|
||||||
self.check_library_version()
|
|
||||||
self.set_resource_definitions(module)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def validate_spec(self):
|
|
||||||
return dict(
|
|
||||||
fail_on_error=dict(type='bool'),
|
|
||||||
version=dict(),
|
|
||||||
strict=dict(type='bool', default=True)
|
|
||||||
)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def argspec(self):
|
|
||||||
argument_spec = copy.deepcopy(NAME_ARG_SPEC)
|
|
||||||
argument_spec.update(copy.deepcopy(RESOURCE_ARG_SPEC))
|
|
||||||
argument_spec.update(copy.deepcopy(AUTH_ARG_SPEC))
|
|
||||||
argument_spec.update(copy.deepcopy(WAIT_ARG_SPEC))
|
|
||||||
argument_spec['merge_type'] = dict(type='list', elements='str', choices=['json', 'merge', 'strategic-merge'])
|
|
||||||
argument_spec['validate'] = dict(type='dict', default=None, options=self.validate_spec)
|
|
||||||
argument_spec['append_hash'] = dict(type='bool', default=False)
|
|
||||||
argument_spec['apply'] = dict(type='bool', default=False)
|
|
||||||
argument_spec['template'] = dict(type='raw', default=None)
|
|
||||||
argument_spec['delete_options'] = dict(type='dict', default=None, options=copy.deepcopy(DELETE_OPTS_ARG_SPEC))
|
|
||||||
argument_spec['continue_on_error'] = dict(type='bool', default=False)
|
|
||||||
argument_spec['state'] = dict(default='present', choices=['present', 'absent', 'patched'])
|
|
||||||
argument_spec['force'] = dict(type='bool', default=False)
|
|
||||||
return argument_spec
|
|
||||||
|
|
||||||
def perform_action(self, resource, definition):
|
|
||||||
state = self.params.get('state', None)
|
|
||||||
name = definition['metadata'].get('name')
|
|
||||||
namespace = definition['metadata'].get('namespace')
|
|
||||||
|
|
||||||
if state != 'absent':
|
|
||||||
|
|
||||||
if resource.kind in ['Project', 'ProjectRequest']:
|
|
||||||
try:
|
|
||||||
resource.get(name, namespace)
|
|
||||||
except (NotFoundError, ForbiddenError):
|
|
||||||
return self.create_project_request(definition)
|
|
||||||
except DynamicApiError as exc:
|
|
||||||
self.fail_json(msg='Failed to retrieve requested object: {0}'.format(exc.body),
|
|
||||||
error=exc.status, status=exc.status, reason=exc.reason)
|
|
||||||
|
|
||||||
try:
|
|
||||||
existing = resource.get(name=name, namespace=namespace).to_dict()
|
|
||||||
except Exception:
|
|
||||||
existing = None
|
|
||||||
|
|
||||||
if existing:
|
|
||||||
if resource.kind == 'DeploymentConfig':
|
|
||||||
if definition.get('spec', {}).get('triggers'):
|
|
||||||
definition = self.resolve_imagestream_triggers(existing, definition)
|
|
||||||
elif existing['metadata'].get('annotations', {}).get(TRIGGER_ANNOTATION):
|
|
||||||
definition = self.resolve_imagestream_trigger_annotation(existing, definition)
|
|
||||||
|
|
||||||
return super(OKDRawModule, self).perform_action(resource, definition)
|
|
||||||
|
|
||||||
@staticmethod
|
|
||||||
def get_index(desired, objects, keys):
|
|
||||||
""" Iterates over keys, returns the first object from objects where the value of the key
|
|
||||||
matches the value in desired
|
|
||||||
"""
|
|
||||||
for i, item in enumerate(objects):
|
|
||||||
if item and all([desired.get(key, True) == item.get(key, False) for key in keys]):
|
|
||||||
return i
|
|
||||||
|
|
||||||
def resolve_imagestream_trigger_annotation(self, existing, definition):
|
|
||||||
|
|
||||||
def get_from_fields(d, fields):
|
|
||||||
try:
|
|
||||||
return reduce(operator.getitem, fields, d)
|
|
||||||
except Exception:
|
|
||||||
return None
|
|
||||||
|
|
||||||
def set_from_fields(d, fields, value):
|
|
||||||
get_from_fields(d, fields[:-1])[fields[-1]] = value
|
|
||||||
|
|
||||||
if TRIGGER_ANNOTATION in definition['metadata'].get('annotations', {}).keys():
|
|
||||||
triggers = yaml.safe_load(definition['metadata']['annotations'][TRIGGER_ANNOTATION] or '[]')
|
|
||||||
else:
|
|
||||||
triggers = yaml.safe_load(existing['metadata'].get('annotations', '{}').get(TRIGGER_ANNOTATION, '[]'))
|
|
||||||
|
|
||||||
if not isinstance(triggers, list):
|
|
||||||
return definition
|
|
||||||
|
|
||||||
for trigger in triggers:
|
|
||||||
if trigger.get('fieldPath'):
|
|
||||||
parsed = self.parse_trigger_fieldpath(trigger['fieldPath'])
|
|
||||||
path = parsed.get('path', '').split('.')
|
|
||||||
if path:
|
|
||||||
existing_containers = get_from_fields(existing, path)
|
|
||||||
new_containers = get_from_fields(definition, path)
|
|
||||||
if parsed.get('name'):
|
|
||||||
existing_index = self.get_index({'name': parsed['name']}, existing_containers, ['name'])
|
|
||||||
new_index = self.get_index({'name': parsed['name']}, new_containers, ['name'])
|
|
||||||
elif parsed.get('index') is not None:
|
|
||||||
existing_index = new_index = int(parsed['index'])
|
|
||||||
else:
|
|
||||||
existing_index = new_index = None
|
|
||||||
if existing_index is not None and new_index is not None:
|
|
||||||
if existing_index < len(existing_containers) and new_index < len(new_containers):
|
|
||||||
set_from_fields(definition, path + [new_index, 'image'], get_from_fields(existing, path + [existing_index, 'image']))
|
|
||||||
return definition
|
|
||||||
|
|
||||||
def resolve_imagestream_triggers(self, existing, definition):
|
|
||||||
|
|
||||||
existing_triggers = existing.get('spec', {}).get('triggers')
|
|
||||||
new_triggers = definition['spec']['triggers']
|
|
||||||
existing_containers = existing.get('spec', {}).get('template', {}).get('spec', {}).get('containers', [])
|
|
||||||
new_containers = definition.get('spec', {}).get('template', {}).get('spec', {}).get('containers', [])
|
|
||||||
for i, trigger in enumerate(new_triggers):
|
|
||||||
if trigger.get('type') == 'ImageChange' and trigger.get('imageChangeParams'):
|
|
||||||
names = trigger['imageChangeParams'].get('containerNames', [])
|
|
||||||
for name in names:
|
|
||||||
old_container_index = self.get_index({'name': name}, existing_containers, ['name'])
|
|
||||||
new_container_index = self.get_index({'name': name}, new_containers, ['name'])
|
|
||||||
if old_container_index is not None and new_container_index is not None:
|
|
||||||
image = existing['spec']['template']['spec']['containers'][old_container_index]['image']
|
|
||||||
definition['spec']['template']['spec']['containers'][new_container_index]['image'] = image
|
|
||||||
|
|
||||||
existing_index = self.get_index(trigger['imageChangeParams'],
|
|
||||||
[x.get('imageChangeParams') for x in existing_triggers],
|
|
||||||
['containerNames'])
|
|
||||||
if existing_index is not None:
|
|
||||||
existing_image = existing_triggers[existing_index].get('imageChangeParams', {}).get('lastTriggeredImage')
|
|
||||||
if existing_image:
|
|
||||||
definition['spec']['triggers'][i]['imageChangeParams']['lastTriggeredImage'] = existing_image
|
|
||||||
existing_from = existing_triggers[existing_index].get('imageChangeParams', {}).get('from', {})
|
|
||||||
new_from = trigger['imageChangeParams'].get('from', {})
|
|
||||||
existing_namespace = existing_from.get('namespace')
|
|
||||||
existing_name = existing_from.get('name', False)
|
|
||||||
new_name = new_from.get('name', True)
|
|
||||||
add_namespace = existing_namespace and 'namespace' not in new_from.keys() and existing_name == new_name
|
|
||||||
if add_namespace:
|
|
||||||
definition['spec']['triggers'][i]['imageChangeParams']['from']['namespace'] = existing_from['namespace']
|
|
||||||
|
|
||||||
return definition
|
|
||||||
|
|
||||||
def parse_trigger_fieldpath(self, expression):
|
|
||||||
parsed = TRIGGER_CONTAINER.search(expression).groupdict()
|
|
||||||
if parsed.get('index'):
|
|
||||||
parsed['index'] = int(parsed['index'])
|
|
||||||
return parsed
|
|
||||||
|
|
||||||
def create_project_request(self, definition):
|
|
||||||
definition['kind'] = 'ProjectRequest'
|
|
||||||
result = {'changed': False, 'result': {}}
|
|
||||||
resource = self.find_resource('ProjectRequest', definition['apiVersion'], fail=True)
|
|
||||||
if not self.check_mode:
|
|
||||||
try:
|
|
||||||
k8s_obj = resource.create(definition)
|
|
||||||
result['result'] = k8s_obj.to_dict()
|
|
||||||
except DynamicApiError as exc:
|
|
||||||
self.fail_json(msg="Failed to create object: {0}".format(exc.body),
|
|
||||||
error=exc.status, status=exc.status, reason=exc.reason)
|
|
||||||
result['changed'] = True
|
|
||||||
result['method'] = 'create'
|
|
||||||
return result
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
OKDRawModule().execute_module()
|
mutually_exclusive = [
|
||||||
|
('resource_definition', 'src'),
|
||||||
|
('merge_type', 'apply'),
|
||||||
|
('template', 'resource_definition'),
|
||||||
|
('template', 'src'),
|
||||||
|
]
|
||||||
|
|
||||||
|
module = AnsibleModule(argument_spec=argspec(), supports_check_mode=True, mutually_exclusive=mutually_exclusive)
|
||||||
|
|
||||||
|
from ansible_collections.community.okd.plugins.module_utils.k8s import OKDRawModule
|
||||||
|
okdraw_module = OKDRawModule(module)
|
||||||
|
|
||||||
|
# remove_aliases from kubernetes.core's common requires the argspec attribute. Ideally, it should
|
||||||
|
# read that throught the module class, but we cannot change that.
|
||||||
|
okdraw_module.argspec = argspec()
|
||||||
|
okdraw_module.execute_module()
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
#!/usr/bin/python
|
#!/usr/bin/python
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
# Copyright (c) 2020, Red Hat
|
|
||||||
# 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
|
from __future__ import absolute_import, division, print_function
|
||||||
__metaclass__ = type
|
__metaclass__ = type
|
||||||
|
|
||||||
|
# Copyright (c) 2020-2021, Red Hat
|
||||||
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
# STARTREMOVE (downstream)
|
# STARTREMOVE (downstream)
|
||||||
DOCUMENTATION = r'''
|
DOCUMENTATION = r'''
|
||||||
module: openshift_process
|
module: openshift_process
|
||||||
@@ -203,188 +203,43 @@ resources:
|
|||||||
'''
|
'''
|
||||||
# ENDREMOVE (downstream)
|
# ENDREMOVE (downstream)
|
||||||
|
|
||||||
import re
|
|
||||||
import os
|
|
||||||
import copy
|
|
||||||
import traceback
|
|
||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
|
||||||
from ansible.module_utils._text import to_native
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.common import K8sAnsibleMixin, get_api_client
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import AnsibleModule
|
||||||
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
|
||||||
AUTH_ARG_SPEC, RESOURCE_ARG_SPEC, WAIT_ARG_SPEC
|
|
||||||
)
|
|
||||||
HAS_KUBERNETES_COLLECTION = True
|
|
||||||
except ImportError as e:
|
|
||||||
HAS_KUBERNETES_COLLECTION = False
|
|
||||||
k8s_collection_import_exception = e
|
|
||||||
K8S_COLLECTION_ERROR = traceback.format_exc()
|
|
||||||
K8sAnsibleMixin = object
|
|
||||||
AUTH_ARG_SPEC = RESOURCE_ARG_SPEC = WAIT_ARG_SPEC = {}
|
|
||||||
|
|
||||||
try:
|
|
||||||
from kubernetes.dynamic.exceptions import DynamicApiError, NotFoundError
|
|
||||||
except ImportError:
|
except ImportError:
|
||||||
pass
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
||||||
DOTENV_PARSER = re.compile(r"(?x)^(\s*(\#.*|\s*|(export\s+)?(?P<key>[A-z_][A-z0-9_.]*)=(?P<value>.+?)?)\s*)[\r\n]*$")
|
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||||
|
AUTH_ARG_SPEC, RESOURCE_ARG_SPEC, WAIT_ARG_SPEC
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class OpenShiftProcess(K8sAnsibleMixin):
|
def argspec():
|
||||||
|
argument_spec = {}
|
||||||
|
argument_spec.update(AUTH_ARG_SPEC)
|
||||||
|
argument_spec.update(WAIT_ARG_SPEC)
|
||||||
|
argument_spec.update(RESOURCE_ARG_SPEC)
|
||||||
|
argument_spec['state'] = dict(type='str', default='rendered', choices=['present', 'absent', 'rendered'])
|
||||||
|
argument_spec['namespace'] = dict(type='str')
|
||||||
|
argument_spec['namespace_target'] = dict(type='str')
|
||||||
|
argument_spec['parameters'] = dict(type='dict')
|
||||||
|
argument_spec['name'] = dict(type='str')
|
||||||
|
argument_spec['parameter_file'] = dict(type='str')
|
||||||
|
|
||||||
def __init__(self):
|
return argument_spec
|
||||||
self.module = AnsibleModule(
|
|
||||||
argument_spec=self.argspec,
|
|
||||||
supports_check_mode=True,
|
|
||||||
)
|
|
||||||
self.fail_json = self.module.fail_json
|
|
||||||
self.exit_json = self.module.exit_json
|
|
||||||
|
|
||||||
if not HAS_KUBERNETES_COLLECTION:
|
|
||||||
self.module.fail_json(
|
|
||||||
msg="The kubernetes.core collection must be installed",
|
|
||||||
exception=K8S_COLLECTION_ERROR,
|
|
||||||
error=to_native(k8s_collection_import_exception)
|
|
||||||
)
|
|
||||||
|
|
||||||
super(OpenShiftProcess, self).__init__(self.module)
|
|
||||||
|
|
||||||
self.params = self.module.params
|
|
||||||
self.check_mode = self.module.check_mode
|
|
||||||
|
|
||||||
@property
|
|
||||||
def argspec(self):
|
|
||||||
spec = copy.deepcopy(AUTH_ARG_SPEC)
|
|
||||||
spec.update(copy.deepcopy(WAIT_ARG_SPEC))
|
|
||||||
spec.update(copy.deepcopy(RESOURCE_ARG_SPEC))
|
|
||||||
|
|
||||||
spec['state'] = dict(type='str', default='rendered', choices=['present', 'absent', 'rendered'])
|
|
||||||
spec['namespace'] = dict(type='str')
|
|
||||||
spec['namespace_target'] = dict(type='str')
|
|
||||||
spec['parameters'] = dict(type='dict')
|
|
||||||
spec['name'] = dict(type='str')
|
|
||||||
spec['parameter_file'] = dict(type='str')
|
|
||||||
|
|
||||||
return spec
|
|
||||||
|
|
||||||
def execute_module(self):
|
|
||||||
self.client = get_api_client(self.module)
|
|
||||||
|
|
||||||
v1_templates = self.find_resource('templates', 'template.openshift.io/v1', fail=True)
|
|
||||||
v1_processed_templates = self.find_resource('processedtemplates', 'template.openshift.io/v1', fail=True)
|
|
||||||
|
|
||||||
name = self.params.get('name')
|
|
||||||
namespace = self.params.get('namespace')
|
|
||||||
namespace_target = self.params.get('namespace_target')
|
|
||||||
definition = self.params.get('resource_definition')
|
|
||||||
src = self.params.get('src')
|
|
||||||
|
|
||||||
state = self.params.get('state')
|
|
||||||
|
|
||||||
parameters = self.params.get('parameters') or {}
|
|
||||||
parameter_file = self.params.get('parameter_file')
|
|
||||||
|
|
||||||
if (name and definition) or (name and src) or (src and definition):
|
|
||||||
self.fail_json("Only one of src, name, or definition may be provided")
|
|
||||||
|
|
||||||
if name and not namespace:
|
|
||||||
self.fail_json("namespace is required when name is set")
|
|
||||||
|
|
||||||
template = None
|
|
||||||
|
|
||||||
if src or definition:
|
|
||||||
self.set_resource_definitions(self.module)
|
|
||||||
if len(self.resource_definitions) < 1:
|
|
||||||
self.fail_json('Unable to load a Template resource from src or resource_definition')
|
|
||||||
elif len(self.resource_definitions) > 1:
|
|
||||||
self.fail_json('Multiple Template resources found in src or resource_definition, only one Template may be processed at a time')
|
|
||||||
template = self.resource_definitions[0]
|
|
||||||
template_namespace = template.get('metadata', {}).get('namespace')
|
|
||||||
namespace = template_namespace or namespace or namespace_target or 'default'
|
|
||||||
elif name and namespace:
|
|
||||||
try:
|
|
||||||
template = v1_templates.get(name=name, namespace=namespace).to_dict()
|
|
||||||
except DynamicApiError as exc:
|
|
||||||
self.fail_json(msg="Failed to retrieve Template with name '{0}' in namespace '{1}': {2}".format(name, namespace, exc.body),
|
|
||||||
error=exc.status, status=exc.status, reason=exc.reason)
|
|
||||||
except Exception as exc:
|
|
||||||
self.module.fail_json(msg="Failed to retrieve Template with name '{0}' in namespace '{1}': {2}".format(name, namespace, to_native(exc)),
|
|
||||||
error='', status='', reason='')
|
|
||||||
else:
|
|
||||||
self.fail_json("One of resource_definition, src, or name and namespace must be provided")
|
|
||||||
|
|
||||||
if parameter_file:
|
|
||||||
parameters = self.parse_dotenv_and_merge(parameters, parameter_file)
|
|
||||||
|
|
||||||
for k, v in parameters.items():
|
|
||||||
template = self.update_template_param(template, k, v)
|
|
||||||
|
|
||||||
result = {'changed': False}
|
|
||||||
|
|
||||||
try:
|
|
||||||
response = v1_processed_templates.create(body=template, namespace=namespace).to_dict()
|
|
||||||
except DynamicApiError as exc:
|
|
||||||
self.fail_json(msg="Server failed to render the Template: {0}".format(exc.body),
|
|
||||||
error=exc.status, status=exc.status, reason=exc.reason)
|
|
||||||
except Exception as exc:
|
|
||||||
self.module.fail_json(msg="Server failed to render the Template: {0}".format(to_native(exc)),
|
|
||||||
error='', status='', reason='')
|
|
||||||
result['message'] = ""
|
|
||||||
if "message" in response:
|
|
||||||
result['message'] = response['message']
|
|
||||||
result['resources'] = response['objects']
|
|
||||||
|
|
||||||
if state != 'rendered':
|
|
||||||
self.resource_definitions = response['objects']
|
|
||||||
self.kind = self.api_version = self.name = None
|
|
||||||
self.namespace = self.params.get('namespace_target')
|
|
||||||
self.append_hash = False
|
|
||||||
self.apply = False
|
|
||||||
self.params['validate'] = None
|
|
||||||
self.params['merge_type'] = None
|
|
||||||
super(OpenShiftProcess, self).execute_module()
|
|
||||||
|
|
||||||
self.module.exit_json(**result)
|
|
||||||
|
|
||||||
def update_template_param(self, template, k, v):
|
|
||||||
for i, param in enumerate(template['parameters']):
|
|
||||||
if param['name'] == k:
|
|
||||||
template['parameters'][i]['value'] = v
|
|
||||||
return template
|
|
||||||
return template
|
|
||||||
|
|
||||||
def parse_dotenv_and_merge(self, parameters, parameter_file):
|
|
||||||
path = os.path.normpath(parameter_file)
|
|
||||||
if not os.path.exists(path):
|
|
||||||
self.fail(msg="Error accessing {0}. Does the file exist?".format(path))
|
|
||||||
try:
|
|
||||||
with open(path, 'r') as f:
|
|
||||||
multiline = ''
|
|
||||||
for line in f.readlines():
|
|
||||||
line = line.strip()
|
|
||||||
if line.endswith('\\'):
|
|
||||||
multiline += ' '.join(line.rsplit('\\', 1))
|
|
||||||
continue
|
|
||||||
if multiline:
|
|
||||||
line = multiline + line
|
|
||||||
multiline = ''
|
|
||||||
match = DOTENV_PARSER.search(line)
|
|
||||||
if not match:
|
|
||||||
continue
|
|
||||||
match = match.groupdict()
|
|
||||||
if match.get('key'):
|
|
||||||
if match['key'] in parameters:
|
|
||||||
self.fail_json(msg="Duplicate value for '{0}' detected in parameter file".format(match['key']))
|
|
||||||
parameters[match['key']] = match['value']
|
|
||||||
except IOError as exc:
|
|
||||||
self.fail(msg="Error loading parameter file: {0}".format(exc))
|
|
||||||
return parameters
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
OpenShiftProcess().execute_module()
|
argument_spec = argspec()
|
||||||
|
module = AnsibleModule(argument_spec=argument_spec, supports_check_mode=True)
|
||||||
|
|
||||||
|
from ansible_collections.community.okd.plugins.module_utils.openshift_process import (
|
||||||
|
OpenShiftProcess)
|
||||||
|
|
||||||
|
openshift_process = OpenShiftProcess(module)
|
||||||
|
# remove_aliases from kubernetes.core's common requires the argspec attribute. Ideally, it should
|
||||||
|
# read that throught the module class, but we cannot change that.
|
||||||
|
openshift_process.argspec = argument_spec
|
||||||
|
openshift_process.execute_module()
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ author: "Fabian von Feilitzsch (@fabianvf)"
|
|||||||
description:
|
description:
|
||||||
- Looks up a Service and creates a new Route based on it.
|
- Looks up a Service and creates a new Route based on it.
|
||||||
- Analogous to `oc expose` and `oc create route` for creating Routes, but does not support creating Services.
|
- Analogous to `oc expose` and `oc create route` for creating Routes, but does not support creating Services.
|
||||||
- For creating Services from other resources, see kubernetes.core.k8s_expose
|
- For creating Services from other resources, see kubernetes.core.k8s.
|
||||||
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- kubernetes.core.k8s_auth_options
|
- kubernetes.core.k8s_auth_options
|
||||||
@@ -51,6 +51,12 @@ options:
|
|||||||
- Specify the labels to apply to the created Route.
|
- Specify the labels to apply to the created Route.
|
||||||
- 'A set of key: value pairs.'
|
- 'A set of key: value pairs.'
|
||||||
type: dict
|
type: dict
|
||||||
|
annotations:
|
||||||
|
description:
|
||||||
|
- Specify the Route Annotations.
|
||||||
|
- 'A set of key: value pairs.'
|
||||||
|
type: dict
|
||||||
|
version_added: "2.1.0"
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
- The desired name of the Route to be created.
|
- The desired name of the Route to be created.
|
||||||
@@ -174,6 +180,8 @@ EXAMPLES = r'''
|
|||||||
service: hello-kubernetes
|
service: hello-kubernetes
|
||||||
namespace: default
|
namespace: default
|
||||||
insecure_policy: allow
|
insecure_policy: allow
|
||||||
|
annotations:
|
||||||
|
haproxy.router.openshift.io/balance: roundrobin
|
||||||
register: route
|
register: route
|
||||||
'''
|
'''
|
||||||
|
|
||||||
@@ -301,7 +309,10 @@ duration:
|
|||||||
import copy
|
import copy
|
||||||
import traceback
|
import traceback
|
||||||
|
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
try:
|
||||||
|
from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import AnsibleModule
|
||||||
|
except ImportError:
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
from ansible.module_utils._text import to_native
|
from ansible.module_utils._text import to_native
|
||||||
|
|
||||||
try:
|
try:
|
||||||
@@ -349,6 +360,7 @@ class OpenShiftRoute(K8sAnsibleMixin):
|
|||||||
self.check_mode = self.module.check_mode
|
self.check_mode = self.module.check_mode
|
||||||
self.warnings = []
|
self.warnings = []
|
||||||
self.params['merge_type'] = None
|
self.params['merge_type'] = None
|
||||||
|
self.client = get_api_client(self.module)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def argspec(self):
|
def argspec(self):
|
||||||
@@ -372,11 +384,11 @@ class OpenShiftRoute(K8sAnsibleMixin):
|
|||||||
insecure_policy=dict(type='str', choices=['allow', 'redirect', 'disallow'], default='disallow'),
|
insecure_policy=dict(type='str', choices=['allow', 'redirect', 'disallow'], default='disallow'),
|
||||||
))
|
))
|
||||||
spec['termination'] = dict(choices=['edge', 'passthrough', 'reencrypt', 'insecure'], default='insecure')
|
spec['termination'] = dict(choices=['edge', 'passthrough', 'reencrypt', 'insecure'], default='insecure')
|
||||||
|
spec['annotations'] = dict(type='dict')
|
||||||
|
|
||||||
return spec
|
return spec
|
||||||
|
|
||||||
def execute_module(self):
|
def execute_module(self):
|
||||||
self.client = get_api_client(self.module)
|
|
||||||
v1_routes = self.find_resource('Route', 'route.openshift.io/v1', fail=True)
|
v1_routes = self.find_resource('Route', 'route.openshift.io/v1', fail=True)
|
||||||
|
|
||||||
service_name = self.params.get('service')
|
service_name = self.params.get('service')
|
||||||
@@ -401,6 +413,7 @@ class OpenShiftRoute(K8sAnsibleMixin):
|
|||||||
path = self.params.get('path')
|
path = self.params.get('path')
|
||||||
wildcard_policy = self.params.get('wildcard_policy')
|
wildcard_policy = self.params.get('wildcard_policy')
|
||||||
port = self.params.get('port')
|
port = self.params.get('port')
|
||||||
|
annotations = self.params.get('annotations')
|
||||||
|
|
||||||
if termination_type and self.params.get('tls'):
|
if termination_type and self.params.get('tls'):
|
||||||
tls_ca_cert = self.params['tls'].get('ca_certificate')
|
tls_ca_cert = self.params['tls'].get('ca_certificate')
|
||||||
@@ -424,6 +437,9 @@ class OpenShiftRoute(K8sAnsibleMixin):
|
|||||||
'spec': {}
|
'spec': {}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if annotations:
|
||||||
|
route['metadata']['annotations'] = annotations
|
||||||
|
|
||||||
if state != 'absent':
|
if state != 'absent':
|
||||||
route['spec'] = self.build_route_spec(
|
route['spec'] = self.build_route_spec(
|
||||||
service_name, namespace,
|
service_name, namespace,
|
||||||
|
|||||||
+1
-1
@@ -1,3 +1,3 @@
|
|||||||
collections:
|
collections:
|
||||||
- name: kubernetes.core
|
- name: kubernetes.core
|
||||||
version: '>=2.0.0,<2.1.0'
|
version: '>=2.1.0,<2.3.0'
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
|
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:return-syntax-error
|
||||||
|
plugins/module_utils/k8s.py pylint:bad-option-value
|
||||||
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
|
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
|
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:return-syntax-error
|
||||||
|
plugins/module_utils/k8s.py pylint:bad-option-value
|
||||||
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
|
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
|
||||||
|
|||||||
@@ -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
|
||||||
@@ -1,2 +1,3 @@
|
|||||||
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
|
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
|
||||||
|
plugins/module_utils/k8s.py pylint:bad-option-value
|
||||||
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
|
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
|
||||||
|
|||||||
Reference in New Issue
Block a user