[stable/2023.1] Transition to Tox (#1641)
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 8c261cd..a05a1d9 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,5 +1,5 @@
-dunamai
furo
+six
sphinx
sphinx-autobuild
sphinx-copybutton
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f99817d..7412fcf 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -12,17 +12,17 @@
# License for the specific language governing permissions and limitations
# under the License.
-from dunamai import Version
-
project = "Atmosphere"
copyright = "2024, VEXXHOST, Inc."
author = "VEXXHOST, Inc."
-release = Version.from_git().serialize()
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-extensions = ["sphinx_copybutton"]
+extensions = [
+ "sphinx_copybutton",
+ "pbr.sphinxext",
+]
templates_path = ["_templates"]
exclude_patterns = []
diff --git a/doc/source/quick-start.rst b/doc/source/quick-start.rst
index 9479f25..9519ed9 100644
--- a/doc/source/quick-start.rst
+++ b/doc/source/quick-start.rst
@@ -57,8 +57,7 @@
.. code-block:: bash
$ sudo apt-get update
- $ sudo apt-get install git python3-pip
- $ sudo pip install poetry
+ $ sudo apt-get install git tox
Once done, you can clone the repository locally and switch to the
``atmosphere`` directory:
@@ -74,8 +73,14 @@
.. code-block:: bash
$ cd atmosphere
- $ sudo poetry install --with dev
- $ sudo poetry run molecule converge -s aio
+ $ sudo tox -e molecule-aio-ovn
+
+If you want to use the ML2/Open vSwitch plugin, you can run the following
+command:
+
+.. code-block:: bash
+
+ $ sudo tox -e molecule-aio-openvswitch
Once the deployment is done, it will have a full deployment of all services
inside the same host, so you can use the cloud from the same machine by
@@ -122,7 +127,7 @@
$ git clone https://github.com/vexxhost/atmosphere
-You will need ``poetry`` installed on your operating system. You will need to make
+You will need ``tox`` installed on your operating system. You will need to make
sure that you have the appropriate OpenStack environment variables set (such
as ``OS_CLOUD`` or ``OS_AUTH_URL``, etc.). You can also use the following
environment variables to tweak the behaviour of the Heat stack that is created:
@@ -161,18 +166,12 @@
generated by molecule. This way you can test your configs before you bring
them to production.
-Once you're ready to get started, you can run the following command to install
-poetry dependencies:
+Once you're ready to get started, you can run the following command to build
+the Heat stack:
.. code-block:: console
- $ poetry install
-
-Then you can run the following command to build the Heat stack:
-
-.. code-block:: console
-
- $ poetry run molecule converge
+ $ tox -e molecule-venv -- converge
This will create a Heat stack with the name `atmosphere` and start deploying
the cloud. Once it's complete, you can login to any of the systems by using
@@ -181,7 +180,7 @@
.. code-block:: console
- $ poetry run molecule login -h ctl1
+ $ tox -e molecule-venv -- login -h ctl1
At this point, you can proceed to the usage section to see how to interact
with the cloud.
@@ -191,7 +190,7 @@
.. code-block:: console
- $ poetry run molecule destroy
+ $ tox -e molecule-venv -- destroy
For more information about the different commands used by Molecule, you can
refer to the Molecule documentation.