diff --git a/doc/source/contributor/dev-quickstart.rst b/doc/source/contributor/dev-quickstart.rst index 511c13e0bb..74928a2add 100644 --- a/doc/source/contributor/dev-quickstart.rst +++ b/doc/source/contributor/dev-quickstart.rst @@ -405,6 +405,10 @@ station. Deploying Ironic with DevStack requires a machine running Ubuntu 16.04 (or later) or Fedora 24 (or later). Make sure your machine is fully up to date and has the latest packages installed before beginning this process. +The ironic-tempest-plugin is necessary if you want to run integration tests, +the section `Ironic with ironic-tempest-plugin`_ tells the extra steps you need +to enable it in DevStack. + .. seealso:: https://docs.openstack.org/devstack/latest/ @@ -428,6 +432,10 @@ Switch to the stack user and clone DevStack:: sudo su - stack git clone https://opendev.org/openstack/devstack.git devstack + +Ironic +------ + Create devstack/local.conf with minimal settings required to enable Ironic. An example local.conf that enables both ``direct`` and ``iscsi`` :doc:`deploy interfaces ` and uses the ``ipmi`` @@ -512,6 +520,111 @@ hardware type by default:: END +.. _itp: + +Ironic with ironic-tempest-plugin +--------------------------------- + +Using the stack user, clone the ironic-tempest-plugin repository in the same +directory you cloned DevStack:: + + git clone https://opendev.org/openstack/ironic-tempest-plugin.git + +An example local.conf that enables the ironic tempest plugin and Ironic can be +found below. The ``TEMPEST_PLUGINS`` variable needs to have the absolute path +to the ironic-tempest-plugin folder, otherwise the plugin won't be installed. +Ironic will have enabled both ``direct`` and +``iscsi`` :doc:`deploy interfaces ` and uses the +``ipmi`` hardware type by default:: + + cd devstack + cat >local.conf <` with the +ironic-tempest-plugin enabled, one might want to run integration +tests against the running cloud. The Tempest project is the project +that offers an integration test suite for OpenStack. First, navigate to Tempest directory::