Skip to content

Commit 3ea5314

Browse files
committed
Add service dependencies reminder to Magnum docs
1 parent 3616595 commit 3ea5314

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

doc/source/configuration/magnum-capi.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ The Cluster API architecture relies on a CAPI management cluster in order to run
1515

1616
2. It must be reachable from the control plane nodes (either controllers or dedicated network hosts) on which the Magnum containers are running (so that the Magnum can reach the IP listed in the management cluster's ``kubeconfig`` file).
1717

18+
The Magnum Cluster API driver requires that Barbican, Octavia, and Redis are deployed and working in your OpenStack environment. Octavia can be deployed with either the Amphora or OVN drivers, but the OVN driver is recommended for new deployments.
19+
1820
For testing purposes, a simple `k3s <https://k3s.io>`_ cluster would suffice. For production deployments, the recommended solution is to instead set up a separate HA management cluster in an isolated OpenStack project by leveraging the CAPI management cluster configuration used in `Azimuth <https://github.com/stackhpc/azimuth>`_. This approach will provide a resilient HA management cluster with a standard set of component versions that are regularly tested in Azimuth CI.
1921
The general process for setting up this CAPI management cluster using Azimuth tooling is described here, but the `Azimuth operator documentation <https://stackhpc.github.io/azimuth-config/#deploying-azimuth>`_ should be consulted for additional information if required.
2022

@@ -105,7 +107,21 @@ Next, copy the CAPI management cluster's kubeconfig file into your stackhpc-kayo
105107

106108
The presence of a kubeconfig file in the Magnum config directory is used by Kolla to determine whether the CAPI Helm driver should be enabled.
107109

108-
To apply the configuration, run ``kayobe overcloud service reconfigure -kt magnum``.
110+
If Magnum is already deployed, apply the configuration with ``kayobe overcloud service reconfigure -kt magnum``.
111+
112+
If Magnum is not yet deployed, enable it and its dependencies in your kayobe environment's ``kolla.yml`` file:
113+
114+
.. code-block:: yaml
115+
:caption: kolla.yml
116+
117+
kolla_enable_magnum: true
118+
kolla_enable_octavia: true
119+
kolla_enable_barbican: true
120+
kolla_enable_redis: true
121+
122+
See the `Kolla-Ansible documentation <https://docs.openstack.org/kolla-ansible/latest/reference/networking/octavia.html>`_ for more details on configuring Octavia.
123+
124+
Deploy the services with ``kayobe overcloud service deploy``.
109125

110126
Magnum Cluster Templates
111127
========================

0 commit comments

Comments
 (0)