cmuck / config-files

Setup your development environment based on Ansible routines for software provisioning, configuration management, and application-deployment as infrastructure as code, tested with molecule.

config-files

Setup your development environment based on Ansible routines for software provisioning, configuration management, and application-deployment as infrastructure as code, tested with molecule.

Installation

Setup SSH for Ansible

Ansible is used to configure the system and requires a SSH connection.

First, ensure to have an up-to-date system

sudo apt update && sudo apt dist-upgrade

A vanilla Ubuntu installation misses openssh-server. Therefore install openssh-server so that the system can be used by Ansible.

sudo apt install openssh-server
# Check if openssh-server is running
systemctl status ssh

Please re-use your existing SSH key if already created or create a new SSH key

Setup Python

The script execution is based on Python 3 and a virtual environment, so continue to install these dependencies.

sudo apt install python3 python3-pip python3-venv

Setup Python virtual environment and install runtime dependencies

# Setup virtual environment
python3 -m venv venv
source venv/bin/activate
# Install required pkg to sync python dependencies
pip install pip-tools
# Install Python runtime dependencies, see requirements.txt
pip-sync

Finally install the script config-files to the local virtual environment

pip install -e .

Usage

When installed to the local virtual environment, you can use the script by the command cf

cf -h
usage: config-files [-h] [-t TAG [TAG ...]] [-v] [-d] [-c] playbook

positional arguments:
  playbook              Playbook from playbooks directory, e.g. "helloworld"

optional arguments:
  -h, --help            show this help message and exit
  -t TAG [TAG ...], --tag TAG [TAG ...]
                        Only tag from playbook is executed, e.g. --tag zsh git
  -v, --verbose         Increase verbosity of ansible to level 1
  -d, --dry-run         Execution with --check option
  -c, --check           Executes only a syntax-check of the playbook

Examples

• Default usage

  cf developer

• Syntax-check of the playbook

  cf -c developer

• Dry-run of the playbook

  cf -d developer

• Execute specific tags of the playbook

  cf -t zsh git developer

• Increase verbosity

  cf -v developer

Playbook helloworld

Can be used to check e.g. if config-files and Ansible works properly

cf helloworld
cf -v helloworld
cf -d helloworld
cf -c helloworld

Development

Details at DEVELOPMENT.md

Links

• Ansible Doc
• Ansible configuration settings
• Ansible FAQ
• Rapidly Build & Test Ansible Roles with Molecule + Docker
• Testing Ansible Roles with Molecule Behind a Proxy