basic-ansible-template

Introduction

🚀 This repository is your go-to template for creating, organizing, and managing Ansible playbooks and roles. 🎯

🌟 Key Features

• 📂 Pre-organized structure for playbooks, roles, and inventory files.
• 🔧 Best practices included for scalable automation setups.
• 🌐 Ready-to-use examples for common automation tasks.

✨ Perfect for

• Sysadmins and DevOps teams automating infrastructure 🛠️
• Beginners learning Ansible through practical examples 📚
• Building reusable and shareable automation frameworks 🚀

Clone, customize, and automate with ease! 🤝

Usage

📦 Dependencies

mise install pipx
pipx install --incude-deps ansible
pipx ensurepath

To use this repository template, simply fork the repo.

gh repo fork --fork-name <FORK_NAME> --org <ORG_NAME>

⚙️ Setup

Update the repository settings:

gh repo edit --add-topic devops,reliability-engineering,axes \
--add-topic infrastructure-as-code,viking,mosher-labs \
--delete-branch-on-merge --enable-discussions=false \
--enable-issues=false --enable-merge-commit=false \
--enable-projects=false --enable-rebase-merge=false \
--enable-wiki=false

Create a ruleset for the default branch.

• Ruleset Name: Default branch
• Enforcement status: Active
• Target Branches: Default
• ✅ Restrict deletions
• ✅ Require linear history
• ✅ Require signed commits
• ✅ Require a pull request before merging
• ✅ Dismiss stale pull request approvals when new commits are pushed
• ✅ Require conversation resolution before merging
• ✅ Request pull request review from Copilot
• Allowed merge methods: "Squash"
• ✅ Require status checks to pass
• ✅ Require branches to be up to date before merging
• ✅ Do not require status checks on creation
• Status checks that are required: pre-commit/pre-commit
• ✅ Block force pushes
• ✅ Require code scanning results

Enable Dependabot.

• In Github UI, navigate to the repositories Settings > Code security
• Enable Dependabot security updates
• Enable Grouped security updates
• Enable Dependabot version updates
• Enable Dependabot on Actions runners
• CodeQL analysis > Set up > Default
• Enable Secret scanning
• Enable Push protection

Update the templated information:

README.md

• Replace basic-ansible-template with your <FORK_NAME>

  find . -not -path '*/\.git/*' -type f -exec \
    sed -i '' -e 's/basic-ansible-template/<FORK_NAME>/g' '{}' \;

• Update the "Introduction" section

• Update the "Usage" section

• Update the "Contributing" section

🔰 Contributing

Upon first clone, install the pre-commit hooks.

pre-commit install

To run pre-commit hooks locally, without a git commit.

pre-commit run -a --all-files

To update pre-commit hooks, this ideally should be ran before a pull request is merged.

pre-commit autoupdate

📋 TODO

• Setup and configure molecule tests