Clarify the current status of Octavia in README
There was some legacy (neutron-lbaas) language in the README.rst file for Octavia. This patch updates that and highlights the API version status documentation. Change-Id: I16bff7fc1a1359f8c34f4e154aa6dd29a5dd7a9b
This commit is contained in:
parent
e2e873fc9d
commit
9097c575c0
10
README.rst
10
README.rst
@ -16,11 +16,11 @@ Octavia
|
||||
:alt: Latest Version
|
||||
|
||||
Octavia is an operator-grade open source scalable load balancer for use in
|
||||
large OpenStack deployments. It delivers load balancing services on `amphorae
|
||||
<https://docs.openstack.org/octavia/latest/reference/glossary.html>`_ and
|
||||
provides centralized command and control. Octavia is currently the reference
|
||||
backend for Neutron LBaaS. In the near future, Octavia is likely to become the
|
||||
standard OpenStack LBaaS API endpoint.
|
||||
large OpenStack deployments.
|
||||
|
||||
Octavia provides the load balancing API for OpenStack. It supports multiple
|
||||
"provider drivers" that implement load balancing, including the "amphora"
|
||||
reference driver included with Octavia.
|
||||
|
||||
Octavia is distributed under the terms of the Apache License, Version 2.0.
|
||||
The full terms and conditions of this license are detailed in the LICENSE
|
||||
|
@ -7,11 +7,11 @@
|
||||
This is a reference for the OpenStack Load Balancing API which is provided by
|
||||
the Octavia project.
|
||||
|
||||
Current API version
|
||||
**Current** API version
|
||||
|
||||
:doc:`Octavia API v2<v2/index>`
|
||||
|
||||
Supported API version
|
||||
**Supported** API version
|
||||
|
||||
None
|
||||
|
||||
@ -27,15 +27,15 @@ superset of the previous versions of the same major revision.
|
||||
|
||||
The API status reflects the state of the endpoint on the service.
|
||||
|
||||
* Current indicates a stable version that is up-to-date, recent, and might
|
||||
* *Current* indicates a stable version that is up-to-date, recent, and might
|
||||
receive future versions. This endpoint should be prioritized over all
|
||||
others.
|
||||
* Supported is a stable version that is available on the server. However, it
|
||||
* *Supported* is a stable version that is available on the server. However, it
|
||||
is not likely the most recent available and might not be updated or might
|
||||
be deprecated at some time in the future.
|
||||
* Deprecated is a stable version that is still available but is being
|
||||
* *Deprecated* is a stable version that is still available but is being
|
||||
deprecated and might be removed in the future.
|
||||
* Experimental is not a stable version. This version is under development or
|
||||
* *Experimental* is not a stable version. This version is under development or
|
||||
contains features that are otherwise subject to change. For more
|
||||
information about API status values and version information, see
|
||||
`Version Discovery <https://wiki.openstack.org/wiki/VersionDiscovery>`__.
|
||||
|
Loading…
Reference in New Issue
Block a user