Documentation

Beyond the basics

This page introduces some concepts that help you manage your Ansible workflow with directory structure and source control. Like the Basic Concepts at the beginning of this guide, these intermediate concepts are common to all uses of Ansible.

A typical Ansible filetree

Ansible expects to find certain files in certain places. As you expand your inventory and create and run more network playbooks, keep your files organized in your working Ansible project directory like this:

.
├── backup
│   ├── [email protected]:10:15
│   ├── [email protected]:22:41
├── first_playbook.yml
├── inventory
├── group_vars
│   ├── vyos.yml
│   └── eos.yml
├── roles
│   ├── static_route
│   └── system
├── second_playbook.yml
└── third_playbook.yml

The backup directory and the files in it get created when you run modules like vyos_config with the backup: yes parameter.

Tracking changes to inventory and playbooks: source control with git

As you expand your inventory, roles and playbooks, you should place your Ansible projects under source control. We recommend git for source control. git provides an audit trail, letting you track changes, roll back mistakes, view history and share the workload of managing, maintaining and expanding your Ansible ecosystem. There are plenty of tutorials and guides to using git available.