Skip to content

Commit a1705c0

Browse files
committed
Add introduction and link to official docs
1 parent 9b6d6d5 commit a1705c0

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

doc/source/operations/octavia.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ Octavia
77
Introduction to Octavia
88
=======================
99

10-
Octavia is known as an *operator-scaled* load balancing service.
10+
Octavia is known as an *operator-scaled* load balancing service, whose primary goal is to
11+
distribute incoming network traffic, destined for a single VM, across multiple VMs instead;
12+
thus preventing overloading the VM and improving the overall performance of the VM's outbound
13+
service.
14+
15+
For more information on Octavia, please refer to the `official documentation <https://docs.openstack.org/octavia/latest/reference/introduction.html>`_.
1116

1217
.. _Deploying Octavia:
1318

@@ -18,21 +23,24 @@ Much like any other Kolla managed service, the method of deploying Octavia is as
1823
as enabling ``kolla_enable_octavia: true`` within the chosen environment's ``kolla.yml``.
1924
However, before running a ``kayobe overcloud service configure``, check
2025
``octavia_net_interface`` (often found within the ``controllers`` directory within
21-
``group_vars``) to see the network which Octavia management network will be using.
22-
If it is configured to use a VLAN then ``kolla_enable_neutron_provider_networks: true``
26+
``${KAYOBE_CONFIG_PATH}/inventory/group_vars``) to see the network which Octavia management
27+
network will be using. If it is configured to use a VLAN then ``kolla_enable_neutron_provider_networks: true``
2328
should also be set in ``kolla.yml``.
2429

2530
.. note::
2631

2732
It of course goes without saying that the network configured for ``octavia_net_interface``
2833
should also exist in ``networks.yml``.
2934

30-
By default Octavia will deploy a single Amphora VM per load balancing service, this should be
35+
By default Octavia will deploy an Amphorae (a single Amphora VM) per load balancing service, this should be
3136
changed to make them highly available and have two Amphora VM per service. Done by setting
3237
``octavia_loadbalancer_topology: "ACTIVE_STANDBY"`` in ``${KAYOBE_CONFIG_PATH}/kolla/globals.yml``,
3338
this will ensure that if the master Amphora VM were to go down, the other would be able to
3439
take over the load balancing functions.
3540

41+
Further configuration options and details on installation can be found in the
42+
`Octavia documentation <https://docs.openstack.org/octavia/latest/install/index.html>`_.
43+
3644
.. _Amphora image:
3745

3846
Building and rotating amphora images

0 commit comments

Comments
 (0)