mirror of
https://github.com/openshift/community.okd.git
synced 2026-11-22 07:00:26 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
874cf9f171 | ||
|
|
5b2ec65cc6 | ||
|
|
74ac82e76d | ||
|
|
308235e032 | ||
|
|
e7c3351309 |
@@ -5,6 +5,21 @@ OKD Collection Release Notes
|
|||||||
.. contents:: Topics
|
.. contents:: Topics
|
||||||
|
|
||||||
|
|
||||||
|
v0.3.0
|
||||||
|
======
|
||||||
|
|
||||||
|
Major Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Add openshift_process module for template rendering and optional application of rendered resources (https://github.com/ansible-collections/community.okd/pull/44).
|
||||||
|
- Add openshift_route module for creating routes from services (https://github.com/ansible-collections/community.okd/pull/40).
|
||||||
|
|
||||||
|
New Modules
|
||||||
|
-----------
|
||||||
|
|
||||||
|
- openshift_process - Process an OpenShift template.openshift.io/v1 Template
|
||||||
|
- openshift_route - Expose a Service as an OpenShift Route.
|
||||||
|
|
||||||
v0.2.0
|
v0.2.0
|
||||||
======
|
======
|
||||||
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# Also needs to be updated in galaxy.yml
|
# Also needs to be updated in galaxy.yml
|
||||||
VERSION = 0.2.0
|
VERSION = 0.3.0
|
||||||
|
|
||||||
# To run sanity tests in a venv, set SANITY_TEST_ARGS to '--venv'
|
# To run sanity tests in a venv, set SANITY_TEST_ARGS to '--venv'
|
||||||
SANITY_TEST_ARGS ?= --docker --color
|
SANITY_TEST_ARGS ?= --docker --color
|
||||||
|
|||||||
@@ -17,8 +17,10 @@ Click on the name of a plugin or module to view that content's documentation:
|
|||||||
- **Modules**:
|
- **Modules**:
|
||||||
- [k8s](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_inventory.html)
|
- [k8s](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_inventory.html)
|
||||||
- [openshift_auth](https://github.com/ansible-collections/community.okd/blob/main/plugins/modules/openshift_auth.py)
|
- [openshift_auth](https://github.com/ansible-collections/community.okd/blob/main/plugins/modules/openshift_auth.py)
|
||||||
|
- [openshift_process](https://github.com/ansible-collections/community.okd/blob/main/plugins/modules/openshift_process.py)
|
||||||
|
- [openshift_route](https://github.com/ansible-collections/community.okd/blob/main/plugins/modules/openshift_route.py)
|
||||||
|
|
||||||
> **Note**: These documentation links currently link to older module versions. For the latest module documentation, please use `ansible-doc` in the CLI.
|
> **Note**: Some of these documentation links currently link to older module versions. For the latest module documentation, please use `ansible-doc` in the CLI.
|
||||||
|
|
||||||
## Installation and Usage
|
## Installation and Usage
|
||||||
|
|
||||||
@@ -34,7 +36,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: 0.2.0
|
version: 0.3.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### Installing the OpenShift Python Library
|
### Installing the OpenShift Python Library
|
||||||
@@ -100,7 +102,11 @@ where the `IMAGE_FORMAT` environment variable is the full reference to your cont
|
|||||||
|
|
||||||
Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:
|
Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:
|
||||||
|
|
||||||
1. Update `galaxy.yml`, this README's `requirements.yml` example, and the `Makefile` with the new `version` for the collection.
|
1. Update the version in the following places:
|
||||||
|
a. The `version` in `galaxy.yml`
|
||||||
|
b. This README's `requirements.yml` example
|
||||||
|
c. The `DOWNSTREAM_VERSION` in `ci/downstream.sh`
|
||||||
|
d. The `VERSION` in `Makefile`
|
||||||
1. Update the CHANGELOG:
|
1. Update the CHANGELOG:
|
||||||
1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
|
1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
|
||||||
1. Make sure there are fragments for all known changes in `changelogs/fragments`.
|
1. Make sure there are fragments for all known changes in `changelogs/fragments`.
|
||||||
|
|||||||
@@ -44,3 +44,20 @@ releases:
|
|||||||
name: openshift_auth
|
name: openshift_auth
|
||||||
namespace: ''
|
namespace: ''
|
||||||
release_date: '2020-09-24'
|
release_date: '2020-09-24'
|
||||||
|
0.3.0:
|
||||||
|
changes:
|
||||||
|
major_changes:
|
||||||
|
- Add openshift_process module for template rendering and optional application
|
||||||
|
of rendered resources (https://github.com/ansible-collections/community.okd/pull/44).
|
||||||
|
- Add openshift_route module for creating routes from services (https://github.com/ansible-collections/community.okd/pull/40).
|
||||||
|
fragments:
|
||||||
|
- 40-openshift_route.yml
|
||||||
|
- 44-openshift_process.yml
|
||||||
|
modules:
|
||||||
|
- description: Process an OpenShift template.openshift.io/v1 Template
|
||||||
|
name: openshift_process
|
||||||
|
namespace: ''
|
||||||
|
- description: Expose a Service as an OpenShift Route.
|
||||||
|
name: openshift_route
|
||||||
|
namespace: ''
|
||||||
|
release_date: '2020-10-12'
|
||||||
|
|||||||
@@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
major_changes:
|
||||||
|
- Add openshift_route module for creating routes from services (https://github.com/ansible-collections/community.okd/pull/40).
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
major_changes:
|
||||||
|
- Add openshift_process module for template rendering and optional application of rendered resources (https://github.com/ansible-collections/community.okd/pull/44).
|
||||||
+1
-1
@@ -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="0.1.0"
|
DOWNSTREAM_VERSION="0.3.0"
|
||||||
KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}"
|
KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}"
|
||||||
_build_dir=""
|
_build_dir=""
|
||||||
|
|
||||||
|
|||||||
+1
-1
@@ -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: 0.2.0
|
version: 0.3.0
|
||||||
|
|||||||
@@ -0,0 +1,9 @@
|
|||||||
|
#
|
||||||
|
NAME=example
|
||||||
|
# Multiline values shouldn't break things
|
||||||
|
export CONTENT=This is a long message\
|
||||||
|
that may take one or more lines to parse\
|
||||||
|
but should still work without issue
|
||||||
|
|
||||||
|
# This shouldn't throw an error
|
||||||
|
UNUSED=
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
# Want to make sure comments don't break it
|
||||||
|
export NAME=test123
|
||||||
|
NAMESPACE=openshift
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# Blank lines should be fine too
|
||||||
|
|
||||||
|
# Equals in comments shouldn't break things=True
|
||||||
|
MEMORY_LIMIT=1Gi
|
||||||
|
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
---
|
||||||
|
apiVersion: template.openshift.io/v1
|
||||||
|
kind: Template
|
||||||
|
labels:
|
||||||
|
template: simple-example-test
|
||||||
|
message: |-
|
||||||
|
The following configmaps have been created in your project: ${NAME}.
|
||||||
|
metadata:
|
||||||
|
annotations:
|
||||||
|
description: A super basic template for testing
|
||||||
|
openshift.io/display-name: Super basic template
|
||||||
|
openshift.io/provider-display-name: Red Hat, Inc.
|
||||||
|
tags: quickstart,examples
|
||||||
|
name: simple-example
|
||||||
|
objects:
|
||||||
|
- apiVersion: v1
|
||||||
|
kind: ConfigMap
|
||||||
|
metadata:
|
||||||
|
annotations:
|
||||||
|
description: Big example
|
||||||
|
name: ${NAME}
|
||||||
|
data:
|
||||||
|
content: "${CONTENT}"
|
||||||
|
parameters:
|
||||||
|
- description: The name assigned to the ConfigMap
|
||||||
|
displayName: Name
|
||||||
|
name: NAME
|
||||||
|
required: true
|
||||||
|
value: example
|
||||||
|
- description: The value for the content key of the configmap
|
||||||
|
displayName: Content
|
||||||
|
name: CONTENT
|
||||||
|
required: true
|
||||||
|
value: ''
|
||||||
@@ -0,0 +1,164 @@
|
|||||||
|
---
|
||||||
|
|
||||||
|
- name: Process a template in the cluster
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: nginx-example
|
||||||
|
namespace: openshift # only needed if using a template already on the server
|
||||||
|
parameters:
|
||||||
|
NAMESPACE: openshift
|
||||||
|
NAME: test123
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Create the rendered resources
|
||||||
|
community.okd.k8s:
|
||||||
|
namespace: process-test
|
||||||
|
definition: '{{ item }}'
|
||||||
|
wait: yes
|
||||||
|
apply: yes
|
||||||
|
loop: '{{ result.resources }}'
|
||||||
|
|
||||||
|
- name: Delete the rendered resources
|
||||||
|
community.okd.k8s:
|
||||||
|
namespace: process-test
|
||||||
|
definition: '{{ item }}'
|
||||||
|
wait: yes
|
||||||
|
state: absent
|
||||||
|
loop: '{{ result.resources }}'
|
||||||
|
|
||||||
|
- name: Process a template and create the resources in the cluster
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: nginx-example
|
||||||
|
namespace: openshift # only needed if using a template already on the server
|
||||||
|
parameters:
|
||||||
|
NAMESPACE: openshift
|
||||||
|
NAME: test123
|
||||||
|
state: present
|
||||||
|
namespace_target: process-test
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Process a template and update the resources in the cluster
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: nginx-example
|
||||||
|
namespace: openshift # only needed if using a template already on the server
|
||||||
|
parameters:
|
||||||
|
NAMESPACE: openshift
|
||||||
|
NAME: test123
|
||||||
|
MEMORY_LIMIT: 1Gi
|
||||||
|
state: present
|
||||||
|
namespace_target: process-test
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Process a template and delete the resources in the cluster
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: nginx-example
|
||||||
|
namespace: openshift # only needed if using a template already on the server
|
||||||
|
parameters:
|
||||||
|
NAMESPACE: openshift
|
||||||
|
NAME: test123
|
||||||
|
state: absent
|
||||||
|
namespace_target: process-test
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Process a template with parameters from an env file and create the resources
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: nginx-example
|
||||||
|
namespace: openshift
|
||||||
|
namespace_target: process-test
|
||||||
|
parameter_file: '{{ files_dir }}/nginx.env'
|
||||||
|
state: present
|
||||||
|
wait: yes
|
||||||
|
|
||||||
|
- name: Process a template with parameters from an env file and delete the resources
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: nginx-example
|
||||||
|
namespace: openshift
|
||||||
|
namespace_target: process-test
|
||||||
|
parameter_file: '{{ files_dir }}/nginx.env'
|
||||||
|
state: absent
|
||||||
|
wait: yes
|
||||||
|
|
||||||
|
|
||||||
|
- name: Process a template with duplicate values
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: nginx-example
|
||||||
|
namespace: openshift # only needed if using a template already on the server
|
||||||
|
parameters:
|
||||||
|
NAME: test123
|
||||||
|
parameter_file: '{{ files_dir }}/nginx.env'
|
||||||
|
ignore_errors: yes
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Assert the expected failure occurred
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- result.msg is defined
|
||||||
|
- result.msg == "Duplicate value for 'NAME' detected in parameter file"
|
||||||
|
|
||||||
|
- name: Process a local template
|
||||||
|
community.okd.openshift_process:
|
||||||
|
src: '{{ files_dir }}/simple-template.yaml'
|
||||||
|
parameter_file: '{{ files_dir }}/example.env'
|
||||||
|
register: rendered
|
||||||
|
|
||||||
|
- name: Process a local template and create the resources
|
||||||
|
community.okd.openshift_process:
|
||||||
|
src: '{{ files_dir }}/simple-template.yaml'
|
||||||
|
parameter_file: '{{ files_dir }}/example.env'
|
||||||
|
namespace_target: process-test
|
||||||
|
state: present
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that: result is changed
|
||||||
|
|
||||||
|
- name: Create the processed resources
|
||||||
|
community.okd.k8s:
|
||||||
|
namespace: process-test
|
||||||
|
definition: '{{ item }}'
|
||||||
|
loop: '{{ rendered.resources }}'
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that: result is not changed
|
||||||
|
|
||||||
|
- name: Process a local template and create the resources
|
||||||
|
community.okd.openshift_process:
|
||||||
|
definition: "{{ lookup('template', files_dir + '/simple-template.yaml') | from_yaml }}"
|
||||||
|
parameter_file: '{{ files_dir }}/example.env'
|
||||||
|
namespace_target: process-test
|
||||||
|
state: present
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that: result is not changed
|
||||||
|
|
||||||
|
- name: Get the created configmap
|
||||||
|
community.kubernetes.k8s_info:
|
||||||
|
api_version: v1
|
||||||
|
kind: ConfigMap
|
||||||
|
name: example
|
||||||
|
namespace: process-test
|
||||||
|
register: templated_cm
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that:
|
||||||
|
- (templated_cm.resources | length) == 1
|
||||||
|
- templated_cm.resources.0.data.content is defined
|
||||||
|
- templated_cm.resources.0.data.content == "This is a long message that may take one or more lines to parse but should still work without issue"
|
||||||
|
|
||||||
|
- name: Create the Template resource
|
||||||
|
community.okd.k8s:
|
||||||
|
src: '{{ files_dir }}/simple-template.yaml'
|
||||||
|
namespace: process-test
|
||||||
|
|
||||||
|
- name: Process the template and create the resources
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: simple-example
|
||||||
|
namespace: process-test # only needed if using a template already on the server
|
||||||
|
namespace_target: process-test
|
||||||
|
parameter_file: '{{ files_dir }}/example.env'
|
||||||
|
state: present
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that: result is not changed
|
||||||
@@ -0,0 +1,240 @@
|
|||||||
|
---
|
||||||
|
- name: Create Deployment
|
||||||
|
community.okd.k8s:
|
||||||
|
wait: yes
|
||||||
|
definition:
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
spec:
|
||||||
|
replicas: 3
|
||||||
|
selector:
|
||||||
|
matchLabels:
|
||||||
|
app: hello-kubernetes
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
app: hello-kubernetes
|
||||||
|
spec:
|
||||||
|
containers:
|
||||||
|
- name: hello-kubernetes
|
||||||
|
image: docker.io/openshift/hello-openshift
|
||||||
|
ports:
|
||||||
|
- containerPort: 8080
|
||||||
|
|
||||||
|
- name: Create Service
|
||||||
|
community.okd.k8s:
|
||||||
|
wait: yes
|
||||||
|
definition:
|
||||||
|
apiVersion: v1
|
||||||
|
kind: Service
|
||||||
|
metadata:
|
||||||
|
name: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
spec:
|
||||||
|
ports:
|
||||||
|
- port: 80
|
||||||
|
targetPort: 8080
|
||||||
|
selector:
|
||||||
|
app: hello-kubernetes
|
||||||
|
|
||||||
|
- name: Create Route with fewest possible arguments
|
||||||
|
community.okd.openshift_route:
|
||||||
|
service: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
register: route
|
||||||
|
|
||||||
|
- name: Attempt to hit http URL
|
||||||
|
uri:
|
||||||
|
url: 'http://{{ route.result.spec.host }}'
|
||||||
|
return_content: yes
|
||||||
|
until: result is successful
|
||||||
|
retries: 10
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Assert the page content is as expected
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- not result.redirected
|
||||||
|
- result.status == 200
|
||||||
|
- result.content == 'Hello OpenShift!\n'
|
||||||
|
|
||||||
|
- name: Delete route
|
||||||
|
community.okd.openshift_route:
|
||||||
|
name: '{{ route.result.metadata.name }}'
|
||||||
|
namespace: default
|
||||||
|
state: absent
|
||||||
|
wait: yes
|
||||||
|
|
||||||
|
- name: Create Route with custom name and wait
|
||||||
|
community.okd.openshift_route:
|
||||||
|
service: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
name: test1
|
||||||
|
wait: yes
|
||||||
|
register: route
|
||||||
|
|
||||||
|
- name: Assert that the condition is properly set
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- route.duration is defined
|
||||||
|
- route.result.status.ingress.0.conditions.0.type == 'Admitted'
|
||||||
|
- route.result.status.ingress.0.conditions.0.status == 'True'
|
||||||
|
|
||||||
|
- name: Attempt to hit http URL
|
||||||
|
uri:
|
||||||
|
url: 'http://{{ route.result.spec.host }}'
|
||||||
|
return_content: yes
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Assert the page content is as expected
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- not result.redirected
|
||||||
|
- result.status == 200
|
||||||
|
- result.content == 'Hello OpenShift!\n'
|
||||||
|
|
||||||
|
- name: Delete route
|
||||||
|
community.okd.openshift_route:
|
||||||
|
name: '{{ route.result.metadata.name }}'
|
||||||
|
namespace: default
|
||||||
|
state: absent
|
||||||
|
wait: yes
|
||||||
|
|
||||||
|
- name: Create edge-terminated route that allows insecure traffic
|
||||||
|
community.okd.openshift_route:
|
||||||
|
service: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
name: hello-kubernetes-https
|
||||||
|
tls:
|
||||||
|
insecure_policy: allow
|
||||||
|
termination: edge
|
||||||
|
register: route
|
||||||
|
|
||||||
|
- name: Attempt to hit http URL
|
||||||
|
uri:
|
||||||
|
url: 'http://{{ route.result.spec.host }}'
|
||||||
|
return_content: yes
|
||||||
|
until: result is successful
|
||||||
|
retries: 10
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Assert the page content is as expected
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- not result.redirected
|
||||||
|
- result.status == 200
|
||||||
|
- result.content == 'Hello OpenShift!\n'
|
||||||
|
|
||||||
|
- name: Attempt to hit https URL
|
||||||
|
uri:
|
||||||
|
url: 'https://{{ route.result.spec.host }}'
|
||||||
|
validate_certs: no
|
||||||
|
return_content: yes
|
||||||
|
until: result is successful
|
||||||
|
retries: 10
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Assert the page content is as expected
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- not result.redirected
|
||||||
|
- result.status == 200
|
||||||
|
- result.content == 'Hello OpenShift!\n'
|
||||||
|
|
||||||
|
- name: Alter edge-terminated route to redirect insecure traffic
|
||||||
|
community.okd.openshift_route:
|
||||||
|
service: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
name: hello-kubernetes-https
|
||||||
|
tls:
|
||||||
|
insecure_policy: redirect
|
||||||
|
termination: edge
|
||||||
|
register: route
|
||||||
|
|
||||||
|
- name: Attempt to hit http URL
|
||||||
|
uri:
|
||||||
|
url: 'http://{{ route.result.spec.host }}'
|
||||||
|
return_content: yes
|
||||||
|
validate_certs: no
|
||||||
|
until:
|
||||||
|
- result is successful
|
||||||
|
- result.redirected
|
||||||
|
retries: 10
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Assert the page content is as expected
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- result.redirected
|
||||||
|
- result.status == 200
|
||||||
|
- result.content == 'Hello OpenShift!\n'
|
||||||
|
|
||||||
|
- name: Attempt to hit https URL
|
||||||
|
uri:
|
||||||
|
url: 'https://{{ route.result.spec.host }}'
|
||||||
|
validate_certs: no
|
||||||
|
return_content: yes
|
||||||
|
until: result is successful
|
||||||
|
retries: 10
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Assert the page content is as expected
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- not result.redirected
|
||||||
|
- result.status == 200
|
||||||
|
- result.content == 'Hello OpenShift!\n'
|
||||||
|
|
||||||
|
- name: Alter edge-terminated route with insecure traffic disabled
|
||||||
|
community.okd.openshift_route:
|
||||||
|
service: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
name: hello-kubernetes-https
|
||||||
|
tls:
|
||||||
|
insecure_policy: disallow
|
||||||
|
termination: edge
|
||||||
|
register: route
|
||||||
|
|
||||||
|
- debug: var=route
|
||||||
|
|
||||||
|
- name: Attempt to hit https URL
|
||||||
|
uri:
|
||||||
|
url: 'https://{{ route.result.spec.host }}'
|
||||||
|
validate_certs: no
|
||||||
|
return_content: yes
|
||||||
|
until: result is successful
|
||||||
|
retries: 10
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Assert the page content is as expected
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- not result.redirected
|
||||||
|
- result.status == 200
|
||||||
|
- result.content == 'Hello OpenShift!\n'
|
||||||
|
|
||||||
|
- name: Attempt to hit http URL
|
||||||
|
uri:
|
||||||
|
url: 'http://{{ route.result.spec.host }}'
|
||||||
|
status_code: 503
|
||||||
|
until: result is successful
|
||||||
|
retries: 10
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- debug: var=result
|
||||||
|
|
||||||
|
- name: Assert the page content is as expected
|
||||||
|
assert:
|
||||||
|
that:
|
||||||
|
- not result.redirected
|
||||||
|
- result.status == 503
|
||||||
|
|
||||||
|
- name: Delete route
|
||||||
|
community.okd.openshift_route:
|
||||||
|
name: '{{ route.result.metadata.name }}'
|
||||||
|
namespace: default
|
||||||
|
state: absent
|
||||||
|
wait: yes
|
||||||
@@ -61,3 +61,20 @@
|
|||||||
- import_tasks: tasks/validate_not_installed.yml
|
- import_tasks: tasks/validate_not_installed.yml
|
||||||
|
|
||||||
- import_tasks: tasks/openshift_auth.yml
|
- import_tasks: tasks/openshift_auth.yml
|
||||||
|
- import_tasks: tasks/openshift_route.yml
|
||||||
|
- block:
|
||||||
|
- name: Create namespace
|
||||||
|
community.okd.k8s:
|
||||||
|
api_version: v1
|
||||||
|
kind: Namespace
|
||||||
|
name: process-test
|
||||||
|
- import_tasks: tasks/openshift_process.yml
|
||||||
|
vars:
|
||||||
|
files_dir: '{{ playbook_dir }}/files'
|
||||||
|
always:
|
||||||
|
- name: Delete namespace
|
||||||
|
community.okd.k8s:
|
||||||
|
api_version: v1
|
||||||
|
kind: Namespace
|
||||||
|
name: process-test
|
||||||
|
state: absent
|
||||||
|
|||||||
@@ -0,0 +1,389 @@
|
|||||||
|
#!/usr/bin/python
|
||||||
|
# -*- 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
|
||||||
|
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
|
||||||
|
DOCUMENTATION = r'''
|
||||||
|
module: openshift_process
|
||||||
|
|
||||||
|
short_description: Process an OpenShift template.openshift.io/v1 Template
|
||||||
|
|
||||||
|
version_added: "0.3.0"
|
||||||
|
|
||||||
|
author: "Fabian von Feilitzsch (@fabianvf)"
|
||||||
|
|
||||||
|
description:
|
||||||
|
- Processes a specified OpenShift template with the provided template.
|
||||||
|
- Templates can be provided inline, from a file, or specified by name and namespace in the cluster.
|
||||||
|
- Analogous to `oc process`.
|
||||||
|
- For CRUD operations on Template resources themselves, see the community.okd.k8s module.
|
||||||
|
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.kubernetes.k8s_auth_options
|
||||||
|
- community.kubernetes.k8s_wait_options
|
||||||
|
- community.kubernetes.k8s_resource_options
|
||||||
|
|
||||||
|
requirements:
|
||||||
|
- "python >= 2.7"
|
||||||
|
- "openshift >= 0.11.0"
|
||||||
|
- "PyYAML >= 3.11"
|
||||||
|
|
||||||
|
options:
|
||||||
|
name:
|
||||||
|
description:
|
||||||
|
- The name of the Template to process.
|
||||||
|
- The Template must be present in the cluster.
|
||||||
|
- When provided, I(namespace) is required.
|
||||||
|
- Mutually exlusive with I(resource_definition) or I(src)
|
||||||
|
type: str
|
||||||
|
namespace:
|
||||||
|
description:
|
||||||
|
- The namespace that the template can be found in.
|
||||||
|
type: str
|
||||||
|
namespace_target:
|
||||||
|
description:
|
||||||
|
- The namespace that resources should be created, updated, or deleted in.
|
||||||
|
- Only used when I(state) is present or absent.
|
||||||
|
parameters:
|
||||||
|
description:
|
||||||
|
- 'A set of key: value pairs that will be used to set/override values in the Template.'
|
||||||
|
- Corresponds to the `--param` argument to oc process.
|
||||||
|
type: dict
|
||||||
|
parameter_file:
|
||||||
|
description:
|
||||||
|
- A path to a file containing template parameter values to override/set values in the Template.
|
||||||
|
- Corresponds to the `--param-file` argument to oc process.
|
||||||
|
type: str
|
||||||
|
state:
|
||||||
|
description:
|
||||||
|
- Determines what to do with the rendered Template.
|
||||||
|
- The state I(rendered) will render the Template based on the provided parameters, and return the rendered
|
||||||
|
objects in the I(resources) field. These can then be referenced in future tasks.
|
||||||
|
- The state I(present) will cause the resources in the rendered Template to be created if they do not
|
||||||
|
already exist, and patched if they do.
|
||||||
|
- The state I(absent) will delete the resources in the rendered Template.
|
||||||
|
type: str
|
||||||
|
default: rendered
|
||||||
|
choices: [ absent, present, rendered ]
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = r'''
|
||||||
|
- name: Process a template in the cluster
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: nginx-example
|
||||||
|
namespace: openshift # only needed if using a template already on the server
|
||||||
|
parameters:
|
||||||
|
NAMESPACE: openshift
|
||||||
|
NAME: test123
|
||||||
|
state: rendered
|
||||||
|
register: result
|
||||||
|
|
||||||
|
- name: Create the rendered resources using apply
|
||||||
|
community.okd.k8s:
|
||||||
|
namespace: default
|
||||||
|
definition: '{{ item }}'
|
||||||
|
wait: yes
|
||||||
|
apply: yes
|
||||||
|
loop: '{{ result.resources }}'
|
||||||
|
|
||||||
|
- name: Process a template with parameters from an env file and create the resources
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: nginx-example
|
||||||
|
namespace: openshift
|
||||||
|
namespace_target: default
|
||||||
|
parameter_file: 'files/nginx.env'
|
||||||
|
state: present
|
||||||
|
wait: yes
|
||||||
|
|
||||||
|
- name: Process a local template and create the resources
|
||||||
|
community.okd.openshift_process:
|
||||||
|
src: files/example-template.yaml
|
||||||
|
parameter_file: files/example.env
|
||||||
|
namespace_target: default
|
||||||
|
state: present
|
||||||
|
|
||||||
|
- name: Process a local template, delete the resources, and wait for them to terminate
|
||||||
|
community.okd.openshift_process:
|
||||||
|
src: files/example-template.yaml
|
||||||
|
parameter_file: files/example.env
|
||||||
|
namespace_target: default
|
||||||
|
state: absent
|
||||||
|
wait: yes
|
||||||
|
'''
|
||||||
|
|
||||||
|
RETURN = r'''
|
||||||
|
result:
|
||||||
|
description:
|
||||||
|
- The created, patched, or otherwise present object. Will be empty in the case of a deletion.
|
||||||
|
returned: on success when state is present or absent
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
apiVersion:
|
||||||
|
description: The versioned schema of this representation of an object.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
kind:
|
||||||
|
description: Represents the REST resource this object represents.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
metadata:
|
||||||
|
description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
name:
|
||||||
|
description: The name of the resource
|
||||||
|
type: str
|
||||||
|
namespace:
|
||||||
|
description: The namespace of the resource
|
||||||
|
type: str
|
||||||
|
spec:
|
||||||
|
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
|
||||||
|
returned: success
|
||||||
|
type: dict
|
||||||
|
status:
|
||||||
|
description: Current status details for the object.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
conditions:
|
||||||
|
type: complex
|
||||||
|
description: Array of status conditions for the object. Not guaranteed to be present
|
||||||
|
items:
|
||||||
|
description: Returned only when multiple yaml documents are passed to src or resource_definition
|
||||||
|
returned: when resource_definition or src contains list of objects
|
||||||
|
type: list
|
||||||
|
duration:
|
||||||
|
description: elapsed time of task in seconds
|
||||||
|
returned: when C(wait) is true
|
||||||
|
type: int
|
||||||
|
sample: 48
|
||||||
|
resources:
|
||||||
|
type: complex
|
||||||
|
description:
|
||||||
|
- The rendered resources defined in the Template
|
||||||
|
returned: on success when state is rendered
|
||||||
|
contains:
|
||||||
|
apiVersion:
|
||||||
|
description: The versioned schema of this representation of an object.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
kind:
|
||||||
|
description: Represents the REST resource this object represents.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
metadata:
|
||||||
|
description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
name:
|
||||||
|
description: The name of the resource
|
||||||
|
type: str
|
||||||
|
namespace:
|
||||||
|
description: The namespace of the resource
|
||||||
|
type: str
|
||||||
|
spec:
|
||||||
|
description: Specific attributes of the object. Will vary based on the I(api_version) and I(kind).
|
||||||
|
returned: success
|
||||||
|
type: dict
|
||||||
|
status:
|
||||||
|
description: Current status details for the object.
|
||||||
|
returned: success
|
||||||
|
type: dict
|
||||||
|
contains:
|
||||||
|
conditions:
|
||||||
|
type: complex
|
||||||
|
description: Array of status conditions for the object. Not guaranteed to be present
|
||||||
|
'''
|
||||||
|
|
||||||
|
import re
|
||||||
|
import os
|
||||||
|
import copy
|
||||||
|
import traceback
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
from ansible.module_utils._text import to_native
|
||||||
|
|
||||||
|
try:
|
||||||
|
from ansible_collections.community.kubernetes.plugins.module_utils.common import (
|
||||||
|
K8sAnsibleMixin, 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 openshift.dynamic.exceptions import DynamicApiError, NotFoundError
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
DOTENV_PARSER = re.compile(r"(?x)^(\s*(\#.*|\s*|(export\s+)?(?P<key>[A-z_][A-z0-9_.]*)=(?P<value>.+?)?)\s*)[\r\n]*$")
|
||||||
|
|
||||||
|
|
||||||
|
class OpenShiftProcess(K8sAnsibleMixin):
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
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 community.kubernetes collection must be installed",
|
||||||
|
exception=K8S_COLLECTION_ERROR,
|
||||||
|
error=to_native(k8s_collection_import_exception)
|
||||||
|
)
|
||||||
|
|
||||||
|
super(OpenShiftProcess, self).__init__()
|
||||||
|
|
||||||
|
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 = self.get_api_client()
|
||||||
|
|
||||||
|
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()
|
||||||
|
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'] = 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():
|
||||||
|
OpenShiftProcess().execute_module()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
@@ -0,0 +1,544 @@
|
|||||||
|
#!/usr/bin/python
|
||||||
|
# -*- 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
|
||||||
|
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
|
||||||
|
DOCUMENTATION = r'''
|
||||||
|
module: openshift_route
|
||||||
|
|
||||||
|
short_description: Expose a Service as an OpenShift Route.
|
||||||
|
|
||||||
|
version_added: "0.3.0"
|
||||||
|
|
||||||
|
author: "Fabian von Feilitzsch (@fabianvf)"
|
||||||
|
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
- For creating Services from other resources, see community.kubernetes.k8s_expose
|
||||||
|
|
||||||
|
extends_documentation_fragment:
|
||||||
|
- community.kubernetes.k8s_auth_options
|
||||||
|
- community.kubernetes.k8s_wait_options
|
||||||
|
- community.kubernetes.k8s_state_options
|
||||||
|
|
||||||
|
requirements:
|
||||||
|
- "python >= 2.7"
|
||||||
|
- "openshift >= 0.11.0"
|
||||||
|
- "PyYAML >= 3.11"
|
||||||
|
|
||||||
|
options:
|
||||||
|
service:
|
||||||
|
description:
|
||||||
|
- The name of the service to expose.
|
||||||
|
- Required when I(state) is not absent.
|
||||||
|
type: str
|
||||||
|
aliases: ['svc']
|
||||||
|
namespace:
|
||||||
|
description:
|
||||||
|
- The namespace of the resource being targeted.
|
||||||
|
- The Route will be created in this namespace as well.
|
||||||
|
required: yes
|
||||||
|
type: str
|
||||||
|
labels:
|
||||||
|
description:
|
||||||
|
- Specify the labels to apply to the created Route.
|
||||||
|
- 'A set of key: value pairs.'
|
||||||
|
type: dict
|
||||||
|
name:
|
||||||
|
description:
|
||||||
|
- The desired name of the Route to be created.
|
||||||
|
- Defaults to the value of I(service)
|
||||||
|
type: str
|
||||||
|
hostname:
|
||||||
|
description:
|
||||||
|
- The hostname for the Route.
|
||||||
|
type: str
|
||||||
|
path:
|
||||||
|
description:
|
||||||
|
- The path for the Route
|
||||||
|
type: str
|
||||||
|
wildcard_policy:
|
||||||
|
description:
|
||||||
|
- The wildcard policy for the hostname.
|
||||||
|
- Currently only Subdomain is supported.
|
||||||
|
- If not provided, the default of None will be used.
|
||||||
|
choices:
|
||||||
|
- Subdomain
|
||||||
|
type: str
|
||||||
|
port:
|
||||||
|
description:
|
||||||
|
- Name or number of the port the Route will route traffic to.
|
||||||
|
type: str
|
||||||
|
tls:
|
||||||
|
description:
|
||||||
|
- TLS configuration for the newly created route.
|
||||||
|
- Only used when I(termination) is set.
|
||||||
|
type: dict
|
||||||
|
suboptions:
|
||||||
|
ca_certificate:
|
||||||
|
description:
|
||||||
|
- Path to a CA certificate file on the target host.
|
||||||
|
- Not supported when I(termination) is set to passthrough.
|
||||||
|
type: str
|
||||||
|
certificate:
|
||||||
|
description:
|
||||||
|
- Path to a certificate file on the target host.
|
||||||
|
- Not supported when I(termination) is set to passthrough.
|
||||||
|
type: str
|
||||||
|
destination_ca_certificate:
|
||||||
|
description:
|
||||||
|
- Path to a CA certificate file used for securing the connection.
|
||||||
|
- Only used when I(termination) is set to reencrypt.
|
||||||
|
- Defaults to the Service CA.
|
||||||
|
type: str
|
||||||
|
key:
|
||||||
|
description:
|
||||||
|
- Path to a key file on the target host.
|
||||||
|
- Not supported when I(termination) is set to passthrough.
|
||||||
|
type: str
|
||||||
|
insecure_policy:
|
||||||
|
description:
|
||||||
|
- Sets the InsecureEdgeTerminationPolicy for the Route.
|
||||||
|
- Not supported when I(termination) is set to reencrypt.
|
||||||
|
- When I(termination) is set to passthrough, only redirect is supported.
|
||||||
|
- If not provided, insecure traffic will be disallowed.
|
||||||
|
type: str
|
||||||
|
choices:
|
||||||
|
- allow
|
||||||
|
- redirect
|
||||||
|
- disallow
|
||||||
|
default: disallow
|
||||||
|
termination:
|
||||||
|
description:
|
||||||
|
- The termination type of the Route.
|
||||||
|
- If left empty no termination type will be set, and the route will be insecure.
|
||||||
|
- When set to insecure I(tls) will be ignored.
|
||||||
|
choices:
|
||||||
|
- edge
|
||||||
|
- passthrough
|
||||||
|
- reencrypt
|
||||||
|
- insecure
|
||||||
|
default: insecure
|
||||||
|
type: str
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = r'''
|
||||||
|
- name: Create hello-world deployment
|
||||||
|
community.okd.k8s:
|
||||||
|
definition:
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
metadata:
|
||||||
|
name: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
spec:
|
||||||
|
replicas: 3
|
||||||
|
selector:
|
||||||
|
matchLabels:
|
||||||
|
app: hello-kubernetes
|
||||||
|
template:
|
||||||
|
metadata:
|
||||||
|
labels:
|
||||||
|
app: hello-kubernetes
|
||||||
|
spec:
|
||||||
|
containers:
|
||||||
|
- name: hello-kubernetes
|
||||||
|
image: paulbouwer/hello-kubernetes:1.8
|
||||||
|
ports:
|
||||||
|
- containerPort: 8080
|
||||||
|
|
||||||
|
- name: Create Service for the hello-world deployment
|
||||||
|
community.okd.k8s:
|
||||||
|
definition:
|
||||||
|
apiVersion: v1
|
||||||
|
kind: Service
|
||||||
|
metadata:
|
||||||
|
name: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
spec:
|
||||||
|
ports:
|
||||||
|
- port: 80
|
||||||
|
targetPort: 8080
|
||||||
|
selector:
|
||||||
|
app: hello-kubernetes
|
||||||
|
|
||||||
|
- name: Expose the insecure hello-world service externally
|
||||||
|
community.okd.openshift_route:
|
||||||
|
service: hello-kubernetes
|
||||||
|
namespace: default
|
||||||
|
insecure_policy: allow
|
||||||
|
register: route
|
||||||
|
'''
|
||||||
|
|
||||||
|
RETURN = r'''
|
||||||
|
result:
|
||||||
|
description:
|
||||||
|
- The Route object that was created or updated. Will be empty in the case of deletion.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
apiVersion:
|
||||||
|
description: The versioned schema of this representation of an object.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
kind:
|
||||||
|
description: Represents the REST resource this object represents.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
metadata:
|
||||||
|
description: Standard object metadata. Includes name, namespace, annotations, labels, etc.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
name:
|
||||||
|
description: The name of the created Route
|
||||||
|
type: str
|
||||||
|
namespace:
|
||||||
|
description: The namespace of the create Route
|
||||||
|
type: str
|
||||||
|
spec:
|
||||||
|
description: Specification for the Route
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
host:
|
||||||
|
description: Host is an alias/DNS that points to the service.
|
||||||
|
type: str
|
||||||
|
path:
|
||||||
|
description: Path that the router watches for, to route traffic for to the service.
|
||||||
|
type: str
|
||||||
|
port:
|
||||||
|
description: Defines a port mapping from a router to an endpoint in the service endpoints.
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
targetPort:
|
||||||
|
description: The target port on pods selected by the service this route points to.
|
||||||
|
type: str
|
||||||
|
tls:
|
||||||
|
description: Defines config used to secure a route and provide termination.
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
caCertificate:
|
||||||
|
description: Provides the cert authority certificate contents.
|
||||||
|
type: str
|
||||||
|
certificate:
|
||||||
|
description: Provides certificate contents.
|
||||||
|
type: str
|
||||||
|
destinationCACertificate:
|
||||||
|
description: Provides the contents of the ca certificate of the final destination.
|
||||||
|
type: str
|
||||||
|
insecureEdgeTerminationPolicy:
|
||||||
|
description: Indicates the desired behavior for insecure connections to a route.
|
||||||
|
type: str
|
||||||
|
key:
|
||||||
|
description: Provides key file contents.
|
||||||
|
type: str
|
||||||
|
termination:
|
||||||
|
description: Indicates termination type.
|
||||||
|
type: str
|
||||||
|
to:
|
||||||
|
description: Specifies the target that resolve into endpoints.
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
kind:
|
||||||
|
description: The kind of target that the route is referring to. Currently, only 'Service' is allowed.
|
||||||
|
type: str
|
||||||
|
name:
|
||||||
|
description: Name of the service/target that is being referred to. e.g. name of the service.
|
||||||
|
type: str
|
||||||
|
weight:
|
||||||
|
description: Specifies the target's relative weight against other target reference objects.
|
||||||
|
type: int
|
||||||
|
wildcardPolicy:
|
||||||
|
description: Wildcard policy if any for the route.
|
||||||
|
type: str
|
||||||
|
status:
|
||||||
|
description: Current status details for the Route
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
ingress:
|
||||||
|
description: List of places where the route may be exposed.
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
conditions:
|
||||||
|
description: Array of status conditions for the Route ingress.
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
type:
|
||||||
|
description: The type of the condition. Currently only 'Ready'.
|
||||||
|
type: str
|
||||||
|
status:
|
||||||
|
description: The status of the condition. Can be True, False, Unknown.
|
||||||
|
type: str
|
||||||
|
host:
|
||||||
|
description: The host string under which the route is exposed.
|
||||||
|
type: str
|
||||||
|
routerCanonicalHostname:
|
||||||
|
description: The external host name for the router that can be used as a CNAME for the host requested for this route. May not be set.
|
||||||
|
type: str
|
||||||
|
routerName:
|
||||||
|
description: A name chosen by the router to identify itself.
|
||||||
|
type: str
|
||||||
|
wildcardPolicy:
|
||||||
|
description: The wildcard policy that was allowed where this route is exposed.
|
||||||
|
type: str
|
||||||
|
duration:
|
||||||
|
description: elapsed time of task in seconds
|
||||||
|
returned: when C(wait) is true
|
||||||
|
type: int
|
||||||
|
sample: 48
|
||||||
|
'''
|
||||||
|
|
||||||
|
import copy
|
||||||
|
import traceback
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
from ansible.module_utils._text import to_native
|
||||||
|
|
||||||
|
try:
|
||||||
|
from ansible_collections.community.kubernetes.plugins.module_utils.common import (
|
||||||
|
K8sAnsibleMixin, AUTH_ARG_SPEC, WAIT_ARG_SPEC, COMMON_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 = WAIT_ARG_SPEC = COMMON_ARG_SPEC = {}
|
||||||
|
|
||||||
|
try:
|
||||||
|
from openshift.dynamic.exceptions import DynamicApiError, NotFoundError
|
||||||
|
except ImportError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class OpenShiftRoute(K8sAnsibleMixin):
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.module = AnsibleModule(
|
||||||
|
argument_spec=self.argspec,
|
||||||
|
supports_check_mode=True,
|
||||||
|
)
|
||||||
|
self.fail_json = self.module.fail_json
|
||||||
|
|
||||||
|
if not HAS_KUBERNETES_COLLECTION:
|
||||||
|
self.module.fail_json(
|
||||||
|
msg="The community.kubernetes collection must be installed",
|
||||||
|
exception=K8S_COLLECTION_ERROR,
|
||||||
|
error=to_native(k8s_collection_import_exception)
|
||||||
|
)
|
||||||
|
|
||||||
|
super(OpenShiftRoute, self).__init__()
|
||||||
|
|
||||||
|
self.params = self.module.params
|
||||||
|
# TODO: should probably make it so that at least some of these aren't required for perform_action to work
|
||||||
|
# Or at least explicitly pass them in
|
||||||
|
self.append_hash = False
|
||||||
|
self.apply = False
|
||||||
|
self.check_mode = self.module.check_mode
|
||||||
|
self.warnings = []
|
||||||
|
self.params['merge_type'] = None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def argspec(self):
|
||||||
|
spec = copy.deepcopy(AUTH_ARG_SPEC)
|
||||||
|
spec.update(copy.deepcopy(WAIT_ARG_SPEC))
|
||||||
|
spec.update(copy.deepcopy(COMMON_ARG_SPEC))
|
||||||
|
|
||||||
|
spec['service'] = dict(type='str', aliases=['svc'])
|
||||||
|
spec['namespace'] = dict(required=True, type='str')
|
||||||
|
spec['labels'] = dict(type='dict')
|
||||||
|
spec['name'] = dict(type='str')
|
||||||
|
spec['hostname'] = dict(type='str')
|
||||||
|
spec['path'] = dict(type='str')
|
||||||
|
spec['wildcard_policy'] = dict(choices=['Subdomain'], type='str')
|
||||||
|
spec['port'] = dict(type='str')
|
||||||
|
spec['tls'] = dict(type='dict', options=dict(
|
||||||
|
ca_certificate=dict(type='str'),
|
||||||
|
certificate=dict(type='str'),
|
||||||
|
destination_ca_certificate=dict(type='str'),
|
||||||
|
key=dict(type='str'),
|
||||||
|
insecure_policy=dict(type='str', choices=['allow', 'redirect', 'disallow'], default='disallow'),
|
||||||
|
))
|
||||||
|
spec['termination'] = dict(choices=['edge', 'passthrough', 'reencrypt', 'insecure'], default='insecure')
|
||||||
|
|
||||||
|
return spec
|
||||||
|
|
||||||
|
def execute_module(self):
|
||||||
|
self.client = self.get_api_client()
|
||||||
|
v1_routes = self.find_resource('Route', 'route.openshift.io/v1', fail=True)
|
||||||
|
|
||||||
|
service_name = self.params.get('service')
|
||||||
|
namespace = self.params['namespace']
|
||||||
|
termination_type = self.params.get('termination')
|
||||||
|
if termination_type == 'insecure':
|
||||||
|
termination_type = None
|
||||||
|
state = self.params.get('state')
|
||||||
|
|
||||||
|
if state != 'absent' and not service_name:
|
||||||
|
self.fail_json("If 'state' is not 'absent' then 'service' must be provided")
|
||||||
|
|
||||||
|
# We need to do something a little wonky to wait if the user doesn't supply a custom condition
|
||||||
|
custom_wait = self.params.get('wait') and not self.params.get('wait_condition') and state != 'absent'
|
||||||
|
if custom_wait:
|
||||||
|
# Don't use default wait logic in perform_action
|
||||||
|
self.params['wait'] = False
|
||||||
|
|
||||||
|
route_name = self.params.get('name') or service_name
|
||||||
|
labels = self.params.get('labels')
|
||||||
|
hostname = self.params.get('hostname')
|
||||||
|
path = self.params.get('path')
|
||||||
|
wildcard_policy = self.params.get('wildcard_policy')
|
||||||
|
port = self.params.get('port')
|
||||||
|
|
||||||
|
if termination_type and self.params.get('tls'):
|
||||||
|
tls_ca_cert = self.params['tls'].get('ca_certificate')
|
||||||
|
tls_cert = self.params['tls'].get('certificate')
|
||||||
|
tls_dest_ca_cert = self.params['tls'].get('destination_ca_certificate')
|
||||||
|
tls_key = self.params['tls'].get('key')
|
||||||
|
tls_insecure_policy = self.params['tls'].get('insecure_policy')
|
||||||
|
if tls_insecure_policy == 'disallow':
|
||||||
|
tls_insecure_policy = None
|
||||||
|
else:
|
||||||
|
tls_ca_cert = tls_cert = tls_dest_ca_cert = tls_key = tls_insecure_policy = None
|
||||||
|
|
||||||
|
route = {
|
||||||
|
'apiVersion': 'route.openshift.io/v1',
|
||||||
|
'kind': 'Route',
|
||||||
|
'metadata': {
|
||||||
|
'name': route_name,
|
||||||
|
'namespace': namespace,
|
||||||
|
'labels': labels,
|
||||||
|
},
|
||||||
|
'spec': {}
|
||||||
|
}
|
||||||
|
|
||||||
|
if state != 'absent':
|
||||||
|
route['spec'] = self.build_route_spec(
|
||||||
|
service_name, namespace,
|
||||||
|
port=port,
|
||||||
|
wildcard_policy=wildcard_policy,
|
||||||
|
hostname=hostname,
|
||||||
|
path=path,
|
||||||
|
termination_type=termination_type,
|
||||||
|
tls_insecure_policy=tls_insecure_policy,
|
||||||
|
tls_ca_cert=tls_ca_cert,
|
||||||
|
tls_cert=tls_cert,
|
||||||
|
tls_key=tls_key,
|
||||||
|
tls_dest_ca_cert=tls_dest_ca_cert,
|
||||||
|
)
|
||||||
|
|
||||||
|
result = self.perform_action(v1_routes, route)
|
||||||
|
timeout = self.params.get('wait_timeout')
|
||||||
|
sleep = self.params.get('wait_sleep')
|
||||||
|
if custom_wait:
|
||||||
|
success, result['result'], result['duration'] = self._wait_for(v1_routes, route_name, namespace, wait_predicate, sleep, timeout, state)
|
||||||
|
|
||||||
|
self.module.exit_json(**result)
|
||||||
|
|
||||||
|
def build_route_spec(self, service_name, namespace, port=None, wildcard_policy=None, hostname=None, path=None, termination_type=None,
|
||||||
|
tls_insecure_policy=None, tls_ca_cert=None, tls_cert=None, tls_key=None, tls_dest_ca_cert=None):
|
||||||
|
v1_services = self.find_resource('Service', 'v1', fail=True)
|
||||||
|
try:
|
||||||
|
target_service = v1_services.get(name=service_name, namespace=namespace)
|
||||||
|
except NotFoundError:
|
||||||
|
if not port:
|
||||||
|
self.module.fail_json(msg="You need to provide the 'port' argument when exposing a non-existent service")
|
||||||
|
target_service = None
|
||||||
|
except DynamicApiError as exc:
|
||||||
|
self.module.fail_json(msg='Failed to retrieve service to be exposed: {0}'.format(exc.body),
|
||||||
|
error=exc.status, status=exc.status, reason=exc.reason)
|
||||||
|
except Exception as exc:
|
||||||
|
self.module.fail_json(msg='Failed to retrieve service to be exposed: {0}'.format(to_native(exc)),
|
||||||
|
error='', status='', reason='')
|
||||||
|
|
||||||
|
route_spec = {
|
||||||
|
'tls': {},
|
||||||
|
'to': {
|
||||||
|
'kind': 'Service',
|
||||||
|
'name': service_name,
|
||||||
|
},
|
||||||
|
'port': {
|
||||||
|
'targetPort': self.set_port(target_service, port),
|
||||||
|
},
|
||||||
|
'wildcardPolicy': wildcard_policy
|
||||||
|
}
|
||||||
|
|
||||||
|
# Want to conditionally add these so we don't overwrite what is automically added when nothing is provided
|
||||||
|
if termination_type:
|
||||||
|
route_spec['tls'] = dict(termination=termination_type.capitalize())
|
||||||
|
if tls_insecure_policy:
|
||||||
|
if termination_type == 'edge':
|
||||||
|
route_spec['tls']['insecureEdgeTerminationPolicy'] = tls_insecure_policy.capitalize()
|
||||||
|
elif termination_type == 'passthrough':
|
||||||
|
if tls_insecure_policy != 'redirect':
|
||||||
|
self.module.fail_json("'redirect' is the only supported insecureEdgeTerminationPolicy for passthrough routes")
|
||||||
|
route_spec['tls']['insecureEdgeTerminationPolicy'] = tls_insecure_policy.capitalize()
|
||||||
|
elif termination_type == 'reencrypt':
|
||||||
|
self.module.fail_json("'tls.insecure_policy' is not supported with reencrypt routes")
|
||||||
|
else:
|
||||||
|
route_spec['tls']['insecureEdgeTerminationPolicy'] = None
|
||||||
|
if tls_ca_cert:
|
||||||
|
if termination_type == 'passthrough':
|
||||||
|
self.module.fail_json("'tls.ca_certificate' is not supported with passthrough routes")
|
||||||
|
route_spec['tls']['caCertificate'] = tls_ca_cert
|
||||||
|
if tls_cert:
|
||||||
|
if termination_type == 'passthrough':
|
||||||
|
self.module.fail_json("'tls.certificate' is not supported with passthrough routes")
|
||||||
|
route_spec['tls']['certificate'] = tls_cert
|
||||||
|
if tls_key:
|
||||||
|
if termination_type == 'passthrough':
|
||||||
|
self.module.fail_json("'tls.key' is not supported with passthrough routes")
|
||||||
|
route_spec['tls']['key'] = tls_key
|
||||||
|
if tls_dest_ca_cert:
|
||||||
|
if termination_type != 'reencrypt':
|
||||||
|
self.module.fail_json("'destination_certificate' is only valid for reencrypt routes")
|
||||||
|
route_spec['tls']['destinationCACertificate'] = tls_dest_ca_cert
|
||||||
|
else:
|
||||||
|
route_spec['tls'] = None
|
||||||
|
if hostname:
|
||||||
|
route_spec['host'] = hostname
|
||||||
|
if path:
|
||||||
|
route_spec['path'] = path
|
||||||
|
|
||||||
|
return route_spec
|
||||||
|
|
||||||
|
def set_port(self, service, port_arg):
|
||||||
|
if port_arg:
|
||||||
|
return port_arg
|
||||||
|
for p in service.spec.ports:
|
||||||
|
if p.protocol == 'TCP':
|
||||||
|
if p.name is not None:
|
||||||
|
return p.name
|
||||||
|
return p.targetPort
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def wait_predicate(route):
|
||||||
|
if not(route.status and route.status.ingress):
|
||||||
|
return False
|
||||||
|
for ingress in route.status.ingress:
|
||||||
|
match = [x for x in ingress.conditions if x.type == 'Admitted']
|
||||||
|
if not match:
|
||||||
|
return False
|
||||||
|
match = match[0]
|
||||||
|
if match.status != "True":
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
OpenShiftRoute().execute_module()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
@@ -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/modules/k8s.py validate-modules:return-syntax-error
|
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/modules/k8s.py validate-modules:return-syntax-error
|
plugins/modules/k8s.py validate-modules:return-syntax-error
|
||||||
|
plugins/modules/openshift_process.py validate-modules:parameter-type-not-in-doc
|
||||||
|
|||||||
@@ -1 +1,2 @@
|
|||||||
plugins/modules/k8s.py validate-modules:parameter-type-not-in-doc
|
plugins/modules/k8s.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