Enasis Network Orchestrations

This project has not released its first major version.

Project for executing the Ansible playbooks for system automation.

Documentation

Read project documentation built using the Sphinx project. Should you venture into the sections below you will be able to use the sphinx recipe to build documention in the sphinx/html directory.

Running the Ansible playbooks

Currently this project assumes it is within the directory structure of workspace. This will change sometime in the near future- though it can be overridden now.

• Specify PYTHON environment variable when calling make.
• Install various collections into the collections directory.
  • Replace the symbolic links or remove and place collections.
  • This is where the Makefile and makefile.py will look.
• ANSIBLE_DISPLAY_TRACEBACK=always to display tracebacks from plugins.

Additional Ansible collections

• Utility supports other Enasis Network Ansible collections
  GitHub repository, Ansible Galaxy
• Projects install and configure Enasis Network projects
  GitHub repository, Ansible Galaxy
• Certificates manage private key infrastructure authorities
  GitHub repository, Ansible Galaxy
• Provision provisioning and hardening inventory targets
  GitHub repository, Ansible Galaxy
• Infrastructure install and configure the infrastructure
  GitHub repository, Ansible Galaxy
• Applications install and configure the applications
  This collection is only a placeholder for the moment
  GitHub repository, Ansible Galaxy
• Internal specific to Robert Harris and the Enasis Network
  This collection is only a placeholder for the moment
  GitHub repository, Ansible Galaxy

Quick start for local development

Start by cloning the repository to your local machine.

git clone https://github.com/enasisnetwork/orchestro.git

Set up the Python virtual environments expected by the Makefile.

make -s venv-create

Execute the linters and tests

The comprehensive approach is to use the check recipe. This will stop on any failure that is encountered.

make -s check

However you can run the linters in a non-blocking mode.

make -s linters-pass

And finally run the various tests to validate the code and produce coverage information found in the htmlcov folder in the root of the project.

make -s pytest

Version management

⚠️ Ensure that no changes are pending.

1. Rebuild the environment.

   make -s check-revenv
   

2. Update the version.txt file.

3. Push to the main branch.

4. Create repository release.