mirror of
https://github.com/openshift/community.okd.git
synced 2026-11-22 07:00:26 +00:00
Compare commits
18
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c196ccd867 | ||
|
|
d2346e4c8f | ||
|
|
140da75c0f | ||
|
|
f54297c2ac | ||
|
|
69bcd79b92 | ||
|
|
93746f2392 | ||
|
|
a3c3a69bbf | ||
|
|
d1788bed2d | ||
|
|
c1683e6dcc | ||
|
|
0bc2515809 | ||
|
|
a76c07c27a | ||
|
|
0a266a6716 | ||
|
|
ec8d7e8299 | ||
|
|
075c143e40 | ||
|
|
adfb5ee140 | ||
|
|
59e78926ec | ||
|
|
a3704021d3 | ||
|
|
3e37a4cf62 |
@@ -25,5 +25,5 @@ jobs:
|
||||
steps:
|
||||
- uses: ansible-network/github_actions/.github/actions/checkout_dependency@main
|
||||
|
||||
- name: Run ansible-lint
|
||||
uses: ansible/ansible-lint@v6.21.0
|
||||
- name: run-ansible-lint
|
||||
uses: ansible/ansible-lint@v25.1.2
|
||||
|
||||
@@ -4,6 +4,14 @@ OKD Collection Release Notes
|
||||
|
||||
.. contents:: Topics
|
||||
|
||||
v4.0.2
|
||||
======
|
||||
|
||||
Release Summary
|
||||
---------------
|
||||
|
||||
This patch updates the k8s dependency version to the 5.x range and modifies tests to handle the manual creation of service account tokens.
|
||||
|
||||
v4.0.1
|
||||
======
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
.PHONY: molecule
|
||||
|
||||
# Also needs to be updated in galaxy.yml
|
||||
VERSION = 4.0.1
|
||||
VERSION = 6.0.0-dev0
|
||||
|
||||
SANITY_TEST_ARGS ?= --docker --color
|
||||
UNITS_TEST_ARGS ?= --docker --color
|
||||
|
||||
@@ -1,14 +1,30 @@
|
||||
# OKD Collection for Ansible
|
||||
|
||||
This repo hosts the `community.okd` Ansible Collection.
|
||||
|
||||
## Description
|
||||
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.
|
||||
|
||||
<!--- STARTREMOVE --->
|
||||
[](https://github.com/ansible-collections/community.okd/actions) [](https://codecov.io/gh/ansible-collections/community.okd)
|
||||
|
||||
This repo hosts the `community.okd` Ansible Collection.
|
||||
## Communication
|
||||
|
||||
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.
|
||||
* Join the Ansible forum:
|
||||
* [Get Help](https://forum.ansible.com/c/help/6): get help or help others.
|
||||
* [POSTS TAGGED WITH 'YOUR TAG'](https://forum.ansible.com/tag/YOUR_TAG): subscribe to participate in collection-related conversations.
|
||||
* [REFER TO YOUR FORUM GROUP HERE IF EXISTS](https://forum.ansible.com/g/): by joining the team you will automatically get subscribed to the posts tagged with [your group forum tag here](https://forum.ansible.com/tags).
|
||||
* [Social Spaces](https://forum.ansible.com/c/chat/4): gather and interact with fellow enthusiasts.
|
||||
* [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide announcements including social events.
|
||||
|
||||
* The Ansible [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn): used to announce releases and important changes.
|
||||
|
||||
For more information about communication, see the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
|
||||
|
||||
## Requirements
|
||||
|
||||
<!--start requires_ansible-->
|
||||
## Ansible version compatibility
|
||||
### Ansible version compatibility
|
||||
|
||||
This collection has been tested against following Ansible versions: **>=2.15.0**.
|
||||
|
||||
@@ -18,30 +34,30 @@ A collection may contain metadata that identifies these versions.
|
||||
PEP440 is the schema used to describe the versions of Ansible.
|
||||
<!--end requires_ansible-->
|
||||
|
||||
## Python Support
|
||||
### Python Support
|
||||
|
||||
* Collection supports 3.9+
|
||||
|
||||
## Kubernetes Version Support
|
||||
### Kubernetes Version Support
|
||||
|
||||
This collection supports Kubernetes versions >=1.24.
|
||||
|
||||
## Included content
|
||||
### Included content
|
||||
|
||||
Click on the name of a plugin or module to view that content's documentation:
|
||||
|
||||
<!--start collection content-->
|
||||
### Connection plugins
|
||||
#### Connection plugins
|
||||
Name | Description
|
||||
--- | ---
|
||||
[community.okd.oc](https://github.com/openshift/community.okd/blob/main/docs/community.okd.oc_connection.rst)|Execute tasks in pods running on OpenShift.
|
||||
|
||||
### Inventory plugins
|
||||
#### Inventory plugins
|
||||
Name | Description
|
||||
--- | ---
|
||||
[community.okd.openshift](https://github.com/openshift/community.okd/blob/main/docs/community.okd.openshift_inventory.rst)|OpenShift inventory source
|
||||
|
||||
### Modules
|
||||
#### Modules
|
||||
Name | Description
|
||||
--- | ---
|
||||
[community.okd.k8s](https://github.com/openshift/community.okd/blob/main/docs/community.okd.k8s_module.rst)|Manage OpenShift objects
|
||||
@@ -62,7 +78,7 @@ Name | Description
|
||||
|
||||
<!--- ENDREMOVE --->
|
||||
|
||||
## Installation and Usage
|
||||
## Installation
|
||||
|
||||
### Installing the Collection from Ansible Galaxy
|
||||
|
||||
@@ -76,7 +92,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible
|
||||
---
|
||||
collections:
|
||||
- name: community.okd
|
||||
version: 4.0.1
|
||||
version: 4.0.2
|
||||
```
|
||||
|
||||
### Installing the Kubernetes Python Library
|
||||
@@ -85,6 +101,8 @@ Content in this collection requires the [Kubernetes Python client](https://pypi.
|
||||
|
||||
pip3 install kubernetes
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Using modules from the OKD Collection in your playbooks
|
||||
|
||||
It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example `community.okd.openshift`:
|
||||
@@ -99,29 +117,30 @@ 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.
|
||||
|
||||
## Ansible Turbo mode Tech Preview
|
||||
### Ansible Turbo mode Tech Preview
|
||||
|
||||
The `community.okd` collection supports Ansible Turbo mode as a tech preview via the `cloud.common` collection. By default, this feature is disabled. To enable Turbo mode, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. For example:
|
||||
|
||||
The ``community.okd`` collection supports Ansible Turbo mode as a tech preview via the ``cloud.common`` collection. By default, this feature is disabled. To enable Turbo mode, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. For example:
|
||||
```yaml
|
||||
---
|
||||
- hosts: remote
|
||||
environment:
|
||||
ENABLE_TURBO_MODE: 1
|
||||
tasks:
|
||||
...
|
||||
```
|
||||
|
||||
```yaml
|
||||
---
|
||||
- hosts: remote
|
||||
environment:
|
||||
ENABLE_TURBO_MODE: 1
|
||||
tasks:
|
||||
...
|
||||
```
|
||||
|
||||
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/community.okd/blob/main/docs/ansible_turbo_mode.rst).
|
||||
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/community.okd/blob/main/docs/ansible_turbo_mode.rst).
|
||||
|
||||
<!--- STARTREMOVE --->
|
||||
## Testing and Development
|
||||
## Contributing to the 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.
|
||||
|
||||
See [Contributing to community.okd](CONTRIBUTING.md).
|
||||
|
||||
## Testing
|
||||
|
||||
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:
|
||||
@@ -159,26 +178,51 @@ 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:
|
||||
|
||||
1. Update the version in the following places:
|
||||
1. Update the version in the following places:
|
||||
* a. The `version` in `galaxy.yml`
|
||||
* b. This README's `requirements.yml` example
|
||||
* c. The `DOWNSTREAM_VERSION` in `ci/downstream.sh`
|
||||
* d. The `VERSION` in `Makefile`
|
||||
* e. The version in `requirements.yml`
|
||||
2. Update the CHANGELOG:
|
||||
2. Update the CHANGELOG:
|
||||
* 1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
|
||||
* 2. Make sure there are fragments for all known changes in `changelogs/fragments`.
|
||||
* 3. Run `antsibull-changelog release`.
|
||||
3. Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
|
||||
4. Tag the version in Git and push to GitHub.
|
||||
3. Commit the changes and create a PR with the changes. Wait for tests to pass, then merge it once they have.
|
||||
4. 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).
|
||||
<!--- ENDREMOVE --->
|
||||
|
||||
## Support
|
||||
|
||||
<!--List available communication channels. In addition to channels specific to your collection, we also recommend to use the following ones.-->
|
||||
|
||||
We announce releases and important changes through Ansible's [The Bullhorn newsletter](https://github.com/ansible/community/wiki/News#the-bullhorn). Be sure you are [subscribed](https://eepurl.com/gZmiEP).
|
||||
|
||||
We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person. Track [The Bullhorn newsletter](https://eepurl.com/gZmiEP) and join us.
|
||||
|
||||
For more information about communication, refer to the [Ansible Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
|
||||
|
||||
For the latest supported versions, refer to the release notes below.
|
||||
|
||||
If you encounter issues or have questions, you can submit a support request through the following channels:
|
||||
- GitHub Issues: Report bugs, request features, or ask questions by opening an issue in the [GitHub repository](https://github.com/openshift/community.okd/).
|
||||
|
||||
## Release notes
|
||||
|
||||
See the [raw generated changelog](https://github.com/openshift/community.okd/blob/main/CHANGELOG.rst).
|
||||
|
||||
## More Information
|
||||
|
||||
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.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project.
|
||||
|
||||
If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint.
|
||||
|
||||
## License
|
||||
|
||||
GNU General Public License v3.0 or later
|
||||
|
||||
@@ -250,3 +250,10 @@ releases:
|
||||
fragments:
|
||||
- 242-fix-failed-token-deletion.yml
|
||||
release_date: '2024-12-03'
|
||||
4.0.2:
|
||||
changes:
|
||||
release_summary: This patch updates the k8s dependency version to the 5.x range
|
||||
and modifies tests to handle the manual creation of service account tokens.
|
||||
fragments:
|
||||
- 4.0.2.yml
|
||||
release_date: '2025-05-28'
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
---
|
||||
minor_changes:
|
||||
- Bump version of ansible-lint to minimum 24.7.0 (https://github.com/openshift/community.okd/pull/240).
|
||||
@@ -1,2 +0,0 @@
|
||||
bugfixes:
|
||||
- openshift_auth - fix issue where openshift_auth module sometimes does not delete the auth token. Based on stale PR (https://github.com/openshift/community.okd/pull/194).
|
||||
@@ -0,0 +1,3 @@
|
||||
---
|
||||
minor_changes:
|
||||
- Bump version of ansible-lint to 25.1.2 (https://github.com/openshift/community.okd/pull/255).
|
||||
@@ -0,0 +1,3 @@
|
||||
---
|
||||
trivial:
|
||||
- Update the README doc to match https://access.redhat.com/articles/7068606.
|
||||
+1
-1
@@ -9,7 +9,7 @@
|
||||
# - All functions are prefixed with f_ so it's obvious where they come
|
||||
# from when in use throughout the script
|
||||
|
||||
DOWNSTREAM_VERSION="4.0.1"
|
||||
DOWNSTREAM_VERSION="6.0.0-dev0"
|
||||
KEEP_DOWNSTREAM_TMPDIR="${KEEP_DOWNSTREAM_TMPDIR:-''}"
|
||||
INSTALL_DOWNSTREAM_COLLECTION_PATH="${INSTALL_DOWNSTREAM_COLLECTION_PATH:-}"
|
||||
_build_dir=""
|
||||
|
||||
+2
-2
@@ -5,7 +5,7 @@ authors:
|
||||
- willthames (https://github.com/willthames)
|
||||
- Akasurde (https://github.com/akasurde)
|
||||
dependencies:
|
||||
kubernetes.core: '>=5.0.0'
|
||||
kubernetes.core: '>=6.0.0'
|
||||
description: OKD Collection for Ansible.
|
||||
documentation: ''
|
||||
homepage: ''
|
||||
@@ -24,4 +24,4 @@ tags:
|
||||
- okd
|
||||
- cluster
|
||||
# Also needs to be updated in the Makefile
|
||||
version: 4.0.1
|
||||
version: 6.0.0-dev0
|
||||
|
||||
+2
-3
@@ -19,11 +19,10 @@ plugin_routing:
|
||||
redirect: community.okd.openshift_auth
|
||||
inventory:
|
||||
openshift:
|
||||
deprecation:
|
||||
tombstone:
|
||||
removal_version: 5.0.0
|
||||
warning_text: >-
|
||||
The openshift inventory plugin has been deprecated and
|
||||
will be removed in release 5.0.0.
|
||||
Use kubernetes.core.k8s_info and ansible.builtin.add_host instead.
|
||||
action:
|
||||
k8s:
|
||||
redirect: kubernetes.core.k8s_info
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
# Want to make sure comments don't break it
|
||||
export NAME=test123
|
||||
NAMESPACE=openshift
|
||||
NGINX_VERSION=1.22-ubi8
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -14,12 +14,7 @@ provisioner:
|
||||
log: true
|
||||
options:
|
||||
vvv: True
|
||||
config_options:
|
||||
inventory:
|
||||
enable_plugins: community.okd.openshift
|
||||
inventory:
|
||||
hosts:
|
||||
plugin: community.okd.openshift
|
||||
host_vars:
|
||||
localhost:
|
||||
virtualenv: ${MOLECULE_EPHEMERAL_DIRECTORY}/virtualenv
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
- set_fact:
|
||||
test_sa: "clusterrole-sa"
|
||||
test_ns: "clusterrole-ns"
|
||||
test_tn: "clusterrole-tn"
|
||||
|
||||
- name: Ensure namespace
|
||||
kubernetes.core.k8s:
|
||||
@@ -26,34 +27,27 @@
|
||||
name: "{{ test_sa }}"
|
||||
namespace: "{{ test_ns }}"
|
||||
|
||||
- name: Read Service Account
|
||||
kubernetes.core.k8s_info:
|
||||
kind: ServiceAccount
|
||||
namespace: "{{ test_ns }}"
|
||||
name: "{{ test_sa }}"
|
||||
register: result
|
||||
|
||||
- set_fact:
|
||||
secret_token: "{{ result.resources[0]['secrets'][0]['name'] }}"
|
||||
- name: Create SA token
|
||||
kubernetes.core.k8s:
|
||||
definition:
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: "{{ test_tn }}"
|
||||
namespace: "{{ test_ns }}"
|
||||
annotations:
|
||||
kubernetes.io/service-account.name: "{{ test_sa }}"
|
||||
type: kubernetes.io/service-account-token
|
||||
|
||||
- name: Get secret details
|
||||
kubernetes.core.k8s_info:
|
||||
kind: Secret
|
||||
namespace: '{{ test_ns }}'
|
||||
name: '{{ secret_token }}'
|
||||
namespace: "{{ test_ns }}"
|
||||
name: "{{ test_tn }}"
|
||||
register: _secret
|
||||
retries: 10
|
||||
delay: 10
|
||||
until:
|
||||
- ("'openshift.io/token-secret.value' in _secret.resources[0]['metadata']['annotations']") or ("'token' in _secret.resources[0]['data']")
|
||||
|
||||
- set_fact:
|
||||
api_token: "{{ _secret.resources[0]['metadata']['annotations']['openshift.io/token-secret.value'] }}"
|
||||
when: "'openshift.io/token-secret.value' in _secret.resources[0]['metadata']['annotations']"
|
||||
|
||||
- set_fact:
|
||||
api_token: "{{ _secret.resources[0]['data']['token'] | b64decode }}"
|
||||
when: "'token' in _secret.resources[0]['data']"
|
||||
|
||||
- name: list Node should failed (forbidden user)
|
||||
kubernetes.core.k8s_info:
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
test_ns: "prune-roles"
|
||||
sa_name: "roles-sa"
|
||||
pod_name: "pod-prune"
|
||||
tn_name: "roles-sa-token"
|
||||
role_definition:
|
||||
- name: pod-list
|
||||
labels:
|
||||
@@ -50,34 +51,27 @@
|
||||
name: '{{ sa_name }}'
|
||||
namespace: '{{ test_ns }}'
|
||||
|
||||
- name: Read Service Account
|
||||
kubernetes.core.k8s_info:
|
||||
kind: ServiceAccount
|
||||
namespace: '{{ test_ns }}'
|
||||
name: '{{ sa_name }}'
|
||||
register: sa_out
|
||||
|
||||
- set_fact:
|
||||
secret_token: "{{ sa_out.resources[0]['secrets'][0]['name'] }}"
|
||||
- name: Create SA secret
|
||||
kubernetes.core.k8s:
|
||||
definition:
|
||||
apiVersion: v1
|
||||
kind: Secret
|
||||
metadata:
|
||||
name: "{{ tn_name }}"
|
||||
namespace: "{{ test_ns }}"
|
||||
annotations:
|
||||
kubernetes.io/service-account.name: "{{ sa_name }}"
|
||||
type: kubernetes.io/service-account-token
|
||||
|
||||
- name: Get secret details
|
||||
kubernetes.core.k8s_info:
|
||||
kind: Secret
|
||||
namespace: '{{ test_ns }}'
|
||||
name: '{{ secret_token }}'
|
||||
name: '{{ tn_name }}'
|
||||
register: r_secret
|
||||
retries: 10
|
||||
delay: 10
|
||||
until:
|
||||
- ("'openshift.io/token-secret.value' in r_secret.resources[0]['metadata']['annotations']") or ("'token' in r_secret.resources[0]['data']")
|
||||
|
||||
- set_fact:
|
||||
api_token: "{{ r_secret.resources[0]['metadata']['annotations']['openshift.io/token-secret.value'] }}"
|
||||
when: "'openshift.io/token-secret.value' in r_secret.resources[0]['metadata']['annotations']"
|
||||
|
||||
- set_fact:
|
||||
api_token: "{{ r_secret.resources[0]['data']['token'] | b64decode }}"
|
||||
when: "'token' in r_secret.resources[0]['data']"
|
||||
|
||||
- name: list resources using service account
|
||||
kubernetes.core.k8s_info:
|
||||
|
||||
@@ -7,6 +7,7 @@
|
||||
parameters:
|
||||
NAMESPACE: openshift
|
||||
NAME: test123
|
||||
NGINX_VERSION: "{{ nginx_version }}"
|
||||
register: result
|
||||
|
||||
- name: Create the rendered resources
|
||||
@@ -32,6 +33,7 @@
|
||||
parameters:
|
||||
NAMESPACE: openshift
|
||||
NAME: test123
|
||||
NGINX_VERSION: "{{ nginx_version }}"
|
||||
state: present
|
||||
namespace_target: process-test
|
||||
register: result
|
||||
@@ -44,6 +46,7 @@
|
||||
NAMESPACE: openshift
|
||||
NAME: test123
|
||||
MEMORY_LIMIT: 1Gi
|
||||
NGINX_VERSION: "{{ nginx_version }}"
|
||||
state: present
|
||||
namespace_target: process-test
|
||||
register: result
|
||||
@@ -55,6 +58,7 @@
|
||||
parameters:
|
||||
NAMESPACE: openshift
|
||||
NAME: test123
|
||||
NGINX_VERSION: "{{ nginx_version }}"
|
||||
state: absent
|
||||
namespace_target: process-test
|
||||
register: result
|
||||
|
||||
@@ -1,9 +1,31 @@
|
||||
---
|
||||
- name: Verify inventory and connection plugins
|
||||
# This group is created by the openshift_inventory plugin
|
||||
# It is automatically configured to use the `oc` connection plugin
|
||||
- name: Create inventory of pods
|
||||
# We need to manually create the inventory of pods now that the inventory plugin has been removed
|
||||
gather_facts: false
|
||||
hosts: localhost
|
||||
connection: local
|
||||
tasks:
|
||||
- name: Get pods
|
||||
kubernetes.core.k8s_info:
|
||||
kind: Pod
|
||||
namespace: testing
|
||||
register: pods
|
||||
|
||||
- name: Add pods to inventory
|
||||
ansible.builtin.add_host:
|
||||
name: "{{ item.metadata.name }}"
|
||||
groups:
|
||||
- namespace_testing_pods
|
||||
ansible_oc_pod: "{{ item.metadata.name }}"
|
||||
ansible_oc_namespace: "{{ item.metadata.namespace }}"
|
||||
pod_phase: "{{ item.status.phase }}"
|
||||
ansible_remote_tmp: /tmp/.ansible
|
||||
loop: "{{ pods.resources }}"
|
||||
|
||||
- name: Verify connection plugin
|
||||
hosts: namespace_testing_pods
|
||||
gather_facts: no
|
||||
connection: community.okd.oc
|
||||
vars:
|
||||
file_content: |
|
||||
Hello world
|
||||
@@ -77,6 +99,7 @@
|
||||
- import_tasks: tasks/openshift_process.yml
|
||||
vars:
|
||||
files_dir: '{{ playbook_dir }}/files'
|
||||
nginx_version: 1.22-ubi8
|
||||
always:
|
||||
- name: Delete namespace
|
||||
community.okd.k8s:
|
||||
|
||||
@@ -1,252 +0,0 @@
|
||||
# Copyright (c) 2018 Ansible Project
|
||||
# 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 = """
|
||||
name: openshift
|
||||
author:
|
||||
- Chris Houseknecht (@chouseknecht)
|
||||
|
||||
short_description: OpenShift inventory source
|
||||
|
||||
description:
|
||||
- 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.
|
||||
|
||||
deprecated:
|
||||
removed_in: 5.0.0
|
||||
why: |
|
||||
As discussed in U(https://github.com/ansible-collections/kubernetes.core/issues/31), we decided to
|
||||
remove the openshift inventory plugin in release 5.0.0.
|
||||
alternative: "Use M(kubernetes.core.k8s_info) and M(ansible.builtin.add_host) instead."
|
||||
|
||||
options:
|
||||
plugin:
|
||||
description: token that ensures this is a source file for the 'openshift' plugin.
|
||||
required: True
|
||||
choices: ['openshift', 'community.okd.openshift']
|
||||
connections:
|
||||
description:
|
||||
- Optional list of cluster connection settings. If no connections are provided, the default
|
||||
I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces
|
||||
the active user is authorized to access.
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- Optional name to assign to the cluster. If not provided, a name is constructed from the server
|
||||
and port.
|
||||
kubeconfig:
|
||||
description:
|
||||
- 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 I(~/.kube/config). Can also be specified via K8S_AUTH_KUBECONFIG
|
||||
environment variable.
|
||||
context:
|
||||
description:
|
||||
- The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment
|
||||
variable.
|
||||
host:
|
||||
description:
|
||||
- Provide a URL for accessing the API. Can also be specified via K8S_AUTH_HOST environment variable.
|
||||
api_key:
|
||||
description:
|
||||
- Token used to authenticate with the API. Can also be specified via K8S_AUTH_API_KEY environment
|
||||
variable.
|
||||
username:
|
||||
description:
|
||||
- Provide a username for authenticating with the API. Can also be specified via K8S_AUTH_USERNAME
|
||||
environment variable.
|
||||
password:
|
||||
description:
|
||||
- Provide a password for authenticating with the API. Can also be specified via K8S_AUTH_PASSWORD
|
||||
environment variable.
|
||||
client_cert:
|
||||
description:
|
||||
- Path to a certificate used to authenticate with the API. Can also be specified via K8S_AUTH_CERT_FILE
|
||||
environment variable.
|
||||
aliases: [ cert_file ]
|
||||
client_key:
|
||||
description:
|
||||
- Path to a key file used to authenticate with the API. Can also be specified via K8S_AUTH_KEY_FILE
|
||||
environment variable.
|
||||
aliases: [ key_file ]
|
||||
ca_cert:
|
||||
description:
|
||||
- Path to a CA certificate used to authenticate with the API. Can also be specified via
|
||||
K8S_AUTH_SSL_CA_CERT environment variable.
|
||||
aliases: [ ssl_ca_cert ]
|
||||
validate_certs:
|
||||
description:
|
||||
- "Whether or not to verify the API server's SSL certificates. Can also be specified via
|
||||
K8S_AUTH_VERIFY_SSL environment variable."
|
||||
type: bool
|
||||
aliases: [ verify_ssl ]
|
||||
namespaces:
|
||||
description:
|
||||
- List of namespaces. If not specified, will fetch all containers for all namespaces user is authorized
|
||||
to access.
|
||||
|
||||
requirements:
|
||||
- "python >= 3.6"
|
||||
- "kubernetes >= 12.0.0"
|
||||
- "PyYAML >= 3.11"
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
# File must be named openshift.yaml or openshift.yml
|
||||
|
||||
- name: 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
|
||||
|
||||
- name: Use default config (~/.kube/config) file and active context, and return objects for a specific namespace
|
||||
plugin: community.okd.openshift
|
||||
connections:
|
||||
- namespaces:
|
||||
- testing
|
||||
|
||||
- name: 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'
|
||||
"""
|
||||
|
||||
try:
|
||||
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.k8s.client import (
|
||||
get_api_client,
|
||||
)
|
||||
|
||||
HAS_KUBERNETES_COLLECTION = True
|
||||
except ImportError as e:
|
||||
HAS_KUBERNETES_COLLECTION = False
|
||||
|
||||
|
||||
try:
|
||||
from kubernetes.dynamic.exceptions import DynamicApiError
|
||||
except ImportError:
|
||||
pass
|
||||
|
||||
|
||||
class InventoryModule(K8sInventoryModule):
|
||||
NAME = "community.okd.openshift"
|
||||
|
||||
connection_plugin = "community.okd.oc"
|
||||
transport = "oc"
|
||||
|
||||
def check_kubernetes_collection(self):
|
||||
if not HAS_KUBERNETES_COLLECTION:
|
||||
raise K8sInventoryException(
|
||||
"The kubernetes.core collection must be installed"
|
||||
)
|
||||
|
||||
def fetch_objects(self, connections):
|
||||
self.check_kubernetes_collection()
|
||||
super(InventoryModule, self).fetch_objects(connections)
|
||||
|
||||
self.display.deprecated(
|
||||
"The 'openshift' inventory plugin has been deprecated and will be removed in release 5.0.0",
|
||||
version="5.0.0",
|
||||
collection_name="community.okd",
|
||||
)
|
||||
|
||||
if connections:
|
||||
if not isinstance(connections, list):
|
||||
raise K8sInventoryException("Expecting connections to be a list.")
|
||||
|
||||
for connection in connections:
|
||||
client = get_api_client(**connection)
|
||||
name = connection.get(
|
||||
"name", self.get_default_host_name(client.configuration.host)
|
||||
)
|
||||
if connection.get("namespaces"):
|
||||
namespaces = connection["namespaces"]
|
||||
else:
|
||||
namespaces = self.get_available_namespaces(client)
|
||||
for namespace in namespaces:
|
||||
self.get_routes_for_namespace(client, name, namespace)
|
||||
else:
|
||||
client = get_api_client()
|
||||
name = self.get_default_host_name(client.configuration.host)
|
||||
namespaces = self.get_available_namespaces(client)
|
||||
for namespace in namespaces:
|
||||
self.get_routes_for_namespace(client, name, namespace)
|
||||
|
||||
def get_routes_for_namespace(self, client, name, namespace):
|
||||
self.check_kubernetes_collection()
|
||||
v1_route = client.resources.get(
|
||||
api_version="route.openshift.io/v1", kind="Route"
|
||||
)
|
||||
try:
|
||||
obj = v1_route.get(namespace=namespace)
|
||||
except DynamicApiError as exc:
|
||||
self.display.debug(exc)
|
||||
raise K8sInventoryException(
|
||||
"Error fetching Routes list: %s" % format_dynamic_api_exc(exc)
|
||||
)
|
||||
|
||||
namespace_group = "namespace_{0}".format(namespace)
|
||||
namespace_routes_group = "{0}_routes".format(namespace_group)
|
||||
|
||||
self.inventory.add_group(name)
|
||||
self.inventory.add_group(namespace_group)
|
||||
self.inventory.add_child(name, namespace_group)
|
||||
self.inventory.add_group(namespace_routes_group)
|
||||
self.inventory.add_child(namespace_group, namespace_routes_group)
|
||||
for route in obj.items:
|
||||
route_name = route.metadata.name
|
||||
route_annotations = (
|
||||
{}
|
||||
if not route.metadata.annotations
|
||||
else dict(route.metadata.annotations)
|
||||
)
|
||||
|
||||
self.inventory.add_host(route_name)
|
||||
|
||||
if route.metadata.labels:
|
||||
# create a group for each label_value
|
||||
for key, value in route.metadata.labels:
|
||||
group_name = "label_{0}_{1}".format(key, value)
|
||||
self.inventory.add_group(group_name)
|
||||
self.inventory.add_child(group_name, route_name)
|
||||
route_labels = dict(route.metadata.labels)
|
||||
else:
|
||||
route_labels = {}
|
||||
|
||||
self.inventory.add_child(namespace_routes_group, route_name)
|
||||
|
||||
# add hostvars
|
||||
self.inventory.set_variable(route_name, "labels", route_labels)
|
||||
self.inventory.set_variable(route_name, "annotations", route_annotations)
|
||||
self.inventory.set_variable(
|
||||
route_name, "cluster_name", route.metadata.clusterName
|
||||
)
|
||||
self.inventory.set_variable(route_name, "object_type", "route")
|
||||
self.inventory.set_variable(
|
||||
route_name, "self_link", route.metadata.selfLink
|
||||
)
|
||||
self.inventory.set_variable(
|
||||
route_name, "resource_version", route.metadata.resourceVersion
|
||||
)
|
||||
self.inventory.set_variable(route_name, "uid", route.metadata.uid)
|
||||
|
||||
if route.spec.host:
|
||||
self.inventory.set_variable(route_name, "host", route.spec.host)
|
||||
|
||||
if route.spec.path:
|
||||
self.inventory.set_variable(route_name, "path", route.spec.path)
|
||||
|
||||
if hasattr(route.spec.port, "targetPort") and route.spec.port.targetPort:
|
||||
self.inventory.set_variable(route_name, "port", dict(route.spec.port))
|
||||
@@ -295,9 +295,9 @@ class OpenShiftMigrateTemplateInstances(AnsibleOpenshiftModule):
|
||||
object_type in transforms.keys()
|
||||
and obj["ref"].get("apiVersion") != transforms[object_type]
|
||||
):
|
||||
ti_elem["status"]["objects"][i]["ref"][
|
||||
"apiVersion"
|
||||
] = transforms[object_type]
|
||||
ti_elem["status"]["objects"][i]["ref"]["apiVersion"] = (
|
||||
transforms[object_type]
|
||||
)
|
||||
ti_to_be_migrated.append(ti_elem)
|
||||
|
||||
return ti_to_be_migrated
|
||||
|
||||
@@ -225,7 +225,7 @@ def get_oauthaccesstoken_objectname_from_token(token_name):
|
||||
|
||||
sha256Prefix = "sha256~"
|
||||
if token_name.startswith(sha256Prefix):
|
||||
content = token_name[len(sha256Prefix):]
|
||||
content = token_name[len(sha256Prefix) :]
|
||||
else:
|
||||
content = token_name
|
||||
b64encoded = urlsafe_b64encode(hashlib.sha256(content.encode()).digest()).rstrip(
|
||||
|
||||
@@ -421,9 +421,9 @@ class OpenShiftRoute(AnsibleOpenshiftModule):
|
||||
if tls_insecure_policy == "disallow":
|
||||
tls_insecure_policy = None
|
||||
else:
|
||||
tls_ca_cert = (
|
||||
tls_cert
|
||||
) = tls_dest_ca_cert = tls_key = tls_insecure_policy = None
|
||||
tls_ca_cert = tls_cert = tls_dest_ca_cert = tls_key = (
|
||||
tls_insecure_policy
|
||||
) = None
|
||||
|
||||
route = {
|
||||
"apiVersion": "route.openshift.io/v1",
|
||||
|
||||
@@ -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
|
||||
@@ -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
|
||||
@@ -8,14 +8,14 @@ install_command = pip install {opts} {packages}
|
||||
|
||||
[testenv:black]
|
||||
deps =
|
||||
black >= 23.0, < 24.0
|
||||
black >= 25.0, < 26.0
|
||||
|
||||
commands =
|
||||
black {toxinidir}/plugins {toxinidir}/tests
|
||||
|
||||
[testenv:ansible-lint]
|
||||
deps =
|
||||
ansible-lint==6.21.0
|
||||
ansible-lint >= 25.1.2
|
||||
changedir = {toxinidir}
|
||||
commands =
|
||||
ansible-lint
|
||||
@@ -24,10 +24,12 @@ commands =
|
||||
deps =
|
||||
flake8
|
||||
{[testenv:black]deps}
|
||||
{[testenv:ansible-lint]deps}
|
||||
|
||||
commands =
|
||||
black -v --check --diff {toxinidir}/plugins {toxinidir}/tests
|
||||
flake8 {toxinidir}
|
||||
ansible-lint
|
||||
|
||||
[flake8]
|
||||
# E123, E125 skipped as they are invalid PEP-8.
|
||||
|
||||
Reference in New Issue
Block a user