openstack/octavia
Code Issues Proposed changes

Add SDK list to octavia user docs

Browse Source 
This patch adds a page tracking SDKs that support the Octavia API to the
user documentation section.

It also clarifies that the neutron client cookbooks are deprecated.

Change-Id: I0485a07c76b06e3e6219877f318e76dade5e1334
This commit is contained in:
Michael Johnson 2018-01-26 10:46:54 -08:00 committed by Jacky Hu
parent 4871531bae
commit e121d76a82
4 changed files with 49 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/user/guides/basic-cookbook-neutron.rst
View File

@ -13,9 +13,9 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
================================================== ===============================================================
Basic Load Balancing Cookbook Using Neutron Client Basic Load Balancing Cookbook Using Neutron Client (deprecated)
================================================== ===============================================================
.. warning:: The neutron client used in this document is deprecated. We .. warning:: The neutron client used in this document is deprecated. We
strongly encourage you to use the OpenStack Client and Octavia strongly encourage you to use the OpenStack Client and Octavia

6
doc/source/user/guides/l7-cookbook-neutron.rst
View File

@ -13,9 +13,9 @@
License for the specific language governing permissions and limitations License for the specific language governing permissions and limitations
under the License. under the License.
===================================== ==================================================
Layer 7 Cookbook Using Neutron Client Layer 7 Cookbook Using Neutron Client (deprecated)
===================================== ==================================================
.. warning:: The neutron client used in this document is deprecated. We .. warning:: The neutron client used in this document is deprecated. We
strongly encourage you to use the OpenStack Client and Octavia strongly encourage you to use the OpenStack Client and Octavia

3
doc/source/user/index.rst
View File

@ -7,8 +7,11 @@ Octavia User
:maxdepth: 1 :maxdepth: 1
Command Line Interface Reference <https://docs.openstack.org/python-octaviaclient/latest/cli/index.html> Command Line Interface Reference <https://docs.openstack.org/python-octaviaclient/latest/cli/index.html>
guides/* guides/*
sdks.rst
Indices and Search Indices and Search
------------------ ------------------

40
doc/source/user/sdks.rst Normal file
View File

@ -0,0 +1,40 @@
..
Copyright (c) 2018 Rackspace, US Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
=======================================
Octavia Software Development Kits (SDK)
=======================================
Introduction
============
This is a list of known SDKs and language bindings that support OpenStack
load balancing via the Octavia API. This list is a "best effort" to keep
updated, so please check with your favorite SDK project to see if they
support OpenStack load balancing. If not, open a bug for them!
.. Note:: The projects listed here may not be maintained by the OpenStack
LBaaS team. Please submit bugs for these projects through their
respective bug tracking systems.
Java
====
`OpenStack4j <http://www.openstack4j.com/>`_
Python
======
`OpenStack SDK <https://docs.openstack.org/python-openstacksdk/latest/>`_