Add OVN support to the documentation

Add support for OVN in the ironic section of the charm-guide.
Additionally, add a release note indicating that OVN is now supported
as the SDN of choice when deploying ironic.

Change-Id: Ic056aee5b2bb7b17c00e7caa499ca874660901ef
This commit is contained in:
Billy Olsen
2024-04-29 20:32:55 -07:00
parent 58a5fea85e
commit de5f2b28bd
2 changed files with 35 additions and 8 deletions

View File

@@ -16,8 +16,8 @@ Ironic. It is important to have `Upstream Ironic Documentation`_ as context.
Ironic is supported by Charmed OpenStack starting with OpenStack Ussuri
on Ubuntu 18.04.
Currently, charmed Ironic requires Neutron OpenVSwtich as the SDN and does
not support OVN.
Ironic with OVN is available starting in the Caracal (2024.1) release of
OpenStack.
Charms
~~~~~~
@@ -34,9 +34,15 @@ There are three Ironic charms:
Deployment considerations
-------------------------
See `Example Bundle`_ for a known working configuration. The bundle deploys an
instantiation of nova-compute dedicated to Ironic. The ``virt-type`` is set to
'ironic' in order to indicate to Nova that bare metal deployments are available.
For releases prior to 2024.1, the deployment required a neutron-gateway configuration using
Neutron Open vSwitch. Starting in 2024.1, Ironic can now be deployed using OVN as the SDN.
* `Neutron Open vSwitch Example Bundle`_
* `Neutron OVN Example Bundle`_
The bundles each deploy an instance of the nova-compute application dedicated to Ironic. The
``virt-type`` is set to 'ironic' in order to indicate to Nova that bare metal deployments are
available.
.. note::
@@ -46,8 +52,8 @@ instantiation of nova-compute dedicated to Ironic. The ``virt-type`` is set to
.. code-block:: yaml
nova-ironic:
charm: cs:~openstack-charmers-next/nova-compute
series: focal
charm: ch:nova-compute
series: jammy
num_units: 1
bindings:
"": *oam-space
@@ -59,6 +65,14 @@ instantiation of nova-compute dedicated to Ironic. The ``virt-type`` is set to
to:
- "lxd:3"
ML/2 OVN
~~~~~~~~
When deploying with OVN as the SDN, the Ironic nova-compute application can
be deployed to a bare-metal machine with the ovn-chassis application in order
to act as a gateway for the deployment. In this scenario, the ``prefer-chassis-as-gw``
option should be set to 'True' on the ovn-chassis application.
Network topology
~~~~~~~~~~~~~~~~
@@ -430,7 +444,8 @@ Boot a bare metal machine
.. LINKS
.. _Neutron networking deployment: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/ussuri/install-openstack.html#neutron-networking
.. _Upstream Ironic Documentation: https://docs.openstack.org/ironic/latest/
.. _Example Bundle: https://github.com/thedac/openstack-bundles/blob/ironic-deployment/development/openstack-ironic-focal-ussuri/bundle.yaml
.. _Neutron Open vSwitch Example Bundle: https://github.com/thedac/openstack-bundles/blob/ironic-deployment/development/openstack-ironic-focal-ussuri/bundle.yaml
.. _Neutron OVN Example Bundle: https://github.com/wolsen/tf-ironic-lab/blob/dae1b8cc2992d1528ba5da6923675758ba8f6f3d/ironic-bundle.yaml
.. _Building deploy ramdisk: https://docs.openstack.org/ironic/latest/install/deploy-ramdisk.html
.. _Ironic Python Agent Builder: https://docs.openstack.org/ironic-python-agent-builder/latest/
.. _vm: https://docs.openstack.org/diskimage-builder/latest/elements/vm/README.html

View File

@@ -70,6 +70,17 @@ This option is disabled by default to prevent log file bloat.
For more details see bug `LP #1856555`_.
Ironic: add support for OVN
~~~~~~~~~~~~~~~~~~~~~~~~~~~
OpenStack Ironic now supports OVN as the configured SDN of choice. The neutron-api,
neutron-api-plugin-ovn, neutron-api-plugin-ironic charms have been update to
support the necessary services and drivers to use OVN instead of Open vSwitch. To
use this feature, deploy OVN services and ensure that both the neutron-api-plugin-ovn
and neutron-api-plugin-ironic are deployed.
For more details see the `Ironic documentation`_ for OpenStack charms.
Documentation updates
---------------------
@@ -128,6 +139,7 @@ Changes backported to this release
.. _Upgrades overview: https://docs.openstack.org/charm-guide/latest/admin/upgrades/overview.html
.. _charm repositories: https://opendev.org/openstack?sort=alphabetically&q=charm-&tab=
.. _keystone_audit_middleware: https://docs.openstack.org/keystonemiddleware/latest/audit.html
.. _Ironic documentation: https://docs.openstack.org/charm-guide/latest/admin/compute/ironic.html
.. COMMITS