Home

Development virtual machine

Files organisation

You can find in the root folder:

• ansible.cfg, configuration file for Ansible
• Vagrantfile, the main Vagrant script which calls the playbook
• configuration folder, which contains the default configuration and eventually your one
• provisioning folder, which contains the Ansible playbook and associated tasks, roles, ...
• downloads folder, which contains all downloaded files during the installation
• sites folder, which contains all generated websites source code

The 2 last folders are created (by default) after the vagrant up execution.

Modify / extend

The configuration folder contains 3 sub-folders: default, example and yours. The first one holds the default configuration files, templates and starters (all files in configuration/default/settings are commented to explain each option).

To override the default configuration, replicate the default folder structure parts you need in the yours folder. You can look at the example to help understand how to do it.

• All files from configuration/yours/settings will be merge with the default configuration.
• All files from configuration/yours/templates will replace the default templates.
• All files from configuration/yours/starters will replace the default starters, and others YAML files not existing in configuration/default/starters will be detected as new starters.

You can also put in yours folder:

• a customised playbook.yml which will be played instead of the default one.
• a customised tasks/main.yml file with your custom Ansible tasks.

Starters resources

You can put a folder with the same name than your starter in configuration/yours/starters to place resources you need (images, scripts, dumps, ...). In your starter-name.yml, you can retrieve them in the configuration.starters dict with the key starter-name as filepath (example below).

Considering you have an image called "img.png" in the starter "my-starter", you can use:

{{ configuration.starters['my-starter'] }}/img.png