Microshift management and automation Collection

Ansible Collection for management and automation of microshift to build rpm-ostree based images to run microshift, configure microshift, upgrade microshift, deploy kubernetes workloads on microshift, and much more.

Installing

To install this collection and its dependencies, you will need to use the Ansible ansible-galaxy command:

ansible-galaxy collection install edge.microshift

Development Environment

To use this while developing, run the following commands from within your local directory you pulled to this git repo to in order to symlink this git repo to the appropriate Ansible Collection path.

  mkdir -p ~/.ansible/collections/ansible_collections/edge
  ln -s $(pwd) ~/.ansible/collections/ansible_collections/edge/microshift

How to use

You will need a RHEL 9.2 system

RPM based install

The RHEL 9.2 system will act as the microshift node. Run the example playbook to install latest V4.13 microshift on the RHEL system. The example uses inventory group all, so be sure to setup your ansible inventory correctly.

ansible-playbook playbooks/microshift_rpm_install.yml -e rpm_install_version=4.13.*

If you just want to try out on the local host, use

ansible-playbook  -i localhost, playbooks/microshift_rpm_install.yml -e rpm_install_version=4.13.*

This requires the current user to ssh into localhost.

RPM-Ostree based install

The RHEL 9.2 system will act as the image build server to create the Microshift image. Run the playbook to create an image with the microshift package and configurations on the RHEL system:

ansible-playbook playbook/microshift_image_build.yml

Deploy application

To deploy an application on a running microshift system refer to the app role README

Communication

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

Join us in the #devel:ansible.com (general use questions and support), #community:ansible.com (community and collection development questions), and other Matrix channels.

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.

Governance

The process of decision making in this collection is based on discussing and finding consensus among participants.

Every voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!

Supported Versions of Ansible

Ansible version compatibility

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

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.

Tested with Ansible

• ansible-core (devel)
• ansible-core 2.14 (stable)
• ansible-core 2.13 (stable)
• ansible-core 2.12 (stable)

Included content

Roles:

• image_builder
• app
• rpm_install

Using this collection

Installing the Collection from Ansible Galaxy

NOTE: This collection is not yet in Ansible Galaxy as it is under heavy development and has not been released

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install edge.microshift

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

---
collections:
  - name: edge.microshift

Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install edge.microshift --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 0.1.0:

ansible-galaxy collection install edge.microshift:==0.1.0

See Ansible Using collections for more details.

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.

Contributing to this collection

The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.

We are actively accepting new contributors.

Any kind of contribution is very welcome.

You don't know how to start? Refer to our contribution guide!

We use the following guidelines:

• CONTRIBUTING
• REVIEW_CHECKLIST
• Ansible Community Guide
• Ansible Development Guide
• Ansible Collection Development Guide

Collection maintenance

The current maintainers are listed in the MAINTAINERS file. If you have questions or need help, feel free to mention them in the proposals.

To learn how to maintain / become a maintainer of this collection, refer to the Maintainer guidelines.

See Ansible Using collections for more details.

Release notes

See the changelog.

More information

• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Collections Checklist
• Ansible Community code of conduct
• The Bullhorn (the Ansible Contributor newsletter)
• News for Maintainers

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.