Docs: Operator installation guide needed

Bug #1558368 reported by Stephen Balukoff
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
octavia
Fix Released
High
Stephen Balukoff

Bug Description

This should contain:

* Basic quick-start / overview of process
* Which other Openstack services Octavia depends on
* Topology considerations (stand-alone / active-standby / use of spares pool / what the lb network is / etc.)
* Which daemons to run and where (point out that API should be on protected network segment since it has no auth right now)
* Sample octavia config file (perhaps automatically pull in the sample?)
* Brief discussion of how neutron-lbaas needs to be configured to use Octavia
* Anything else that seems appropriate for the installation guide.

(See: https://etherpad.openstack.org/p/lbaas-octavia-docs-needed )

tags: added: docs
Changed in octavia:
importance: Undecided → High
Changed in octavia:
assignee: nobody → Stephen Balukoff (sbalukoff)
Changed in octavia:
status: New → In Progress
Revision history for this message
Leslie Lundquist (llundquist-e) wrote :

Working on a quick start/tutorial from the Summit talk. Also have a short Q&A I pulled from IRC. Do you want this?

Revision history for this message
Leslie Lundquist (llundquist-e) wrote :

Getting Started with Installing Octavia Q & A

Q. Hello, I have a question regarding using Octavia. I have a running setup with controller node, network, and hypervisors. We got LBAASv2 working with HAproxy, installing LBaaSv2 on the controller and lbaas-agent and haproxy on the network host.

 For Octavia, where exactly is the module installed? On controller node, network, or on whichever hypervisor we want to deploy our load balancing VM?

 Also, do we need a VM image for Octavia to deploy, and if so, how do we prep it? What needs to be preconfigured on the image?

A. Octavia boots service VMs to do the load balancing. The Octavia controller processes reside on your OpenStack controller nodes. Octavia does not require to be installed on specific nodes.

 As for the service VM image, we provide a script that will build an image in /diskimage-create under the Octavia directory. Our test gates use "diskimage-create.sh -s 2" to create a 2GB image.

 Q. So we do not need to install any additional stuff on our network hosts or hypervisors (as we did with HAproxy)?

A. Right, yes, the HAproxy drive has to be on the network node.
 You do need to install Octavia somewhere in your OpenStack.

 To use Octavia, instead of installing the LBaaSv2 agent and HAproxy, you should install Octavia control processes (API, worker, health manager, and housekeeping)

You can install them anywhere you want, as long as Neutron can reach the Octavia API.
Q. Yes, I was just confused as to whether we needed a separate Octavia module running somewhere on our hosts in addition to a controller node or a node where neutron-server lies.

Does Octavia deploy the load-balancing VM automatically when we create a load-balancer/listener (similar to the way HAproxy and agent creates an qlbaas Linux namespace)?
A. Yes, Octavia handles booting the VM.

Q. 1 more question :) How does it know to use the image created via the above script? We have many images in our image library. Is the image name/path specified somewhere in the LBaaS CLI or API?

A. You provide the image id or tag in the octavia.conf file.

Revision history for this message
Leslie Lundquist (llundquist-e) wrote :

I was putting together a tutorial.

Revision history for this message
Leslie Lundquist (llundquist-e) wrote :

I am so very bad at this process of contributing docs, but I want you to know I am doing something.

tags: added: lbaas-merge
Changed in octavia:
assignee: Stephen Balukoff (sbalukoff) → Michael Johnson (johnsom)
Changed in octavia:
assignee: Michael Johnson (johnsom) → Leslie Lundquist (llundquist)
Changed in octavia:
assignee: Leslie Lundquist (llundquist) → Stephen Balukoff (sbalukoff)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to octavia (master)

Reviewed: https://review.openstack.org/232173
Committed: https://git.openstack.org/cgit/openstack/octavia/commit/?id=1360c197c9f9d9de32a865a357e8985f7b093890
Submitter: Jenkins
Branch: master

commit 1360c197c9f9d9de32a865a357e8985f7b093890
Author: Stephen Balukoff <email address hidden>
Date: Wed Oct 7 12:47:11 2015 -0700

    Adding introduction and developer quick start docs

    Octavia is currently missing any documentation designed to help
    new developers and operators understand what we're doing with the project
    or how to get started using and contributing to it. This patch set aims
    to correct this problem.

    Co-Authored-By: Michael Johnson <email address hidden>
    Co-Authored-By: Leslie Lundquist <email address hidden>
    Closes-Bug: #1558368
    Change-Id: Idaa37277bd342b644a463d4a0884ea40c2e8d4f5

Changed in octavia:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/octavia 0.9.0

This issue was fixed in the openstack/octavia 0.9.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.