diff --git a/README.rst b/README.rst index 3de85cbf4c..dd8b415991 100644 --- a/README.rst +++ b/README.rst @@ -10,23 +10,32 @@ Octavia :target: https://pypi.python.org/pypi/octavia/ :alt: Downloads -Operator-grade open source scalable load balancer. +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. -* Free software: Apache license -* Documentation: http://docs.openstack.org/developer/octavia -* Source: http://git.openstack.org/cgit/openstack/octavia -* Bugs: http://bugs.launchpad.net/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. -The Octavia project seeks to become the standard operator-grade load balancer -in use in large OpenStack deployments. Note that it is not competing with the -Neutron LBaaS extension and may never actually replace it. Rather, Octavia -should be seen as "yet another vendor" which is accessed via a driver for -Neutron LBaaS. +Project resources +~~~~~~~~~~~~~~~~~ + +Developer documentation for the Octavia project is available at +http://docs.openstack.org/developer/octavia + +The project source code repository is located at +http://git.openstack.org/cgit/openstack/octavia + +Project status, bugs, and requests for feature enhancements are tracked on +http://launchpad.net/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/ subdirectory. Other documentation can be -found in the docs/ directory. +specifications in the specs/ sub-directory. -Please also see https://wiki.openstack.org/wiki/Octavia/Roadmap for the -latest version of our project roadmap. +The project roadmap is available at +https://wiki.openstack.org/wiki/Octavia/Roadmap