Skip to content

Commit 9097c57

Browse files
committed
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
1 parent e2e873f commit 9097c57

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ Octavia
1616
:alt: Latest Version
1717

1818
Octavia is an operator-grade open source scalable load balancer for use in
19-
large OpenStack deployments. It delivers load balancing services on `amphorae
20-
<https://docs.openstack.org/octavia/latest/reference/glossary.html>`_ and
21-
provides centralized command and control. Octavia is currently the reference
22-
backend for Neutron LBaaS. In the near future, Octavia is likely to become the
23-
standard OpenStack LBaaS API endpoint.
19+
large OpenStack deployments.
20+
21+
Octavia provides the load balancing API for OpenStack. It supports multiple
22+
"provider drivers" that implement load balancing, including the "amphora"
23+
reference driver included with Octavia.
2424

2525
Octavia is distributed under the terms of the Apache License, Version 2.0.
2626
The full terms and conditions of this license are detailed in the LICENSE

api-ref/source/index.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
This is a reference for the OpenStack Load Balancing API which is provided by
88
the Octavia project.
99

10-
Current API version
10+
**Current** API version
1111

1212
:doc:`Octavia API v2<v2/index>`
1313

14-
Supported API version
14+
**Supported** API version
1515

1616
None
1717

@@ -27,15 +27,15 @@ superset of the previous versions of the same major revision.
2727

2828
The API status reflects the state of the endpoint on the service.
2929

30-
* Current indicates a stable version that is up-to-date, recent, and might
30+
* *Current* indicates a stable version that is up-to-date, recent, and might
3131
receive future versions. This endpoint should be prioritized over all
3232
others.
33-
* Supported is a stable version that is available on the server. However, it
33+
* *Supported* is a stable version that is available on the server. However, it
3434
is not likely the most recent available and might not be updated or might
3535
be deprecated at some time in the future.
36-
* Deprecated is a stable version that is still available but is being
36+
* *Deprecated* is a stable version that is still available but is being
3737
deprecated and might be removed in the future.
38-
* Experimental is not a stable version. This version is under development or
38+
* *Experimental* is not a stable version. This version is under development or
3939
contains features that are otherwise subject to change. For more
4040
information about API status values and version information, see
4141
`Version Discovery <https://wiki.openstack.org/wiki/VersionDiscovery>`__.

0 commit comments

Comments
 (0)