Skip to content

Commit

Permalink
Add L2 population docs
Browse files Browse the repository at this point in the history
Issues:
Fixes F5Networks#1196

Problem: Need additonal documenation of L2 population service.

Analysis:
Added L2 Population section to L2 adjancent docs.
Hard-code the `2` for step 2 because the `#` won't render following the `include` directive.
Move instructions to set-up section; add docker-html command to makefile
Edit reused 'edit agent config' file to fix formatting in bulleted lists
  • Loading branch information
jlongstaf committed Jan 12, 2018
1 parent eef572c commit 9d83bba
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 2 deletions.
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,16 @@

.PHONY: help
help:
@echo " docker-html one-time HTML build using a docker container"
@echo " docker-preview to build live preview of docs using sphinx-autobuild in a docker container"
@echo " docker-test to build and test docs in a docker container"

# run quality tests in a docker container
.PHONY: docker-test
docker-html:
make -C docs clean
./docs/scripts/docker-docs.sh make -C docs/ html

# Build live preview docs in a docker container
.PHONY: docker-preview
docker-preview:
Expand Down
4 changes: 2 additions & 2 deletions docs/_static/reuse/edit-agent-config-file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

Use your text editor of choice to edit the :ref:`F5 Agent Configuration File` as appropriate for your environment.

.. code-block:: console
.. code-block:: console
vim /etc/neutron/services/f5/f5-openstack-agent.ini
vim /etc/neutron/services/f5/f5-openstack-agent.ini
24 changes: 24 additions & 0 deletions docs/l2-adjacent-mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@ L2-adjacent mode is the **default mode of operation** for the |agent-short|.
Many L3 segmentation mode parameters depend on other configuration parameters.
Read about the :ref:`F5 agent configuration parameters <agent-config-parameters>` before changing these settings to ensure they don't conflict.

**L2 Population Service**

The F5 LBaaS agent supports the OpenStack Neutron ML2 population service. When you enable L2 population, the agent registers for Neutron L2 population updates and populates tunnel FDB entries in your BIG-IP device. When you place VIPs on tenant overlay networks, the F5 LBaaS agent sends tunnel update messages to the Open vSwitch agents, informing them of TMOS device VTEPs. This enables tenant guest virtual machines or network node services to interact with the TMOS provisioned VIPs across overlay networks. The F5 LBaaS Agent reports the BIG-IP VTEP addresses stored in its configuration to Neutron.

Enable L2 population if you intend to migrate pool members to different virtual machines without re-creating your load balancer configuration. Pool member migration won't function properly if L2 population isn't enabled.

With L2 population enabled, the F5 agent can also create static ARP entries on the BIG-IP device(s). This eliminates the need for the BIG-IP device to use ARP broadcast (flooding) across tunnels to learn the location of pool members.

.. note::

You can set the F5 Agent to create Static ARP entries for BIG-IP devices running version 12.x or later.

Set-up
------

Expand All @@ -41,6 +53,18 @@ Set-up

:fonticon:`fa fa-download` :download:`Download the example configuration file </_static/config_examples/f5-openstack-agent.vxlan.ini>`

.. tip:: To enable L2 population and static ARP (optional), use the settings shown below.

.. code-block:: text
#
f5_populate_static_arp = True
#
l2_population = True
#
#. Restart the |agent-short| service.

.. include:: /_static/reuse/restart-f5-agent.rst
Expand Down

0 comments on commit 9d83bba

Please sign in to comment.