F5Networks / f5-openstack-lbaasv2-driver

F5 LBaaSv2 service provider driver for OpenStack Liberty and beyond
http://clouddocs.f5.com/products/openstack/lbaasv2-driver/master/
Apache License 2.0
21 stars 37 forks source link

Fix documentation bugs/inaccuracies #159

Closed jputrino closed 8 years ago

jputrino commented 8 years ago

OpenStack Release

Liberty +

Description

I asked @jgruber to review the docs and give me feedback. Now I need to fix all the issues he identified in his email.

jputrino commented 8 years ago

email from John G

Supported Features – Notes

HA Mode:– Remove from Preqs

Two (2) VLANs configured in Neutron to be used for BIG-IP internal and external traffic.

The setup of the cluster is not documented here, so there are no ‘VLAN requirements’.

L2/L3 Segmentation Modes Overview:

I would rewrite this sentence from:

The F5® agent doesn’t manage any networking components. Rather, it relies on the L2/L3 segmentation mode settings to determine how your BIG-IP® device(s) is configured.

to:

The F5 agent determine you BIG-IP device(s) L2 and L3 network configurations base on the L2/L3 segmentation mode settings in the agent configuration.

Use Case:

This highlights Global Routed mode, but the default mode of operation is actually L2 Adjacent mode. We’ll have to create a picture.

I messed up when I said the Global Routed mode picture was OK.. Sorry.. You need to remove the line between the routers that says ‘bridge’ and replace it with a ‘cloud’ which is symbolic of a L3 routed network. This same picture needs to be corrected in the Global Routed mode section.

Under the Prerequisites sections we need this bullet item:

Under L3 Binding section, this:

The L3 Binding driver is required for overcloud BIG-IP deployments. This setting binds L3 addresses to specific ports to allow communications between Nova guest instances.

Uncomment this line in the Agent Configuration File if you’re using an undercloud VE.

Needs to read:

The L3 Binding driver is required for overcloud BIG-IP deployments. This setting binds L3 addresses to specific ports to allow communications between Nova guest instances.

Uncomment this line in the Agent Configuration File if you’re using an overcloud VE.

Just a note: I hate the use of ‘over the cloud’ and ‘under the cloud’ they are such bogus terms.. I just don’t have any better ones to give you.

F5 OpenStack LBaaSv2 User Guide - Notes

Install the F5 Service Provider Package

The installation of the packages using file copies is a really bad idea. We need to get things packaged as RPMs and Debs. The current instructions need to say CentOS7 and Ubuntu 14.04 or 16.04 as the default version of python and the file path for the PYTHONLIB path can change from release to release of CentOS or Ubuntu.

Let’s review this at the next Sprint.. we’re asking for bad installs.

Install the F5 Agent

“You can also install it on any host for which you’d like to provision BIG-IP services.”

Needs to read:

“You can also install it on any host FROM which you’d like to provision BIG-IP services.” There are not BIG-IP services installed on the host running the agent process.

I also assume we will include a section on install the F5 agent similar to the ‘Install the F5 LBaaSv2 Driver’ section that follows. It should have the pip commands to install the agent.

Managing BIG-IP Cluster: Use Cases:

Remove this sentence:

A few commonly-used BIG-IP clustering examples are Sync-Failover device groups and Sync-Only device groups.

Only a Sync-Failover device group provides HA for data traffic that could cause a service disruption. We don’t use Sync-Only device groups in our LBaaS solution at all.

In the footnotes.. I’m not sure I understand:

You can use the following F5 Heat templates to prep an overcloud VE and deploy an active/standby cluster of BIG-IP devices (over- or undercloud).