From 9097c575c05997586bf15c8f46750c74694f04cb Mon Sep 17 00:00:00 2001 From: Michael Johnson Date: Mon, 20 Jul 2020 09:36:11 -0700 Subject: [PATCH] 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 --- README.rst | 10 +++++----- api-ref/source/index.rst | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 8eb70a82c4..cc1a771ef3 100644 --- a/README.rst +++ b/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 -`_ 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 diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index daf86e7f33..933de610c1 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -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` -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 `__.