openstack
/
tenks
Code Issues Proposed changes

docs: linux bridge, supported OS distros 

Some small docs updates for linux bridge support and syncing the
supported OS distros.

Change-Id: I17c9b8274c65acbf16f0ea04ac6e018c71b65694
This commit is contained in:
Mark Goddard 2022-02-08 10:40:29 +00:00 committed by Radosław Piliszek
parent d25067dd1a
commit 2474797bcf
3 changed files with 20 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/source/architecture.rst
View File

@ -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 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 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 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. a mapping on a hypervisor, a new Tenks-managed Open vSwitch or Linux bridge is
If the device mapped to this physnet is an interface, it is plugged directly created. If the device mapped to this physnet is an interface, it is plugged
into the new bridge. If the device is an existing Linux bridge, a veth pair is directly into the new bridge. If the device is an existing Linux bridge, a veth
created to connect the existing bridge to the new bridge. If the device is an pair is created to connect the existing bridge to the new bridge. If the device
existing Open vSwitch bridge, an Open vSwitch patch port is created to link the is an existing Open vSwitch bridge, an Open vSwitch patch port is created to
two bridges. link the two bridges.
A new veth pair is created for each physical network that each node on each 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 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 Open vSwitch or Linux bridge for that physical network; the other end will be
into the node itself. Creation of these veth pairs is necessary (at least for plugged into the node itself. Creation of these veth pairs is necessary (at
the Libvirt provider) to ensure that an interface is present in Open vSwitch least for the Libvirt provider) to ensure that an interface is present in Open
even when the node itself is powered off. vSwitch even when the node itself is powered off.
An example of the networking structure of Tenks is shown below. In this 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 example, one node was requested to be connected to physnet0 and physnet1, and

6
doc/source/configuration.rst
View File

@ -7,9 +7,9 @@ Hosts
----- -----
Tenks uses Ansible inventory to manage hosts. A multi-host setup is therefore 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 supported, although the default hosts configuration in ``ansible/inventory/``
setup on the host where the ``ansible-playbook`` command is executed will deploy an all-in-one setup on the host where the ``ansible-playbook``
(*localhost*). command is executed (*localhost*).
* Configuration management of the Tenks cluster is always performed on * Configuration management of the Tenks cluster is always performed on
*localhost*. *localhost*.

11
doc/source/install.rst
View File

@ -29,7 +29,10 @@ It is assumed that...
Pre-Requisites 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 To avoid conflicts with Python packages installed by the system package manager
it is recommended to install Tenks in a virtualenv. Ensure that the 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 $ yum install --assumeyes python-virtualenv git
Open vSwitch must be installed and running. Please see the If using Open vSwitch for networking, it must be installed and running. Please
`Open vSwitch docs <https://docs.openvswitch.org/en/latest/intro/install/>`_ see the `Open vSwitch docs
for more details. <https://docs.openvswitch.org/en/latest/intro/install/>`_ for more details.
Tenks Installation Tenks Installation
------------------ ------------------