OpenShift Collection for Ansible

Installation and Usage

Installing the Collection from Automation Hub

Before using the OpenShift collection, you need to install it with the Automation Hub CLI:

ansible-galaxy collection install redhat.openshift

You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: redhat.openshift
    version: 4.0.2

Installing the Kubernetes Python Library

Content in this collection requires the Kubernetes Python client to interact with Kubernetes' APIs. You can install it with:

pip3 install kubernetes

Using modules from the OpenShift Collection in your playbooks

It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example redhat.openshift.openshift:

---
plugin: redhat.openshift.openshift
connections:
  - namespaces:
    - testing

For documentation on how to use individual plugins included in this collection, please see the links in the 'Included content' section earlier in this README.

Ansible Turbo mode Tech Preview

The redhat.openshift collection supports Ansible Turbo mode as a tech preview via the cloud.common collection. By default, this feature is disabled. To enable Turbo mode, set the environment variable ENABLE_TURBO_MODE=1 on the managed node. For example:

```yaml

• hosts: remote environment: ENABLE_TURBO_MODE: 1 tasks: ... ```

Please read more about Ansible Turbo mode - here.

More Information

For more information about Ansible's Kubernetes and OpenShift integrations, join the #ansible-kubernetes channel on libera.chat IRC, and browse the resources in the Kubernetes Working Group Community wiki page.

License

GNU General Public License v3.0 or later

See LICENCE to see the full text.