python-octaviaclient/README.rst
Michael Johnson b1afaa3b54 Update python-octaviaclient docs for migration
This patch updates the python-octaviaclient project for the OpenStack
documentation migration [1].

[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

Change-Id: Id873ab00fcc80507d841bcfade47fa2308100099
2017-07-28 00:03:52 +00:00

48 lines
1.3 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/badges/python-octaviaclient.svg
:target: https://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
====================
python-octaviaclient
====================
Octavia client for OpenStack Load Balancing
This is an OpenStack Client (OSC) plugin for Octavia, an OpenStack
Load Balancing project.
For more information about Octavia see:
https://docs.openstack.org/octavia/latest/
For more information about the OpenStack Client see:
https://docs.openstack.org/python-openstackclient/latest/
* Free software: Apache license
* Documentation: https://docs.openstack.org/octavia/latest/
* Source: http://git.openstack.org/cgit/openstack/python-octaviaclient
* Bugs: http://bugs.launchpad.net/octavia
Getting Started
===============
.. note:: This is an OpenStack Client plugin. The ``python-openstackclient``
project should be installed to use this plugin.
Octavia client can be installed from PyPI using pip::
pip install python-octaviaclient
If you want to make changes to the Octavia client for testing and contribution,
make any changes and then run::
python setup.py develop
or::
pip install -e .