Skip to content

Latest commit

 

History

History
231 lines (150 loc) · 12.2 KB

README.md

File metadata and controls

231 lines (150 loc) · 12.2 KB
Raw

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.

CI Codecov

Communication

For more information about communication, see the Ansible communication guide.

Requirements

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.15.0.

Please ensure to update the network_os to use the fully qualified collection name (for example, cisco.ios.ios). 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.

Python Support

  • Collection supports 3.9+

Kubernetes Version Support

This collection supports Kubernetes versions >=1.24.

Included content

Click on the name of a plugin or module to view that content's documentation:

Connection plugins

Name Description
community.okd.oc Execute tasks in pods running on OpenShift.

Inventory plugins

Name Description
community.okd.openshift OpenShift inventory source

Modules

Name Description
community.okd.k8s Manage OpenShift objects
community.okd.openshift_adm_groups_sync Sync OpenShift Groups with records from an external provider.
community.okd.openshift_adm_migrate_template_instances Update TemplateInstances to point to the latest group-version-kinds
community.okd.openshift_adm_prune_auth Removes references to the specified roles, clusterroles, users, and groups
community.okd.openshift_adm_prune_builds Prune old completed and failed builds
community.okd.openshift_adm_prune_deployments Remove old completed and failed deployment configs
community.okd.openshift_adm_prune_images Remove unreferenced images
community.okd.openshift_auth Authenticate to OpenShift clusters which require an explicit login step
community.okd.openshift_build Start a new build or Cancel running, pending, or new builds.
community.okd.openshift_import_image Import the latest image information from a tag in a container image registry.
community.okd.openshift_process Process an OpenShift template.openshift.io/v1 Template
community.okd.openshift_registry_info Display information about the integrated registry.
community.okd.openshift_route Expose a Service as an OpenShift Route.

Installation

Installing the Collection from Ansible Galaxy

Before using the OKD collection, you need to install it with the Ansible Galaxy CLI:

ansible-galaxy collection install community.okd

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: community.okd
    version: 4.0.0

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

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:

---
plugin: community.okd.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 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:

---
- hosts: remote
  environment:
    ENABLE_TURBO_MODE: 1
  tasks:
    ...

Please read more about Ansible Turbo mode - here.

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, and work on it there.

See Contributing to community.okd.

Testing

The tests directory contains configuration for running sanity tests using ansible-test.

You can run the ansible-test sanity tests with the command:

make test-sanity

The molecule directory contains configuration for running integration tests using molecule.

You can run the molecule integration tests with the command:

make test-integration

These commands will create a directory called ansible_collections which should not be committed or added to the .gitignore (Tracking issue: ansible/ansible#68499)

Prow

This repository uses the OpenShift Prow instance for testing against live OpenShift clusters. The configuration for the CI jobs that this repository runs can be found in the openshift/release repository.

The Prow CI integration test job runs the command:

make test-integration-incluster

which will create a job that runs the normal make integration target. In order to mimic the Prow CI job, you must first build the test image using the Dockerfile in ci/Dockerfile. Then, push the image somewhere that it will be accessible to the cluster, and run

IMAGE_FORMAT=<your image> make test-integration-incluser

where the IMAGE_FORMAT environment variable is the full reference to your container (ie, IMAGE_FORMAT=quay.io/example/molecule-test-runner)

Publishing New Versions

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:
    • 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:
      1. Make sure you have antsibull-changelog installed.
      1. Make sure there are fragments for all known changes in changelogs/fragments.
      1. 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.

After the version is published, verify it exists on the OKD Collection Galaxy page.

Support

We announce releases and important changes through Ansible's The Bullhorn newsletter. Be sure you are subscribed.

We take part in the global quarterly Ansible Contributor Summit virtually or in-person. Track The Bullhorn newsletter and join us.

For more information about communication, refer to the Ansible Communication guide.

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.

Release notes

See the raw generated changelog.

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.

Code of Conduct

We follow the Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.

License

GNU General Public License v3.0 or later

See LICENCE to see the full text.