Gruntwork Boilerplate is a tool that helps you create and manage reusable templates for your code and configuration. It allows you to define a template once and then generate new files or projects from it by filling in variables.
Tutorial
Here’s an example of how to use boilerplate to generate a new Ansible role from the template in this project:
# Navigate to the directory where you want to create the new role
cd ansible/roles/
# Run boilerplate, pointing to the template and providing necessary variables
boilerplate --template-url ../../.boilerplates/ansible-role/ --var role_name=my-new-role
Make sure the example aligns with the project’s actual boilerplate usage if possible, for example, by referencing the .boilerplates/ansible-role/ path.
Usage in this Project
This project uses Gruntwork Boilerplate to maintain consistency and speed up the creation of new components, particularly for Ansible roles.
- Ansible Role Template: A template for new Ansible roles is located in
.boilerplates/ansible-role/. This includes a standard directory structure, placeholder files, and common configuration. - Generating New Roles: You can use the
boilerplateCLI (installable via./bin/bash/setup.sh boilerplate) to generate a new Ansible role from this template.
This helps ensure that all Ansible roles follow a similar structure, making them easier to understand and maintain.