https://github.com/mirantis/mosk-hocm-contrib
https://github.com/mirantis/mosk-hocm-contrib
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/mirantis/mosk-hocm-contrib
- Owner: Mirantis
- License: apache-2.0
- Created: 2025-01-22T21:19:38.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-04-28T12:36:55.000Z (20 days ago)
- Last Synced: 2025-05-07T16:16:40.743Z (11 days ago)
- Language: Jinja
- Size: 60.5 KB
- Stars: 1
- Watchers: 5
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Contributed Host OS Configuration Modules for MOSK
Welcome to the collection of 3rd party-developed **Host OS Configuration Modules** for **Mirantis OpenStack for Kubernetes (MOSK)**. This repository contains various configuration modules created and contributed by Mirantis Professional Services, Customer Support teams, partners, and users of Mirantis' products.
## ⚠️ Disclaimer
- **Mirantis does not guarantee** that any of the contributed modules will be functional at any time or will be compatible with the latest version of MOSK.
- **Mirantis is not responsible** for any damage, issues, or disruptions caused by the usage of these modules, use these modules **at your own risk** and test them in a safe environment before deploying them in production.
## 📌 What is This Repository For?
This repository serves as a community-driven collection of host OS configuration modules, which can be used to fine-tune the underlying host operating system for MOSK deployments. Contributors from the community, Mirantis professional services, and customer support teams can publish their modules here.
The standard modules shipped with MOSK are maintained under the [Mirantis/mosk-host-os-modules repository on GitHub](https://github.com/Mirantis/mosk-host-os-modules).
## 🚀 Getting Started
To use any of the modules from this repository:
1. Clone the repository:
```sh
git clone https://github.com/Mirantis/mosk-hocm-contrib.git
cd mosk-hocm-contrib
```
2. Browse the available modules in the root directory of this repository, check the modules' documentation.
3. Package the selected module. A package is a simple `*.tgz` archive of all the files in the directory. Make sure to include the version of the module into the archive name.
```sh
tar -czf module_name-module_version.tgz -C /path/to/module/directory .
```
5. Place the package to a HTTP server where your MOSK management cluster can download it.
6. Following the instructions provided in [MOSK Operations Guide :: Bare metal operations :: Host OS configuration](https://docs.mirantis.com/mosk/latest/ops/bm-operations/host-os-conf.html) for adding a custom module. This is achieved by creating a new HostOSConfigurationModules custom resource in the MOSK management API.
7. Create a new HostOSConfiguration resource in the MOSK management API referencing the package by URL, name and version, passing necessary parameters and targeting machines by labels.
## 📜 Contribution Guidelines
We encourage contributions from the community! If you have developed a module that you believe would benefit others, feel free to contribute it by following these steps:
1. **Fork** this repository.
2. **Create a new branch** for your module:
```sh
git checkout -b feature-new-module
```
3. **Add your module** to the appropriate directory, along with a README file explaining how it works.
4. **Submit a Pull Request (PR)** with a clear description of your module.
### Contribution Requirements
- Ensure your module is well-documented.
- Include a `README.md` explaining the purpose and usage of the module.
- Do not include proprietary or sensitive information, like password, keys, SSL certificates, etc.
- Leave your name and contact e-mail address in the metadata, so that users of your module can reach out if necessary.
- Please make sure to update the version of your module, when introducing changes to the code, so that users can pick up the changes consistenly.
### Module Development Guidelines
Read the [offical MOSK documentation](https://docs.mirantis.com/mosk/latest/ops/bm-operations/host-os-conf.html) for detailed information about the structure and the interfaces the host OS configuration module need to have.
## 🛠 Support & Issues
Since this is a **community-driven** repository, there is **no official support from Mirantis**. However, if you encounter an issue or have a question, you can:
- Open an **Issue** on this repository.
- Engage with the community for discussions and solutions.
## 📄 License
This repository is open-source and distributed under the **Apache 2.0 License**. See the [LICENSE](LICENSE) file for more details.
---
We appreciate your contributions and efforts in making MOSK a truly flexible and configurable platform! 🚀