Ansible project creation script

This project is made by Marco Sepp to automate Ansible project creation.

Script will create Ansible project, initalize new local Git repository and create Python virual environment for Ansible installation.

Requirements

Linux distro in development computer
Python3
Pip3
Python3-venv
Git
Access to Pypi.org or any local Pypi server

Project structure

The script will create following directory structure with example files. The directory structure is a best practice for Ansible project: https://docs.ansible.com/ansible/2.9/user_guide/playbooks_best_practices.html#alternative-directory-layout

All directories contain a README.md file that describes the directory purpose.

<your-project-name>/                    #  Project root directory
    inventories/                        #  Project inventories directory
        production/                     
            group_vars/
                all.yml                 #  here we assign variables to particular groups
                README.md
            host_vars/
                hostname.yml            #  here we assign variables to particular systems
                README.md
            hosts                       #  Inventory file for production servers
            README.md
        README.md

    <your-project-name>-venv/           #  Python3 virtual environment

    library/                            #  if any custom modules, put them here (optional)
        README.md
    
    module_utils/                       #  if any custom module_utils to support modules, put them here (optional)
        README.md
    
    playbook.yml                        #  Master playbook and all other playbooks are in project root directory
    
    roles/
        README.md

    .gitignore                          #  Gitignore for the project
    ansible-requirements.yml            #  Ansible requirements for the project
    ansible.cfg                         #  Ansible config file for the project
    python-requirements.txt             #  Python requirements fot the project
    README.md
    ansible-vault                       #  Ansible Vault secret file

How to use?

Clone this repository:

$ git clone https://github.com/marcosepp/ansible-project-create.git

Add execution permissions for script:

$ chmod u+x ansible-project-create/create-ansible-project

Run create-ansible-project script. Replace <your-project-name> with your project name.

$ ./create-ansible-project -a -d /tmp <your-project-name>

Usage

$ ./create-ansible-project --help
    
    Usage: create-ansible-project [OPTIONS] <project_root_directory_name>
    
    <project_root_directory_name>     It will be the project name.

    OPTIONS:
      -o, --openstack-init            Add OpenStack inventory
      -g, --git-init                  Initialize git repository
      -h, --help                      Show this help
      -p, --python-init               Create Python venv
      -a, --all                       Creates all. Same as using options ' -o -g -p '
      -d, --dir                       Specify directory where project directory will be created
      -v, --vault                     Create Ansible vault secret. Needs '/dev/urandom', 'tr' and 'head'

(Optional) Install Python dependencies

Python virtual environment is used for local testing. All Python modules has to be described in python-requirements.txt file.

Install Python modules by executing following commands in your project directory:

$ source ./<your-project-name>-venv/bin/activate
$ pip install -r python-requirements.txt

Replace <your-project-name> with your project name.

Licence

MIT

Credits

Marco Sepp