This script deploys an OpenStack on Grid'5000 using Kolla and allows easy customization of the system (change in the default topology, configuration parameters) and reproductible experiments.

To install Enos, first connect to the Grid'5000 frontend of your choice and run.

pip install git+git://github.com/BeyondTheClouds/enos@master#egg=enos

To deploy a full stack, you need to provide a configuration file in the YAML format. This file must include information about the Grid'5000 job and how the OpenStack services must be deployed. reservation.yaml.sample is given as an example.

# copy the sample file
cp reservation.yaml.sample reservation.yaml

#edit it with your parameters
<editor> reservation.yaml

The deployment makes use of a private docker registry configured as a mirror of the official docker registry. There are two modes

• ceph: false. It will start a fresh registry that will cache the images for the duration of the experiment.
• ceph: true. It will use an existing Ceph rados block device of the Rennes cluster. The block device will be mounted and used as the registry storage. Setting this is usefull as the cache will persist different experiments.

The G5k ceph tutorial will guide you on how to create your rados block device.

Then, to launch the deployment:

enos deploy

by default the script use the file reservation.yaml as configuration file

This will run the following phases:

• up: reserve physical machine on Grid'5000, deploys the base linux distribution, instruments nodes with the monitoring stack, installs Kolla prerequisites (runtime dependencies, input files).

• os: launch the OpenStack deployment with Kolla

• init: bootstrap the freshly deployed OpenStack with users, images...

Run enos --help for a full list of command-line arguments.

After the execution, the ./current directory will contain some generated files (please note that current is a symbolic link toward the real directory associated to your deployment) and the results of the benchmarks.

git clone https://github.com/BeyondTheClouds/enos

Then install the dependencies:

cd enos
pip install -r requirements.txt --user

Make sure to add ansible binaries to your PATH (export PATH=YOUR_HOME/.local/bin:$PATH).

Finally, to launch the deployment, run:

python -m enos.enos deploy

And, to command line arguments:

python -m enos.enos -h

Using a virtualenv is encouraged

A workload is a set of scenarios grouped by type. A workload is launched with the following command :

python -m enos.enos bench --workload=workload

enos will look into the workload directory for a file named run.yml. This file is the description of the workload to launch. One example is given below :

rally:
  enabled: true  # default is true
  args:
    concurrency:
      - 1
      - 2
      - 4
    times:
      - 1
  scenarios:
    - name: boot and list servers
      enabled: true # default is true
      file: nova-boot-list-cc.yml
      args:
        sla_max_avg_duration: 30
        times : 5

This will launch all the scenarios described under the scenarios keys with all the possible parameters. The parameters are calculated using the cartesian product of the parameters given under the args keys. Locally defined args (scenario level) shadow globally defined args (top level). The same mecanism is applied to the enabled values. The scenario must be parameterized accordingly. The key (rally here) defines the type of benchmark to launch : in the future we may support other type of scenarios (Shaker, PerfkitBenchmarker ...)

After running the workload, a backup of the environment can be done through enos backup.

At the end of the benchmarks, various datas (logs, influxdb, rally home directory, ...) are stored under the current directory. This enables post-mortem analysis of the experimentation.

Please refer to the result directory to know how to get started with post-mortem analysis

Custom Kolla / Ansible parameters can be put in the configuration file under the key kolla.

Let's assume you want to run the nova-conductor in a dedicated node:

1. Add a new node reservation in the configuration file:

paravance:
  control: 1
  network: 1
  compute: 1
  conductor-node: 1

2. Create an new inventory file in the inventories subdirectory (copy paste the sample inventory) and change the group of the conductor service:

[nova-conductor:children]
conductor-node

3. In the configuration file, points the inventory to use to this new inventory.

4. Launch the deployment as usual, and you'll get the nova-conductor on a dedicated node.

At some point, Kolla default parameters won't fit your needs. Kolla provides a mechanism to override custom section of configuration files but isn't applicable in our case (at least in the corresponding branch). So we implement a quick and dirty way of patching Kolla code to enable custom configuration files to be used (and by extension custom kolla code). See the possible patch declaration in ansible/group_vars/all.yml. Patches should be added in the configuration file of the experiment.

• There might be an issue if your reservation contains multiple Grid'5000 clusters composed of nodes that have different network device names, e.g. paravance that has eth0 andl eth1, and parapluie that has devices eth1 and eth2.

https://en.wikipedia.org/wiki/Enos_(chimpanzee)

Enos runs performance stress workloads on OpenStack for postmortem analysis.
Copyright (C) 2016 Didier Iscovery

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.