Metadata-Version: 2.1
Name: enos
Version: 7.0.0
Summary: Experimental eNvironment for OpenStack
Home-page: https://github.com/BeyondTheClouds/enos
License: GPL-3.0-or-later
Keywords: OpenStack,Evaluation,Grid'5000,Chameleon,Vagrant
Author: Didier Iscovery
Author-email: discovery-dev@inria.fr
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: annotations
Requires-Dist: docopt (>=0.6.2,<0.7.0)
Requires-Dist: enoslib[chameleon] (>=5.6,<5.7)
Requires-Dist: influxdb (==4.0.0); extra == "annotations"
Requires-Dist: python-heatclient (>=2.3.0,<3.0.0)
Requires-Dist: python-openstackclient (>=5.5.0,<6.0.0)
Requires-Dist: virtualenv (>=20.4.3,<21.0.0)
Project-URL: Documentation, https://enos.readthedocs.io/en/stable/
Description-Content-Type: text/x-rst

|Build Status| |Documentation Status| |Code style| |License| |Pypi|

Join us on gitter :  |Join the chat at
https://gitter.im/BeyondTheClouds/enos|

About Enos
==========

Enos aims at reproducible experiments of OpenStack.  Enos relies on
`Kolla Ansible <https://docs.openstack.org/kolla-ansible/>`__ and
helps you to easily deploy, customize and benchmark an OpenStack on
several testbeds including `Grid'5000 <https://www.grid5000.fr>`__,
`Chameleon <https://www.chameleoncloud.org/>`__ and more generally any
OpenStack cloud.

Installation
============

Enos is best installed via `pip <https://pip.pypa.io/>`__.  It is
tested with python3.7+::

  pip install enos

Quick Start
===========

For the quick-start, we will bring up an OpenStack on VirtualBox
because it is free and works on all major platforms.  Enos can,
however, work with many testbeds including `Grid'5000
<https://enos.readthedocs.io/en/stable/provider/grid5000.html>`__ and
`Chameleon
<https://enos.readthedocs.io/en/stable/provider/openstack.html>`__.

First, make sure your development machine has `VirtualBox
<https://www.virtualbox.org/>`__ and `Vagrant
<https://www.vagrantup.com/downloads>`__ installed.  Then, ensure that
you have at least 10 GiB of memory.

To deploy your fist OpenStack with enos::

  enos new --provider=vagrant:virtualbox
  enos deploy

Enos starts three virtual machines and configures Kolla Ansible to
deploy the OpenStack control plane on the first one, the network
related services (Neutron, HAProxy, RabbitMQ) on the second one, and
use the last one as a compute node.  Note that the full deployment may
take a while (around 30 minutes to pull and run all OpenStack docker
images).

You can `customize
<https://enos.readthedocs.io/en/stable/customization/>`__ the deployed
services and the number of virtual machines allocated by modifying the
generated `reservation.yaml` file.  Calls `enos --help` or read the
`documentation <https://enos.readthedocs.io>`__ for more information.

Acknowledgment
==============

Enos is developed in the context of the `Discovery
<https://beyondtheclouds.github.io/>`__ initiative.


Links
=====

-  Docs - https://enos.readthedocs.io
-  Docker - https://hub.docker.com/r/beyondtheclouds/
-  Discovery - https://beyondtheclouds.github.io/

.. |Build Status| image:: https://travis-ci.org/BeyondTheClouds/enos.svg?branch=master
   :target: https://travis-ci.org/BeyondTheClouds/enos
.. |Documentation Status| image:: https://readthedocs.org/projects/enos/badge/?version=stable
   :target: http://enos.readthedocs.io/en/stable/?badge=stable
.. |Join the chat at https://gitter.im/BeyondTheClouds/enos| image:: https://badges.gitter.im/BeyondTheClouds/enos.svg
   :target: https://gitter.im/BeyondTheClouds/enos?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
.. |Code style| image:: https://api.codacy.com/project/badge/Grade/87536e9c0f0d47e08d1b9e0950c9d14b
   :target: https://www.codacy.com/app/msimonin/enos?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=BeyondTheClouds/enos&amp;utm_campaign=Badge_Grade
.. |License| image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg
   :target: https://www.gnu.org/licenses/gpl-3.0
.. |Pypi| image:: https://badge.fury.io/py/enos.svg
    :target: https://badge.fury.io/py/enos

