diff --git a/README.rst b/README.rst index 0b80bcaf..4d732cc9 100644 --- a/README.rst +++ b/README.rst @@ -55,3 +55,44 @@ Howto 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 | 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 | | | | | ++---------------+-----------------+----------------+-----------+--------------+ \ No newline at end of file