https://github.com/betadots/ansible-control-repo-template

An Ansible Control Repository Template
https://github.com/betadots/ansible-control-repo-template

ansible ansible-collection ansible-role

Last synced: 13 days ago
JSON representation

An Ansible Control Repository Template

• Host: GitHub
• URL: https://github.com/betadots/ansible-control-repo-template
• Owner: betadots
• Created: 2023-08-30T20:27:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-07T09:28:11.000Z (about 1 year ago)
• Last Synced: 2025-01-22T15:48:37.651Z (13 days ago)
• Topics: ansible, ansible-collection, ansible-role
• Language: Shell
• Size: 22.5 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Ansible Control Repository Template

[![⚒️ CI](https://github.com/betadots/ansible-control-repo-template/actions/workflows/ci.yaml/badge.svg)](https://github.com/betadots/ansible-control-repo-template/actions/workflows/ci.yaml)

[![Created by betadots GmbH](https://img.shields.io/badge/Created_by-betadots_GmbH-blue)](https://www.betadots.de)

# Usage

Copy this repository into your own Git Server.

Then clone it from there and adapt your changes.

# What's in this template

Here is a visual representation of the structure of this repository:

```bash

bin/helpers               # here you may place scripts which help the ci or the ansible surroundings

inventories/              #

   production/            #

      hosts               # inventory file for production servers

      group_vars/         # here we assign variables to particular groups

      host_vars/          # here we assign variables to particular systems

   staging/               #

      hosts               # inventory file for staging environment

      group_vars/         # here we assign variables to particular groups

      host_vars/          # here we assign variables to particular systems

                          #

library/                  # if any custom modules, put them here (optional)

module_utils/             # if any custom module_utils to support modules, put them here (optional)

filter_plugins/           # if any custom filter plugins, put them here (optional)

                          #

site.yml                  # master playbook

                          #

playbooks/                # put all playbooks here

    foo.yml               # foo demo playbook

                          #

collections/              # local collections

    requirements.yml      # <-- required remote collections

roles/                    #

    common/               # this hierarchy represents a "role"

        tasks/            #

            main.yml      #  <-- tasks file can include smaller files if warranted

        handlers/         #

            main.yml      #  <-- handlers file

        templates/        #  <-- files for use with the template resource

        files/            #  <-- files for use with the copy resource

        vars/             #

            main.yml      #  <-- variables associated with this role

        defaults/         #

            main.yml      #  <-- default lower priority variables for this role

        meta/             #

            main.yml      #  <-- role dependencies

        library/          # roles can also include custom modules

        module_utils/     # roles can also include custom module_utils

        lookup_plugins/   # or other types of plugins, like lookup in this case

                          #

    requirements.yml      # required remote roles

```