{"id":20155250,"url":"https://github.com/redhat-cop/edge.microshift","last_synced_at":"2026-03-09T08:32:01.554Z","repository":{"id":65630812,"uuid":"593786662","full_name":"redhat-cop/edge.microshift","owner":"redhat-cop","description":"Microshift Management and Automation Collection","archived":false,"fork":false,"pushed_at":"2024-09-11T15:43:08.000Z","size":125,"stargazers_count":13,"open_issues_count":0,"forks_count":8,"subscribers_count":21,"default_branch":"main","last_synced_at":"2026-01-30T18:04:15.552Z","etag":null,"topics":["validated-content"],"latest_commit_sha":null,"homepage":"","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/redhat-cop.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-26T20:48:36.000Z","updated_at":"2024-12-29T01:22:20.000Z","dependencies_parsed_at":"2024-09-11T22:11:54.441Z","dependency_job_id":"9c38dd0b-a850-4c90-ab16-f23c99de29ef","html_url":"https://github.com/redhat-cop/edge.microshift","commit_stats":null,"previous_names":["redhat-cop/edge.microshift"],"tags_count":3,"template":false,"template_full_name":"ansible-collections/collection_template","purl":"pkg:github/redhat-cop/edge.microshift","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-cop%2Fedge.microshift","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-cop%2Fedge.microshift/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-cop%2Fedge.microshift/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-cop%2Fedge.microshift/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/redhat-cop","download_url":"https://codeload.github.com/redhat-cop/edge.microshift/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/redhat-cop%2Fedge.microshift/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30287831,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T02:57:19.223Z","status":"ssl_error","status_checked_at":"2026-03-09T02:56:26.373Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["validated-content"],"created_at":"2024-11-13T23:30:57.116Z","updated_at":"2026-03-09T08:32:01.529Z","avatar_url":"https://github.com/redhat-cop.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Microshift management and automation Collection\n\n[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7481/badge)](https://bestpractices.coreinfrastructure.org/projects/7481)\n\n[Ansible Collection](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html)\nfor management and automation of [microshift](https://microshift.io/)\nto build [rpm-ostree](https://rpm-ostree.readthedocs.io/en/latest/) based images to run microshift,\nconfigure microshift, upgrade microshift, deploy [kubernetes](https://kubernetes.io/) workloads on\nmicroshift, and much more.\n\n## Installing\n\nTo install this collection and its dependencies, you will need to use the [Ansible](https://github.com/ansible/ansible) `ansible-galaxy` command:\n\n```shell\nansible-galaxy collection install edge.microshift\n```\n\n## Development Environment\n\nTo 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](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths).\n\n```shell\nmkdir -p ~/.ansible/collections/ansible_collections/edge\nln -s $(pwd) ~/.ansible/collections/ansible_collections/edge/microshift\n```\n\n## How to use\n\nYou will need a RHEL 9.2 system\n\n### RPM based install\n\nThe RHEL 9.2 system will act as the microshift node.\nRun the example playbook to install latest V4.13 microshift on the RHEL system.\nThe example uses inventory group `all`, so be sure to setup your ansible inventory correctly.\n\n```bash\nansible-playbook playbooks/microshift_rpm_install.yml -e rpm_install_version=4.13.*\n```\n\nIf you just want to try out on the local host, use\n\n```bash\nansible-playbook  -i localhost, playbooks/microshift_rpm_install.yml -e rpm_install_version=4.13.*\n```\n\nThis requires the current user to ssh into localhost.\n\n### RPM-Ostree based install\n\nThe RHEL 9.2 system will act as the image build server to create the Microshift image.\nRun the playbook to create an image with the microshift package and configurations on the RHEL system:\n\n```bash\nansible-playbook playbook/microshift_image_build.yml\n```\n\n### Deploy application\n\nTo deploy an application on a running microshift system refer to the app role [README](https://github.com/redhat-cop/edge.microshift/blob/main/roles/app/README.md)\n\n## Communication\n\n\u003c!--List available communication channels. In addition to channels specific to your collection, we also recommend to use the following ones.--\u003e\n\nJoin the Ansible forum to ask questions, get help, and interact with us.\n\n- [Get Help](https://forum.ansible.com/c/help/6): get help or help others.\n  Please add appropriate tags if you start new discussions; for example,\n  use the [`edge`](https://forum.ansible.com/tags/c/help/6/none/edge) tag.\n- [Social Spaces](https://forum.ansible.com/c/chat/4): meet and interact with\n  fellow enthusiasts.\n- [News \u0026 Announcements](https://forum.ansible.com/c/news/5): track project-wide\n  announcements including social events.\n\nWe announce releases and important changes through Ansible's [Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).\n\nWe also take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit) virtually or in-person.\n\nFor more information about communication, refer to the [Ansible Communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).\n\n## Governance\n\n\u003c!--Describe how the collection is governed. Here can be the following text:--\u003e\n\nThe process of decision making in this collection is based on discussing and finding consensus among participants.\n\nEvery voice is important. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!\n\n## Supported Versions of Ansible\n\n\u003c!--start requires_ansible--\u003e\n\n## Ansible version compatibility\n\nThis collection has been tested against following Ansible versions: **\u003e=2.12**.\n\nPlugins and modules within a collection may be tested with only specific\nAnsible versions.  A collection may contain metadata that identifies these versions.\nPEP440 is the schema used to describe the versions of Ansible.\n\n\u003c!--end requires_ansible--\u003e\n\n## Tested with Ansible\n\n\u003c!-- List the versions of Ansible the collection has been tested with. Must match what is in galaxy.yml. --\u003e\n\n- ansible-core (devel)\n- ansible-core 2.14 (stable)\n- ansible-core 2.13 (stable)\n- ansible-core 2.12 (stable)\n\n## Included content\n\n\u003c!-- Galaxy will eventually list the module docs within the UI, but until that is ready, you may need to either describe your plugins etc here, or point to an external docsite to cover that information. --\u003e\nRoles:\n\n- image_builder\n- app\n- rpm_install\n\n## Using this collection\n\n\u003c!--Include some quick examples that cover the most common use cases for your collection content. It can include the following examples of installation and upgrade (change edge.microshift correspondingly):--\u003e\n\n### Installing the Collection from Ansible Galaxy\n\n\u003e NOTE: This collection is not yet in Ansible Galaxy as it is under heavy development and has not been released\n\nBefore using this collection, you need to install it with the Ansible Galaxy command-line tool:\n\n```bash\nansible-galaxy collection install edge.microshift\n```\n\nYou can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format:\n\n```yaml\n---\ncollections:\n  - name: edge.microshift\n```\n\nNote 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:\n\n```bash\nansible-galaxy collection install edge.microshift --upgrade\n```\n\nYou 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`:\n\n```bash\nansible-galaxy collection install edge.microshift:==0.1.0\n```\n\nSee [Ansible Using collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details.\n\n## Code of Conduct\n\nWe follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project.\n\nIf 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.\n\n## Contributing to this collection\n\n\u003c!--Describe how the community can contribute to your collection. At a minimum, fill up and include the CONTRIBUTING.md file containing how and where users can create issues to report problems or request features for this collection. List contribution requirements, including preferred workflows and necessary testing, so you can benefit from community PRs. If you are following general Ansible contributor guidelines, you can link to - [Ansible Community Guide](https://docs.ansible.com/ansible/devel/community/index.html). List the current maintainers (contributors with write or higher access to the repository). The following can be included:--\u003e\n\nThe content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.\n\nWe are actively accepting new contributors.\n\nAny kind of contribution is very welcome.\n\nYou don't know how to start? Refer to our [contribution guide](https://docs.ansible.com/ansible/devel/community/contributor_path.html)!\n\nWe use the following guidelines:\n\n- [CONTRIBUTING](https://docs.ansible.com/ansible/devel/community/contributor_path.html#making-your-first-contribution)\n- [REVIEW_CHECKLIST](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_reviewing.html)\n- [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html)\n- [Ansible Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)\n- [Ansible Collection Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections)\n\n## Collection maintenance\n\nThe current maintainers are listed in the [MAINTAINERS](MAINTAINERS) file. If you have questions or need help, feel free to mention them in the proposals.\n\nTo learn how to maintain / become a maintainer of this collection, refer to the [Maintainer guidelines](https://docs.ansible.com/ansible/devel/community/maintainers.html).\n\nSee [Ansible Using collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details.\n\n## Release notes\n\nSee the [changelog](https://github.com/redhat-cop/edge.microshift/blob/main/CHANGELOG.rst).\n\n## More information\n\n- [Ansible Collection overview](https://github.com/ansible-collections/overview)\n- [Ansible User guide](https://docs.ansible.com/ansible/devel/user_guide/index.html)\n- [Ansible Developer guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)\n- [Ansible Collections Checklist](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst)\n- [Ansible Community code of conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html)\n- [News for Maintainers](https://forum.ansible.com/tag/news-for-maintainers)\n\n## Licensing\n\n\u003c!-- Include the appropriate license information here and a pointer to the full licensing details. If the collection contains modules migrated from the ansible/ansible repo, you must use the same license that existed in the ansible/ansible repo. See the GNU license example below. --\u003e\n\nGNU General Public License v3.0 or later.\n\nSee [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhat-cop%2Fedge.microshift","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredhat-cop%2Fedge.microshift","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhat-cop%2Fedge.microshift/lists"}