octavia/README.rst
Michael Johnson 9097c575c0 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
2020-08-18 17:23:06 +00:00

59 lines
1.8 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/octavia.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
=======
Octavia
=======
.. image:: https://img.shields.io/pypi/v/octavia.svg
:target: https://pypi.org/project/octavia/
:alt: Latest Version
Octavia is an operator-grade open source scalable load balancer for use in
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
file.
Project resources
~~~~~~~~~~~~~~~~~
Developer documentation for the Octavia project is available at
https://docs.openstack.org/octavia/latest/
Release notes for the Octavia project are available at
https://docs.openstack.org/releasenotes/octavia/
The project source code repository is located at
https://opendev.org/openstack/octavia
Project status, bugs, and requests for feature enhancements are tracked on
https://storyboard.openstack.org/#!/project/openstack/octavia
For more information on project direction and guiding principles for
contributors, please see the CONSTITUTION.rst file in this directory, or
specifications in the specs/ sub-directory.
The project roadmap is available at
https://wiki.openstack.org/wiki/Octavia/Roadmap
External Resources
~~~~~~~~~~~~~~~~~~
* Octavia Wiki: https://wiki.openstack.org/wiki/Octavia
* For help on usage and hacking of Octavia, please send an email to
OpenStack-dev Mailing List <mailto:openstack-discuss@lists.openstack.org>
with **[Octavia]** tag.