mirror of
https://github.com/openshift/community.okd.git
synced 2026-11-22 15:10:29 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6942cd6756 | ||
|
|
b7e341842d | ||
|
|
037f8b1f4f | ||
|
|
f52d63c83f | ||
|
|
1339e2bdf7 | ||
|
|
80ae2e6b1e |
@@ -51,7 +51,7 @@ jobs:
|
|||||||
# 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
|
# Explicity specify the version of Python we want to test
|
||||||
- name: Run sanity tests
|
- name: Run sanity tests
|
||||||
run: make test-sanity TEST_ARGS='--python ${{ matrix.python }}'
|
run: make upstream-test-sanity TEST_ARGS='--python ${{ matrix.python }}'
|
||||||
working-directory: ./ansible_collections/community/okd
|
working-directory: ./ansible_collections/community/okd
|
||||||
|
|
||||||
###
|
###
|
||||||
|
|||||||
@@ -5,6 +5,25 @@ OKD Collection Release Notes
|
|||||||
.. contents:: Topics
|
.. contents:: Topics
|
||||||
|
|
||||||
|
|
||||||
|
v0.2.0
|
||||||
|
======
|
||||||
|
|
||||||
|
Major Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- openshift_auth - new module (migrated from k8s_auth in community.kubernetes) (https://github.com/ansible-collections/community.okd/pull/33).
|
||||||
|
|
||||||
|
Minor Changes
|
||||||
|
-------------
|
||||||
|
|
||||||
|
- Add a contribution guide (https://github.com/ansible-collections/community.okd/pull/37).
|
||||||
|
- Use the API Group APIVersion for the `Route` object (https://github.com/ansible-collections/community.okd/pull/27).
|
||||||
|
|
||||||
|
New Modules
|
||||||
|
-----------
|
||||||
|
|
||||||
|
- openshift_auth - Authenticate to OpenShift clusters which require an explicit login step
|
||||||
|
|
||||||
v0.1.0
|
v0.1.0
|
||||||
======
|
======
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,65 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
General information about setting up your Python environment, testing modules,
|
||||||
|
Ansible coding styles, and more can be found in the [Ansible Community Guide](
|
||||||
|
https://docs.ansible.com/ansible/latest/community/index.html).
|
||||||
|
|
||||||
|
|
||||||
|
## Kubernetes Collections
|
||||||
|
|
||||||
|
### community.okd
|
||||||
|
|
||||||
|
This collection contains modules and plugins contributed and maintained by the Ansible Kubernetes
|
||||||
|
community.
|
||||||
|
|
||||||
|
New modules and plugins developed by the community should be proposed to `community.okd`.
|
||||||
|
|
||||||
|
## Submitting Issues
|
||||||
|
All software has bugs, and the `community.okd` collection is no exception. When you find a bug,
|
||||||
|
you can help tremendously by [telling us about it](https://github.com/ansible-collections/community.okd/issues/new/choose).
|
||||||
|
|
||||||
|
If you should discover that the bug you're trying to file already exists in an issue,
|
||||||
|
you can help by verifying the behavior of the reported bug with a comment in that
|
||||||
|
issue, or by reporting any additional information.
|
||||||
|
|
||||||
|
## Pull Requests
|
||||||
|
|
||||||
|
All modules MUST have integration tests for new features.
|
||||||
|
Bug fixes for modules that currently have integration tests SHOULD have tests added.
|
||||||
|
New modules should be submitted to the [community.okd](https://github.com/ansible-collections/community.okd) collection and MUST have integration tests.
|
||||||
|
|
||||||
|
Expected test criteria:
|
||||||
|
* Resource creation under check mode
|
||||||
|
* Resource creation
|
||||||
|
* Resource creation again (idempotency) under check mode
|
||||||
|
* Resource creation again (idempotency)
|
||||||
|
* Resource modification under check mode
|
||||||
|
* Resource modification
|
||||||
|
* Resource modification again (idempotency) under check mode
|
||||||
|
* Resource modification again (idempotency)
|
||||||
|
* Resource deletion under check mode
|
||||||
|
* Resource deletion
|
||||||
|
* Resource deletion (of a non-existent resource) under check mode
|
||||||
|
* Resource deletion (of a non-existent resource)
|
||||||
|
|
||||||
|
Where modules have multiple parameters we recommend running through the 4-step modification cycle for each parameter the module accepts, as well as a modification cycle where as most, if not all, parameters are modified at the same time.
|
||||||
|
|
||||||
|
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),
|
||||||
|
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.
|
||||||
|
|
||||||
|
|
||||||
|
### Code of Conduct
|
||||||
|
The `community.okd` collection follows the Ansible project's
|
||||||
|
[Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html).
|
||||||
|
Please read and familiarize yourself with this document.
|
||||||
|
|
||||||
|
### IRC
|
||||||
|
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.
|
||||||
|
|
||||||
|
The `#ansible-kubernetes` channel on Freenode IRC 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.
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
# Also needs to be updated in galaxy.yml
|
# Also needs to be updated in galaxy.yml
|
||||||
VERSION = 0.1.0
|
VERSION = 0.2.0
|
||||||
|
|
||||||
# To run sanity tests in a venv, set SANITY_TEST_ARGS to '--venv'
|
# To run sanity tests in a venv, set SANITY_TEST_ARGS to '--venv'
|
||||||
SANITY_TEST_ARGS ?= --docker --color
|
SANITY_TEST_ARGS ?= --docker --color
|
||||||
@@ -20,19 +20,18 @@ install-kubernetes-src:
|
|||||||
install: build install-kubernetes-src
|
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
|
||||||
|
|
||||||
test-sanity: install
|
test-integration-incluster:
|
||||||
cd ansible_collections/community/okd && ansible-test sanity --exclude ci/ -v $(SANITY_TEST_ARGS)
|
./ci/incluster_integration.sh
|
||||||
|
|
||||||
test-integration: install
|
test-sanity: upstream-test-sanity downstream-test-sanity
|
||||||
|
|
||||||
|
test-integration: upstream-test-integration downstream-test-integration
|
||||||
|
|
||||||
|
upstream-test-integration: install
|
||||||
molecule test
|
molecule test
|
||||||
|
|
||||||
test-integration-incluster: test-integration-incluster-upstream test-integration-incluster-downstream
|
upstream-test-sanity: install
|
||||||
|
cd ansible_collections/community/okd && ansible-test sanity --exclude ci/ -v $(SANITY_TEST_ARGS)
|
||||||
test-integration-incluster-upstream:
|
|
||||||
./ci/incluster_integration_upstream.sh
|
|
||||||
|
|
||||||
test-integration-incluster-downstream:
|
|
||||||
./ci/incluster_integration_downstream.sh
|
|
||||||
|
|
||||||
downstream-test-sanity:
|
downstream-test-sanity:
|
||||||
./ci/downstream.sh -s
|
./ci/downstream.sh -s
|
||||||
@@ -42,4 +41,3 @@ downstream-test-integration:
|
|||||||
|
|
||||||
downstream-build:
|
downstream-build:
|
||||||
./ci/downstream.sh -b
|
./ci/downstream.sh -b
|
||||||
|
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ Click on the name of a plugin or module to view that content's documentation:
|
|||||||
- [openshift](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/openshift_inventory.html)
|
- [openshift](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/openshift_inventory.html)
|
||||||
- **Modules**:
|
- **Modules**:
|
||||||
- [k8s](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_inventory.html)
|
- [k8s](https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_inventory.html)
|
||||||
|
- [openshift_auth](https://github.com/ansible-collections/community.okd/blob/main/plugins/modules/openshift_auth.py)
|
||||||
|
|
||||||
> **Note**: These documentation links currently link to older module versions. For the latest module documentation, please use `ansible-doc` in the CLI.
|
> **Note**: These documentation links currently link to older module versions. For the latest module documentation, please use `ansible-doc` in the CLI.
|
||||||
|
|
||||||
@@ -33,7 +34,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible
|
|||||||
---
|
---
|
||||||
collections:
|
collections:
|
||||||
- name: community.okd
|
- name: community.okd
|
||||||
version: 0.1.0
|
version: 0.2.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### Installing the OpenShift Python Library
|
### Installing the OpenShift Python Library
|
||||||
@@ -60,6 +61,8 @@ For documentation on how to use individual plugins included in this collection,
|
|||||||
|
|
||||||
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.
|
||||||
|
|
||||||
|
See [Contributing to community.okd](CONTRIBUTING.md).
|
||||||
|
|
||||||
The `tests` directory contains configuration for running sanity tests using [`ansible-test`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html).
|
The `tests` directory contains configuration for running sanity tests using [`ansible-test`](https://docs.ansible.com/ansible/latest/dev_guide/testing_integration.html).
|
||||||
|
|
||||||
You can run the `ansible-test` sanity tests with the command:
|
You can run the `ansible-test` sanity tests with the command:
|
||||||
@@ -97,7 +100,7 @@ where the `IMAGE_FORMAT` environment variable is the full reference to your cont
|
|||||||
|
|
||||||
Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:
|
Releases are automatically built and pushed to Ansible Galaxy for any new tag. Before tagging a release, make sure to do the following:
|
||||||
|
|
||||||
1. Update `galaxy.yml` and this README's `requirements.yml` example with the new `version` for the collection.
|
1. Update `galaxy.yml`, this README's `requirements.yml` example, and the `Makefile` with the new `version` for the collection.
|
||||||
1. Update the CHANGELOG:
|
1. Update the CHANGELOG:
|
||||||
1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
|
1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
|
||||||
1. Make sure there are fragments for all known changes in `changelogs/fragments`.
|
1. Make sure there are fragments for all known changes in `changelogs/fragments`.
|
||||||
|
|||||||
@@ -26,3 +26,21 @@ releases:
|
|||||||
- 7-molecule-tests.yml
|
- 7-molecule-tests.yml
|
||||||
- 8-stale-bot.yml
|
- 8-stale-bot.yml
|
||||||
release_date: '2020-09-04'
|
release_date: '2020-09-04'
|
||||||
|
0.2.0:
|
||||||
|
changes:
|
||||||
|
major_changes:
|
||||||
|
- openshift_auth - new module (migrated from k8s_auth in community.kubernetes)
|
||||||
|
(https://github.com/ansible-collections/community.okd/pull/33).
|
||||||
|
minor_changes:
|
||||||
|
- Add a contribution guide (https://github.com/ansible-collections/community.okd/pull/37).
|
||||||
|
- Use the API Group APIVersion for the `Route` object (https://github.com/ansible-collections/community.okd/pull/27).
|
||||||
|
fragments:
|
||||||
|
- 27-route-api-group.yml
|
||||||
|
- 33-add-k8s_auth.yml
|
||||||
|
- 36-contribution-guide.yml
|
||||||
|
modules:
|
||||||
|
- description: Authenticate to OpenShift clusters which require an explicit login
|
||||||
|
step
|
||||||
|
name: openshift_auth
|
||||||
|
namespace: ''
|
||||||
|
release_date: '2020-09-24'
|
||||||
|
|||||||
@@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
minor_changes:
|
||||||
|
- Use the API Group APIVersion for the `Route` object (https://github.com/ansible-collections/community.okd/pull/27).
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
major_changes:
|
||||||
|
- openshift_auth - new module (migrated from k8s_auth in community.kubernetes) (https://github.com/ansible-collections/community.okd/pull/33).
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
minor_changes:
|
||||||
|
- Add a contribution guide (https://github.com/ansible-collections/community.okd/pull/37).
|
||||||
+1
-1
@@ -17,7 +17,7 @@ RUN yum install -y \
|
|||||||
&& 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 \
|
openshift \
|
||||||
ansible \
|
ansible==2.9.* \
|
||||||
molecule \
|
molecule \
|
||||||
&& yum clean all \
|
&& yum clean all \
|
||||||
&& rm -rf $HOME/.cache \
|
&& rm -rf $HOME/.cache \
|
||||||
|
|||||||
+8
-3
@@ -133,9 +133,8 @@ f_install_kubernetes_core_from_src()
|
|||||||
# ansible-galaxy collection install -p "${install_collections_dir}" "${community_k8s_tmpdir}"/kubernetes-core-*.tar.gz
|
# ansible-galaxy collection install -p "${install_collections_dir}" "${community_k8s_tmpdir}"/kubernetes-core-*.tar.gz
|
||||||
# popd
|
# popd
|
||||||
#popd
|
#popd
|
||||||
git clone https://github.com/maxamillion/community.kubernetes "${community_k8s_tmpdir}"
|
git clone https://github.com/ansible-collections/community.kubernetes "${community_k8s_tmpdir}"
|
||||||
pushd "${community_k8s_tmpdir}"
|
pushd "${community_k8s_tmpdir}"
|
||||||
git checkout downstream/fix_collection_name
|
|
||||||
make downstream-build
|
make downstream-build
|
||||||
ansible-galaxy collection install -p "${install_collections_dir}" "${community_k8s_tmpdir}"/kubernetes-core-*.tar.gz
|
ansible-galaxy collection install -p "${install_collections_dir}" "${community_k8s_tmpdir}"/kubernetes-core-*.tar.gz
|
||||||
popd
|
popd
|
||||||
@@ -170,7 +169,13 @@ f_test_sanity_option()
|
|||||||
## Can't do this because the upstream community.kubernetes dependency logic
|
## Can't do this because the upstream community.kubernetes dependency logic
|
||||||
## is bound as a Makefile dep to the test-sanity target
|
## is bound as a Makefile dep to the test-sanity target
|
||||||
#SANITY_TEST_ARGS="--docker --color --python 3.6" make test-sanity
|
#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
|
||||||
|
then
|
||||||
ansible-test sanity --docker -v --exclude ci/ --color --python 3.6
|
ansible-test sanity --docker -v --exclude ci/ --color --python 3.6
|
||||||
|
else
|
||||||
|
ansible-test sanity --venv -v --exclude ci/ --color --python 3.6
|
||||||
|
fi
|
||||||
popd || return
|
popd || return
|
||||||
f_cleanup
|
f_cleanup
|
||||||
}
|
}
|
||||||
@@ -183,7 +188,7 @@ f_test_integration_option()
|
|||||||
f_install_kubernetes_core_from_src
|
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}"
|
||||||
make test-integration-incluster
|
OVERRIDE_COLLECTION_PATH="${_tmp_dir}" molecule test
|
||||||
popd || return
|
popd || return
|
||||||
f_cleanup
|
f_cleanup
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,8 @@
|
|||||||
|
|
||||||
set -x
|
set -x
|
||||||
|
|
||||||
|
NAMESPACE=${NAMESPACE:-default}
|
||||||
|
|
||||||
# IMAGE_FORMAT is in the form $registry/$org/$image:$$component, ie
|
# IMAGE_FORMAT is in the form $registry/$org/$image:$$component, ie
|
||||||
# quay.io/openshift/release:$component
|
# quay.io/openshift/release:$component
|
||||||
# To test with your own image, build and push the test image
|
# To test with your own image, build and push the test image
|
||||||
@@ -14,6 +16,15 @@ eval IMAGE=$IMAGE_FORMAT
|
|||||||
|
|
||||||
PULL_POLICY=${PULL_POLICY:-IfNotPresent}
|
PULL_POLICY=${PULL_POLICY:-IfNotPresent}
|
||||||
|
|
||||||
|
if ! oc get namespace $NAMESPACE
|
||||||
|
then
|
||||||
|
oc create namespace $NAMESPACE
|
||||||
|
fi
|
||||||
|
|
||||||
|
oc project $NAMESPACE
|
||||||
|
oc adm policy add-cluster-role-to-user cluster-admin -z default
|
||||||
|
oc adm policy who-can create projectrequests
|
||||||
|
|
||||||
echo "Deleting test job if it exists"
|
echo "Deleting test job if it exists"
|
||||||
oc delete job molecule-integration-test --wait --ignore-not-found
|
oc delete job molecule-integration-test --wait --ignore-not-found
|
||||||
|
|
||||||
@@ -40,22 +51,36 @@ spec:
|
|||||||
parallelism: 1
|
parallelism: 1
|
||||||
EOF
|
EOF
|
||||||
|
|
||||||
function wait_for_success {
|
function check_success {
|
||||||
oc wait --for=condition=complete job/molecule-integration-test --timeout 5m
|
oc wait --for=condition=complete job/molecule-integration-test --timeout 5s -n $NAMESPACE \
|
||||||
echo "Molecule integration tests ran successfully"
|
&& oc logs job/molecule-integration-test \
|
||||||
exit 0
|
&& echo "Molecule integration tests ran successfully" \
|
||||||
|
&& return 0
|
||||||
|
return 1
|
||||||
}
|
}
|
||||||
|
|
||||||
function wait_for_failure {
|
function check_failure {
|
||||||
oc wait --for=condition=failed job/molecule-integration-test --timeout 5m
|
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..." \
|
||||||
exit 1
|
&& return 0
|
||||||
|
return 1
|
||||||
}
|
}
|
||||||
|
|
||||||
# Ensure the child processes are killed
|
runtime="15 minute"
|
||||||
trap 'kill -SIGTERM 0' SIGINT EXIT
|
endtime=$(date -ud "$runtime" +%s)
|
||||||
|
|
||||||
echo "Waiting for test job to complete"
|
echo "Waiting for test job to complete"
|
||||||
wait_for_success &
|
while [[ $(date -u +%s) -le $endtime ]]
|
||||||
wait_for_failure
|
do
|
||||||
|
if check_success
|
||||||
|
then
|
||||||
|
exit 0
|
||||||
|
elif check_failure
|
||||||
|
then
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
sleep 10
|
||||||
|
done
|
||||||
|
|
||||||
|
exit 1
|
||||||
@@ -1,61 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
set -x
|
|
||||||
|
|
||||||
# IMAGE_FORMAT is in the form $registry/$org/$image:$$component, ie
|
|
||||||
# quay.io/openshift/release:$component
|
|
||||||
# To test with your own image, build and push the test image
|
|
||||||
# (using the Dockerfile in ci/Dockerfile)
|
|
||||||
# and set the IMAGE_FORMAT environment variable so that it properly
|
|
||||||
# resolves to your image. For example, quay.io/mynamespace/$component
|
|
||||||
# would resolve to quay.io/mynamespace/molecule-test-runner
|
|
||||||
component='molecule-test-runner'
|
|
||||||
eval IMAGE=$IMAGE_FORMAT
|
|
||||||
|
|
||||||
PULL_POLICY=${PULL_POLICY:-IfNotPresent}
|
|
||||||
|
|
||||||
echo "Deleting test job if it exists"
|
|
||||||
oc delete job molecule-integration-test --wait --ignore-not-found
|
|
||||||
|
|
||||||
echo "Creating molecule test job"
|
|
||||||
cat << EOF | oc create -f -
|
|
||||||
---
|
|
||||||
apiVersion: batch/v1
|
|
||||||
kind: Job
|
|
||||||
metadata:
|
|
||||||
name: molecule-integration-test
|
|
||||||
spec:
|
|
||||||
template:
|
|
||||||
spec:
|
|
||||||
containers:
|
|
||||||
- name: test-runner
|
|
||||||
image: ${IMAGE}
|
|
||||||
imagePullPolicy: ${PULL_POLICY}
|
|
||||||
command:
|
|
||||||
- make
|
|
||||||
- downstream-test-integration
|
|
||||||
restartPolicy: Never
|
|
||||||
backoffLimit: 2
|
|
||||||
completions: 1
|
|
||||||
parallelism: 1
|
|
||||||
EOF
|
|
||||||
|
|
||||||
function wait_for_success {
|
|
||||||
oc wait --for=condition=complete job/molecule-integration-test --timeout 5m
|
|
||||||
echo "Molecule integration tests ran successfully"
|
|
||||||
exit 0
|
|
||||||
}
|
|
||||||
|
|
||||||
function wait_for_failure {
|
|
||||||
oc wait --for=condition=failed job/molecule-integration-test --timeout 5m
|
|
||||||
oc logs job/molecule-integration-test
|
|
||||||
echo "Molecule integration tests failed, see logs for more information..."
|
|
||||||
exit 1
|
|
||||||
}
|
|
||||||
|
|
||||||
# Ensure the child processes are killed
|
|
||||||
trap 'kill -SIGTERM 0' SIGINT EXIT
|
|
||||||
|
|
||||||
echo "Waiting for test job to complete"
|
|
||||||
wait_for_success &
|
|
||||||
wait_for_failure
|
|
||||||
+1
-1
@@ -24,4 +24,4 @@ tags:
|
|||||||
- okd
|
- okd
|
||||||
- cluster
|
- cluster
|
||||||
# Also needs to be updated in the Makefile
|
# Also needs to be updated in the Makefile
|
||||||
version: 0.1.0
|
version: 0.2.0
|
||||||
|
|||||||
@@ -5,6 +5,8 @@
|
|||||||
gather_facts: no
|
gather_facts: no
|
||||||
vars:
|
vars:
|
||||||
ansible_python_interpreter: '{{ virtualenv_interpreter }}'
|
ansible_python_interpreter: '{{ virtualenv_interpreter }}'
|
||||||
|
vars_files:
|
||||||
|
- vars/main.yml
|
||||||
tasks:
|
tasks:
|
||||||
# OpenShift Resources
|
# OpenShift Resources
|
||||||
- name: Create a project
|
- name: Create a project
|
||||||
@@ -22,41 +24,76 @@
|
|||||||
- name: Create deployment config
|
- name: Create deployment config
|
||||||
community.okd.k8s:
|
community.okd.k8s:
|
||||||
state: present
|
state: present
|
||||||
inline: &dc
|
|
||||||
apiVersion: v1
|
|
||||||
kind: DeploymentConfig
|
|
||||||
metadata:
|
|
||||||
name: hello-world
|
name: hello-world
|
||||||
labels:
|
|
||||||
app: galaxy
|
|
||||||
service: hello-world
|
|
||||||
namespace: testing
|
namespace: testing
|
||||||
spec:
|
definition: '{{ okd_dc_template }}'
|
||||||
template:
|
|
||||||
metadata:
|
|
||||||
labels:
|
|
||||||
app: galaxy
|
|
||||||
service: hello-world
|
|
||||||
spec:
|
|
||||||
containers:
|
|
||||||
- name: hello-world
|
|
||||||
image: python
|
|
||||||
command:
|
|
||||||
- python
|
|
||||||
- '-m'
|
|
||||||
- http.server
|
|
||||||
env:
|
|
||||||
- name: TEST
|
|
||||||
value: test
|
|
||||||
replicas: 1
|
|
||||||
strategy:
|
|
||||||
type: Recreate
|
|
||||||
wait: yes
|
wait: yes
|
||||||
wait_condition:
|
wait_condition:
|
||||||
type: Available
|
type: Available
|
||||||
status: True
|
status: True
|
||||||
|
vars:
|
||||||
|
k8s_pod_name: hello-world
|
||||||
|
k8s_pod_image: python
|
||||||
|
k8s_pod_command:
|
||||||
|
- python
|
||||||
|
- '-m'
|
||||||
|
- http.server
|
||||||
|
k8s_pod_env:
|
||||||
|
- name: TEST
|
||||||
|
value: test
|
||||||
|
okd_dc_triggers:
|
||||||
|
- type: ConfigChange
|
||||||
register: output
|
register: output
|
||||||
|
|
||||||
- name: Show output
|
- name: Show output
|
||||||
debug:
|
debug:
|
||||||
var: output
|
var: output
|
||||||
|
|
||||||
|
- vars:
|
||||||
|
image: docker.io/python
|
||||||
|
image_name: python
|
||||||
|
image_tag: latest
|
||||||
|
k8s_pod_image: python
|
||||||
|
k8s_pod_command:
|
||||||
|
- python
|
||||||
|
- '-m'
|
||||||
|
- http.server
|
||||||
|
namespace: idempotence-testing
|
||||||
|
block:
|
||||||
|
- name: Create a namespace
|
||||||
|
community.okd.k8s:
|
||||||
|
name: '{{ namespace }}'
|
||||||
|
kind: Namespace
|
||||||
|
api_version: v1
|
||||||
|
|
||||||
|
- name: Create imagestream
|
||||||
|
community.okd.k8s:
|
||||||
|
namespace: '{{ namespace }}'
|
||||||
|
definition: '{{ okd_imagestream_template }}'
|
||||||
|
|
||||||
|
- name: Create DeploymentConfig to reference ImageStream
|
||||||
|
community.okd.k8s:
|
||||||
|
name: '{{ k8s_pod_name }}'
|
||||||
|
namespace: '{{ namespace }}'
|
||||||
|
definition: '{{ okd_dc_template }}'
|
||||||
|
vars:
|
||||||
|
k8s_pod_name: is-idempotent-dc
|
||||||
|
|
||||||
|
- name: Create Deployment to reference ImageStream
|
||||||
|
community.okd.k8s:
|
||||||
|
name: '{{ k8s_pod_name }}'
|
||||||
|
namespace: '{{ namespace }}'
|
||||||
|
definition: '{{ k8s_deployment_template | combine(metadata) }}'
|
||||||
|
vars:
|
||||||
|
k8s_pod_annotations:
|
||||||
|
"alpha.image.policy.openshift.io/resolve-names": "*"
|
||||||
|
k8s_pod_name: is-idempotent-deployment
|
||||||
|
annotation:
|
||||||
|
- from:
|
||||||
|
kind: ImageStreamTag
|
||||||
|
name: "{{ image_name }}:{{ image_tag}}}"
|
||||||
|
fieldPath: 'spec.template.spec.containers[?(@.name=="{{ k8s_pod_name }}")].image}'
|
||||||
|
metadata:
|
||||||
|
metadata:
|
||||||
|
annotations:
|
||||||
|
image.openshift.io/triggers: '{{ annotation | to_json }}'
|
||||||
|
|||||||
@@ -9,6 +9,9 @@ platforms:
|
|||||||
- k8s
|
- k8s
|
||||||
provisioner:
|
provisioner:
|
||||||
name: ansible
|
name: ansible
|
||||||
|
log: true
|
||||||
|
options:
|
||||||
|
vvv: True
|
||||||
config_options:
|
config_options:
|
||||||
inventory:
|
inventory:
|
||||||
enable_plugins: community.okd.openshift
|
enable_plugins: community.okd.openshift
|
||||||
@@ -26,7 +29,7 @@ provisioner:
|
|||||||
playbook_namespace: molecule-tests
|
playbook_namespace: molecule-tests
|
||||||
env:
|
env:
|
||||||
ANSIBLE_FORCE_COLOR: 'true'
|
ANSIBLE_FORCE_COLOR: 'true'
|
||||||
ANSIBLE_COLLECTIONS_PATHS: ${MOLECULE_PROJECT_DIRECTORY}
|
ANSIBLE_COLLECTIONS_PATHS: ${OVERRIDE_COLLECTION_PATH:-$MOLECULE_PROJECT_DIRECTORY}
|
||||||
verifier:
|
verifier:
|
||||||
name: ansible
|
name: ansible
|
||||||
lint: |
|
lint: |
|
||||||
|
|||||||
@@ -15,3 +15,46 @@
|
|||||||
virtualenv: "{{ virtualenv }}"
|
virtualenv: "{{ virtualenv }}"
|
||||||
virtualenv_command: "{{ virtualenv_command }}"
|
virtualenv_command: "{{ virtualenv_command }}"
|
||||||
virtualenv_site_packages: no
|
virtualenv_site_packages: no
|
||||||
|
|
||||||
|
- name: 'Configure htpasswd secret (username: test, password: testing123)'
|
||||||
|
community.okd.k8s:
|
||||||
|
definition:
|
||||||
|
apiVersion: v1
|
||||||
|
kind: Secret
|
||||||
|
metadata:
|
||||||
|
name: htpass-secret
|
||||||
|
namespace: openshift-config
|
||||||
|
stringData:
|
||||||
|
htpasswd: "test:$2y$05$zgjczyp96jCIp//CGmnWiefhd7G3l54IdsZoV4IwA1UWtd04L0lE2"
|
||||||
|
|
||||||
|
- name: Configure htpasswd identity provider
|
||||||
|
community.okd.k8s:
|
||||||
|
definition:
|
||||||
|
apiVersion: config.openshift.io/v1
|
||||||
|
kind: OAuth
|
||||||
|
metadata:
|
||||||
|
name: cluster
|
||||||
|
spec:
|
||||||
|
identityProviders:
|
||||||
|
- name: htpasswd_provider
|
||||||
|
mappingMethod: claim
|
||||||
|
type: HTPasswd
|
||||||
|
htpasswd:
|
||||||
|
fileData:
|
||||||
|
name: htpass-secret
|
||||||
|
|
||||||
|
- name: Create ClusterRoleBinding for test user
|
||||||
|
community.okd.k8s:
|
||||||
|
definition:
|
||||||
|
apiVersion: rbac.authorization.k8s.io/v1
|
||||||
|
kind: ClusterRoleBinding
|
||||||
|
metadata:
|
||||||
|
name: test-cluster-reader
|
||||||
|
roleRef:
|
||||||
|
apiGroup: rbac.authorization.k8s.io
|
||||||
|
kind: ClusterRole
|
||||||
|
name: cluster-reader
|
||||||
|
subjects:
|
||||||
|
- apiGroup: rbac.authorization.k8s.io
|
||||||
|
kind: User
|
||||||
|
name: test
|
||||||
|
|||||||
@@ -0,0 +1,51 @@
|
|||||||
|
---
|
||||||
|
- vars:
|
||||||
|
# TODO(fabianvf) Get this parameter working locally as well
|
||||||
|
openshift_host: 'https://kubernetes.default.svc'
|
||||||
|
block:
|
||||||
|
- name: Log in (obtain access token)
|
||||||
|
community.okd.openshift_auth:
|
||||||
|
username: test
|
||||||
|
password: testing123
|
||||||
|
host: '{{ openshift_host }}'
|
||||||
|
verify_ssl: false
|
||||||
|
register: openshift_auth_results
|
||||||
|
|
||||||
|
- name: Get the test User
|
||||||
|
community.kubernetes.k8s_info:
|
||||||
|
api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
|
||||||
|
host: '{{ openshift_host }}'
|
||||||
|
verify_ssl: false
|
||||||
|
kind: User
|
||||||
|
api_version: user.openshift.io/v1
|
||||||
|
name: test
|
||||||
|
register: user_result
|
||||||
|
|
||||||
|
- name: assert that the user was found
|
||||||
|
assert:
|
||||||
|
that: (user_result.resources | length) == 1
|
||||||
|
|
||||||
|
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 }}"
|
||||||
|
host: '{{ openshift_host }}'
|
||||||
|
verify_ssl: false
|
||||||
|
|
||||||
|
- name: Get the test user
|
||||||
|
community.kubernetes.k8s_info:
|
||||||
|
api_key: "{{ openshift_auth_results.openshift_auth.api_key }}"
|
||||||
|
host: '{{ openshift_host }}'
|
||||||
|
verify_ssl: false
|
||||||
|
kind: User
|
||||||
|
name: test
|
||||||
|
api_version: user.openshift.io/v1
|
||||||
|
register: failed_user_result
|
||||||
|
ignore_errors: yes
|
||||||
|
|
||||||
|
# TODO(fabianvf) determine why token is not being rejected, maybe add more info to return
|
||||||
|
# - name: assert that the user was not found
|
||||||
|
# assert:
|
||||||
|
# that: (failed_user_result.resources | length) == 0
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
---
|
||||||
|
k8s_pod_annotations: {}
|
||||||
|
|
||||||
|
k8s_pod_metadata:
|
||||||
|
labels:
|
||||||
|
app: '{{ k8s_pod_name }}'
|
||||||
|
annotations: '{{ k8s_pod_annotations }}'
|
||||||
|
|
||||||
|
k8s_pod_spec:
|
||||||
|
serviceAccount: "{{ k8s_pod_service_account }}"
|
||||||
|
containers:
|
||||||
|
- image: "{{ k8s_pod_image }}"
|
||||||
|
imagePullPolicy: Always
|
||||||
|
name: "{{ k8s_pod_name }}"
|
||||||
|
command: "{{ k8s_pod_command }}"
|
||||||
|
readinessProbe:
|
||||||
|
initialDelaySeconds: 15
|
||||||
|
exec:
|
||||||
|
command:
|
||||||
|
- /bin/true
|
||||||
|
resources: "{{ k8s_pod_resources }}"
|
||||||
|
ports: "{{ k8s_pod_ports }}"
|
||||||
|
env: "{{ k8s_pod_env }}"
|
||||||
|
|
||||||
|
k8s_pod_service_account: default
|
||||||
|
|
||||||
|
k8s_pod_resources:
|
||||||
|
limits:
|
||||||
|
cpu: "100m"
|
||||||
|
memory: "100Mi"
|
||||||
|
|
||||||
|
k8s_pod_command: []
|
||||||
|
|
||||||
|
k8s_pod_ports: []
|
||||||
|
|
||||||
|
k8s_pod_env: []
|
||||||
|
|
||||||
|
k8s_pod_template:
|
||||||
|
metadata: "{{ k8s_pod_metadata }}"
|
||||||
|
spec: "{{ k8s_pod_spec }}"
|
||||||
|
|
||||||
|
k8s_deployment_spec:
|
||||||
|
template: '{{ k8s_pod_template }}'
|
||||||
|
selector:
|
||||||
|
matchLabels:
|
||||||
|
app: '{{ k8s_pod_name }}'
|
||||||
|
replicas: 1
|
||||||
|
|
||||||
|
k8s_deployment_template:
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
spec: '{{ k8s_deployment_spec }}'
|
||||||
|
|
||||||
|
okd_dc_triggers:
|
||||||
|
- type: ConfigChange
|
||||||
|
- type: ImageChange
|
||||||
|
imageChangeParams:
|
||||||
|
automatic: true
|
||||||
|
containerNames:
|
||||||
|
- '{{ k8s_pod_name }}'
|
||||||
|
from:
|
||||||
|
kind: ImageStreamTag
|
||||||
|
name: '{{ image_name }}:{{ image_tag }}'
|
||||||
|
|
||||||
|
okd_dc_spec:
|
||||||
|
template: '{{ k8s_pod_template }}'
|
||||||
|
triggers: '{{ okd_dc_triggers }}'
|
||||||
|
replicas: 1
|
||||||
|
strategy:
|
||||||
|
type: Recreate
|
||||||
|
|
||||||
|
okd_dc_template:
|
||||||
|
apiVersion: v1
|
||||||
|
kind: DeploymentConfig
|
||||||
|
spec: '{{ okd_dc_spec }}'
|
||||||
|
|
||||||
|
okd_imagestream_template:
|
||||||
|
apiVersion: image.openshift.io/v1
|
||||||
|
kind: ImageStream
|
||||||
|
metadata:
|
||||||
|
name: '{{ image_name }}'
|
||||||
|
spec:
|
||||||
|
lookupPolicy:
|
||||||
|
local: true
|
||||||
|
tags:
|
||||||
|
- annotations: null
|
||||||
|
from:
|
||||||
|
kind: DockerImage
|
||||||
|
name: '{{ image }}'
|
||||||
|
name: '{{ image_tag }}'
|
||||||
|
referencePolicy:
|
||||||
|
type: Source
|
||||||
|
|
||||||
|
image_tag: latest
|
||||||
@@ -59,3 +59,5 @@
|
|||||||
virtualenv_site_packages: no
|
virtualenv_site_packages: no
|
||||||
|
|
||||||
- import_tasks: tasks/validate_not_installed.yml
|
- import_tasks: tasks/validate_not_installed.yml
|
||||||
|
|
||||||
|
- import_tasks: tasks/openshift_auth.yml
|
||||||
|
|||||||
@@ -151,7 +151,7 @@ class InventoryModule(K8sInventoryModule):
|
|||||||
self.get_routes_for_namespace(client, name, namespace)
|
self.get_routes_for_namespace(client, name, namespace)
|
||||||
|
|
||||||
def get_routes_for_namespace(self, client, name, namespace):
|
def get_routes_for_namespace(self, client, name, namespace):
|
||||||
v1_route = client.resources.get(api_version='v1', kind='Route')
|
v1_route = client.resources.get(api_version='route.openshift.io/v1', kind='Route')
|
||||||
try:
|
try:
|
||||||
obj = v1_route.get(namespace=namespace)
|
obj = v1_route.get(namespace=namespace)
|
||||||
except DynamicApiError as exc:
|
except DynamicApiError as exc:
|
||||||
|
|||||||
+107
-1
@@ -265,7 +265,10 @@ result:
|
|||||||
sample: 48
|
sample: 48
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
import re
|
||||||
|
import operator
|
||||||
import traceback
|
import traceback
|
||||||
|
from functools import reduce
|
||||||
|
|
||||||
from ansible.module_utils._text import to_native
|
from ansible.module_utils._text import to_native
|
||||||
|
|
||||||
@@ -279,11 +282,15 @@ except ImportError as e:
|
|||||||
from ansible.module_utils.basic import AnsibleModule as KubernetesRawModule
|
from ansible.module_utils.basic import AnsibleModule as KubernetesRawModule
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
import yaml
|
||||||
from openshift.dynamic.exceptions import DynamicApiError, NotFoundError, ForbiddenError
|
from openshift.dynamic.exceptions import DynamicApiError, NotFoundError, ForbiddenError
|
||||||
except ImportError:
|
except ImportError:
|
||||||
# Exceptions handled in common
|
# Exceptions handled in common
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
TRIGGER_ANNOTATION = 'image.openshift.io/triggers'
|
||||||
|
TRIGGER_CONTAINER = re.compile(r"(?P<path>.*)\[((?P<index>[0-9]+)|\?\(@\.name==[\"'\\]*(?P<name>[a-z0-9]([-a-z0-9]*[a-z0-9])?))")
|
||||||
|
|
||||||
|
|
||||||
class OKDRawModule(KubernetesRawModule):
|
class OKDRawModule(KubernetesRawModule):
|
||||||
|
|
||||||
@@ -301,7 +308,9 @@ class OKDRawModule(KubernetesRawModule):
|
|||||||
name = definition['metadata'].get('name')
|
name = definition['metadata'].get('name')
|
||||||
namespace = definition['metadata'].get('namespace')
|
namespace = definition['metadata'].get('namespace')
|
||||||
|
|
||||||
if definition['kind'] in ['Project', 'ProjectRequest'] and state != 'absent':
|
if state != 'absent':
|
||||||
|
|
||||||
|
if resource.kind in ['Project', 'ProjectRequest']:
|
||||||
try:
|
try:
|
||||||
resource.get(name, namespace)
|
resource.get(name, namespace)
|
||||||
except (NotFoundError, ForbiddenError):
|
except (NotFoundError, ForbiddenError):
|
||||||
@@ -310,8 +319,105 @@ class OKDRawModule(KubernetesRawModule):
|
|||||||
self.fail_json(msg='Failed to retrieve requested object: {0}'.format(exc.body),
|
self.fail_json(msg='Failed to retrieve requested object: {0}'.format(exc.body),
|
||||||
error=exc.status, status=exc.status, reason=exc.reason)
|
error=exc.status, status=exc.status, reason=exc.reason)
|
||||||
|
|
||||||
|
try:
|
||||||
|
existing = resource.get(name=name, namespace=namespace).to_dict()
|
||||||
|
except Exception:
|
||||||
|
existing = None
|
||||||
|
|
||||||
|
if existing:
|
||||||
|
if resource.kind == 'DeploymentConfig':
|
||||||
|
if definition.get('spec', {}).get('triggers'):
|
||||||
|
definition = self.resolve_imagestream_triggers(existing, definition)
|
||||||
|
elif existing['metadata'].get('annotations', {}).get(TRIGGER_ANNOTATION):
|
||||||
|
definition = self.resolve_imagestream_trigger_annotation(existing, definition)
|
||||||
|
|
||||||
return super(OKDRawModule, self).perform_action(resource, definition)
|
return super(OKDRawModule, self).perform_action(resource, definition)
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def get_index(desired, objects, keys):
|
||||||
|
""" Iterates over keys, returns the first object from objects where the value of the key
|
||||||
|
matches the value in desired
|
||||||
|
"""
|
||||||
|
for i, item in enumerate(objects):
|
||||||
|
if item and all([desired.get(key, True) == item.get(key, False) for key in keys]):
|
||||||
|
return i
|
||||||
|
|
||||||
|
def resolve_imagestream_trigger_annotation(self, existing, definition):
|
||||||
|
|
||||||
|
def get_from_fields(d, fields):
|
||||||
|
try:
|
||||||
|
return reduce(operator.getitem, fields, d)
|
||||||
|
except Exception:
|
||||||
|
return None
|
||||||
|
|
||||||
|
def set_from_fields(d, fields, value):
|
||||||
|
get_from_fields(d, fields[:-1])[fields[-1]] = value
|
||||||
|
|
||||||
|
if TRIGGER_ANNOTATION in definition['metadata'].get('annotations', {}).keys():
|
||||||
|
triggers = yaml.safe_load(definition['metadata']['annotations'][TRIGGER_ANNOTATION] or '[]')
|
||||||
|
else:
|
||||||
|
triggers = yaml.safe_load(existing['metadata'].get('annotations', '{}').get(TRIGGER_ANNOTATION, '[]'))
|
||||||
|
|
||||||
|
if not isinstance(triggers, list):
|
||||||
|
return definition
|
||||||
|
|
||||||
|
for trigger in triggers:
|
||||||
|
if trigger.get('fieldPath'):
|
||||||
|
parsed = self.parse_trigger_fieldpath(trigger['fieldPath'])
|
||||||
|
path = parsed.get('path', '').split('.')
|
||||||
|
if path:
|
||||||
|
existing_containers = get_from_fields(existing, path)
|
||||||
|
new_containers = get_from_fields(definition, path)
|
||||||
|
if parsed.get('name'):
|
||||||
|
existing_index = self.get_index({'name': parsed['name']}, existing_containers, ['name'])
|
||||||
|
new_index = self.get_index({'name': parsed['name']}, new_containers, ['name'])
|
||||||
|
elif parsed.get('index') is not None:
|
||||||
|
existing_index = new_index = int(parsed['index'])
|
||||||
|
else:
|
||||||
|
existing_index = new_index = None
|
||||||
|
if existing_index is not None and new_index is not None:
|
||||||
|
if existing_index < len(existing_containers) and new_index < len(new_containers):
|
||||||
|
set_from_fields(definition, path + [new_index, 'image'], get_from_fields(existing, path + [existing_index, 'image']))
|
||||||
|
return definition
|
||||||
|
|
||||||
|
def resolve_imagestream_triggers(self, existing, definition):
|
||||||
|
|
||||||
|
existing_triggers = existing.get('spec', {}).get('triggers')
|
||||||
|
new_triggers = definition['spec']['triggers']
|
||||||
|
existing_containers = existing.get('spec', {}).get('template', {}).get('spec', {}).get('containers', [])
|
||||||
|
new_containers = definition.get('spec', {}).get('template', {}).get('spec', {}).get('containers', [])
|
||||||
|
for i, trigger in enumerate(new_triggers):
|
||||||
|
if trigger.get('type') == 'ImageChange' and trigger.get('imageChangeParams'):
|
||||||
|
names = trigger['imageChangeParams'].get('containerNames', [])
|
||||||
|
for name in names:
|
||||||
|
old_container_index = self.get_index({'name': name}, existing_containers, ['name'])
|
||||||
|
new_container_index = self.get_index({'name': name}, new_containers, ['name'])
|
||||||
|
if old_container_index is not None and new_container_index is not None:
|
||||||
|
image = existing['spec']['template']['spec']['containers'][old_container_index]['image']
|
||||||
|
definition['spec']['template']['spec']['containers'][new_container_index]['image'] = image
|
||||||
|
|
||||||
|
existing_index = self.get_index(trigger['imageChangeParams'], [x.get('imageChangeParams') for x in existing_triggers], ['containerNames'])
|
||||||
|
if existing_index is not None:
|
||||||
|
existing_image = existing_triggers[existing_index].get('imageChangeParams', {}).get('lastTriggeredImage')
|
||||||
|
if existing_image:
|
||||||
|
definition['spec']['triggers'][i]['imageChangeParams']['lastTriggeredImage'] = existing_image
|
||||||
|
existing_from = existing_triggers[existing_index].get('imageChangeParams', {}).get('from', {})
|
||||||
|
new_from = trigger['imageChangeParams'].get('from', {})
|
||||||
|
existing_namespace = existing_from.get('namespace')
|
||||||
|
existing_name = existing_from.get('name', False)
|
||||||
|
new_name = new_from.get('name', True)
|
||||||
|
add_namespace = existing_namespace and 'namespace' not in new_from.keys() and existing_name == new_name
|
||||||
|
if add_namespace:
|
||||||
|
definition['spec']['triggers'][i]['imageChangeParams']['from']['namespace'] = existing_from['namespace']
|
||||||
|
|
||||||
|
return definition
|
||||||
|
|
||||||
|
def parse_trigger_fieldpath(self, expression):
|
||||||
|
parsed = TRIGGER_CONTAINER.search(expression).groupdict()
|
||||||
|
if parsed.get('index'):
|
||||||
|
parsed['index'] = int(parsed['index'])
|
||||||
|
return parsed
|
||||||
|
|
||||||
def create_project_request(self, definition):
|
def create_project_request(self, definition):
|
||||||
definition['kind'] = 'ProjectRequest'
|
definition['kind'] = 'ProjectRequest'
|
||||||
result = {'changed': False, 'result': {}}
|
result = {'changed': False, 'result': {}}
|
||||||
|
|||||||
Symlink
+1
@@ -0,0 +1 @@
|
|||||||
|
openshift_auth.py
|
||||||
@@ -0,0 +1,365 @@
|
|||||||
|
#!/usr/bin/python
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
# Copyright (c) 2018, KubeVirt Team <@kubevirt>
|
||||||
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
from __future__ import absolute_import, division, print_function
|
||||||
|
|
||||||
|
__metaclass__ = type
|
||||||
|
|
||||||
|
|
||||||
|
DOCUMENTATION = r'''
|
||||||
|
|
||||||
|
module: openshift_auth
|
||||||
|
|
||||||
|
short_description: Authenticate to OpenShift clusters which require an explicit login step
|
||||||
|
|
||||||
|
version_added: "0.2.0"
|
||||||
|
|
||||||
|
author:
|
||||||
|
- KubeVirt Team (@kubevirt)
|
||||||
|
- Fabian von Feilitzsch (@fabianvf)
|
||||||
|
|
||||||
|
description:
|
||||||
|
- This module handles authenticating to OpenShift clusters requiring I(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 C(k8s) module (and other
|
||||||
|
resource–specific modules) by utilizing the C(host), C(username) and C(password) parameters. Please
|
||||||
|
consult your preferred module's documentation for more details.
|
||||||
|
|
||||||
|
options:
|
||||||
|
state:
|
||||||
|
description:
|
||||||
|
- If set to I(present) connect to the API server using the URL specified in C(host) and attempt to log in.
|
||||||
|
- If set to I(absent) attempt to log out by revoking the authentication token specified in C(api_key).
|
||||||
|
default: present
|
||||||
|
choices:
|
||||||
|
- present
|
||||||
|
- absent
|
||||||
|
type: str
|
||||||
|
host:
|
||||||
|
description:
|
||||||
|
- Provide a URL for accessing the API server.
|
||||||
|
required: true
|
||||||
|
type: str
|
||||||
|
username:
|
||||||
|
description:
|
||||||
|
- Provide a username for authenticating with the API server.
|
||||||
|
type: str
|
||||||
|
password:
|
||||||
|
description:
|
||||||
|
- Provide a password for authenticating with the API server.
|
||||||
|
type: str
|
||||||
|
ca_cert:
|
||||||
|
description:
|
||||||
|
- "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."
|
||||||
|
aliases: [ ssl_ca_cert ]
|
||||||
|
type: path
|
||||||
|
validate_certs:
|
||||||
|
description:
|
||||||
|
- "Whether or not to verify the API server's SSL certificates."
|
||||||
|
type: bool
|
||||||
|
default: true
|
||||||
|
aliases: [ verify_ssl ]
|
||||||
|
api_key:
|
||||||
|
description:
|
||||||
|
- When C(state) is set to I(absent), this specifies the token to revoke.
|
||||||
|
type: str
|
||||||
|
|
||||||
|
requirements:
|
||||||
|
- python >= 2.7
|
||||||
|
- urllib3
|
||||||
|
- requests
|
||||||
|
- requests-oauthlib
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = r'''
|
||||||
|
- 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
|
||||||
|
community.kubernetes.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 }}"
|
||||||
|
'''
|
||||||
|
|
||||||
|
# Returned value names need to match k8s modules parameter names, to make it
|
||||||
|
# easy to pass returned values of openshift_auth to other k8s modules.
|
||||||
|
# Discussion: https://github.com/ansible/ansible/pull/50807#discussion_r248827899
|
||||||
|
RETURN = r'''
|
||||||
|
openshift_auth:
|
||||||
|
description: OpenShift authentication facts.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
api_key:
|
||||||
|
description: Authentication token.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
host:
|
||||||
|
description: URL for accessing the API server.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
ca_cert:
|
||||||
|
description: Path to a CA certificate file used to verify connection to the API server.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
validate_certs:
|
||||||
|
description: "Whether or not to verify the API server's SSL certificates."
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
username:
|
||||||
|
description: Username for authenticating with the API server.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
k8s_auth:
|
||||||
|
description: Same as returned openshift_auth. Kept only for backwards compatibility
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
api_key:
|
||||||
|
description: Authentication token.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
host:
|
||||||
|
description: URL for accessing the API server.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
ca_cert:
|
||||||
|
description: Path to a CA certificate file used to verify connection to the API server.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
validate_certs:
|
||||||
|
description: "Whether or not to verify the API server's SSL certificates."
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
username:
|
||||||
|
description: Username for authenticating with the API server.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
import traceback
|
||||||
|
|
||||||
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
from ansible.module_utils.six.moves.urllib_parse import urlparse, parse_qs, urlencode
|
||||||
|
|
||||||
|
# 3rd party imports
|
||||||
|
try:
|
||||||
|
import requests
|
||||||
|
HAS_REQUESTS = True
|
||||||
|
except ImportError:
|
||||||
|
HAS_REQUESTS = False
|
||||||
|
|
||||||
|
try:
|
||||||
|
from requests_oauthlib import OAuth2Session
|
||||||
|
HAS_REQUESTS_OAUTH = True
|
||||||
|
except ImportError:
|
||||||
|
HAS_REQUESTS_OAUTH = False
|
||||||
|
|
||||||
|
try:
|
||||||
|
from urllib3.util import make_headers
|
||||||
|
HAS_URLLIB3 = True
|
||||||
|
except ImportError:
|
||||||
|
HAS_URLLIB3 = False
|
||||||
|
|
||||||
|
|
||||||
|
K8S_AUTH_ARG_SPEC = {
|
||||||
|
'state': {
|
||||||
|
'default': 'present',
|
||||||
|
'choices': ['present', 'absent'],
|
||||||
|
},
|
||||||
|
'host': {'required': True},
|
||||||
|
'username': {},
|
||||||
|
'password': {'no_log': True},
|
||||||
|
'ca_cert': {'type': 'path', 'aliases': ['ssl_ca_cert']},
|
||||||
|
'validate_certs': {
|
||||||
|
'type': 'bool',
|
||||||
|
'default': True,
|
||||||
|
'aliases': ['verify_ssl']
|
||||||
|
},
|
||||||
|
'api_key': {'no_log': True},
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class OpenShiftAuthModule(AnsibleModule):
|
||||||
|
def __init__(self):
|
||||||
|
AnsibleModule.__init__(
|
||||||
|
self,
|
||||||
|
argument_spec=K8S_AUTH_ARG_SPEC,
|
||||||
|
required_if=[
|
||||||
|
('state', 'present', ['username', 'password']),
|
||||||
|
('state', 'absent', ['api_key']),
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
if not HAS_REQUESTS:
|
||||||
|
self.fail("This module requires the python 'requests' package. Try `pip install requests`.")
|
||||||
|
|
||||||
|
if not HAS_REQUESTS_OAUTH:
|
||||||
|
self.fail("This module requires the python 'requests-oauthlib' package. Try `pip install requests-oauthlib`.")
|
||||||
|
|
||||||
|
if not HAS_URLLIB3:
|
||||||
|
self.fail("This module requires the python 'urllib3' package. Try `pip install urllib3`.")
|
||||||
|
|
||||||
|
def execute_module(self):
|
||||||
|
state = self.params.get('state')
|
||||||
|
verify_ssl = self.params.get('validate_certs')
|
||||||
|
ssl_ca_cert = self.params.get('ca_cert')
|
||||||
|
|
||||||
|
self.auth_username = self.params.get('username')
|
||||||
|
self.auth_password = self.params.get('password')
|
||||||
|
self.auth_api_key = self.params.get('api_key')
|
||||||
|
self.con_host = self.params.get('host')
|
||||||
|
|
||||||
|
# python-requests takes either a bool or a path to a ca file as the 'verify' param
|
||||||
|
if verify_ssl and ssl_ca_cert:
|
||||||
|
self.con_verify_ca = ssl_ca_cert # path
|
||||||
|
else:
|
||||||
|
self.con_verify_ca = verify_ssl # bool
|
||||||
|
|
||||||
|
# Get needed info to access authorization APIs
|
||||||
|
self.openshift_discover()
|
||||||
|
|
||||||
|
if state == 'present':
|
||||||
|
new_api_key = self.openshift_login()
|
||||||
|
result = dict(
|
||||||
|
host=self.con_host,
|
||||||
|
validate_certs=verify_ssl,
|
||||||
|
ca_cert=ssl_ca_cert,
|
||||||
|
api_key=new_api_key,
|
||||||
|
username=self.auth_username,
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
self.openshift_logout()
|
||||||
|
result = dict()
|
||||||
|
|
||||||
|
# return k8s_auth as well for backwards compatibility
|
||||||
|
self.exit_json(changed=False, openshift_auth=result, k8s_auth=result)
|
||||||
|
|
||||||
|
def openshift_discover(self):
|
||||||
|
url = '{0}/.well-known/oauth-authorization-server'.format(self.con_host)
|
||||||
|
ret = requests.get(url, verify=self.con_verify_ca)
|
||||||
|
|
||||||
|
if ret.status_code != 200:
|
||||||
|
self.fail_request("Couldn't find OpenShift's OAuth API", method='GET', url=url,
|
||||||
|
reason=ret.reason, status_code=ret.status_code)
|
||||||
|
|
||||||
|
try:
|
||||||
|
oauth_info = ret.json()
|
||||||
|
|
||||||
|
self.openshift_auth_endpoint = oauth_info['authorization_endpoint']
|
||||||
|
self.openshift_token_endpoint = oauth_info['token_endpoint']
|
||||||
|
except Exception:
|
||||||
|
self.fail_json(msg="Something went wrong discovering OpenShift OAuth details.",
|
||||||
|
exception=traceback.format_exc())
|
||||||
|
|
||||||
|
def openshift_login(self):
|
||||||
|
os_oauth = OAuth2Session(client_id='openshift-challenging-client')
|
||||||
|
authorization_url, state = os_oauth.authorization_url(self.openshift_auth_endpoint,
|
||||||
|
state="1", code_challenge_method='S256')
|
||||||
|
auth_headers = make_headers(basic_auth='{0}:{1}'.format(self.auth_username, self.auth_password))
|
||||||
|
|
||||||
|
# Request authorization code using basic auth credentials
|
||||||
|
ret = os_oauth.get(
|
||||||
|
authorization_url,
|
||||||
|
headers={'X-Csrf-Token': state, 'authorization': auth_headers.get('authorization')},
|
||||||
|
verify=self.con_verify_ca,
|
||||||
|
allow_redirects=False
|
||||||
|
)
|
||||||
|
|
||||||
|
if ret.status_code != 302:
|
||||||
|
self.fail_request("Authorization failed.", method='GET', url=authorization_url,
|
||||||
|
reason=ret.reason, status_code=ret.status_code)
|
||||||
|
|
||||||
|
# In here we have `code` and `state`, I think `code` is the important one
|
||||||
|
qwargs = {}
|
||||||
|
for k, v in parse_qs(urlparse(ret.headers['Location']).query).items():
|
||||||
|
qwargs[k] = v[0]
|
||||||
|
qwargs['grant_type'] = 'authorization_code'
|
||||||
|
|
||||||
|
# Using authorization code given to us in the Location header of the previous request, request a token
|
||||||
|
ret = os_oauth.post(
|
||||||
|
self.openshift_token_endpoint,
|
||||||
|
headers={
|
||||||
|
'Accept': 'application/json',
|
||||||
|
'Content-Type': 'application/x-www-form-urlencoded',
|
||||||
|
# This is just base64 encoded 'openshift-challenging-client:'
|
||||||
|
'Authorization': 'Basic b3BlbnNoaWZ0LWNoYWxsZW5naW5nLWNsaWVudDo='
|
||||||
|
},
|
||||||
|
data=urlencode(qwargs),
|
||||||
|
verify=self.con_verify_ca
|
||||||
|
)
|
||||||
|
|
||||||
|
if ret.status_code != 200:
|
||||||
|
self.fail_request("Failed to obtain an authorization token.", method='POST',
|
||||||
|
url=self.openshift_token_endpoint,
|
||||||
|
reason=ret.reason, status_code=ret.status_code)
|
||||||
|
|
||||||
|
return ret.json()['access_token']
|
||||||
|
|
||||||
|
def openshift_logout(self):
|
||||||
|
url = '{0}/apis/oauth.openshift.io/v1/oauthaccesstokens/{1}'.format(self.con_host, self.auth_api_key)
|
||||||
|
headers = {
|
||||||
|
'Accept': 'application/json',
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
'Authorization': 'Bearer {0}'.format(self.auth_api_key)
|
||||||
|
}
|
||||||
|
json = {
|
||||||
|
"apiVersion": "oauth.openshift.io/v1",
|
||||||
|
"kind": "DeleteOptions"
|
||||||
|
}
|
||||||
|
|
||||||
|
requests.delete(url, headers=headers, json=json, verify=self.con_verify_ca)
|
||||||
|
# Ignore errors, the token will time out eventually anyway
|
||||||
|
|
||||||
|
def fail(self, msg=None):
|
||||||
|
self.fail_json(msg=msg)
|
||||||
|
|
||||||
|
def fail_request(self, msg, **kwargs):
|
||||||
|
req_info = {}
|
||||||
|
for k, v in kwargs.items():
|
||||||
|
req_info['req_' + k] = v
|
||||||
|
self.fail_json(msg=msg, **req_info)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
module = OpenShiftAuthModule()
|
||||||
|
try:
|
||||||
|
module.execute_module()
|
||||||
|
except Exception as e:
|
||||||
|
module.fail_json(msg=str(e), exception=traceback.format_exc())
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
Reference in New Issue
Block a user