On SEAPATH, the definition of our setup must be described inside Ansible inventories. You have to define your own inventories files which match with your setup.
In the examples directory, you can find some commented and minimal examples of inventories for a standalone and cluster configuration.
It is possible with Ansible to provides multiple inventories files, and we recommend using this feature for complex setup.
All these inventories contain only the minimal variables required to configure and run SEAPATH. For advanced configuration, please refer to the Ansible configuration page on the wiki.
This inventory describes a cluster using two hypervisors and one observer. It is possible to use a three-hypervisor setup by adding a machine into the hypervisors section and removing the observers part.
TODO : Put link to cluster architecture page on wiki when written
This inventory describes a standalone SEAPATH machine. It contains virtualization and cybersecurity features of SEAPATH, but not the redundancy offered by the cluster.
This inventory describes a network Open vSwitch bridge over the cluster. It allows VM to communicate even after a migration toward another hypervisor.
This work is done through the variable ovs_bridges, that is passed to python3-setup-ovs tool.
Note: The same extended network bridge is defined for all hypervisors through the variable cluster_machines.
This inventory describes the variables to deploy a Virtual machine on a hypervisor or on the cluster. It does not define any variables to configure what is inside the VM.
Two files are required to deploy a virtual machine on SEAPATH :
- A qemu image file (.qcow2, .iso or .img)
- A Libvirt XML configuration file
The VM example inventory uses the template templates/vm/guest.xml.j2 which aims to be a general purpose VM template for SEAPATH.
If you aim to run virtual machine for production, we recommend proving your own Libvirt XML. Refer to the Libvirt API documentation for more information.
You can find in the subdirectory providers some example for COTS VM from providers.