tenks/doc/source/install.rst
Will Szumski 9c126332be Do not install Open vSwitch
Open vSwitch packages are no longer present in the default, or EPEL
repoistories. This means there is no clean way to install Open vSwitch
on CentOS. Instead, we should leave it up the user to decide how to
install it.

Change-Id: Ie56296230c9840e542ac70d96dc68c285d198ad6
2019-10-21 16:59:06 +01:00

76 lines
2.1 KiB
ReStructuredText

.. _installation:
Installation
============
.. _assumptions:
Assumptions
-----------
Some assumptions that are made about the configuration of your system are noted
below.
It is assumed that...
* ...you already have an OpenStack cloud deployed, for which...
* ...the host from which Tenks is executed (*localhost*) has access to the
OpenStack APIs. These are used for Ironic node enrolment and Nova flavor
registration.
* ...the OpenStack *OS_\** authentication variables are present in
*localhost*'s environment. These can typically be sourced from your
*openrc* file.
* ... a distinct network device (interface or bridge) is present for each
physical network that a hypervisor is connected to.
Pre-Requisites
--------------
Currently, Tenks supports CentOS 7.5.
To avoid conflicts with Python packages installed by the system package manager
it is recommended to install Tenks in a virtualenv. Ensure that the
``virtualenv`` Python module is available. For cloning and working with the
Tenks source code repository, Git is required. These pre-requisites can be
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 <https://docs.openvswitch.org/en/latest/intro/install/>`_
for more details.
Tenks Installation
------------------
Create a virtualenv for Tenks. For example::
$ virtualenv tenks
Activate the virtualenv and update pip::
$ source tenks/bin/activate
(tenks) $ pip install --upgrade pip
Obtain the Tenks source code and change into the directory. For example::
(tenks) $ git clone https://opendev.org/openstack/tenks.git
(tenks) $ cd tenks
Install Tenks and its requirements using the source code checkout::
(tenks) $ pip install .
Tenks has dependencies on Ansible roles that are hosted by Ansible Galaxy.
These can be installed by a command such as::
(tenks) $ ansible-galaxy install --role-file=requirements.yml --roles-path=ansible/roles/
If you now wish to run Tenks (see :ref:`run`), keep your virtualenv active. If
not, deactivate it::
(tenks) $ deactivate