openstack
/
fuel-devops
Code Issues Proposed changes
fuel-devops/doc/source/install.rst

18 KiB
Raw Blame History

Installation

The installation procedure can be implemented via PyPI in Python virtual environment (suppose you are using Ubuntu 12.04 or Ubuntu 14.04).

Install required system packages

Before using it, please install the following required dependencies:

sudo apt-get install --yes \
git \
libyaml-dev \
libffi-dev \
python-dev \
python-pip \
qemu \
qemu-utils \
libvirt-bin \
libvirt-dev \
vlan \
bridge-utils \
ebtables \
pm-utils \
genisoimage

sudo apt-get update && sudo apt-get upgrade -y

Install database packages

Fuel-devops requires a SQLite3 or PostgreSQL database, please install any of them.

For use fuel-devops with SQLite3 database:

sudo apt-get install --yes libsqlite3-0

For use fuel-devops with PostgreSQL database:

sudo apt-get install --yes postgresql libpq-dev

Devops installation in virtualenv

  1. Install packages needed for building python eggs
sudo apt-get install --yes python-virtualenv libgmp-dev libssl-dev pkg-config
  1. In case you are using Ubuntu 12.04 or RHEL let's update pip and virtualenv, otherwise you can skip this step
sudo pip install pip virtualenv --upgrade
hash -r
  1. In oder to store the path where your Python virtualenv will be located create your working directory and use the following environment variable. If it is not specified, it will use the current working directory:
export WORKING_DIR=$HOME/working_dir
mkdir $HOME/working_dir
  1. Create virtualenv for the devops project (e.g. fuel-devops-venv). Note: the related directory will be used for the VENV_PATH variable:
cd $WORKING_DIR
sudo apt-get install --yes python-virtualenv
virtualenv --no-site-packages fuel-devops-venv

Note

If you want to use different devops versions in the same time, you can create several different folders for each version, and then activate the required virtual environment for each case.

For example:

virtualenv --no-site-packages fuel-devops-venv-2.9    # For fuel-devops 2.9.x
virtualenv --no-site-packages fuel-devops-venv-3.0    # For fuel-devops 3.0.x

5. Activate virtualenv and install devops package using PyPI. In order to indentify the latest available versions you would like to install, visit fuel-devops repo. Please use the latest tag from 2.9.x tags for Fuel 6.1 or later.

Install fuel-devops with SQLite3 database:

. fuel-devops-venv/bin/activate
pip install git+https://github.com/openstack/fuel-devops.git --upgrade

[Optional] Install fuel-devops with PostgreSQL database:

. fuel-devops-venv/bin/activate
pip install git+https://github.com/openstack/fuel-devops.git#egg=project[postgre] --upgrade

[Optional] Install fuel-devops with specified tag:

. fuel-devops-venv/bin/activate
pip install git+https://github.com/openstack/fuel-devops.git@2.9.21 --upgrade  # Do not install 2.9.x over 3.x !

setup.py in fuel-devops repository does everything required.

Hint

You can also use virtualenvwrapper which can help you manage virtual environments

  1. Next, follow DevOpsConf section

Configuration

Basically devops requires that the following system-wide settings are configured:

  • Default libvirt storage pool is active (called 'default')
  • Current user must have permission to run KVM VMs with libvirt
  • PostgreSQL server running with appropriate grants and schema for devops
  • [Optional] Nested Paging is enabled

Configuring libvirt pool

Create libvirt's pool

sudo virsh pool-define-as --type=dir --name=default --target=/var/lib/libvirt/images
sudo virsh pool-autostart default
sudo virsh pool-start default

Permissions to run KVM VMs with libvirt with current user

Give current user permissions to use libvirt: do not forget to log out and log back in.

sudo usermod $(whoami) -a -G libvirtd,sudo

Configuring database

You can configure PostgreSQL database or as an alternative SQLite.

Configuring PostgreSQL

Set local peers to be trusted by default, create user and db and load fixtures.

pg_version=$(dpkg-query --show --showformat='${version;3}' postgresql)
pg_createcluster $pg_version main --start
sudo sed -ir 's/peer\|md5/trust/' /etc/postgresql/9.*/main/pg_hba.conf
sudo service postgresql restart

  • default <user>, <db> and <password> are fuel_devops (for 2.9.x and 3.0.x version)

    sudo -u postgres createuser -P fuel_devops
sudo -u postgres psql -c "CREATE ROLE fuel_devops WITH LOGIN PASSWORD 'fuel_devops'"
sudo -u postgres createdb fuel_devops -O fuel_devops

    If you have already created database from previous install of the same fuel-devops version, you can set environment variables to use it.

    Here are the default values that you can override:

    export DEVOPS_DB_ENGINE='django.db.backends.postgresql_psycopg2'
export DEVOPS_DB_NAME=fuel_devops
export DEVOPS_DB_USER=fuel_devops
export DEVOPS_DB_PASSWORD=fuel_devops
export DEVOPS_DB_HOST=127.0.0.1
export DEVOPS_DB_PORT=5432
export DEVOPS_DB_CHARSET=UTF8

Configuring SQLite3 database

Export the path to the SQLite3 database as the database name:

export DEVOPS_DB_NAME=$WORKING_DIR/fuel-devops.sqlite
export DEVOPS_DB_ENGINE="django.db.backends.sqlite3"

Configuring Django

After the database setup, we can install the django tables and data:

dos-manage.py migrate

[Optional] Enabling Nested Paging

The following section covers only Intel platform. This option is enabled by default in the KVM kernel module. If the file qemu-system-x86.conf does not exist, you have to create it.

cat /etc/modprobe.d/qemu-system-x86.conf
options kvm_intel nested=1

In order to be sure that this feature is enabled on your system, please run:

sudo apt-get install --yes cpu-checker
sudo modprobe kvm_intel
sudo kvm-ok && cat /sys/module/kvm_intel/parameters/nested

The result should be:

INFO: /dev/kvm exists
KVM acceleration can be used
Y

Environment creation via Devops + Fuel_QA or Fuel_main

Depending on the Fuel release, you may need a different repository.

  1. Clone GIT repository

For 6.1 and later, the fuel-qa is required:

git clone https://github.com/openstack/fuel-qa
cd fuel-qa/

Note

It is recommended to use the stable branch related to the ISO version. For instance, with FUEL v7.0 ISO:

git clone https://github.com/openstack/fuel-qa -b stable/7.0

In case of 6.0 or earlier, please use fuel-main repository:

git clone https://github.com/openstack/fuel-main -b stable/6.0
cd fuel-main/

2. Install requirements (follow DevOpsPyPIvenv section for the WORKING_DIR variable)

. $WORKING_DIR/fuel-devops-venv/bin/activate
pip install -r ./fuelweb_test/requirements.txt --upgrade

Note

A certain version of fuel-devops is specified in the ./fuelweb_test/requirements.txt , so it will overwrite the already installed fuel-devops. For example, for fuel-master branch stable/6.0, there is:

git+git://github.com/stackforge/fuel-devops.git@2.5.6

It is recommended to install the django tables and data after installing fuel-qa requiremets:

django-admin.py syncdb --settings=devops.settings
django-admin.py migrate devops --settings=devops.settings
  1. Check DevOpsConf section
  2. Prepare environment

Download Fuel ISO from Nightly builds or build it yourself (please, refer to building-fuel-iso)

Next, you need to define several variables for the future environment:
  • the path where is located your iso (e.g. $WORKING_DIR/fuel-community-7.0.iso)
  • the number of nodes instantiated for the environment (e.g. 5)
export ISO_PATH=$WORKING_DIR/fuel-community-7.0.iso
export NODES_COUNT=5

Optionally you can specify the name of your test environment (it will be used as a prefix for the domains and networks names created by libvirt, defaults is fuel_system_test).

export ENV_NAME=fuel_system_test
export VENV_PATH=$WORKING_DIR/fuel-devops-venv

If you want to use separated files for snapshots you need to set env variable and use the following required versions:

  • fuel-devops >= 2.9.17
  • libvirt-bin >= 1.2.12

This change will switch snapshots created by libvirt from internal to external mode.

export SNAPSHOTS_EXTERNAL=true

Note

External snapshots by default uses ~/.devops/snap directory to store memory dumps. If you want to use other directory you can set SNAPSHOTS_EXTERNAL_DIR variable.

export SNAPSHOTS_EXTERNAL_DIR=~/.devops/snap

Alternatively, you can edit this file to set them as a default values

fuelweb_test/settings.py

Start tests by running this command

./utils/jenkins/system_tests.sh -t test -w $(pwd) -j fuelweb_test -i $ISO_PATH -o --group=setup

For more information about how tests work, read the usage information

./utils/jenkins/system_tests.sh -h

Important notes for Sahara tests

  • It is not recommended to start tests without KVM.
  • For the best performance Put Sahara image savanna-0.3-vanilla-1.2.1-ubuntu-13.04.qcow2 (md5: 9ab37ec9a13bb005639331c4275a308d) in /tmp/ before start, otherwise (If Internet access is available) the image will download automatically.

Important notes for Murano tests

  • Murano is deprecated in Fuel 9.0.
  • Put Murano image ubuntu-murano-agent.qcow2 (md5: b0a0fdc0b4a8833f79701eb25e6807a3) in /tmp before start.
  • Running Murano tests on instances without an Internet connection will fail.
  • For Murano tests execute 'export SLAVE_NODE_MEMORY=5120' before starting.
  • If you need an image For Heat autoscale tests check prebuilt-jeos-images.

Run single OSTF tests several times

  • Export environment variable OSTF_TEST_NAME. Example: export OSTF_TEST_NAME='Request list of networks'
  • Export environment variable OSTF_TEST_RETRIES_COUNT. Example: export OSTF_TEST_RETRIES_COUNT=120
  • Execute test_ostf_repetable_tests from tests_strength package

Run tests :

sh "utils/jenkins/system_tests.sh" -t test \
     -w $(pwd) \
     -j "fuelweb_test" \
     -i "$ISO_PATH" \
     -V $(pwd)/venv/fuelweb_test \
     -o \
     --group=create_delete_ip_n_times_nova_flat

Upgrade from system-wide devops to devops in Python virtual environment

To migrate from older devops, follow these steps:

  1. Remove system-wide fuel-devops (e.g. python-devops)

You must remove system-wide fuel-devops and switch to separate venvs with different versions of fuel-devops, for Fuel 6.0.x (and older) and 6.1 release.

Repositories 'fuel-main' and 'fuel-qa', that contain system tests, must use different Python virtual environments, for example:

  • ~/venv-nailgun-tests - used for Fuel 6.0.x and older releases.

    Contains version 2.5.x of fuel-devops (deprecated).

  • ~/venv-nailgun-tests-2.9 - used for Fuel 6.1 and newer.

    Contains version 2.9.x of fuel-devops.

If you have scripts which use system fuel-devops, fix them, and activate Python venv before you start working in your devops environment.

By default, the network pool is configured as follows:

  • 10.108.0.0/16 for devops 2.5.x
  • 10.109.0.0/16 for 2.9.x

Please check other settings in devops.settings, especially the connection settings to the database.

Before using devops in Python venv, you need to install system dependencies, see the section _DevOpsSystemDependencies

  1. Update fuel-devops and Python venv on CI servers

  • Update fuel-devops versions 2.5 - 2.9

    To update fuel-devops, you can use the following examples:

    # DevOps 2.5.x for system tests from 'fuel-main' repository
if [ -f ~/venv-nailgun-tests/bin/activate ]; then
  echo "Python virtual env exist"
else
  rm -rf ~/venv-nailgun-tests
  virtualenv --no-site-packages ~/venv-nailgun-tests
fi
source ~/venv-nailgun-tests/bin/activate
pip install -r https://raw.githubusercontent.com/openstack/fuel-main/master/fuelweb_test/requirements.txt --upgrade
django-admin.py syncdb --settings=devops.settings --noinput
django-admin.py migrate devops --settings=devops.settings --noinput
deactivate

# DevOps 2.9.x for system tests from 'fuel-qa' repository
if [ -f ~/venv-nailgun-tests-2.9/bin/activate ]; then
  echo "Python virtual env exist"
else
  rm -rf ~/venv-nailgun-tests-2.9
  virtualenv --no-site-packages ~/venv-nailgun-tests-2.9
fi
source ~/venv-nailgun-tests-2.9/bin/activate
pip install -r https://raw.githubusercontent.com/openstack/fuel-qa/master/fuelweb_test/requirements.txt --upgrade
django-admin.py syncdb --settings=devops.settings --noinput
django-admin.py migrate devops --settings=devops.settings --noinput
deactivate

    Note

    Devops 3.0 has incompatible internal API with previous versions, so upgrade procedure is different.

  • Upgrade fuel-devops 3.0 and upper

    • Upgrade from devops versions < 3.0 requires additional step and it's always destructive:

      Note

      You should drop ALL virtual environments before processing! If you want to use both 2.9 and 3.0 environments - you should use separate databases.

      Drop environments:

      source ~/venv-nailgun-tests-2.9/bin/activate
dos.py list  # get environments
dos.py erase $env_name  # substitute correct $env name manually
deactivate

      Recreate database:

      sudo -u postgres dropdb fuel_devops
sudo -u postgres createdb fuel_devops -O fuel_devops

    Update:

    # DevOps 3.0.x for system tests from 'fuel-qa' repository using old dir
if [ -f ~/venv-nailgun-tests-2.9/bin/activate ]; then
  echo "Python virtual env exist"
else
  rm -rf ~/venv-nailgun-tests-2.9
  virtualenv --no-site-packages ~/venv-nailgun-tests-2.9
fi
source ~/venv-nailgun-tests-2.9/bin/activate
pip install -r https://raw.githubusercontent.com/openstack/fuel-qa/master/fuelweb_test/requirements.txt --upgrade
django-admin.py migrate devops --settings=devops.settings --noinput
deactivate

# DevOps 3.0.x for system tests from 'fuel-qa' repository using new dir
if [ -f ~/venv-nailgun-tests-3.0/bin/activate ]; then
  echo "Python virtual env exist"
else
  rm -rf ~/venv-nailgun-tests-3.0
  virtualenv --no-site-packages ~/venv-nailgun-tests-3.0
fi
source ~/venv-nailgun-tests-3.0/bin/activate
pip install -r https://raw.githubusercontent.com/openstack/fuel-qa/master/fuelweb_test/requirements.txt --upgrade
django-admin.py migrate devops --settings=devops.settings --noinput
deactivate
  1. Setup new repository of system tests for 6.1 release

All system tests for 6.1 and higher were moved to fuel-qa repo.

To upgrade 6.1 jobs, follow these steps:

  • make a separate Python venv, for example in ~/venv-nailgun-tests-2.9

  • install requirements of system tests

  • if you are using system tests on CI, please configure your CI to use new Python venv, or export path to the new Python venv in the variable VENV_PATH (follow DevOpsPyPIvenv section for the WORKING_DIR variable):

    export VENV_PATH=$WORKING_DIR/fuel-devops-venv-2.9

Known issues

  • Some versions of libvirt contain a bug that breaks QEMU virtual machine XML. You can see this when tests crush with a libvirt: QEMU Driver error: unsupported configuration: host doesn't support invariant TSC. See: Bug 1133155.

    Workaround: upgrade libvirt to the latest version.