openstack/ironic
Code Issues Proposed changes

Clarify how to configure for non-master branch

Browse Source 
Since we're a plugin, the TARGET_BRANCH instructions in the normal
devstack guide are not enough. We should specifically instruct people to
avoid this pitfall.

Change-Id: I7c9fd98c582984036e0b19714b8f387a31e8715f
This commit is contained in:
Jay Faulkner 2024-08-22 10:32:09 -07:00
parent 501b8f463b
commit 8e6b758bfa
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/source/contributor/devstack-guide.rst
View File

@ -254,11 +254,23 @@ enabled and use the ``ipmi`` hardware type with this config::
END
.. note::
For adding :ref:`tempest` support to this configuration, see the
:ref:`tempest` section of this document.
Stable Branch Configuration
---------------------------
If you want to run Ironic in a branch other than master, you need to specify
the correct version Ironic you want at the end of the enable_plugin line, e.g.
``enable_plugin ironic https://opendev.org/openstack/ironic stable/2024.1``.
In almost all situations, you'll also want any other associated OpenStack
services to run in that version, too. Just add this config:
``TARGET_BRANCH=stable/2024.1``
Other Devstack Configurations
-----------------------------
There are additional devstack configurations in other parts of contributor
@ -279,7 +291,7 @@ This section assumes you already have a working, deployed Ironic with Nova
configured as laid out above.
First, set the user to the admin demo (Note
that all the user options can be seen in `/etc/openstack/clouds.yaml`)::
that all the user options can be seen in ``/etc/openstack/clouds.yaml``)::
export OS_CLOUD=devstack-admin-demo