The docs currently show deprecated forms of client creation. Update them
to use keystoneauth Session and Identity v3.
Change-Id: I3ec285e9b02db870276bae6a9b7e1278e5d306f6
Closes-Bug: #1566448
This patch adds a new path under neutronclient docs
to document the newly added OSC commands. All new CLI commands
added via the openstack client plugin must now provide a user
guide to these commands under doc/source/usage/osc/v2
Change-Id: Id16d2fb0712fe6dd4a45a765bf7b65410302f5b8
All occurrences of tenant replaced with project (where applicable).
Partially Implements blueprint: keystone-v3
Change-Id: I4919745aa59863f99c7740e730d8cbfd91c2f646
Update the "Transition to OpenStack Client" devref with the plan
for handling network resources in Newton. In particular, this
update clarifies the OpenStack project where the commands will
reside. This update attempts to capture some of the information
in [1] and to address packaging concerns.
[1] https://etherpad.openstack.org/p/osc-neutron-support
Change-Id: I95e579ab23377a6cf36fc7a50356ab406d350053
Related-Bug: #1521291
Update the "Transition to OpenStack Client" devref with the following:
- Status update per start of Newton release
- Change developer references to use github for latest information
Change-Id: I17111b833a83395f379ed8e93091cd1956b80dbd
Related-Bug: #1521291
Update the "Transition to OpenStack Client" devref with information
about the new OSC command specs process. This process can be used
to propose new networking commands while deferring their
implementation. This process may help speed the overall transition
to OSC.
This update also includes information about the OSC neutron support
etherpad which provides detailed status for the transition.
And finally, updates were made to the overall transition plan
based on discussions at the midcycle.
Change-Id: I46bc066d2169a1e20af13baac7131ffa2eedd7c8
Related-Bug: #1521291
Added wrapper classes which are inherited from base data types tuple, dict
and str. Each of these wrapper classes contain a 'request_ids' attribute
which is populated with a 'x-openstack-request-id' received in a header
from a response body.
This change is required to return 'request_id' from client to log
request_id mappings of cross projects[1].
[1]: http://specs.openstack.org/openstack/openstack-specs/specs/return-request-id.html
Change-Id: I55fcba61c4efb308f575e95e154aba23e5dd5245
Implements: blueprint return-request-id-to-caller
Add developer reference for the transitition of the neutron CLI
support to the openstack CLI.
Change-Id: I5f9885eab7b6d1b6f4ee0d9cf84a07a0cb9d8c9a
Related-Bug: #1521291
A lot of changes have been proposed to add options to
*-create/update operations. This guideline tries to clarify
the conventions used in neutornclient.
Change-Id: I2c66c3dcba2569fdac2e54afb49406084cbf7037
* Filtering in list operation
* Changing displayed columns in list operation
* Debug: display API level communication
Change-Id: Ifba20559c76bf0c1b29f9ef3ac9def3882099956
Per the recent release note guidelines for libraries [1],
reno based release notes will be moved out from the normal docs.
The previous (partial) release notes are also moved to
releasenotes directory. The developer documentation now
has a link to the releasenote web site.
In addition, having reno directive in normal sphinx document
prevents users from generating our docs from release tarballs.
[1] http://lists.openstack.org/pipermail/openstack-dev/2015-November/080694.html
Change-Id: I817f1a7331b8664486544c82e1a9a917864601bf
Closes-Bug: #1520096
This reorganization is to make it easier to add more contents.
It move the usage of CLI and python binding to separate pages.
Change-Id: I39e0d1d18010dfd1c687c573619a09331f12241a
Even though [pbr] warnerrors = true is specified,
somehow sphinx warnings are not treated as errors.
If we use sphinx-build, -W option detects document warnings
and it leads to better documentation quality.
Fix a warning in the existing document too.
Change-Id: Icbb39686c7a24f0040d998fb14e14c63613da190
In addition to the convention of releasenotes/source directory
which used in most OpenStack project, we have the release notes
in our developer documents.
Change-Id: Ied07af5ee5c8929e639e17a34b559cebfe419dc4
In addition, to remove the contrib/ way to load commands since
it is not implemented at all.
Change-Id: Id15eb10e7cb086d55d2bcad4f719f9120c6f7d1a
Closes-Bug:#1486824
A way to test it is to follow the description and create
a neutron client using the alternative way
Make changes based on Akihiro comments
Add extra colon in line 19
Change-Id: I2f7a5a3e8f7386d24d258303b3056615da8612ad
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
The current developer docs theme used is out of sync with the other
openstack projects. This patch will update the docs to provide a more
consistent look and feel when using developer docs
Change-Id: I03985039381c2ba4f81a2015258f7b49bba441d9
