mirror of
https://github.com/openshift/community.okd.git
synced 2026-11-22 07:00:26 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d7a8ba15c7 | ||
|
|
9ff94989ae | ||
|
|
f60ded17b0 | ||
|
|
37833d4316 | ||
|
|
4609c20a91 | ||
|
|
63deaeecf0 | ||
|
|
d696fcaa06 | ||
|
|
7e653aee65 | ||
|
|
dd2ed851ab | ||
|
|
c5f822a0a7 | ||
|
|
748d40d244 | ||
|
|
152c6e42c5 | ||
|
|
74ce4c31ae | ||
|
|
ac86a8900c | ||
|
|
fb1912728d | ||
|
|
22f878023a | ||
|
|
921c451f0d | ||
|
|
e7e114743c | ||
|
|
ef6712c8f6 | ||
|
|
570a8ccd27 | ||
|
|
d76430d879 | ||
|
|
2b51c229ad | ||
|
|
d197d28cd1 | ||
|
|
5361c9322e | ||
|
|
6c1dc79c7f | ||
|
|
4cfbde3d14 | ||
|
|
56e39540a0 | ||
|
|
2d71c469bd | ||
|
|
87cd174b96 | ||
|
|
32a6a1fda3 | ||
|
|
775312c037 |
@@ -24,13 +24,11 @@ jobs:
|
|||||||
ansible:
|
ansible:
|
||||||
- stable-2.9
|
- stable-2.9
|
||||||
- stable-2.10
|
- stable-2.10
|
||||||
|
- stable-2.11
|
||||||
- devel
|
- devel
|
||||||
python:
|
python:
|
||||||
- 2.7
|
|
||||||
- 3.7
|
- 3.7
|
||||||
- 3.8
|
- 3.8
|
||||||
exclude:
|
|
||||||
- python: 3.8 # blocked by ansible/ansible#70155
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Check out code
|
- name: Check out code
|
||||||
@@ -49,75 +47,22 @@ jobs:
|
|||||||
|
|
||||||
# run ansible-test sanity inside of Docker.
|
# run ansible-test sanity inside of Docker.
|
||||||
# The docker container has all the pinned dependencies that are required.
|
# The docker container has all the pinned dependencies that are required.
|
||||||
# Explicity specify the version of Python we want to test
|
# Explicitly specify the version of Python we want to test
|
||||||
- name: Run sanity tests
|
- name: Run sanity tests
|
||||||
run: make upstream-test-sanity TEST_ARGS='--python ${{ matrix.python }}'
|
run: make upstream-test-sanity PYTHON_VERSION='${{ matrix.python }}'
|
||||||
working-directory: ./ansible_collections/community/okd
|
working-directory: ./ansible_collections/community/okd
|
||||||
|
|
||||||
###
|
|
||||||
# Integration tests (RECOMMENDED)
|
|
||||||
#
|
|
||||||
# https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html
|
|
||||||
|
|
||||||
# integration:
|
|
||||||
# runs-on: ubuntu-latest
|
|
||||||
# name: Integration (Ⓐ${{ matrix.ansible }}+py${{ matrix.python }}})
|
|
||||||
# strategy:
|
|
||||||
# fail-fast: false
|
|
||||||
# matrix:
|
|
||||||
# ansible:
|
|
||||||
# - stable-2.9
|
|
||||||
# - stable-2.10
|
|
||||||
# - devel
|
|
||||||
# python:
|
|
||||||
# - 2.7
|
|
||||||
# - 3.7
|
|
||||||
# - 3.8
|
|
||||||
# exclude:
|
|
||||||
# - python: 3.8 # blocked by ansible/ansible#70155
|
|
||||||
|
|
||||||
# steps:
|
|
||||||
# - name: Check out code
|
|
||||||
# uses: actions/checkout@v2
|
|
||||||
# with:
|
|
||||||
# path: ansible_collections/community/okd
|
|
||||||
|
|
||||||
# - name: Set up Python ${{ matrix.ansible }}
|
|
||||||
# uses: actions/setup-python@v2
|
|
||||||
# with:
|
|
||||||
# python-version: ${{ matrix.python }}
|
|
||||||
|
|
||||||
# - name: Install ansible-base (${{ matrix.ansible }})
|
|
||||||
# run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
|
|
||||||
|
|
||||||
# # OPTIONAL If your integration test requires Python libraries or modules from other collections
|
|
||||||
# # Install them like this
|
|
||||||
# - name: Install collection dependencies
|
|
||||||
# run: ansible-galaxy collection install community.kubernetes -p .
|
|
||||||
|
|
||||||
# # Run the integration tests
|
|
||||||
# - name: Run integration test
|
|
||||||
# run: ansible-test integration -v --color --retry-on-error --continue-on-error --diff --python ${{ matrix.python }} --docker --coverage
|
|
||||||
# working-directory: ./ansible_collections/community/okd
|
|
||||||
|
|
||||||
# # ansible-test support producing code coverage date
|
|
||||||
# - name: Generate coverage report
|
|
||||||
# run: ansible-test coverage xml -v --requirements --group-by command --group-by version
|
|
||||||
# working-directory: ./ansible_collections/community/okd
|
|
||||||
|
|
||||||
# # See the reports at https://codecov.io/gh/ansible_collections/GITHUBORG/REPONAME
|
|
||||||
# - uses: codecov/codecov-action@v1
|
|
||||||
# with:
|
|
||||||
# fail_ci_if_error: false
|
|
||||||
#
|
|
||||||
downstream-sanity-29:
|
downstream-sanity-29:
|
||||||
name: Sanity (Ⓐ${{ matrix.ansible }}+py${{ matrix.python }})
|
name: Downstream Sanity (Ⓐ${{ matrix.ansible }}+py${{ matrix.python }})
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
ansible:
|
ansible:
|
||||||
- stable-2.9
|
- stable-2.9
|
||||||
|
- stable-2.10
|
||||||
|
- stable-2.11
|
||||||
python:
|
python:
|
||||||
- 3.6
|
- 3.7
|
||||||
|
- 3.8
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Check out code
|
- name: Check out code
|
||||||
@@ -130,12 +75,13 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
python-version: ${{ matrix.python }}
|
python-version: ${{ matrix.python }}
|
||||||
|
|
||||||
- name: Install ansible 2.9
|
# Install the head of the given branch (devel, stable-2.10)
|
||||||
run: pip install "ansible>=2.9.0,<2.10.0"
|
- name: Install ansible-base (${{ matrix.ansible }})
|
||||||
|
run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
|
||||||
|
|
||||||
# run ansible-test sanity inside of Docker.
|
# run ansible-test sanity inside of Docker.
|
||||||
# The docker container has all the pinned dependencies that are required.
|
# The docker container has all the pinned dependencies that are required.
|
||||||
# Explicity specify the version of Python we want to test
|
# Explicitly specify the version of Python we want to test
|
||||||
- name: Run sanity tests
|
- name: Run sanity tests
|
||||||
run: make downstream-test-sanity
|
run: make downstream-test-sanity PYTHON_VERSION='${{ matrix.python }}'
|
||||||
working-directory: ./ansible_collections/community/okd
|
working-directory: ./ansible_collections/community/okd
|
||||||
|
|||||||
@@ -5,6 +5,74 @@ OKD Collection Release Notes
|
|||||||
.. contents:: Topics
|
.. contents:: Topics
|
||||||
|
|
||||||
|
|
||||||
|
v2.0.0
|
||||||
|
======
|
||||||
|
|
||||||
|
Major Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- update to use kubernetes.core 2.0 (https://github.com/openshift/community.okd/pull/93).
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Added documentation for the ``community.okd`` collection.
|
||||||
|
- openshift - inventory plugin supports FQCN ``redhat.openshift``.
|
||||||
|
|
||||||
|
Breaking Changes / Porting Guide
|
||||||
|
--------------------------------
|
||||||
|
|
||||||
|
- drop python 2 support (https://github.com/openshift/community.okd/pull/93).
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- fixes test suite to use correct versions of python and dependencies (https://github.com/ansible-collections/community.okd/pull/89).
|
||||||
|
- openshift_process - fix module execution when template does not include a message (https://github.com/ansible-collections/community.okd/pull/87).
|
||||||
|
|
||||||
|
v1.1.2
|
||||||
|
======
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- include requirements.txt in downstream build process (https://github.com/ansible-collections/community.okd/pull/81).
|
||||||
|
|
||||||
|
v1.1.1
|
||||||
|
======
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- add missing requirements.txt file needed for execution environments (https://github.com/ansible-collections/community.okd/pull/78).
|
||||||
|
- openshift_route - default to ``no_log=False`` for the ``key`` parameter in TLS configuration to fix sanity failures (https://github.com/ansible-collections/community.okd/pull/77).
|
||||||
|
- restrict molecule version to <3.3.0 to address breaking change (https://github.com/ansible-collections/community.okd/pull/77).
|
||||||
|
- update CI to work with ansible 2.11 (https://github.com/ansible-collections/community.okd/pull/80).
|
||||||
|
|
||||||
|
v1.1.0
|
||||||
|
======
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- increase the kubernetes.core dependency version number (https://github.com/ansible-collections/community.okd/pull/71).
|
||||||
|
|
||||||
|
v1.0.2
|
||||||
|
======
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- restrict the version of kubernetes.core dependency (https://github.com/ansible-collections/community.okd/pull/66).
|
||||||
|
|
||||||
|
v1.0.1
|
||||||
|
======
|
||||||
|
|
||||||
|
Bugfixes
|
||||||
|
--------
|
||||||
|
|
||||||
|
- Generate downstream redhat.openshift documentation (https://github.com/ansible-collections/community.okd/pull/59).
|
||||||
|
|
||||||
v1.0.0
|
v1.0.0
|
||||||
======
|
======
|
||||||
|
|
||||||
|
|||||||
+3
-3
@@ -48,7 +48,7 @@ Where modules have multiple parameters we recommend running through the 4-step m
|
|||||||
|
|
||||||
For general information on running the integration tests see the
|
For general information on running the integration tests see the
|
||||||
[Integration Tests page of the Module Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/testing_integration.html#testing-integration),
|
[Integration Tests page of the Module Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/testing_integration.html#testing-integration),
|
||||||
especially the section on configuration for cloud tests. For questions about writing tests the Ansible Kubernetes community can be found on Freenode IRC as detailed below.
|
especially the section on configuration for cloud tests. For questions about writing tests the Ansible Kubernetes community can be found on Libera.Chat IRC as detailed below.
|
||||||
|
|
||||||
|
|
||||||
### Code of Conduct
|
### Code of Conduct
|
||||||
@@ -58,8 +58,8 @@ Please read and familiarize yourself with this document.
|
|||||||
|
|
||||||
### IRC
|
### IRC
|
||||||
Our IRC channels may require you to register your nickname. If you receive an error when you connect, see
|
Our IRC channels may require you to register your nickname. If you receive an error when you connect, see
|
||||||
[Freenode's Nickname Registration guide](https://freenode.net/kb/answer/registration) for instructions.
|
[Libera.Chat's Nickname Registration guide](https://libera.chat/guides/registration) for instructions.
|
||||||
|
|
||||||
The `#ansible-kubernetes` channel on Freenode IRC is the main and official place to discuss use and development of the `community.okd` collection.
|
The `#ansible-kubernetes` channel on [irc.libera.chat](https://libera.chat/) is the main and official place to discuss use and development of the `community.okd` collection.
|
||||||
|
|
||||||
For more information about Ansible's Kubernetes and OpenShift integration, browse the resources in the [Kubernetes Working Group](https://github.com/ansible/community/wiki/Kubernetes) Community wiki page.
|
For more information about Ansible's Kubernetes and OpenShift integration, browse the resources in the [Kubernetes Working Group](https://github.com/ansible/community/wiki/Kubernetes) Community wiki page.
|
||||||
|
|||||||
@@ -1,37 +1,38 @@
|
|||||||
|
.PHONY: molecule
|
||||||
|
|
||||||
# Also needs to be updated in galaxy.yml
|
# Also needs to be updated in galaxy.yml
|
||||||
VERSION = 1.0.0
|
VERSION = 2.0.0
|
||||||
|
|
||||||
# To run sanity tests in a venv, set SANITY_TEST_ARGS to '--venv'
|
|
||||||
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]))'`
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
rm -f community-okd-$(VERSION).tar.gz
|
rm -f community-okd-$(VERSION).tar.gz
|
||||||
|
rm -f redhat-openshift-$(VERSION).tar.gz
|
||||||
rm -rf ansible_collections
|
rm -rf ansible_collections
|
||||||
|
|
||||||
build: clean
|
build: clean
|
||||||
ansible-galaxy collection build
|
ansible-galaxy collection build
|
||||||
|
|
||||||
install-kubernetes-src:
|
install: build
|
||||||
mkdir -p ansible_collections/community/kubernetes
|
|
||||||
rm -rf ansible_collections/community/kubernetes/*
|
|
||||||
curl -L https://github.com/ansible-collections/community.kubernetes/archive/main.tar.gz | tar -xz -C ansible_collections/community/kubernetes --strip-components 1
|
|
||||||
|
|
||||||
# TODO: Once we no longer rely on features in main we should drop the install-kubernetes-src dependency
|
|
||||||
install: build install-kubernetes-src
|
|
||||||
ansible-galaxy collection install -p ansible_collections community-okd-$(VERSION).tar.gz
|
ansible-galaxy collection install -p ansible_collections community-okd-$(VERSION).tar.gz
|
||||||
|
|
||||||
|
sanity: install
|
||||||
|
cd ansible_collections/community/okd && ansible-test sanity -v --python $(PYTHON_VERSION) $(SANITY_TEST_ARGS)
|
||||||
|
|
||||||
|
molecule: install
|
||||||
|
molecule test
|
||||||
|
|
||||||
|
test-integration: upstream-test-integration downstream-test-integration
|
||||||
|
|
||||||
|
test-sanity: upstream-test-sanity downstream-test-sanity
|
||||||
|
|
||||||
test-integration-incluster:
|
test-integration-incluster:
|
||||||
./ci/incluster_integration.sh
|
./ci/incluster_integration.sh
|
||||||
|
|
||||||
test-sanity: upstream-test-sanity downstream-test-sanity
|
upstream-test-sanity: sanity
|
||||||
|
|
||||||
test-integration: upstream-test-integration downstream-test-integration
|
upstream-test-integration: molecule
|
||||||
|
|
||||||
upstream-test-integration: install
|
|
||||||
molecule test
|
|
||||||
|
|
||||||
upstream-test-sanity: install
|
|
||||||
cd ansible_collections/community/okd && ansible-test sanity --exclude ci/ -v $(SANITY_TEST_ARGS)
|
|
||||||
|
|
||||||
downstream-test-sanity:
|
downstream-test-sanity:
|
||||||
./ci/downstream.sh -s
|
./ci/downstream.sh -s
|
||||||
|
|||||||
@@ -1,12 +1,10 @@
|
|||||||
approvers:
|
approvers:
|
||||||
- geerlingguy
|
- gravesm
|
||||||
- fabianvf
|
|
||||||
- maxamillion
|
|
||||||
- akasurde
|
- akasurde
|
||||||
|
- fabianvf
|
||||||
- tima
|
- tima
|
||||||
reviewers:
|
reviewers:
|
||||||
- geerlingguy
|
- gravesm
|
||||||
- fabianvf
|
|
||||||
- maxamillion
|
|
||||||
- akasurde
|
- akasurde
|
||||||
|
- fabianvf
|
||||||
- tima
|
- tima
|
||||||
|
|||||||
@@ -1,26 +1,48 @@
|
|||||||
# OKD/OpenShift Collection for Ansible
|
# OKD Collection for Ansible
|
||||||
|
|
||||||
|
<!--- STARTREMOVE --->
|
||||||
[](https://github.com/ansible-collections/community.okd/actions) [](https://codecov.io/gh/ansible-collections/community.okd)
|
[](https://github.com/ansible-collections/community.okd/actions) [](https://codecov.io/gh/ansible-collections/community.okd)
|
||||||
|
|
||||||
This repo hosts the `community.okd` Ansible Collection.
|
This repo hosts the `community.okd` Ansible Collection.
|
||||||
|
|
||||||
The collection includes a variety of Ansible content to help automate the management of applications in OKD/OpenShift clusters, as well as the provisioning and maintenance of clusters themselves.
|
The collection includes a variety of Ansible content to help automate the management of applications in OKD clusters, as well as the provisioning and maintenance of clusters themselves.
|
||||||
|
|
||||||
|
<!--start requires_ansible-->
|
||||||
|
## Ansible version compatibility
|
||||||
|
|
||||||
|
This collection has been tested against following Ansible versions: **>=2.9.17**.
|
||||||
|
|
||||||
|
Plugins and modules within a collection may be tested with only specific Ansible versions.
|
||||||
|
A collection may contain metadata that identifies these versions.
|
||||||
|
PEP440 is the schema used to describe the versions of Ansible.
|
||||||
|
<!--end requires_ansible-->
|
||||||
|
|
||||||
## Included content
|
## Included content
|
||||||
|
|
||||||
Click on the name of a plugin or module to view that content's documentation:
|
Click on the name of a plugin or module to view that content's documentation:
|
||||||
|
|
||||||
- **Connection Plugins**:
|
<!--start collection content-->
|
||||||
- [oc](https://docs.ansible.com/ansible/2.10/collections/community/general/oc_connection.html)
|
### Connection plugins
|
||||||
- **Inventory Plugins**:
|
Name | Description
|
||||||
- [openshift](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/openshift_inventory.html)
|
--- | ---
|
||||||
- **Modules**:
|
[community.okd.oc](https://github.com/ansible-collections/community.okd/blob/main/docs/community.okd.oc_connection.rst)|Execute tasks in pods running on OpenShift.
|
||||||
- [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_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**: Some of these documentation links currently link to older module versions. For the latest module documentation, please use `ansible-doc` in the CLI.
|
### Inventory plugins
|
||||||
|
Name | Description
|
||||||
|
--- | ---
|
||||||
|
[community.okd.openshift](https://github.com/ansible-collections/community.okd/blob/main/docs/community.okd.openshift_inventory.rst)|OpenShift inventory source
|
||||||
|
|
||||||
|
### Modules
|
||||||
|
Name | Description
|
||||||
|
--- | ---
|
||||||
|
[community.okd.k8s](https://github.com/ansible-collections/community.okd/blob/main/docs/community.okd.k8s_module.rst)|Manage OpenShift objects
|
||||||
|
[community.okd.openshift_auth](https://github.com/ansible-collections/community.okd/blob/main/docs/community.okd.openshift_auth_module.rst)|Authenticate to OpenShift clusters which require an explicit login step
|
||||||
|
[community.okd.openshift_process](https://github.com/ansible-collections/community.okd/blob/main/docs/community.okd.openshift_process_module.rst)|Process an OpenShift template.openshift.io/v1 Template
|
||||||
|
[community.okd.openshift_route](https://github.com/ansible-collections/community.okd/blob/main/docs/community.okd.openshift_route_module.rst)|Expose a Service as an OpenShift Route.
|
||||||
|
|
||||||
|
<!--end collection content-->
|
||||||
|
|
||||||
|
<!--- ENDREMOVE --->
|
||||||
|
|
||||||
## Installation and Usage
|
## Installation and Usage
|
||||||
|
|
||||||
@@ -36,14 +58,14 @@ You can also include it in a `requirements.yml` file and install it via `ansible
|
|||||||
---
|
---
|
||||||
collections:
|
collections:
|
||||||
- name: community.okd
|
- name: community.okd
|
||||||
version: 1.0.0
|
version: 2.0.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### Installing the OpenShift Python Library
|
### Installing the Kubernetes Python Library
|
||||||
|
|
||||||
Content in this collection requires the [OpenShift Python client](https://pypi.org/project/openshift/) to interact with Kubernetes' APIs. You can install it with:
|
Content in this collection requires the [Kubernetes Python client](https://pypi.org/project/kubernetes/) to interact with Kubernetes' APIs. You can install it with:
|
||||||
|
|
||||||
pip3 install openshift
|
pip3 install kubernetes
|
||||||
|
|
||||||
### Using modules from the OKD Collection in your playbooks
|
### Using modules from the OKD Collection in your playbooks
|
||||||
|
|
||||||
@@ -59,6 +81,7 @@ 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.
|
||||||
|
|
||||||
|
<!--- STARTREMOVE --->
|
||||||
## Testing and Development
|
## Testing and Development
|
||||||
|
|
||||||
If you want to develop new content for this collection or improve what's already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
|
If you want to develop new content for this collection or improve what's already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
|
||||||
@@ -115,10 +138,11 @@ Releases are automatically built and pushed to Ansible Galaxy for any new tag. B
|
|||||||
1. Tag the version in Git and push to GitHub.
|
1. Tag the version in Git and push to GitHub.
|
||||||
|
|
||||||
After the version is published, verify it exists on the [OKD Collection Galaxy page](https://galaxy.ansible.com/community/okd).
|
After the version is published, verify it exists on the [OKD Collection Galaxy page](https://galaxy.ansible.com/community/okd).
|
||||||
|
<!--- ENDREMOVE --->
|
||||||
|
|
||||||
## More Information
|
## More Information
|
||||||
|
|
||||||
For more information about Ansible's Kubernetes and OpenShift integrations, join the `#ansible-kubernetes` channel on Freenode IRC, and browse the resources in the [Kubernetes Working Group](https://github.com/ansible/community/wiki/Kubernetes) Community wiki page.
|
For more information about Ansible's Kubernetes and OpenShift integrations, join the `#ansible-kubernetes` channel on [libera.chat](https://libera.chat/) IRC, and browse the resources in the [Kubernetes Working Group](https://github.com/ansible/community/wiki/Kubernetes) Community wiki page.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
@@ -68,3 +68,64 @@ releases:
|
|||||||
fragments:
|
fragments:
|
||||||
- 51-redhat-openshift-ah-release.yml
|
- 51-redhat-openshift-ah-release.yml
|
||||||
release_date: '2020-11-12'
|
release_date: '2020-11-12'
|
||||||
|
1.0.1:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- Generate downstream redhat.openshift documentation (https://github.com/ansible-collections/community.okd/pull/59).
|
||||||
|
fragments:
|
||||||
|
- 59-downstream-docs.yml
|
||||||
|
release_date: '2020-11-17'
|
||||||
|
1.0.2:
|
||||||
|
changes:
|
||||||
|
minor_changes:
|
||||||
|
- restrict the version of kubernetes.core dependency (https://github.com/ansible-collections/community.okd/pull/66).
|
||||||
|
fragments:
|
||||||
|
- 66-restrict-kubernetes-core-version.yaml
|
||||||
|
release_date: '2021-02-19'
|
||||||
|
1.1.0:
|
||||||
|
changes:
|
||||||
|
minor_changes:
|
||||||
|
- increase the kubernetes.core dependency version number (https://github.com/ansible-collections/community.okd/pull/71).
|
||||||
|
fragments:
|
||||||
|
- 71-bump-kubernetes-core-version.yaml
|
||||||
|
release_date: '2021-02-23'
|
||||||
|
1.1.1:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- add missing requirements.txt file needed for execution environments (https://github.com/ansible-collections/community.okd/pull/78).
|
||||||
|
- openshift_route - default to ``no_log=False`` for the ``key`` parameter in
|
||||||
|
TLS configuration to fix sanity failures (https://github.com/ansible-collections/community.okd/pull/77).
|
||||||
|
- restrict molecule version to <3.3.0 to address breaking change (https://github.com/ansible-collections/community.okd/pull/77).
|
||||||
|
- update CI to work with ansible 2.11 (https://github.com/ansible-collections/community.okd/pull/80).
|
||||||
|
fragments:
|
||||||
|
- 77-fix-ci-failure.yaml
|
||||||
|
- 78-add-requirements-file.yaml
|
||||||
|
- 80-update-ci.yaml
|
||||||
|
release_date: '2021-04-06'
|
||||||
|
1.1.2:
|
||||||
|
changes:
|
||||||
|
bugfixes:
|
||||||
|
- include requirements.txt in downstream build process (https://github.com/ansible-collections/community.okd/pull/81).
|
||||||
|
fragments:
|
||||||
|
- 81-include-requirements.yaml
|
||||||
|
release_date: '2021-04-08'
|
||||||
|
2.0.0:
|
||||||
|
changes:
|
||||||
|
breaking_changes:
|
||||||
|
- drop python 2 support (https://github.com/openshift/community.okd/pull/93).
|
||||||
|
bugfixes:
|
||||||
|
- fixes test suite to use correct versions of python and dependencies (https://github.com/ansible-collections/community.okd/pull/89).
|
||||||
|
- openshift_process - fix module execution when template does not include a
|
||||||
|
message (https://github.com/ansible-collections/community.okd/pull/87).
|
||||||
|
major_changes:
|
||||||
|
- update to use kubernetes.core 2.0 (https://github.com/openshift/community.okd/pull/93).
|
||||||
|
minor_changes:
|
||||||
|
- Added documentation for the ``community.okd`` collection.
|
||||||
|
- openshift - inventory plugin supports FQCN ``redhat.openshift``.
|
||||||
|
fragments:
|
||||||
|
- 87-openshift_process-fix-template-without-message.yaml
|
||||||
|
- 89-clean-up-ci.yaml
|
||||||
|
- 93-update-to-k8s-2.yaml
|
||||||
|
- add_docs.yml
|
||||||
|
- fqcn_inventory.yml
|
||||||
|
release_date: '2021-06-22'
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ changelog_filename_template: ../CHANGELOG.rst
|
|||||||
changelog_filename_version_depth: 0
|
changelog_filename_version_depth: 0
|
||||||
changes_file: changelog.yaml
|
changes_file: changelog.yaml
|
||||||
changes_format: combined
|
changes_format: combined
|
||||||
keep_fragments: true
|
keep_fragments: false
|
||||||
mention_ancestor: true
|
mention_ancestor: true
|
||||||
new_plugins_after_name: removed_features
|
new_plugins_after_name: removed_features
|
||||||
notesdir: fragments
|
notesdir: fragments
|
||||||
|
|||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
major_changes:
|
|
||||||
- Initial content migration from community.kubernetes (https://github.com/ansible-collections/community.okd/pull/3).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
minor_changes:
|
|
||||||
- Dockerfile now is properly set up to run tests in a rootless container (https://github.com/ansible-collections/community.okd/pull/11).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
minor_changes:
|
|
||||||
- Docker container can run as an arbitrary user (https://github.com/ansible-collections/community.okd/pull/12).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
minor_changes:
|
|
||||||
- Add incluster Makefile target for CI (https://github.com/ansible-collections/community.okd/pull/13).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
minor_changes:
|
|
||||||
- CI Documentation for working with Prow (https://github.com/ansible-collections/community.okd/pull/15).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
minor_changes:
|
|
||||||
- Add tests for inventory plugin (https://github.com/ansible-collections/community.okd/pull/16).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
major_changes:
|
|
||||||
- Add openshift connection plugin, update inventory plugin to use it (https://github.com/ansible-collections/community.okd/pull/18).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
major_changes:
|
|
||||||
- Add downstream build scripts to build redhat.openshift (https://github.com/ansible-collections/community.okd/pull/20).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
minor_changes:
|
|
||||||
- Use the API Group APIVersion for the `Route` object (https://github.com/ansible-collections/community.okd/pull/27).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
major_changes:
|
|
||||||
- openshift_auth - new module (migrated from k8s_auth in community.kubernetes) (https://github.com/ansible-collections/community.okd/pull/33).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
minor_changes:
|
|
||||||
- Add a contribution guide (https://github.com/ansible-collections/community.okd/pull/37).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
major_changes:
|
|
||||||
- Add openshift_route module for creating routes from services (https://github.com/ansible-collections/community.okd/pull/40).
|
|
||||||
@@ -1,3 +0,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).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
minor_changes:
|
|
||||||
- Released version 1 to Automation Hub as redhat.openshift (https://github.com/ansible-collections/community.okd/issues/51).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
major_changes:
|
|
||||||
- Add custom k8s module, integrate better Molecule tests (https://github.com/ansible-collections/community.okd/pull/7).
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
---
|
|
||||||
minor_changes:
|
|
||||||
- Integrate stale bot for issue queue maintenance (https://github.com/ansible-collections/community.okd/pull/14).
|
|
||||||
+2
-2
@@ -16,9 +16,9 @@ RUN yum install -y \
|
|||||||
python3-setuptools \
|
python3-setuptools \
|
||||||
&& pip3 install --no-cache-dir --upgrade setuptools pip \
|
&& pip3 install --no-cache-dir --upgrade setuptools pip \
|
||||||
&& pip3 install --no-cache-dir \
|
&& pip3 install --no-cache-dir \
|
||||||
openshift \
|
kubernetes \
|
||||||
ansible==2.9.* \
|
ansible==2.9.* \
|
||||||
molecule \
|
"molecule<3.3.0" \
|
||||||
&& yum clean all \
|
&& yum clean all \
|
||||||
&& rm -rf $HOME/.cache \
|
&& rm -rf $HOME/.cache \
|
||||||
&& curl -L https://github.com/openshift/okd/releases/download/4.5.0-0.okd-2020-08-12-020541/openshift-client-linux-4.5.0-0.okd-2020-08-12-020541.tar.gz | tar -xz -C /usr/local/bin
|
&& curl -L https://github.com/openshift/okd/releases/download/4.5.0-0.okd-2020-08-12-020541/openshift-client-linux-4.5.0-0.okd-2020-08-12-020541.tar.gz | tar -xz -C /usr/local/bin
|
||||||
|
|||||||
+92
-65
@@ -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="1.0.0"
|
DOWNSTREAM_VERSION="2.0.0"
|
||||||
KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}"
|
KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}"
|
||||||
_build_dir=""
|
_build_dir=""
|
||||||
|
|
||||||
@@ -31,15 +31,23 @@ f_show_help()
|
|||||||
f_text_sub()
|
f_text_sub()
|
||||||
{
|
{
|
||||||
# Switch FQCN and dependent components
|
# Switch FQCN and dependent components
|
||||||
sed -i "s/community-okd/redhat-openshift/" "${_build_dir}/Makefile"
|
OKD_sed_files="${_build_dir}/README.md ${_build_dir}/CHANGELOG.rst ${_build_dir}/changelogs/config.yaml ${_build_dir}/ci/downstream.sh ${_build_dir}/galaxy.yml"
|
||||||
sed -i "s/community\/okd/redhat\/openshift/" "${_build_dir}/Makefile"
|
# shellcheck disable=SC2068
|
||||||
sed -i "s/^VERSION\:/VERSION: ${DOWNSTREAM_VERSION}/" "${_build_dir}/Makefile"
|
for okd_file in ${OKD_sed_files[@]}; do sed -i.bak "s/OKD/OpenShift/g" "${okd_file}"; done
|
||||||
sed -i "s/name\:.*$/name: openshift/" "${_build_dir}/galaxy.yml"
|
|
||||||
sed -i "s/namespace\:.*$/namespace: redhat/" "${_build_dir}/galaxy.yml"
|
sed -i.bak "s/============================/==================================/" "${_build_dir}/CHANGELOG.rst"
|
||||||
sed -i "s/Kubernetes/OpenShift/g" "${_build_dir}/galaxy.yml"
|
sed -i.bak "s/Ansible Galaxy/Automation Hub/" "${_build_dir}/README.md"
|
||||||
sed -i "s/^version\:.*$/version: ${DOWNSTREAM_VERSION}/" "${_build_dir}/galaxy.yml"
|
sed -i.bak "s/community-okd/redhat-openshift/" "${_build_dir}/Makefile"
|
||||||
find ${_build_dir} -type f -exec sed -i "s/community\.kubernetes/kubernetes\.core/g" {} \;
|
sed -i.bak "s/community\/okd/redhat\/openshift/" "${_build_dir}/Makefile"
|
||||||
find ${_build_dir} -type f -exec sed -i "s/community\.okd/redhat\.openshift/g" {} \;
|
sed -i.bak "s/^VERSION\:/VERSION: ${DOWNSTREAM_VERSION}/" "${_build_dir}/Makefile"
|
||||||
|
sed -i.bak "s/name\:.*$/name: openshift/" "${_build_dir}/galaxy.yml"
|
||||||
|
sed -i.bak "s/namespace\:.*$/namespace: redhat/" "${_build_dir}/galaxy.yml"
|
||||||
|
sed -i.bak "s/Kubernetes/OpenShift/g" "${_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"
|
||||||
|
|
||||||
|
find "${_build_dir}" -type f -exec sed -i.bak "s/community\.okd/redhat\.openshift/g" {} \;
|
||||||
|
find "${_build_dir}" -type f -name "*.bak" -delete
|
||||||
}
|
}
|
||||||
|
|
||||||
f_prep()
|
f_prep()
|
||||||
@@ -58,6 +66,8 @@ f_prep()
|
|||||||
Makefile
|
Makefile
|
||||||
setup.cfg
|
setup.cfg
|
||||||
.yamllint
|
.yamllint
|
||||||
|
requirements.txt
|
||||||
|
requirements.yml
|
||||||
)
|
)
|
||||||
|
|
||||||
# Directories to recursively copy downstream (relative repo root dir path)
|
# Directories to recursively copy downstream (relative repo root dir path)
|
||||||
@@ -70,9 +80,18 @@ f_prep()
|
|||||||
tests
|
tests
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Modules with inherited doc fragments from kubernetes.core that need
|
||||||
|
# rendering to deal with Galaxy/AH lack of functionality.
|
||||||
|
_doc_fragment_modules=(
|
||||||
|
k8s
|
||||||
|
openshift_process
|
||||||
|
openshift_route
|
||||||
|
)
|
||||||
|
|
||||||
# Temp build dir
|
|
||||||
|
# Temp build dir
|
||||||
_tmp_dir=$(mktemp -d)
|
_tmp_dir=$(mktemp -d)
|
||||||
|
_start_dir="${PWD}"
|
||||||
_build_dir="${_tmp_dir}/ansible_collections/redhat/openshift"
|
_build_dir="${_tmp_dir}/ansible_collections/redhat/openshift"
|
||||||
mkdir -p "${_build_dir}"
|
mkdir -p "${_build_dir}"
|
||||||
}
|
}
|
||||||
@@ -111,36 +130,55 @@ f_create_collection_dir_structure()
|
|||||||
do
|
do
|
||||||
cp -r "./${d_name}" "${_build_dir}/${d_name}"
|
cp -r "./${d_name}" "${_build_dir}/${d_name}"
|
||||||
done
|
done
|
||||||
for exclude_file in "${_file_exclude[@]}";
|
if [ -n "${_file_exclude:-}" ]; then
|
||||||
do
|
for exclude_file in "${_file_exclude[@]}";
|
||||||
if [[ -f "${_build_dir}/${exclude_file}" ]]; then
|
do
|
||||||
rm -f "${_build_dir}/${exclude_file}"
|
if [[ -f "${_build_dir}/${exclude_file}" ]]; then
|
||||||
fi
|
rm -f "${_build_dir}/${exclude_file}"
|
||||||
done
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
}
|
}
|
||||||
|
|
||||||
f_install_kubernetes_core_from_src()
|
f_handle_doc_fragments_workaround()
|
||||||
{
|
{
|
||||||
local community_k8s_tmpdir="${_tmp_dir}/community.kubernetes"
|
f_log_info "${FUNCNAME[0]}"
|
||||||
local install_collections_dir="${_tmp_dir}/ansible_collections"
|
local install_collections_dir="${_build_dir}/collections/"
|
||||||
mkdir -p "${community_k8s_tmpdir}"
|
local temp_fragments_json="${_tmp_dir}/fragments.json"
|
||||||
pushd "${_tmp_dir}"
|
local temp_start="${_tmp_dir}/startfile.txt"
|
||||||
# curl -L \
|
local temp_end="${_tmp_dir}/endfile.txt"
|
||||||
# https://github.com/ansible-collections/community.kubernetes/archive/main.tar.gz \
|
local rendered_fragments="./rendereddocfragments.txt"
|
||||||
# | tar -xz -C "${community_k8s_tmpdir}" --strip-components 1
|
|
||||||
# pushd "${community_k8s_tmpdir}"
|
|
||||||
# make downstream-build
|
|
||||||
# ansible-galaxy collection install -p "${install_collections_dir}" "${community_k8s_tmpdir}"/kubernetes-core-*.tar.gz
|
|
||||||
# popd
|
|
||||||
#popd
|
|
||||||
git clone https://github.com/ansible-collections/community.kubernetes "${community_k8s_tmpdir}"
|
|
||||||
pushd "${community_k8s_tmpdir}"
|
|
||||||
make downstream-build
|
|
||||||
ansible-galaxy collection install -p "${install_collections_dir}" "${community_k8s_tmpdir}"/kubernetes-core-*.tar.gz
|
|
||||||
popd
|
|
||||||
popd
|
|
||||||
}
|
|
||||||
|
|
||||||
|
# Build the collection, export docs, render them, stitch it all back together
|
||||||
|
pushd "${_build_dir}" || return
|
||||||
|
ansible-galaxy collection build
|
||||||
|
ansible-galaxy collection install -p "${install_collections_dir}" ./*.tar.gz
|
||||||
|
rm ./*.tar.gz
|
||||||
|
for doc_fragment_mod in "${_doc_fragment_modules[@]}"
|
||||||
|
do
|
||||||
|
local module_py="plugins/modules/${doc_fragment_mod}.py"
|
||||||
|
f_log_info "Processing doc fragments for ${module_py}"
|
||||||
|
# We need following variable for ansible-doc only
|
||||||
|
# shellcheck disable=SC2097,SC2098
|
||||||
|
ANSIBLE_COLLECTIONS_PATH="${install_collections_dir}" \
|
||||||
|
ANSIBLE_COLLECTIONS_PATHS="${ANSIBLE_COLLECTIONS_PATH}:${install_collections_dir}" \
|
||||||
|
ansible-doc -j "redhat.openshift.${doc_fragment_mod}" > "${temp_fragments_json}"
|
||||||
|
# FIXME: Check Python interpreter from environment variable to work with prow
|
||||||
|
if [ -e /usr/bin/python3.6 ]; then
|
||||||
|
PYTHON="/usr/bin/python3.6"
|
||||||
|
else
|
||||||
|
PYTHON="python"
|
||||||
|
fi
|
||||||
|
"${PYTHON}" "${_start_dir}/ci/downstream_fragments.py" "redhat.openshift.${doc_fragment_mod}" "${temp_fragments_json}"
|
||||||
|
sed -n '/STARTREMOVE/q;p' "${module_py}" > "${temp_start}"
|
||||||
|
sed '1,/ENDREMOVE/d' "${module_py}" > "${temp_end}"
|
||||||
|
cat "${temp_start}" "${rendered_fragments}" "${temp_end}" > "${module_py}"
|
||||||
|
done
|
||||||
|
rm -f "${rendered_fragments}"
|
||||||
|
rm -fr "${install_collections_dir}"
|
||||||
|
popd
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
f_copy_collection_to_working_dir()
|
f_copy_collection_to_working_dir()
|
||||||
{
|
{
|
||||||
@@ -155,6 +193,7 @@ f_common_steps()
|
|||||||
f_prep
|
f_prep
|
||||||
f_create_collection_dir_structure
|
f_create_collection_dir_structure
|
||||||
f_text_sub
|
f_text_sub
|
||||||
|
f_handle_doc_fragments_workaround
|
||||||
}
|
}
|
||||||
|
|
||||||
# Run the test sanity scanerio
|
# Run the test sanity scanerio
|
||||||
@@ -162,20 +201,15 @@ f_test_sanity_option()
|
|||||||
{
|
{
|
||||||
f_log_info "${FUNCNAME[0]}"
|
f_log_info "${FUNCNAME[0]}"
|
||||||
f_common_steps
|
f_common_steps
|
||||||
f_install_kubernetes_core_from_src
|
|
||||||
pushd "${_build_dir}" || return
|
pushd "${_build_dir}" || return
|
||||||
ansible-galaxy collection build
|
|
||||||
f_log_info "SANITY TEST PWD: ${PWD}"
|
|
||||||
## Can't do this because the upstream community.kubernetes dependency logic
|
|
||||||
## is bound as a Makefile dep to the test-sanity target
|
|
||||||
#SANITY_TEST_ARGS="--docker --color --python 3.6" make test-sanity
|
|
||||||
# Run tests in docker if available, venv otherwise
|
|
||||||
if command -v docker &> /dev/null
|
if command -v docker &> /dev/null
|
||||||
then
|
then
|
||||||
ansible-test sanity --docker -v --exclude ci/ --color --python 3.6
|
make sanity
|
||||||
else
|
else
|
||||||
ansible-test sanity --venv -v --exclude ci/ --color --python 3.6
|
SANITY_TEST_ARGS="--venv --color" make sanity
|
||||||
fi
|
fi
|
||||||
|
f_log_info "SANITY TEST PWD: ${PWD}"
|
||||||
|
make sanity
|
||||||
popd || return
|
popd || return
|
||||||
f_cleanup
|
f_cleanup
|
||||||
}
|
}
|
||||||
@@ -185,10 +219,9 @@ f_test_integration_option()
|
|||||||
{
|
{
|
||||||
f_log_info "${FUNCNAME[0]}"
|
f_log_info "${FUNCNAME[0]}"
|
||||||
f_common_steps
|
f_common_steps
|
||||||
f_install_kubernetes_core_from_src
|
|
||||||
pushd "${_build_dir}" || return
|
pushd "${_build_dir}" || return
|
||||||
f_log_info "INTEGRATION TEST WD: ${PWD}"
|
f_log_info "INTEGRATION TEST WD: ${PWD}"
|
||||||
OVERRIDE_COLLECTION_PATH="${_tmp_dir}" molecule test
|
make molecule
|
||||||
popd || return
|
popd || return
|
||||||
f_cleanup
|
f_cleanup
|
||||||
}
|
}
|
||||||
@@ -198,16 +231,10 @@ f_build_option()
|
|||||||
{
|
{
|
||||||
f_log_info "${FUNCNAME[0]}"
|
f_log_info "${FUNCNAME[0]}"
|
||||||
f_common_steps
|
f_common_steps
|
||||||
pushd "${_build_dir}" || return
|
pushd "${_build_dir}" || return
|
||||||
f_log_info "BUILD WD: ${PWD}"
|
f_log_info "BUILD WD: ${PWD}"
|
||||||
# FIXME
|
make build
|
||||||
# This doesn't work because we end up either recursively curl'ing
|
popd || return
|
||||||
# community.kubernetes and redoing the text replacement over and over
|
|
||||||
#
|
|
||||||
# make build
|
|
||||||
ansible-galaxy collection build
|
|
||||||
|
|
||||||
popd || return
|
|
||||||
f_copy_collection_to_working_dir
|
f_copy_collection_to_working_dir
|
||||||
f_cleanup
|
f_cleanup
|
||||||
}
|
}
|
||||||
@@ -222,19 +249,19 @@ fi
|
|||||||
while getopts ":sirb" option
|
while getopts ":sirb" option
|
||||||
do
|
do
|
||||||
case $option in
|
case $option in
|
||||||
s)
|
s)
|
||||||
f_test_sanity_option
|
f_test_sanity_option
|
||||||
;;
|
;;
|
||||||
i)
|
i)
|
||||||
f_test_integration_option
|
f_test_integration_option
|
||||||
;;
|
;;
|
||||||
r)
|
r)
|
||||||
f_release_option
|
f_release_option
|
||||||
;;
|
;;
|
||||||
b)
|
b)
|
||||||
f_build_option
|
f_build_option
|
||||||
;;
|
;;
|
||||||
*)
|
*)
|
||||||
printf "ERROR: Unimplemented option chosen.\n"
|
printf "ERROR: Unimplemented option chosen.\n"
|
||||||
f_show_help
|
f_show_help
|
||||||
f_exit 1
|
f_exit 1
|
||||||
|
|||||||
Executable
+28
@@ -0,0 +1,28 @@
|
|||||||
|
#!/usr/bin/env python
|
||||||
|
|
||||||
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
import json
|
||||||
|
import sys
|
||||||
|
import yaml
|
||||||
|
|
||||||
|
with open("./rendereddocfragments.txt", 'w') as df_fd:
|
||||||
|
with open(sys.argv[2], 'r') as fd:
|
||||||
|
json_docs = json.load(fd)
|
||||||
|
|
||||||
|
json_docs[sys.argv[1]]['doc'].pop('collection', '')
|
||||||
|
json_docs[sys.argv[1]]['doc'].pop('filename', '')
|
||||||
|
json_docs[sys.argv[1]]['doc'].pop('has_action', '')
|
||||||
|
|
||||||
|
df_fd.write("DOCUMENTATION = '''\n")
|
||||||
|
df_fd.write(yaml.dump(json_docs[sys.argv[1]]['doc'], default_flow_style=False))
|
||||||
|
df_fd.write("'''\n\n")
|
||||||
|
|
||||||
|
df_fd.write("EXAMPLES = '''\n")
|
||||||
|
df_fd.write(json_docs[sys.argv[1]]['examples'])
|
||||||
|
df_fd.write("'''\n\n")
|
||||||
|
|
||||||
|
df_fd.write("RETURN = '''\n")
|
||||||
|
df_fd.write(yaml.dump(json_docs[sys.argv[1]]['return'], default_flow_style=False))
|
||||||
|
df_fd.write("'''\n\n")
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash -eu
|
||||||
|
|
||||||
set -x
|
set -x
|
||||||
|
|
||||||
@@ -11,17 +11,18 @@ NAMESPACE=${NAMESPACE:-default}
|
|||||||
# and set the IMAGE_FORMAT environment variable so that it properly
|
# and set the IMAGE_FORMAT environment variable so that it properly
|
||||||
# resolves to your image. For example, quay.io/mynamespace/$component
|
# resolves to your image. For example, quay.io/mynamespace/$component
|
||||||
# would resolve to quay.io/mynamespace/molecule-test-runner
|
# would resolve to quay.io/mynamespace/molecule-test-runner
|
||||||
|
# shellcheck disable=SC2034
|
||||||
component='molecule-test-runner'
|
component='molecule-test-runner'
|
||||||
eval IMAGE=$IMAGE_FORMAT
|
eval IMAGE="$IMAGE_FORMAT"
|
||||||
|
|
||||||
PULL_POLICY=${PULL_POLICY:-IfNotPresent}
|
PULL_POLICY=${PULL_POLICY:-IfNotPresent}
|
||||||
|
|
||||||
if ! oc get namespace $NAMESPACE
|
if ! oc get namespace "$NAMESPACE"
|
||||||
then
|
then
|
||||||
oc create namespace $NAMESPACE
|
oc create namespace "$NAMESPACE"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
oc project $NAMESPACE
|
oc project "$NAMESPACE"
|
||||||
oc adm policy add-cluster-role-to-user cluster-admin -z default
|
oc adm policy add-cluster-role-to-user cluster-admin -z default
|
||||||
oc adm policy who-can create projectrequests
|
oc adm policy who-can create projectrequests
|
||||||
|
|
||||||
@@ -52,7 +53,7 @@ spec:
|
|||||||
EOF
|
EOF
|
||||||
|
|
||||||
function check_success {
|
function check_success {
|
||||||
oc wait --for=condition=complete job/molecule-integration-test --timeout 5s -n $NAMESPACE \
|
oc wait --for=condition=complete job/molecule-integration-test --timeout 5s -n "$NAMESPACE" \
|
||||||
&& oc logs job/molecule-integration-test \
|
&& oc logs job/molecule-integration-test \
|
||||||
&& echo "Molecule integration tests ran successfully" \
|
&& echo "Molecule integration tests ran successfully" \
|
||||||
&& return 0
|
&& return 0
|
||||||
@@ -60,7 +61,7 @@ function check_success {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function check_failure {
|
function check_failure {
|
||||||
oc wait --for=condition=failed job/molecule-integration-test --timeout 5s -n $NAMESPACE \
|
oc wait --for=condition=failed job/molecule-integration-test --timeout 5s -n "$NAMESPACE" \
|
||||||
&& oc logs job/molecule-integration-test \
|
&& oc logs job/molecule-integration-test \
|
||||||
&& echo "Molecule integration tests failed, see logs for more information..." \
|
&& echo "Molecule integration tests failed, see logs for more information..." \
|
||||||
&& return 0
|
&& return 0
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,315 @@
|
|||||||
|
.. _community.okd.oc_connection:
|
||||||
|
|
||||||
|
|
||||||
|
****************
|
||||||
|
community.okd.oc
|
||||||
|
****************
|
||||||
|
|
||||||
|
**Execute tasks in pods running on OpenShift.**
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
:local:
|
||||||
|
:depth: 1
|
||||||
|
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
--------
|
||||||
|
- Use the oc exec command to run tasks in, or put/fetch files to, pods running on the OpenShift container platform.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
The below requirements are needed on the local Ansible controller node that executes this connection.
|
||||||
|
|
||||||
|
- oc (go binary)
|
||||||
|
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table border=0 cellpadding=0 class="documentation-table">
|
||||||
|
<tr>
|
||||||
|
<th colspan="1">Parameter</th>
|
||||||
|
<th>Choices/<font color="blue">Defaults</font></th>
|
||||||
|
<th>Configuration</th>
|
||||||
|
<th width="100%">Comments</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>ca_cert</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_SSL_CA_CERT</div>
|
||||||
|
<div>var: ansible_oc_ssl_ca_cert</div>
|
||||||
|
<div>var: ansible_oc_ca_cert</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a CA certificate used to authenticate with the API.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: oc_ssl_ca_cert</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>client_cert</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_CERT_FILE</div>
|
||||||
|
<div>var: ansible_oc_cert_file</div>
|
||||||
|
<div>var: ansible_oc_client_cert</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a certificate used to authenticate with the API.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: oc_cert_file</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>client_key</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_KEY_FILE</div>
|
||||||
|
<div>var: ansible_oc_key_file</div>
|
||||||
|
<div>var: ansible_oc_client_key</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a key file used to authenticate with the API.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: oc_key_file</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>oc_container</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_CONTAINER</div>
|
||||||
|
<div>var: ansible_oc_container</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Container name. Required when a pod contains more than one container.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>oc_context</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_CONTEXT</div>
|
||||||
|
<div>var: ansible_oc_context</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>The name of a context found in the K8s config file.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>oc_extra_args</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_EXTRA_ARGS</div>
|
||||||
|
<div>var: ansible_oc_extra_args</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Extra arguments to pass to the oc command line.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>oc_host</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_HOST</div>
|
||||||
|
<div>env:K8S_AUTH_SERVER</div>
|
||||||
|
<div>var: ansible_oc_host</div>
|
||||||
|
<div>var: ansible_oc_server</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>URL for accessing the API.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>oc_kubeconfig</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_KUBECONFIG</div>
|
||||||
|
<div>var: ansible_oc_kubeconfig</div>
|
||||||
|
<div>var: ansible_oc_config</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a oc config file. Defaults to <em>~/.kube/config</em></div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>oc_namespace</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_NAMESPACE</div>
|
||||||
|
<div>var: ansible_oc_namespace</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>The namespace of the pod</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>oc_pod</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_POD</div>
|
||||||
|
<div>var: ansible_oc_pod</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Pod name. Required when the host name does not match pod name.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>oc_token</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_TOKEN</div>
|
||||||
|
<div>env:K8S_AUTH_API_KEY</div>
|
||||||
|
<div>var: ansible_oc_token</div>
|
||||||
|
<div>var: ansible_oc_api_key</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>API authentication bearer token.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>validate_certs</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<b>Default:</b><br/><div style="color: blue">""</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>env:K8S_AUTH_VERIFY_SSL</div>
|
||||||
|
<div>var: ansible_oc_verify_ssl</div>
|
||||||
|
<div>var: ansible_oc_validate_certs</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Whether or not to verify the API server's SSL certificate. Defaults to <em>true</em>.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: oc_verify_ssl</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Status
|
||||||
|
------
|
||||||
|
|
||||||
|
|
||||||
|
Authors
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
- xuxinkun
|
||||||
|
|
||||||
|
|
||||||
|
.. hint::
|
||||||
|
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
|
||||||
@@ -0,0 +1,424 @@
|
|||||||
|
.. _community.okd.openshift_auth_module:
|
||||||
|
|
||||||
|
|
||||||
|
****************************
|
||||||
|
community.okd.openshift_auth
|
||||||
|
****************************
|
||||||
|
|
||||||
|
**Authenticate to OpenShift clusters which require an explicit login step**
|
||||||
|
|
||||||
|
|
||||||
|
Version added: 0.2.0
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
:local:
|
||||||
|
:depth: 1
|
||||||
|
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
--------
|
||||||
|
- This module handles authenticating to OpenShift clusters requiring *explicit* authentication procedures, meaning ones where a client logs in (obtains an authentication token), performs API operations using said token and then logs out (revokes the token).
|
||||||
|
- On the other hand a popular configuration for username+password authentication is one utilizing HTTP Basic Auth, which does not involve any additional login/logout steps (instead login credentials can be attached to each and every API call performed) and as such is handled directly by the ``k8s`` module (and other resource–specific modules) by utilizing the ``host``, ``username`` and ``password`` parameters. Please consult your preferred module's documentation for more details.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
The below requirements are needed on the host that executes this module.
|
||||||
|
|
||||||
|
- python >= 3.6
|
||||||
|
- urllib3
|
||||||
|
- requests
|
||||||
|
- requests-oauthlib
|
||||||
|
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table border=0 cellpadding=0 class="documentation-table">
|
||||||
|
<tr>
|
||||||
|
<th colspan="1">Parameter</th>
|
||||||
|
<th>Choices/<font color="blue">Defaults</font></th>
|
||||||
|
<th width="100%">Comments</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>api_key</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>When <code>state</code> is set to <em>absent</em>, this specifies the token to revoke.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>ca_cert</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">path</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a CA certificate file used to verify connection to the API server. The full certificate chain must be provided to avoid certificate validation errors.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: ssl_ca_cert</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>host</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
/ <span style="color: red">required</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Provide a URL for accessing the API server.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>password</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Provide a password for authenticating with the API server.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>state</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li><div style="color: blue"><b>present</b> ←</div></li>
|
||||||
|
<li>absent</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>If set to <em>present</em> connect to the API server using the URL specified in <code>host</code> and attempt to log in.</div>
|
||||||
|
<div>If set to <em>absent</em> attempt to log out by revoking the authentication token specified in <code>api_key</code>.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>username</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Provide a username for authenticating with the API server.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>validate_certs</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li>no</li>
|
||||||
|
<li><div style="color: blue"><b>yes</b> ←</div></li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Whether or not to verify the API server's SSL certificates.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: verify_ssl</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Examples
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
- hosts: localhost
|
||||||
|
module_defaults:
|
||||||
|
group/k8s:
|
||||||
|
host: https://k8s.example.com/
|
||||||
|
ca_cert: ca.pem
|
||||||
|
tasks:
|
||||||
|
- block:
|
||||||
|
# It's good practice to store login credentials in a secure vault and not
|
||||||
|
# directly in playbooks.
|
||||||
|
- include_vars: openshift_passwords.yml
|
||||||
|
|
||||||
|
- name: Log in (obtain access token)
|
||||||
|
community.okd.openshift_auth:
|
||||||
|
username: admin
|
||||||
|
password: "{{ openshift_admin_password }}"
|
||||||
|
register: openshift_auth_results
|
||||||
|
|
||||||
|
# Previous task provides the token/api_key, while all other parameters
|
||||||
|
# are taken from module_defaults
|
||||||
|
- name: Get a list of all pods from any namespace
|
||||||
|
kubernetes.core.k8s_info:
|
||||||
|
api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
|
||||||
|
kind: Pod
|
||||||
|
register: pod_list
|
||||||
|
|
||||||
|
always:
|
||||||
|
- name: If login succeeded, try to log out (revoke access token)
|
||||||
|
when: openshift_auth_results.openshift_auth.api_key is defined
|
||||||
|
community.okd.openshift_auth:
|
||||||
|
state: absent
|
||||||
|
api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Return Values
|
||||||
|
-------------
|
||||||
|
Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
|
||||||
|
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table border=0 cellpadding=0 class="documentation-table">
|
||||||
|
<tr>
|
||||||
|
<th colspan="2">Key</th>
|
||||||
|
<th>Returned</th>
|
||||||
|
<th width="100%">Description</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>k8s_auth</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">complex</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>Same as returned openshift_auth. Kept only for backwards compatibility</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>api_key</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>Authentication token.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>ca_cert</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a CA certificate file used to verify connection to the API server.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>host</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>URL for accessing the API server.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>username</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>Username for authenticating with the API server.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>validate_certs</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>Whether or not to verify the API server's SSL certificates.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>openshift_auth</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">complex</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>OpenShift authentication facts.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>api_key</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>Authentication token.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>ca_cert</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a CA certificate file used to verify connection to the API server.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>host</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>URL for accessing the API server.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>username</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">string</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>Username for authenticating with the API server.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"> </td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="return-"></div>
|
||||||
|
<b>validate_certs</b>
|
||||||
|
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>success</td>
|
||||||
|
<td>
|
||||||
|
<div>Whether or not to verify the API server's SSL certificates.</div>
|
||||||
|
<br/>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
</table>
|
||||||
|
<br/><br/>
|
||||||
|
|
||||||
|
|
||||||
|
Status
|
||||||
|
------
|
||||||
|
|
||||||
|
|
||||||
|
Authors
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
- KubeVirt Team (@kubevirt)
|
||||||
|
- Fabian von Feilitzsch (@fabianvf)
|
||||||
@@ -0,0 +1,356 @@
|
|||||||
|
.. _community.okd.openshift_inventory:
|
||||||
|
|
||||||
|
|
||||||
|
***********************
|
||||||
|
community.okd.openshift
|
||||||
|
***********************
|
||||||
|
|
||||||
|
**OpenShift inventory source**
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
:local:
|
||||||
|
:depth: 1
|
||||||
|
|
||||||
|
|
||||||
|
Synopsis
|
||||||
|
--------
|
||||||
|
- Fetch containers, services and routes for one or more clusters
|
||||||
|
- Groups by cluster name, namespace, namespace_services, namespace_pods, namespace_routes, and labels
|
||||||
|
- Uses openshift.(yml|yaml) YAML configuration file to set parameter values.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
The below requirements are needed on the local Ansible controller node that executes this inventory.
|
||||||
|
|
||||||
|
- python >= 3.6
|
||||||
|
- kubernetes >= 12.0.0
|
||||||
|
- PyYAML >= 3.11
|
||||||
|
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
|
||||||
|
.. raw:: html
|
||||||
|
|
||||||
|
<table border=0 cellpadding=0 class="documentation-table">
|
||||||
|
<tr>
|
||||||
|
<th colspan="2">Parameter</th>
|
||||||
|
<th>Choices/<font color="blue">Defaults</font></th>
|
||||||
|
<th>Configuration</th>
|
||||||
|
<th width="100%">Comments</th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>connections</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Optional list of cluster connection settings. If no connections are provided, the default <em>~/.kube/config</em> and active context will be used, and objects will be returned for all namespaces the active user is authorized to access.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>api_key</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>ca_cert</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a CA certificate used to authenticate with the API. Can also be specified via K8S_AUTH_SSL_CA_CERT environment variable.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: ssl_ca_cert</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>client_cert</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE environment variable.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: cert_file</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>client_key</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE environment variable.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: key_file</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>context</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>host</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>kubeconfig</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Path to an existing Kubernetes config file. If not provided, and no other connection options are provided, the Kubernetes client will attempt to load the default configuration file from <em>~/.kube/config</em>. Can also be specified via K8S_AUTH_KUBECONFIG environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>name</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Optional name to assign to the cluster. If not provided, a name is constructed from the server and port.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>namespaces</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized to access.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>password</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>username</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME environment variable.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td class="elbow-placeholder"></td>
|
||||||
|
<td colspan="1">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>validate_certs</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">boolean</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li>no</li>
|
||||||
|
<li>yes</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>Whether or not to verify the API server's SSL certificates. Can also be specified via K8S_AUTH_VERIFY_SSL environment variable.</div>
|
||||||
|
<div style="font-size: small; color: darkgreen"><br/>aliases: verify_ssl</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
|
||||||
|
<tr>
|
||||||
|
<td colspan="2">
|
||||||
|
<div class="ansibleOptionAnchor" id="parameter-"></div>
|
||||||
|
<b>plugin</b>
|
||||||
|
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
|
||||||
|
<div style="font-size: small">
|
||||||
|
<span style="color: purple">-</span>
|
||||||
|
/ <span style="color: red">required</span>
|
||||||
|
</div>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||||||
|
<li>openshift</li>
|
||||||
|
<li>community.okd.openshift</li>
|
||||||
|
</ul>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
</td>
|
||||||
|
<td>
|
||||||
|
<div>token that ensures this is a source file for the 'openshift' plugin.</div>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Examples
|
||||||
|
--------
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
# File must be named openshift.yaml or openshift.yml
|
||||||
|
|
||||||
|
# Authenticate with token, and return all pods and services for all namespaces
|
||||||
|
plugin: community.okd.openshift
|
||||||
|
connections:
|
||||||
|
- host: https://192.168.64.4:8443
|
||||||
|
api_key: xxxxxxxxxxxxxxxx
|
||||||
|
verify_ssl: false
|
||||||
|
|
||||||
|
# Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
|
||||||
|
plugin: community.okd.openshift
|
||||||
|
connections:
|
||||||
|
- namespaces:
|
||||||
|
- testing
|
||||||
|
|
||||||
|
# Use a custom config file, and a specific context.
|
||||||
|
plugin: community.okd.openshift
|
||||||
|
connections:
|
||||||
|
- kubeconfig: /path/to/config
|
||||||
|
context: 'awx/192-168-64-4:8443/developer'
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Status
|
||||||
|
------
|
||||||
|
|
||||||
|
|
||||||
|
Authors
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
- Chris Houseknecht <@chouseknecht>
|
||||||
|
|
||||||
|
|
||||||
|
.. hint::
|
||||||
|
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
+2
-2
@@ -5,7 +5,7 @@ authors:
|
|||||||
- willthames (https://github.com/willthames)
|
- willthames (https://github.com/willthames)
|
||||||
- Akasurde (https://github.com/akasurde)
|
- Akasurde (https://github.com/akasurde)
|
||||||
dependencies:
|
dependencies:
|
||||||
community.kubernetes: '>=1.0.0'
|
kubernetes.core: '>=2.0.0,<2.1.0'
|
||||||
description: OKD Collection for Ansible.
|
description: OKD Collection for Ansible.
|
||||||
documentation: ''
|
documentation: ''
|
||||||
homepage: ''
|
homepage: ''
|
||||||
@@ -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: 1.0.0
|
version: 2.0.0
|
||||||
|
|||||||
+8
-1
@@ -1,2 +1,9 @@
|
|||||||
---
|
---
|
||||||
requires_ansible: '>=2.9'
|
requires_ansible: '>=2.9.17'
|
||||||
|
plugin_routing:
|
||||||
|
modules:
|
||||||
|
k8s_auth:
|
||||||
|
redirect: community.okd.openshift_auth
|
||||||
|
action:
|
||||||
|
k8s:
|
||||||
|
redirect: kubernetes.core.k8s_info
|
||||||
|
|||||||
@@ -0,0 +1,23 @@
|
|||||||
|
---
|
||||||
|
kind: Template
|
||||||
|
apiVersion: template.openshift.io/v1
|
||||||
|
metadata:
|
||||||
|
name: pod-template
|
||||||
|
objects:
|
||||||
|
- apiVersion: v1
|
||||||
|
kind: Pod
|
||||||
|
metadata:
|
||||||
|
name: "Pod-${{ NAME }}"
|
||||||
|
spec:
|
||||||
|
containers:
|
||||||
|
- args:
|
||||||
|
- /bin/sh
|
||||||
|
- -c
|
||||||
|
- while true; do echo $(date); sleep 15; done
|
||||||
|
image: python:3.7-alpine
|
||||||
|
imagePullPolicy: Always
|
||||||
|
name: python
|
||||||
|
parameters:
|
||||||
|
- name: NAME
|
||||||
|
description: trailing name of the pod
|
||||||
|
required: true
|
||||||
@@ -1,6 +1,8 @@
|
|||||||
---
|
---
|
||||||
dependency:
|
dependency:
|
||||||
name: galaxy
|
name: galaxy
|
||||||
|
options:
|
||||||
|
requirements-file: requirements.yml
|
||||||
driver:
|
driver:
|
||||||
name: delegated
|
name: delegated
|
||||||
platforms:
|
platforms:
|
||||||
@@ -38,6 +40,7 @@ verifier:
|
|||||||
scenario:
|
scenario:
|
||||||
name: default
|
name: default
|
||||||
test_sequence:
|
test_sequence:
|
||||||
|
- dependency
|
||||||
- lint
|
- lint
|
||||||
- syntax
|
- syntax
|
||||||
- prepare
|
- prepare
|
||||||
|
|||||||
@@ -10,7 +10,7 @@
|
|||||||
|
|
||||||
- pip:
|
- pip:
|
||||||
name:
|
name:
|
||||||
- openshift>=0.9.2
|
- kubernetes>=12.0.0
|
||||||
- coverage
|
- coverage
|
||||||
virtualenv: "{{ virtualenv }}"
|
virtualenv: "{{ virtualenv }}"
|
||||||
virtualenv_command: "{{ virtualenv_command }}"
|
virtualenv_command: "{{ virtualenv_command }}"
|
||||||
|
|||||||
@@ -1,8 +1,13 @@
|
|||||||
---
|
---
|
||||||
- vars:
|
- block:
|
||||||
# TODO(fabianvf) Get this parameter working locally as well
|
- name: Retrieve cluster info
|
||||||
openshift_host: 'https://kubernetes.default.svc'
|
kubernetes.core.k8s_cluster_info:
|
||||||
block:
|
register: k8s_cluster
|
||||||
|
|
||||||
|
- name: set openshift host value
|
||||||
|
set_fact:
|
||||||
|
openshift_host: "{{ k8s_cluster.connection.host }}"
|
||||||
|
|
||||||
- name: Log in (obtain access token)
|
- name: Log in (obtain access token)
|
||||||
community.okd.openshift_auth:
|
community.okd.openshift_auth:
|
||||||
username: test
|
username: test
|
||||||
@@ -12,7 +17,7 @@
|
|||||||
register: openshift_auth_results
|
register: openshift_auth_results
|
||||||
|
|
||||||
- name: Get the test User
|
- name: Get the test User
|
||||||
community.kubernetes.k8s_info:
|
kubernetes.core.k8s_info:
|
||||||
api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
|
api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
|
||||||
host: '{{ openshift_host }}'
|
host: '{{ openshift_host }}'
|
||||||
verify_ssl: false
|
verify_ssl: false
|
||||||
@@ -35,7 +40,7 @@
|
|||||||
verify_ssl: false
|
verify_ssl: false
|
||||||
|
|
||||||
- name: Get the test user
|
- name: Get the test user
|
||||||
community.kubernetes.k8s_info:
|
kubernetes.core.k8s_info:
|
||||||
api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
|
api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
|
||||||
host: '{{ openshift_host }}'
|
host: '{{ openshift_host }}'
|
||||||
verify_ssl: false
|
verify_ssl: false
|
||||||
|
|||||||
@@ -133,7 +133,7 @@
|
|||||||
that: result is not changed
|
that: result is not changed
|
||||||
|
|
||||||
- name: Get the created configmap
|
- name: Get the created configmap
|
||||||
community.kubernetes.k8s_info:
|
kubernetes.core.k8s_info:
|
||||||
api_version: v1
|
api_version: v1
|
||||||
kind: ConfigMap
|
kind: ConfigMap
|
||||||
name: example
|
name: example
|
||||||
@@ -162,3 +162,22 @@
|
|||||||
|
|
||||||
- assert:
|
- assert:
|
||||||
that: result is not changed
|
that: result is not changed
|
||||||
|
|
||||||
|
# Processing template without message
|
||||||
|
- name: create template with file {{ files_dir }}/pod-template.yaml
|
||||||
|
kubernetes.core.k8s:
|
||||||
|
namespace: process-test
|
||||||
|
src: "{{ files_dir }}/pod-template.yaml"
|
||||||
|
state: present
|
||||||
|
|
||||||
|
- name: Process pod template
|
||||||
|
community.okd.openshift_process:
|
||||||
|
name: pod-template
|
||||||
|
namespace: process-test
|
||||||
|
state: rendered
|
||||||
|
parameters:
|
||||||
|
NAME: ansible
|
||||||
|
register: rendered_template
|
||||||
|
|
||||||
|
- assert:
|
||||||
|
that: rendered_template.message == ""
|
||||||
|
|||||||
@@ -71,7 +71,7 @@ DOCUMENTATION = '''
|
|||||||
- name: K8S_AUTH_EXTRA_ARGS
|
- name: K8S_AUTH_EXTRA_ARGS
|
||||||
oc_kubeconfig:
|
oc_kubeconfig:
|
||||||
description:
|
description:
|
||||||
- Path to a oc config file. Defaults to I(~/.kube/conig)
|
- Path to a oc config file. Defaults to I(~/.kube/config)
|
||||||
default: ''
|
default: ''
|
||||||
vars:
|
vars:
|
||||||
- name: ansible_oc_kubeconfig
|
- name: ansible_oc_kubeconfig
|
||||||
@@ -147,7 +147,7 @@ DOCUMENTATION = '''
|
|||||||
aliases: [ oc_verify_ssl ]
|
aliases: [ oc_verify_ssl ]
|
||||||
'''
|
'''
|
||||||
|
|
||||||
from ansible_collections.community.kubernetes.plugins.connection.kubectl import Connection as KubectlConnection
|
from ansible_collections.kubernetes.core.plugins.connection.kubectl import Connection as KubectlConnection
|
||||||
|
|
||||||
|
|
||||||
CONNECTION_TRANSPORT = 'oc'
|
CONNECTION_TRANSPORT = 'oc'
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ DOCUMENTATION = '''
|
|||||||
plugin:
|
plugin:
|
||||||
description: token that ensures this is a source file for the 'openshift' plugin.
|
description: token that ensures this is a source file for the 'openshift' plugin.
|
||||||
required: True
|
required: True
|
||||||
choices: ['openshift']
|
choices: ['openshift', 'community.okd.openshift']
|
||||||
connections:
|
connections:
|
||||||
description:
|
description:
|
||||||
- Optional list of cluster connection settings. If no connections are provided, the default
|
- Optional list of cluster connection settings. If no connections are provided, the default
|
||||||
@@ -36,8 +36,8 @@ DOCUMENTATION = '''
|
|||||||
kubeconfig:
|
kubeconfig:
|
||||||
description:
|
description:
|
||||||
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
- Path to an existing Kubernetes config file. If not provided, and no other connection
|
||||||
options are provided, the OpenShift client will attempt to load the default
|
options are provided, the Kubernetes client will attempt to load the default
|
||||||
configuration file from I(~/.kube/config.json). Can also be specified via K8S_AUTH_KUBECONFIG
|
configuration file from I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG
|
||||||
environment variable.
|
environment variable.
|
||||||
context:
|
context:
|
||||||
description:
|
description:
|
||||||
@@ -85,8 +85,8 @@ DOCUMENTATION = '''
|
|||||||
to access.
|
to access.
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.7"
|
- "python >= 3.6"
|
||||||
- "openshift >= 0.6"
|
- "kubernetes >= 12.0.0"
|
||||||
- "PyYAML >= 3.11"
|
- "PyYAML >= 3.11"
|
||||||
'''
|
'''
|
||||||
|
|
||||||
@@ -113,10 +113,11 @@ connections:
|
|||||||
context: 'awx/192-168-64-4:8443/developer'
|
context: 'awx/192-168-64-4:8443/developer'
|
||||||
'''
|
'''
|
||||||
|
|
||||||
from ansible_collections.community.kubernetes.plugins.inventory.k8s import K8sInventoryException, InventoryModule as K8sInventoryModule, format_dynamic_api_exc
|
from ansible_collections.kubernetes.core.plugins.inventory.k8s import K8sInventoryException, InventoryModule as K8sInventoryModule, format_dynamic_api_exc
|
||||||
|
from ansible_collections.kubernetes.core.plugins.module_utils.common import get_api_client
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from openshift.dynamic.exceptions import DynamicApiError
|
from kubernetes.dynamic.exceptions import DynamicApiError
|
||||||
except ImportError:
|
except ImportError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
@@ -135,7 +136,7 @@ class InventoryModule(K8sInventoryModule):
|
|||||||
raise K8sInventoryException("Expecting connections to be a list.")
|
raise K8sInventoryException("Expecting connections to be a list.")
|
||||||
|
|
||||||
for connection in connections:
|
for connection in connections:
|
||||||
client = self.get_api_client(**connection)
|
client = get_api_client(**connection)
|
||||||
name = connection.get('name', self.get_default_host_name(client.configuration.host))
|
name = connection.get('name', self.get_default_host_name(client.configuration.host))
|
||||||
if connection.get('namespaces'):
|
if connection.get('namespaces'):
|
||||||
namespaces = connection['namespaces']
|
namespaces = connection['namespaces']
|
||||||
@@ -144,7 +145,7 @@ class InventoryModule(K8sInventoryModule):
|
|||||||
for namespace in namespaces:
|
for namespace in namespaces:
|
||||||
self.get_routes_for_namespace(client, name, namespace)
|
self.get_routes_for_namespace(client, name, namespace)
|
||||||
else:
|
else:
|
||||||
client = self.get_api_client()
|
client = get_api_client()
|
||||||
name = self.get_default_host_name(client.configuration.host)
|
name = self.get_default_host_name(client.configuration.host)
|
||||||
namespaces = self.get_available_namespaces(client)
|
namespaces = self.get_available_namespaces(client)
|
||||||
for namespace in namespaces:
|
for namespace in namespaces:
|
||||||
|
|||||||
+142
-85
@@ -1,21 +1,16 @@
|
|||||||
#!/usr/bin/python
|
#!/usr/bin/python
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
# (c) 2018, Chris Houseknecht <@chouseknecht>
|
# Copyright: (c) 2018, Chris Houseknecht <@chouseknecht>
|
||||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
# 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
|
||||||
|
|
||||||
|
# STARTREMOVE (downstream)
|
||||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
DOCUMENTATION = r'''
|
||||||
'status': ['preview'],
|
|
||||||
'supported_by': 'community'}
|
|
||||||
|
|
||||||
DOCUMENTATION = '''
|
|
||||||
|
|
||||||
module: k8s
|
module: k8s
|
||||||
|
|
||||||
@@ -26,29 +21,38 @@ author:
|
|||||||
- "Fabian von Feilitzsch (@fabianvf)"
|
- "Fabian von Feilitzsch (@fabianvf)"
|
||||||
|
|
||||||
description:
|
description:
|
||||||
- Use the OpenShift Python client to perform CRUD operations on K8s objects.
|
- Use the Kubernetes Python client to perform CRUD operations on K8s objects.
|
||||||
- Pass the object definition from a source file or inline. See examples for reading
|
- Pass the object definition from a source file or inline. See examples for reading
|
||||||
files and using Jinja templates or vault-encrypted files.
|
files and using Jinja templates or vault-encrypted files.
|
||||||
- Access to the full range of K8s APIs.
|
- Access to the full range of K8s APIs.
|
||||||
- Use the M(k8s_info) module to obtain a list of items about an object of type C(kind)
|
- Use the M(kubernetes.core.k8s_info) module to obtain a list of items about an object of type C(kind).
|
||||||
- Authenticate using either a config file, certificates, password or token.
|
- Authenticate using either a config file, certificates, password or token.
|
||||||
- Supports check mode.
|
- Supports check mode.
|
||||||
- Optimized for OKD/OpenShift Kubernetes flavors
|
- Optimized for OKD/OpenShift Kubernetes flavors.
|
||||||
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.kubernetes.k8s_state_options
|
- kubernetes.core.k8s_name_options
|
||||||
- community.kubernetes.k8s_name_options
|
- kubernetes.core.k8s_resource_options
|
||||||
- community.kubernetes.k8s_resource_options
|
- kubernetes.core.k8s_auth_options
|
||||||
- community.kubernetes.k8s_auth_options
|
- kubernetes.core.k8s_wait_options
|
||||||
|
- kubernetes.core.k8s_delete_options
|
||||||
notes:
|
|
||||||
- If your OpenShift Python library is not 0.9.0 or newer and you are trying to
|
|
||||||
remove an item from an associative array/dictionary, for example a label or
|
|
||||||
an annotation, you will need to explicitly set the value of the item to be
|
|
||||||
removed to `null`. Simply deleting the entry in the dictionary will not
|
|
||||||
remove it from openshift or kubernetes.
|
|
||||||
|
|
||||||
options:
|
options:
|
||||||
|
state:
|
||||||
|
description:
|
||||||
|
- Determines if an object should be created, patched, or deleted. When set to C(present), an object will be
|
||||||
|
created, if it does not already exist. If set to C(absent), an existing object will be deleted. If set to
|
||||||
|
C(present), an existing object will be patched, if its attributes differ from those specified using
|
||||||
|
I(resource_definition) or I(src).
|
||||||
|
- C(patched) state is an existing resource that has a given patch applied. If the resource doesn't exist, silently skip it (do not raise an error).
|
||||||
|
type: str
|
||||||
|
default: present
|
||||||
|
choices: [ absent, present, patched ]
|
||||||
|
force:
|
||||||
|
description:
|
||||||
|
- If set to C(yes), and I(state) is C(present), an existing object will be replaced.
|
||||||
|
type: bool
|
||||||
|
default: no
|
||||||
merge_type:
|
merge_type:
|
||||||
description:
|
description:
|
||||||
- Whether to override the default patch merge approach with a specific type. By default, the strategic
|
- Whether to override the default patch merge approach with a specific type. By default, the strategic
|
||||||
@@ -56,65 +60,17 @@ options:
|
|||||||
- For example, Custom Resource Definitions typically aren't updatable by the usual strategic merge. You may
|
- For example, Custom Resource Definitions typically aren't updatable by the usual strategic merge. You may
|
||||||
want to use C(merge) if you see "strategic merge patch format is not supported"
|
want to use C(merge) if you see "strategic merge patch format is not supported"
|
||||||
- See U(https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment)
|
- See U(https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment)
|
||||||
- Requires openshift >= 0.6.2
|
|
||||||
- If more than one merge_type is given, the merge_types will be tried in order
|
- If more than one merge_type is given, the merge_types will be tried in order
|
||||||
- If openshift >= 0.6.2, this defaults to C(['strategic-merge', 'merge']), which is ideal for using the same parameters
|
- Defaults to C(['strategic-merge', 'merge']), which is ideal for using the same parameters
|
||||||
on resource kinds that combine Custom Resources and built-in resources. For openshift < 0.6.2, the default
|
on resource kinds that combine Custom Resources and built-in resources.
|
||||||
is simply C(strategic-merge).
|
|
||||||
- mutually exclusive with C(apply)
|
- mutually exclusive with C(apply)
|
||||||
|
- I(merge_type=json) is deprecated and will be removed in version 3.0.0. Please use M(kubernetes.core.k8s_json_patch) instead.
|
||||||
choices:
|
choices:
|
||||||
- json
|
- json
|
||||||
- merge
|
- merge
|
||||||
- strategic-merge
|
- strategic-merge
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
wait:
|
|
||||||
description:
|
|
||||||
- Whether to wait for certain resource kinds to end up in the desired state. By default the module exits once Kubernetes has
|
|
||||||
received the request
|
|
||||||
- Implemented for C(state=present) for C(Deployment), C(DaemonSet) and C(Pod), and for C(state=absent) for all resource kinds.
|
|
||||||
- For resource kinds without an implementation, C(wait) returns immediately unless C(wait_condition) is set.
|
|
||||||
default: no
|
|
||||||
type: bool
|
|
||||||
wait_sleep:
|
|
||||||
description:
|
|
||||||
- Number of seconds to sleep between checks.
|
|
||||||
default: 5
|
|
||||||
type: int
|
|
||||||
wait_timeout:
|
|
||||||
description:
|
|
||||||
- How long in seconds to wait for the resource to end up in the desired state. Ignored if C(wait) is not set.
|
|
||||||
default: 120
|
|
||||||
type: int
|
|
||||||
wait_condition:
|
|
||||||
description:
|
|
||||||
- Specifies a custom condition on the status to wait for. Ignored if C(wait) is not set or is set to False.
|
|
||||||
suboptions:
|
|
||||||
type:
|
|
||||||
type: str
|
|
||||||
description:
|
|
||||||
- The type of condition to wait for. For example, the C(Pod) resource will set the C(Ready) condition (among others)
|
|
||||||
- Required if you are specifying a C(wait_condition). If left empty, the C(wait_condition) field will be ignored.
|
|
||||||
- The possible types for a condition are specific to each resource type in Kubernetes. See the API documentation of the status field
|
|
||||||
for a given resource to see possible choices.
|
|
||||||
status:
|
|
||||||
type: str
|
|
||||||
description:
|
|
||||||
- The value of the status field in your desired condition.
|
|
||||||
- For example, if a C(Deployment) is paused, the C(Progressing) C(type) will have the C(Unknown) status.
|
|
||||||
choices:
|
|
||||||
- True
|
|
||||||
- False
|
|
||||||
- Unknown
|
|
||||||
default: "True"
|
|
||||||
reason:
|
|
||||||
type: str
|
|
||||||
description:
|
|
||||||
- The value of the reason field in your desired condition
|
|
||||||
- For example, if a C(Deployment) is paused, The C(Progressing) C(type) will have the C(DeploymentPaused) reason.
|
|
||||||
- The possible reasons in a condition are specific to each resource type in Kubernetes. See the API documentation of the status field
|
|
||||||
for a given resource to see possible choices.
|
|
||||||
type: dict
|
|
||||||
validate:
|
validate:
|
||||||
description:
|
description:
|
||||||
- how (if at all) to validate the resource definition against the kubernetes schema.
|
- how (if at all) to validate the resource definition against the kubernetes schema.
|
||||||
@@ -140,6 +96,7 @@ options:
|
|||||||
will only work if the same object is passed with state=absent (alternatively, just use state=absent with the name including
|
will only work if the same object is passed with state=absent (alternatively, just use state=absent with the name including
|
||||||
the generated hash and append_hash=no)
|
the generated hash and append_hash=no)
|
||||||
type: bool
|
type: bool
|
||||||
|
default: false
|
||||||
apply:
|
apply:
|
||||||
description:
|
description:
|
||||||
- C(apply) compares the desired resource definition with the previously supplied resource definition,
|
- C(apply) compares the desired resource definition with the previously supplied resource definition,
|
||||||
@@ -147,14 +104,47 @@ options:
|
|||||||
- C(apply) works better with Services than 'force=yes'
|
- C(apply) works better with Services than 'force=yes'
|
||||||
- mutually exclusive with C(merge_type)
|
- mutually exclusive with C(merge_type)
|
||||||
type: bool
|
type: bool
|
||||||
|
default: false
|
||||||
|
template:
|
||||||
|
description:
|
||||||
|
- Provide a valid YAML template definition file for an object when creating or updating.
|
||||||
|
- Value can be provided as string or dictionary.
|
||||||
|
- Mutually exclusive with C(src) and C(resource_definition).
|
||||||
|
- Template files needs to be present on the Ansible Controller's file system.
|
||||||
|
- Additional parameters can be specified using dictionary.
|
||||||
|
- 'Valid additional parameters - '
|
||||||
|
- 'C(newline_sequence) (str): Specify the newline sequence to use for templating files.
|
||||||
|
valid choices are "\n", "\r", "\r\n". Default value "\n".'
|
||||||
|
- 'C(block_start_string) (str): The string marking the beginning of a block.
|
||||||
|
Default value "{%".'
|
||||||
|
- 'C(block_end_string) (str): The string marking the end of a block.
|
||||||
|
Default value "%}".'
|
||||||
|
- 'C(variable_start_string) (str): The string marking the beginning of a print statement.
|
||||||
|
Default value "{{".'
|
||||||
|
- 'C(variable_end_string) (str): The string marking the end of a print statement.
|
||||||
|
Default value "}}".'
|
||||||
|
- 'C(trim_blocks) (bool): Determine when newlines should be removed from blocks. When set to C(yes) the first newline
|
||||||
|
after a block is removed (block, not variable tag!). Default value is true.'
|
||||||
|
- 'C(lstrip_blocks) (bool): Determine when leading spaces and tabs should be stripped.
|
||||||
|
When set to C(yes) leading spaces and tabs are stripped from the start of a line to a block.
|
||||||
|
This functionality requires Jinja 2.7 or newer. Default value is false.'
|
||||||
|
type: raw
|
||||||
|
version_added: '2.0.0'
|
||||||
|
continue_on_error:
|
||||||
|
description:
|
||||||
|
- Whether to continue on creation/deletion errors when multiple resources are defined.
|
||||||
|
- This has no effect on the validation step which is controlled by the C(validate.fail_on_error) parameter.
|
||||||
|
type: bool
|
||||||
|
default: False
|
||||||
|
version_added: 2.0.0
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.7"
|
- "python >= 3.6"
|
||||||
- "openshift >= 0.6"
|
- "kubernetes >= 12.0.0"
|
||||||
- "PyYAML >= 3.11"
|
- "PyYAML >= 3.11"
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = r'''
|
||||||
- name: Create a k8s namespace
|
- name: Create a k8s namespace
|
||||||
community.okd.k8s:
|
community.okd.k8s:
|
||||||
name: testing
|
name: testing
|
||||||
@@ -227,7 +217,7 @@ EXAMPLES = '''
|
|||||||
strict: yes
|
strict: yes
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = '''
|
RETURN = r'''
|
||||||
result:
|
result:
|
||||||
description:
|
description:
|
||||||
- The created, patched, or otherwise present object. Will be empty in the case of a deletion.
|
- The created, patched, or otherwise present object. Will be empty in the case of a deletion.
|
||||||
@@ -263,27 +253,35 @@ result:
|
|||||||
returned: when C(wait) is true
|
returned: when C(wait) is true
|
||||||
type: int
|
type: int
|
||||||
sample: 48
|
sample: 48
|
||||||
|
error:
|
||||||
|
description: error while trying to create/delete the object.
|
||||||
|
returned: error
|
||||||
|
type: complex
|
||||||
'''
|
'''
|
||||||
|
# ENDREMOVE (downstream)
|
||||||
|
|
||||||
|
import copy
|
||||||
import re
|
import re
|
||||||
import operator
|
import operator
|
||||||
import traceback
|
import traceback
|
||||||
from functools import reduce
|
from functools import reduce
|
||||||
|
|
||||||
|
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:
|
||||||
from ansible_collections.community.kubernetes.plugins.module_utils.raw import KubernetesRawModule
|
from ansible_collections.kubernetes.core.plugins.module_utils.common import get_api_client, K8sAnsibleMixin
|
||||||
|
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
|
HAS_KUBERNETES_COLLECTION = True
|
||||||
except ImportError as e:
|
except ImportError as e:
|
||||||
HAS_KUBERNETES_COLLECTION = False
|
HAS_KUBERNETES_COLLECTION = False
|
||||||
k8s_collection_import_exception = e
|
k8s_collection_import_exception = e
|
||||||
K8S_COLLECTION_ERROR = traceback.format_exc()
|
K8S_COLLECTION_ERROR = traceback.format_exc()
|
||||||
from ansible.module_utils.basic import AnsibleModule as KubernetesRawModule
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import yaml
|
import yaml
|
||||||
from openshift.dynamic.exceptions import DynamicApiError, NotFoundError, ForbiddenError
|
from kubernetes.dynamic.exceptions import DynamicApiError, NotFoundError, ForbiddenError
|
||||||
except ImportError:
|
except ImportError:
|
||||||
# Exceptions handled in common
|
# Exceptions handled in common
|
||||||
pass
|
pass
|
||||||
@@ -292,16 +290,73 @@ 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])?))")
|
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(KubernetesRawModule):
|
class OKDRawModule(K8sAnsibleMixin):
|
||||||
|
|
||||||
|
def __init__(self, k8s_kind=None, *args, **kwargs):
|
||||||
|
mutually_exclusive = [
|
||||||
|
('resource_definition', 'src'),
|
||||||
|
('merge_type', 'apply'),
|
||||||
|
('template', 'resource_definition'),
|
||||||
|
('template', 'src'),
|
||||||
|
]
|
||||||
|
|
||||||
|
module = AnsibleModule(
|
||||||
|
argument_spec=self.argspec,
|
||||||
|
mutually_exclusive=mutually_exclusive,
|
||||||
|
supports_check_mode=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
self.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
|
||||||
|
|
||||||
def __init__(self):
|
|
||||||
if not HAS_KUBERNETES_COLLECTION:
|
if not HAS_KUBERNETES_COLLECTION:
|
||||||
self.fail_json(
|
self.fail_json(
|
||||||
msg="The community.kubernetes collection must be installed",
|
msg="The kubernetes.core collection must be installed",
|
||||||
exception=K8S_COLLECTION_ERROR,
|
exception=K8S_COLLECTION_ERROR,
|
||||||
error=to_native(k8s_collection_import_exception)
|
error=to_native(k8s_collection_import_exception)
|
||||||
)
|
)
|
||||||
super(OKDRawModule, self).__init__()
|
|
||||||
|
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):
|
def perform_action(self, resource, definition):
|
||||||
state = self.params.get('state', None)
|
state = self.params.get('state', None)
|
||||||
@@ -396,7 +451,9 @@ class OKDRawModule(KubernetesRawModule):
|
|||||||
image = existing['spec']['template']['spec']['containers'][old_container_index]['image']
|
image = existing['spec']['template']['spec']['containers'][old_container_index]['image']
|
||||||
definition['spec']['template']['spec']['containers'][new_container_index]['image'] = 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'])
|
existing_index = self.get_index(trigger['imageChangeParams'],
|
||||||
|
[x.get('imageChangeParams') for x in existing_triggers],
|
||||||
|
['containerNames'])
|
||||||
if existing_index is not None:
|
if existing_index is not None:
|
||||||
existing_image = existing_triggers[existing_index].get('imageChangeParams', {}).get('lastTriggeredImage')
|
existing_image = existing_triggers[existing_index].get('imageChangeParams', {}).get('lastTriggeredImage')
|
||||||
if existing_image:
|
if existing_image:
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
openshift_auth.py
|
|
||||||
@@ -5,10 +5,8 @@
|
|||||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
# 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
|
||||||
|
|
||||||
|
|
||||||
DOCUMENTATION = r'''
|
DOCUMENTATION = r'''
|
||||||
|
|
||||||
module: openshift_auth
|
module: openshift_auth
|
||||||
@@ -72,7 +70,7 @@ options:
|
|||||||
type: str
|
type: str
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- python >= 2.7
|
- python >= 3.6
|
||||||
- urllib3
|
- urllib3
|
||||||
- requests
|
- requests
|
||||||
- requests-oauthlib
|
- requests-oauthlib
|
||||||
@@ -99,7 +97,7 @@ EXAMPLES = r'''
|
|||||||
# Previous task provides the token/api_key, while all other parameters
|
# Previous task provides the token/api_key, while all other parameters
|
||||||
# are taken from module_defaults
|
# are taken from module_defaults
|
||||||
- name: Get a list of all pods from any namespace
|
- name: Get a list of all pods from any namespace
|
||||||
community.kubernetes.k8s_info:
|
kubernetes.core.k8s_info:
|
||||||
api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
|
api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
|
||||||
kind: Pod
|
kind: Pod
|
||||||
register: pod_list
|
register: pod_list
|
||||||
|
|||||||
@@ -5,10 +5,9 @@
|
|||||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
# 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
|
||||||
|
|
||||||
|
# STARTREMOVE (downstream)
|
||||||
DOCUMENTATION = r'''
|
DOCUMENTATION = r'''
|
||||||
module: openshift_process
|
module: openshift_process
|
||||||
|
|
||||||
@@ -25,13 +24,13 @@ description:
|
|||||||
- For CRUD operations on Template resources themselves, see the community.okd.k8s module.
|
- For CRUD operations on Template resources themselves, see the community.okd.k8s module.
|
||||||
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.kubernetes.k8s_auth_options
|
- kubernetes.core.k8s_auth_options
|
||||||
- community.kubernetes.k8s_wait_options
|
- kubernetes.core.k8s_wait_options
|
||||||
- community.kubernetes.k8s_resource_options
|
- kubernetes.core.k8s_resource_options
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.7"
|
- "python >= 3.6"
|
||||||
- "openshift >= 0.11.0"
|
- "kubernetes >= 12.0.0"
|
||||||
- "PyYAML >= 3.11"
|
- "PyYAML >= 3.11"
|
||||||
|
|
||||||
options:
|
options:
|
||||||
@@ -40,7 +39,7 @@ options:
|
|||||||
- The name of the Template to process.
|
- The name of the Template to process.
|
||||||
- The Template must be present in the cluster.
|
- The Template must be present in the cluster.
|
||||||
- When provided, I(namespace) is required.
|
- When provided, I(namespace) is required.
|
||||||
- Mutually exlusive with I(resource_definition) or I(src)
|
- Mutually exclusive with I(resource_definition) or I(src)
|
||||||
type: str
|
type: str
|
||||||
namespace:
|
namespace:
|
||||||
description:
|
description:
|
||||||
@@ -202,6 +201,7 @@ resources:
|
|||||||
type: complex
|
type: complex
|
||||||
description: Array of status conditions for the object. Not guaranteed to be present
|
description: Array of status conditions for the object. Not guaranteed to be present
|
||||||
'''
|
'''
|
||||||
|
# ENDREMOVE (downstream)
|
||||||
|
|
||||||
import re
|
import re
|
||||||
import os
|
import os
|
||||||
@@ -212,8 +212,9 @@ 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:
|
||||||
from ansible_collections.community.kubernetes.plugins.module_utils.common import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.common import K8sAnsibleMixin, get_api_client
|
||||||
K8sAnsibleMixin, AUTH_ARG_SPEC, RESOURCE_ARG_SPEC, WAIT_ARG_SPEC
|
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||||
|
AUTH_ARG_SPEC, RESOURCE_ARG_SPEC, WAIT_ARG_SPEC
|
||||||
)
|
)
|
||||||
HAS_KUBERNETES_COLLECTION = True
|
HAS_KUBERNETES_COLLECTION = True
|
||||||
except ImportError as e:
|
except ImportError as e:
|
||||||
@@ -224,7 +225,7 @@ except ImportError as e:
|
|||||||
AUTH_ARG_SPEC = RESOURCE_ARG_SPEC = WAIT_ARG_SPEC = {}
|
AUTH_ARG_SPEC = RESOURCE_ARG_SPEC = WAIT_ARG_SPEC = {}
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from openshift.dynamic.exceptions import DynamicApiError, NotFoundError
|
from kubernetes.dynamic.exceptions import DynamicApiError, NotFoundError
|
||||||
except ImportError:
|
except ImportError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
@@ -243,12 +244,12 @@ class OpenShiftProcess(K8sAnsibleMixin):
|
|||||||
|
|
||||||
if not HAS_KUBERNETES_COLLECTION:
|
if not HAS_KUBERNETES_COLLECTION:
|
||||||
self.module.fail_json(
|
self.module.fail_json(
|
||||||
msg="The community.kubernetes collection must be installed",
|
msg="The kubernetes.core collection must be installed",
|
||||||
exception=K8S_COLLECTION_ERROR,
|
exception=K8S_COLLECTION_ERROR,
|
||||||
error=to_native(k8s_collection_import_exception)
|
error=to_native(k8s_collection_import_exception)
|
||||||
)
|
)
|
||||||
|
|
||||||
super(OpenShiftProcess, self).__init__()
|
super(OpenShiftProcess, self).__init__(self.module)
|
||||||
|
|
||||||
self.params = self.module.params
|
self.params = self.module.params
|
||||||
self.check_mode = self.module.check_mode
|
self.check_mode = self.module.check_mode
|
||||||
@@ -269,7 +270,7 @@ class OpenShiftProcess(K8sAnsibleMixin):
|
|||||||
return spec
|
return spec
|
||||||
|
|
||||||
def execute_module(self):
|
def execute_module(self):
|
||||||
self.client = self.get_api_client()
|
self.client = get_api_client(self.module)
|
||||||
|
|
||||||
v1_templates = self.find_resource('templates', 'template.openshift.io/v1', fail=True)
|
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)
|
v1_processed_templates = self.find_resource('processedtemplates', 'template.openshift.io/v1', fail=True)
|
||||||
@@ -294,7 +295,7 @@ class OpenShiftProcess(K8sAnsibleMixin):
|
|||||||
template = None
|
template = None
|
||||||
|
|
||||||
if src or definition:
|
if src or definition:
|
||||||
self.set_resource_definitions()
|
self.set_resource_definitions(self.module)
|
||||||
if len(self.resource_definitions) < 1:
|
if len(self.resource_definitions) < 1:
|
||||||
self.fail_json('Unable to load a Template resource from src or resource_definition')
|
self.fail_json('Unable to load a Template resource from src or resource_definition')
|
||||||
elif len(self.resource_definitions) > 1:
|
elif len(self.resource_definitions) > 1:
|
||||||
@@ -330,8 +331,9 @@ class OpenShiftProcess(K8sAnsibleMixin):
|
|||||||
except Exception as exc:
|
except Exception as exc:
|
||||||
self.module.fail_json(msg="Server failed to render the Template: {0}".format(to_native(exc)),
|
self.module.fail_json(msg="Server failed to render the Template: {0}".format(to_native(exc)),
|
||||||
error='', status='', reason='')
|
error='', status='', reason='')
|
||||||
|
result['message'] = ""
|
||||||
result['message'] = response['message']
|
if "message" in response:
|
||||||
|
result['message'] = response['message']
|
||||||
result['resources'] = response['objects']
|
result['resources'] = response['objects']
|
||||||
|
|
||||||
if state != 'rendered':
|
if state != 'rendered':
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ from __future__ import absolute_import, division, print_function
|
|||||||
|
|
||||||
__metaclass__ = type
|
__metaclass__ = type
|
||||||
|
|
||||||
|
# STARTREMOVE (downstream)
|
||||||
DOCUMENTATION = r'''
|
DOCUMENTATION = r'''
|
||||||
module: openshift_route
|
module: openshift_route
|
||||||
|
|
||||||
@@ -21,16 +21,16 @@ 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 community.kubernetes.k8s_expose
|
- For creating Services from other resources, see kubernetes.core.k8s_expose
|
||||||
|
|
||||||
extends_documentation_fragment:
|
extends_documentation_fragment:
|
||||||
- community.kubernetes.k8s_auth_options
|
- kubernetes.core.k8s_auth_options
|
||||||
- community.kubernetes.k8s_wait_options
|
- kubernetes.core.k8s_wait_options
|
||||||
- community.kubernetes.k8s_state_options
|
- kubernetes.core.k8s_state_options
|
||||||
|
|
||||||
requirements:
|
requirements:
|
||||||
- "python >= 2.7"
|
- "python >= 3.6"
|
||||||
- "openshift >= 0.11.0"
|
- "kubernetes >= 12.0.0"
|
||||||
- "PyYAML >= 3.11"
|
- "PyYAML >= 3.11"
|
||||||
|
|
||||||
options:
|
options:
|
||||||
@@ -296,6 +296,7 @@ duration:
|
|||||||
type: int
|
type: int
|
||||||
sample: 48
|
sample: 48
|
||||||
'''
|
'''
|
||||||
|
# ENDREMOVE (downstream)
|
||||||
|
|
||||||
import copy
|
import copy
|
||||||
import traceback
|
import traceback
|
||||||
@@ -304,8 +305,9 @@ 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:
|
||||||
from ansible_collections.community.kubernetes.plugins.module_utils.common import (
|
from ansible_collections.kubernetes.core.plugins.module_utils.common import K8sAnsibleMixin, get_api_client
|
||||||
K8sAnsibleMixin, AUTH_ARG_SPEC, WAIT_ARG_SPEC, COMMON_ARG_SPEC
|
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
|
||||||
|
AUTH_ARG_SPEC, WAIT_ARG_SPEC, COMMON_ARG_SPEC
|
||||||
)
|
)
|
||||||
HAS_KUBERNETES_COLLECTION = True
|
HAS_KUBERNETES_COLLECTION = True
|
||||||
except ImportError as e:
|
except ImportError as e:
|
||||||
@@ -316,7 +318,7 @@ except ImportError as e:
|
|||||||
AUTH_ARG_SPEC = WAIT_ARG_SPEC = COMMON_ARG_SPEC = {}
|
AUTH_ARG_SPEC = WAIT_ARG_SPEC = COMMON_ARG_SPEC = {}
|
||||||
|
|
||||||
try:
|
try:
|
||||||
from openshift.dynamic.exceptions import DynamicApiError, NotFoundError
|
from kubernetes.dynamic.exceptions import DynamicApiError, NotFoundError
|
||||||
except ImportError:
|
except ImportError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
@@ -332,12 +334,12 @@ class OpenShiftRoute(K8sAnsibleMixin):
|
|||||||
|
|
||||||
if not HAS_KUBERNETES_COLLECTION:
|
if not HAS_KUBERNETES_COLLECTION:
|
||||||
self.module.fail_json(
|
self.module.fail_json(
|
||||||
msg="The community.kubernetes collection must be installed",
|
msg="The kubernetes.core collection must be installed",
|
||||||
exception=K8S_COLLECTION_ERROR,
|
exception=K8S_COLLECTION_ERROR,
|
||||||
error=to_native(k8s_collection_import_exception)
|
error=to_native(k8s_collection_import_exception)
|
||||||
)
|
)
|
||||||
|
|
||||||
super(OpenShiftRoute, self).__init__()
|
super(OpenShiftRoute, self).__init__(self.module)
|
||||||
|
|
||||||
self.params = self.module.params
|
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
|
# TODO: should probably make it so that at least some of these aren't required for perform_action to work
|
||||||
@@ -366,7 +368,7 @@ class OpenShiftRoute(K8sAnsibleMixin):
|
|||||||
ca_certificate=dict(type='str'),
|
ca_certificate=dict(type='str'),
|
||||||
certificate=dict(type='str'),
|
certificate=dict(type='str'),
|
||||||
destination_ca_certificate=dict(type='str'),
|
destination_ca_certificate=dict(type='str'),
|
||||||
key=dict(type='str'),
|
key=dict(type='str', no_log=False),
|
||||||
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')
|
||||||
@@ -374,7 +376,7 @@ class OpenShiftRoute(K8sAnsibleMixin):
|
|||||||
return spec
|
return spec
|
||||||
|
|
||||||
def execute_module(self):
|
def execute_module(self):
|
||||||
self.client = self.get_api_client()
|
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')
|
||||||
|
|||||||
@@ -0,0 +1,2 @@
|
|||||||
|
kubernetes>=12.0.0
|
||||||
|
requests-oauthlib
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
collections:
|
||||||
|
- name: kubernetes.core
|
||||||
|
version: '>=2.0.0,<2.1.0'
|
||||||
@@ -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
|
||||||
Reference in New Issue
Block a user