Horizon UI support for Octavia
Go to file
Michael Johnson 424b307689 Remove tox_install
Tox_install is no longer required, this patch removes it.

Change-Id: I630f110810f9f3fbd16eeed0034bb3f665f66075
2018-03-14 20:18:16 +01:00
devstack Remove neutron-lbaas checks and rename "slug" 2017-08-24 14:17:10 -07:00
doc Merge "Update docs config for storyboard bugs" 2018-02-03 21:40:48 +00:00
octavia_dashboard Imported Translations from Zanata 2018-03-13 07:30:34 +00:00
releasenotes Imported Translations from Zanata 2018-03-13 07:30:34 +00:00
tools/gate/integration Remove tox_install 2018-03-14 20:18:16 +01:00
.coveragerc Remove old unused code. 2017-08-23 16:15:21 -07:00
.eslintrc Update npm dependencies 2016-01-26 22:49:38 +00:00
.gitignore Modify the '.gitignore' file 2018-02-09 11:01:45 +08:00
.gitreview Replace SortedDict with OrderedDict and fixing Python 3.5 test 2017-06-08 10:21:44 -07:00
.mailmap Initial cookiecutter commit 2015-08-07 15:41:49 -06:00
.testr.conf Initial cookiecutter commit 2015-08-07 15:41:49 -06:00
CONTRIBUTING.rst Update the installation and contributors documents 2018-01-17 03:55:19 +00:00
HACKING.rst Replace http with https for doc links in octavia-dashboard 2017-08-31 19:21:44 -07:00
LICENSE Initial cookiecutter commit 2015-08-07 15:41:49 -06:00
README.rst Adds some notes on enabling both dashboards 2018-02-20 20:40:09 -08:00
babel-django.cfg Translation preparation for neutron-lbaas-dashboard 2016-09-20 03:19:59 +09:00
babel-djangojs.cfg Translation preparation for neutron-lbaas-dashboard 2016-09-20 03:19:59 +09:00
manage.py Make sure django env var is set 2015-10-01 14:24:12 +00:00
package.json Setup octavia-dashboard for Queens release 2018-01-24 17:39:26 -08:00
requirements.txt Remove tox_install 2018-03-14 20:18:16 +01:00
setup.cfg Updating for new sphinx docs jobs 2018-01-11 22:28:05 +08:00
setup.py Updated from global requirements 2017-06-09 03:52:13 +00:00
test-requirements.txt Update the release notes for Queens 2018-01-29 23:28:29 -08:00
tox.ini Remove tox_install 2018-03-14 20:18:16 +01:00

README.rst

Team and repository tags

image

octavia-dashboard

Horizon panels for Octavia

Features

  • Please see octavia repository

Howto

  1. Package the octavia_dashboard by running:

    python setup.py sdist

    This will create a python egg in the dist folder, which can be used to install on the horizon machine or within horizon's python virtual environment.

  2. Copy _1482_project_load_balancer_panel.py in octavia_dashboard/enabled directory to openstack_dashboard/local/enabled.

  3. (Optional) Copy the policy file into horizon's policy files folder, and add this config POLICY_FILES:

    'octavia': 'octavia_policy.json',
  4. Django has a compressor feature that performs many enhancements for the delivery of static files. If the compressor feature is enabled in your environment (COMPRESS_OFFLINE = True), run the following commands:

    $ ./manage.py collectstatic
    $ ./manage.py compress
  5. Finally restart your web server to enable octavia-dashboard in your Horizon:

    $ sudo service apache2 restart

Enabling octavia-dashboard and neutron-lbaas-dashboard

In general we advise against having both dashboards running at the same time to avoid confusing users, which is exaggerated since the dashboards will have the same label.

In rare circumstances, e.g. as part of a migration strategy, it might be necessary to do so. The main issue to watch out for is to avoid neutron-lbaas and Octavia getting out of sync and neutron-lbaas-dashboard showing phantom load balancers - this can be avoided if the sync between Octavia and neutron-lbaas is fully enabled.

Here is a table to show some cases:

Configuration neutron-lbaas Configuration Octavia neutron-lbaas-dashboard enabled octavia-dashboard enabled Notes
not installed v2 API enabled not supported preferred
octavia-driver v2 API disabled v1 API enabled supported not supported sync required
octavia-driver v2 API enabled v1 API enabled supported preferred sync required
octavia-proxy plugin v1 API disabled v2 API enabled Supported (but not recommended) preferred
no octavia driver but other drivers not installed preferred not supported
no octavia driver but other drivers v2 API enabled v1 API disabled preferred preferred independent services