This is the template repository structure for a rollyourown module.
The general architecture of rollyourown projects and modules is documented here
The structure of a rollyourown module (which this template provides) is documented here.
Issues for this module template can be submitted on Codeberg (preferred) or GitHub:
Clone this repository as a starting point for a new module and make the following changes:
- If needed, add additional parameters for the module in the
configuration/configuration.ymlconfiguration file, and change themodule_idfor the new module - Add additional Ansible playbooks, roles and tasks for module-specific host setup in the
host-setupdirectory - Add Packer templates and Ansible playbooks for each module component in the
image-builddirectory - Add Terraform and cloud-init files in the
module-deploymentdirectory - Modify the scripts in the
scripts-moduledirectory, if necessary - Update the
READMEfor the new module
This template README can be used for the new module by deleting this part, changing the title and introductory text above, and completing the sections below.
This is a rollyourown module to deploy <MODULE_PURPOSE> using Ansible, Packer and Terraform.
This module uses Ansible, Packer and Terraform to deploy ..., as a module for other rollyourown projects.
A short summary of the purpose of the module.
A rollyourown module contains automation code to configure, build, deploy, maintain, back up and restore a module for use by other rollyourown projects.
In itself, a module doesn’t provide a full end-to-end service, but rather provides a reusable building block that is used in a full rollyourown project as part of the end-to-end solution for that project.
A detailed description for project developers of how to use this module in a project can be found in the module's documentation.
We would be delighted if you would like to contribute to rollyourown and there are a number of ways you can collaborate on this module:
- Raising security-related issues
- Contributing bug reports, feature requests and ideas
- Improving the module - e.g. to provide fixes or enhancements
You may also like to contribute to the wider rollyourown project by, for example:
- Contributing a new project or module
- Contributing to the rollyourown website content or design
- Maintaining a rollyourown repository
Issues for this module can be submitted on Codeberg (preferred) or GitHub:
If you have found a security vulnerability in any rollyourown service or any of the rollyourown projects, modules or other repositories, please read our security disclosure policy and report this via our security vulnerability report form.
For public contributions, we maintain mirror repositories of this module on Codeberg and GitHub:
Our preferred collaboration space is Codeberg:
The primary repository for this module is hosted on our own Git repository server at:
Repositories on our own Git server are accessible only to members of our organisation.
For information on copyright, licences and trademarks, see https://rollyourown.xyz/about/copyright_licenses_trademarks/.