From 2474797bcfaac02cf7a4485405bd0650adfb732d Mon Sep 17 00:00:00 2001 From: Mark Goddard Date: Tue, 8 Feb 2022 10:40:29 +0000 Subject: [PATCH] docs: linux bridge, supported OS distros Some small docs updates for linux bridge support and syncing the supported OS distros. Change-Id: I17c9b8274c65acbf16f0ea04ac6e018c71b65694 --- doc/source/architecture.rst | 20 ++++++++++---------- doc/source/configuration.rst | 6 +++--- doc/source/install.rst | 11 +++++++---- 3 files changed, 20 insertions(+), 17 deletions(-) diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst index cd7445b..57f32ae 100644 --- a/doc/source/architecture.rst +++ b/doc/source/architecture.rst @@ -27,19 +27,19 @@ to the hardware networks plugged into the hypervisors. It requires device mappings to be specified on a hypervisor for each physical network that is to be connected to nodes on that hypervisor. This device can be an interface, a Linux bridge or an Open vSwitch bridge. For each physical network that is given -a mapping on a hypervisor, a new Tenks-managed Open vSwitch bridge is created. -If the device mapped to this physnet is an interface, it is plugged directly -into the new bridge. If the device is an existing Linux bridge, a veth pair is -created to connect the existing bridge to the new bridge. If the device is an -existing Open vSwitch bridge, an Open vSwitch patch port is created to link the -two bridges. +a mapping on a hypervisor, a new Tenks-managed Open vSwitch or Linux bridge is +created. If the device mapped to this physnet is an interface, it is plugged +directly into the new bridge. If the device is an existing Linux bridge, a veth +pair is created to connect the existing bridge to the new bridge. If the device +is an existing Open vSwitch bridge, an Open vSwitch patch port is created to +link the two bridges. A new veth pair is created for each physical network that each node on each hypervisor is connected to, and one end of the pair is plugged into the Tenks -Open vSwitch bridge for that physical network; the other end will be plugged -into the node itself. Creation of these veth pairs is necessary (at least for -the Libvirt provider) to ensure that an interface is present in Open vSwitch -even when the node itself is powered off. +Open vSwitch or Linux bridge for that physical network; the other end will be +plugged into the node itself. Creation of these veth pairs is necessary (at +least for the Libvirt provider) to ensure that an interface is present in Open +vSwitch even when the node itself is powered off. An example of the networking structure of Tenks is shown below. In this example, one node was requested to be connected to physnet0 and physnet1, and diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 7008e02..a2e66e3 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -7,9 +7,9 @@ Hosts ----- Tenks uses Ansible inventory to manage hosts. A multi-host setup is therefore -supported, although the default hosts configuration will deploy an all-in-one -setup on the host where the ``ansible-playbook`` command is executed -(*localhost*). +supported, although the default hosts configuration in ``ansible/inventory/`` +will deploy an all-in-one setup on the host where the ``ansible-playbook`` +command is executed (*localhost*). * Configuration management of the Tenks cluster is always performed on *localhost*. diff --git a/doc/source/install.rst b/doc/source/install.rst index 9884029..31c281f 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -29,7 +29,10 @@ It is assumed that... Pre-Requisites -------------- -Currently, Tenks supports CentOS 7.5. +Currently, Tenks supports the following OS distributions on the hypervisor: + +* CentOS Stream 8 +* Ubuntu Focal 20.04 To avoid conflicts with Python packages installed by the system package manager it is recommended to install Tenks in a virtualenv. Ensure that the @@ -39,9 +42,9 @@ installed with a command such as:: $ yum install --assumeyes python-virtualenv git - Open vSwitch must be installed and running. Please see the - `Open vSwitch docs `_ - for more details. +If using Open vSwitch for networking, it must be installed and running. Please +see the `Open vSwitch docs +`_ for more details. Tenks Installation ------------------