This manual explains how to install and upgrade an OpenBACH platform.
For specific requirements of each kind of machine, see the advanced page of requirements.
Make sure that the version of ansible you have installed is actually using Python 3 and not Python 2. If this is not the case please refer to the Ansible installation instructions.
$ ansible --version ansible 2.10.5 config file = None configured module search path = ['/home/ubuntu/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules'] ansible python module location = /usr/local/lib/python3.8/dist-packages/ansible executable location = /usr/local/bin/ansible python version = 3.8.5 (default, Jul 28 2020, 12:59:40) [GCC 9.3.0]
Before being able to deploy an OpenBACH platform, you must acquire the sources files hosted on the Net4Sat forge.
You can either:
git clone --depth 1 --single-branch https://forge.net4sat.org/openbach/openbach.git
Before deploying OpenBACH to your target machines, you need to configure which component will be installed on which machine. Just create a file in the
ansible/inventory folder of your sources and populate it with your installation instructions. The name of the file does not matter, this tutorial considers a file named
We propose herein an example where the Controller, Collector, and Auditorium are installed in the same machine, and two additional Agents in separate machines. You give a name to your agents with the option 'openbach_name', otherwise openbach will take the hostname of the machine to name each agent. For advanced topologies see the advanced toplogy guide or see the README file of this folder as a quick reminder of this section.
[controller] 172.20.0.1 [agent] 172.20.0.2 openbach_name=client 172.20.0.3 openbach_name=server [all:vars] ansible_python_interpreter=/usr/bin/python3
Before the installation, we highly recommend to test the SSH connectivity between your installation machine and your OpenBACH platform by means of an Ansible ping. Assuming you created the topology file
ansible/inventory/my-openbach-inventory, you can issue the following command in the
ansible directory of
$ cd openbach/ansible/ $ ansible -i inventory/my-openbach-inventory -u *ssh_username* -k -m ping all
ansible folder of the OpenBACH sources. Other means of connecting to the target machines as well as debugging connection issues are explained in the using Ansible guide.
Installing OpenBACH itself can then be as simple as issuing:
$ cd openbach/ansible/ $ ansible-playbook -i inventory/my-openbach-inventory install.yml -u *ssh_username* -k -K
In case you want to upgrade an existing OpenBACH platform, we recommend to clone the relevant OpenBACH git repository and repeat the install procedure.
Before upgrading an OpenBACH platform, you may want to uninstall it as follows, before repeating the install procedure.
$ cd openbach/ansible/ $ ansible-playbook -i inventory/my-openbach-inventory uninstall.yml -u *ssh_username* -k -K
More information on the uninstall can be found in the Using Ansible Manual.