there are no docs for using octavia

Bug #1877417 reported by sean mooney
14
This bug affects 3 people
Affects Status Importance Assigned to Milestone
kolla-ansible
Fix Released
Medium
Mark Goddard
Victoria
Fix Released
Medium
Mark Goddard

Bug Description

kolla ansible has support for octavia however there are no docs for how to use it at all.
looking at the upstream octaiva docs i was eventually able to determin how to get octavia to work but kolla ansible does not deploy the service in a working state.

we shoudl either mark it as tech preview/experimental or add docmentation describing how to deploy correctly.

before deployment you need to create a cert athority
in /etc/kolla/config/octaivia

following this process https://docs.openstack.org/octavia/latest/admin/guides/certificates.html
then you need to rename the generated certs and copy them to the name kolla expects
cp certs/server_ca/private/ca.key.pem /etc/kolla/config/octavia/server_ca.key.pem
cp certs/server_ca/certs/ca.cert.pem /etc/kolla/config/octavia/server_ca.cert.pem
cp certs/client_ca/private/client.cert-and-key.pem /etc/kolla/config/octavia/client.cert-and-key.pem
cp certs/client_ca/certs/ca.cert.pem /etc/kolla/config/octavia/client_ca.cert.pem

this is error prone and tedious and should be automated.

addtionally a prodier netwrok needs to be created for octavia to spawn the loadblancer vms
this netwrok uuid need to be set in the octaiva config e.g. /etc/kolla/config/octavia.conf
a default flavor should also be set
amp_boot_network_list = a5555da0-3118-4b11-b68b-2cbfb4a3324f
amp_image_tag = amphora
amp_secgroup_list =
amp_flavor_id = 100
amp_ssh_key_name = octavia_ssh_key

some steps that are required post deployment are as follows
- create a the octavia_ssh_key in the octavia user
- create an ampohora image https://docs.openstack.org/octavia/latest/admin/amphora-image-build.html (this require you to git clone ocativa and then use disk image builder to build the imag ethen upload it to glance with an amphora tag.)
- add the ocativa user to the admin project. (this should not be required but we have a bug in our config generation) the octavia user should only be a member of the service project bu we currently
configure the service_auth project to {{ openstack_auth.project_name }}
https://github.com/openstack/kolla-ansible/blob/a44bba845fef741594b532a7f0f90651a5ef0b6c/ansible/roles/octavia/templates/octavia.conf.j2#L36
it should be set to service so either you can fix that with a template override or you can add the octavia user to admin porject as an admin. if you dont you will get a error when create a loadblancer

(openstack) loadbalancer create --vip-network-id 92ac19a4-4241-40fc-8baf-1d9f4c3e0838
The request you have made requires authentication. (HTTP 401) (Request-ID: req-8e2f5af7-a3df-40a1-a76e-ac075a6bc8c1) (HTTP 500) (Request-ID: req-1bcad1c2-af18-454a-85fc-3c3c772f66b7)

Changed in kolla-ansible:
assignee: nobody → Dincer Celik (osmanlicilegi)
Revision history for this message
Mark Goddard (mgoddard) wrote :

I recently helped someone through this process, let me know if you need any info Dincer. I was thinking we could build the docs up iteratively, first starting with a checklist, then adding full instructions. Ideally we would link to Octavia docs rather than reproduce them where possible e.g. for cert generation.

Mark Goddard (mgoddard)
Changed in kolla-ansible:
importance: Undecided → Medium
Mark Goddard (mgoddard)
Changed in kolla-ansible:
assignee: Dincer Celik (osmanlicilegi) → Mark Goddard (mgoddard)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to kolla-ansible (master)

Fix proposed to branch: master
Review: https://review.opendev.org/737227

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (master)

Reviewed: https://review.opendev.org/737227
Committed: https://git.openstack.org/cgit/openstack/kolla-ansible/commit/?id=543eb4bdfd8336c690bc10dbb3b986fd0e0a1c95
Submitter: Zuul
Branch: master

commit 543eb4bdfd8336c690bc10dbb3b986fd0e0a1c95
Author: Mark Goddard <email address hidden>
Date: Thu Jun 18 20:46:32 2020 +0100

    octavia: Add documentation

    Covers manual registration of resources.

    Change-Id: Idbee6ea1dba911cda38a0df307ed94e4ef98900d
    Closes-Bug: #1877417

Changed in kolla-ansible:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to kolla-ansible (stable/ussuri)

Fix proposed to branch: stable/ussuri
Review: https://review.opendev.org/737971

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to kolla-ansible (stable/train)

Fix proposed to branch: stable/train
Review: https://review.opendev.org/737973

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to kolla-ansible (stable/stein)

Fix proposed to branch: stable/stein
Review: https://review.opendev.org/737974

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (stable/ussuri)

Reviewed: https://review.opendev.org/737971
Committed: https://git.openstack.org/cgit/openstack/kolla-ansible/commit/?id=9b6ec38b8922a49eb8a08bc63e4b1ebbf3e757b1
Submitter: Zuul
Branch: stable/ussuri

commit 9b6ec38b8922a49eb8a08bc63e4b1ebbf3e757b1
Author: Mark Goddard <email address hidden>
Date: Thu Jun 18 20:46:32 2020 +0100

    octavia: Add documentation

    Covers manual registration of resources.

    Change-Id: Idbee6ea1dba911cda38a0df307ed94e4ef98900d
    Closes-Bug: #1877417
    (cherry picked from commit 543eb4bdfd8336c690bc10dbb3b986fd0e0a1c95)

tags: added: in-stable-ussuri
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (stable/train)

Reviewed: https://review.opendev.org/737973
Committed: https://git.openstack.org/cgit/openstack/kolla-ansible/commit/?id=2918bae992c91667d8cb823e4952965b1389c9f5
Submitter: Zuul
Branch: stable/train

commit 2918bae992c91667d8cb823e4952965b1389c9f5
Author: Mark Goddard <email address hidden>
Date: Thu Jun 18 20:46:32 2020 +0100

    octavia: Add documentation

    Backport note: modified default project from service to admin.

    Covers manual registration of resources.

    Change-Id: Idbee6ea1dba911cda38a0df307ed94e4ef98900d
    Closes-Bug: #1877417
    (cherry picked from commit 543eb4bdfd8336c690bc10dbb3b986fd0e0a1c95)

tags: added: in-stable-train
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to kolla-ansible (stable/stein)

Reviewed: https://review.opendev.org/737974
Committed: https://git.openstack.org/cgit/openstack/kolla-ansible/commit/?id=ed426f6afab16ed7086db2b31b3c5c5caf61a28d
Submitter: Zuul
Branch: stable/stein

commit ed426f6afab16ed7086db2b31b3c5c5caf61a28d
Author: Mark Goddard <email address hidden>
Date: Thu Jun 18 20:46:32 2020 +0100

    octavia: Add documentation

    Backport note: modified default project from service to admin.

    Covers manual registration of resources.

    Change-Id: Idbee6ea1dba911cda38a0df307ed94e4ef98900d
    Closes-Bug: #1877417
    (cherry picked from commit 543eb4bdfd8336c690bc10dbb3b986fd0e0a1c95)

tags: added: in-stable-stein
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.