README.rst 4.93 KB
Newer Older
1 2 3 4
========================
Team and repository tags
========================

lidong's avatar
lidong committed
5 6
.. image:: https://governance.openstack.org/tc/badges/octavia-dashboard.svg
    :target: https://governance.openstack.org/tc/reference/tags/index.html
7 8 9

.. Change things from this point on

10 11 12
=================
octavia-dashboard
=================
13

14
Horizon panels for Octavia
15 16

* Free software: Apache license
chenxiangui's avatar
chenxiangui committed
17
* Documentation: https://docs.openstack.org/octavia-dashboard/latest/
Nir Magnezi's avatar
Nir Magnezi committed
18
* Source: https://git.openstack.org/cgit/openstack/octavia-dashboard
19
* Release notes: https://docs.openstack.org/releasenotes/octavia-dashboard/
20
* Bugs: https://storyboard.openstack.org/#!/project/909
21 22 23 24

Features
--------

25
* Please see octavia repository
26

27 28 29 30

Howto
-----

31
1. Package the octavia_dashboard by running::
32 33 34

    python setup.py sdist

35 36 37
   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.
38

39
2. Copy ``_1482_project_load_balancer_panel.py`` in
40
   ``octavia_dashboard/enabled`` directory
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
   to ``openstack_dashboard/local/enabled``::

    $ cp -a \
      ${OCTAVIA_DASHBOARD_DIR}/octavia_dashboard/enabled/_1482_*.py \
      ${HORIZON_DIR}/openstack_dashboard/local/enabled/

3. (Optional) Generate the policy file and copy into horizon's policy files
   folder, and copy ``_1499_load_balancer_settings.py`` in
   ``octavia_dashboard/local_settings.d`` directory
   to ``openstack_dashboard/local/local_settings.d``::

    $ oslopolicy-policy-generator \
      --config-file \
      ${OCTAVIA_DIR}/etc/policy/octavia-policy-generator.conf \
      --output-file \
      ${OCTAVIA_DASHBOARD_DIR}/octavia_dashboard/conf/octavia_policy.yaml
    $ cp -a \
      ${OCTAVIA_DASHBOARD_DIR}/octavia_dashboard/conf/octavia_policy.yaml \
      ${HORIZON_DIR}/openstack_dashboard/conf/
    $ cp -a \
      ${OCTAVIA_DASHBOARD_DIR}/octavia_dashboard/local_settings.d/_1499_*.py \
      ${HORIZON_DIR}/openstack_dashboard/local/local_settings.d/
63

64 65 66
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::
67

68 69
    $ ./manage.py collectstatic
    $ ./manage.py compress
70

71
5. Finally restart your web server to enable octavia-dashboard
72
   in your Horizon::
73

74
    $ sudo service apache2 restart
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114

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 | Configuration   | neutron-lbaas- | octavia-  | Notes        |
| neutron-lbaas | Octavia         | dashboard      | dashboard |              |
|               |                 | enabled        | enabled   |              |
+---------------+-----------------+----------------+-----------+--------------+
| not installed | v2 API enabled  | not supported  | preferred |              |
+---------------+-----------------+----------------+-----------+--------------+
| octavia-driver| v2 API disabled | supported      | not       | sync         |
|               | v1 API enabled  |                | supported | required     |
+---------------+-----------------+----------------+-----------+--------------+
| octavia-driver| v2 API enabled  | supported      | preferred | sync         |
|               | v1 API enabled  |                |           | required     |
+---------------+-----------------+----------------+-----------+--------------+
| octavia-proxy | v1 API disabled | Supported (but | preferred |              |
| plugin        | v2 API enabled  | not            |           |              |
|               |                 | recommended)   |           |              |
+---------------+-----------------+----------------+-----------+--------------+
| no octavia    | not installed   | preferred      | not       |              |
| driver but    |                 |                | supported |              |
| other drivers |                 |                |           |              |
+---------------+-----------------+----------------+-----------+--------------+
| no octavia    | v2 API enabled  | preferred      | preferred | independent  |
| driver but    | v1 API disabled |                |           | services     |
| other drivers |                 |                |           |              |
115
+---------------+-----------------+----------------+-----------+--------------+