Commit Graph

14 Commits

Author SHA1 Message Date
Stephen Finucane e11efd8d76 doc: Create directory structure for docs migration
The spec [1] recommends the following sections:

- install
- contributor
- configuration
- cli
- admin
- user
- reference

Only a few of these are useful here:

- contributor
- cli
- user
- reference

Add these and populate them.

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

Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
2017-07-12 15:07:35 +01:00
Monty Taylor 92665dbcd8
Add novaclient client_name and client_version to user-agent
keystoneauth supports setting additional info into the user-agent string
about what the client is. Set it so that novaclient shows up in server
logs as the client.

Change-Id: I084a16f5372ec7df598505e9f925a70d26d66f69
2017-04-18 08:03:23 -05:00
meretiko 54ed91583f The novaclient Python API doc keystoneauth example fixed
The novaclient Python API document's keystoneauth session
example is not working.

AttributeError: 'Password' object has no attribute 'Password'
is fixed with this patch

Change-Id: I0c06279eed936619a770e84207bb02e79f42f6a7
Closes-Bug: #1552206
2016-03-02 14:25:29 +02:00
Monty Taylor 1f11840dd8 Migrate to keystoneauth from keystoneclient
As a stepping stone to the os-client-config patch, first switch to
using keystoneauth, its Session and its argparse registration and
plugin loading to sort out any issues with that level of plumbing.
The next patch will layer on the ability to use os-client-config
for argument processing and client construction.

Change-Id: Id681e5eb56b47d06000620f7c92c9b0c5f8d4408
2015-12-12 20:39:57 -08:00
Andrey Kurilin a96e9d57c5 Restrict direct usage of novaclient.v2.client
A lot of project uses incorrect import of versioned novaclient client obj
(i.e. novaclient.v2.client.Client). It leads to unability to change
interface of such inner classes.

This patch updates docs to include warning note and add warning message to
`novaclient.v2.client.Client` object.

Change-Id: Ifeba391716d3d51d6a75a53cad405e1ec595e27b
Related-Bug: #1493576
2015-09-10 15:54:38 +03:00
Chris Yeoh 0343dff973 Removes reference to v3 nova api from novaclient docs
The Nova V3 API no longer exists. Although a version of the framework
exists in Nova as part of the new V2.1 API which is equivalent to
the V2 API there is no need to make mention of V3 in the novaclient
documentation.

In future we will be distinguish between legacy Nova API support (one
implementation of V2) and microversions Nova API support (the
new one) to reduce confusion around version numbers which will change quite
a bit without the framework changing.

Co-Authored-By: Andrey Kurilin <akurilin@mirantis.com>

Change-Id: Id0ff51e1165cb267045d7a63aff13c0e41336738
2015-03-25 12:15:40 +10:30
Jenkins 1940093621 Merge "Fix client usage in api example" 2015-03-12 15:17:55 +00:00
Thomas Bechtold dc2d210f75 Fix client usage in api example
The used class to create an instance was not available. Use the correct
class.

Change-Id: Ie07504bff47e2c3e7120750cd2064cb97ad863a6
2015-03-07 01:07:56 +00:00
Andrey Kurilin 0a60aae852 Rename v1_1 to v2
Module novaclient.v1_1 is used as implementation of V1.1, V2 and V3.
Since future development(microversioning) will be done across V2,
implementation should be done in appropriate module(to prevent misleading).

Despite the fact that implementation for all versions are equal, discover
method for contrib path worked only for v1.1. This patch fixes this bug and
modifies shell tests to check all versions.

Change-Id: Ib6798f4dfe177586302141f522dc593560ce6a5b
2015-02-04 17:40:46 +02:00
Mark McLoughlin 9f1ee1249a Mention keystoneclient.Session use in docs
Jamie added some excellent "Using Sessions" docs to keystoneclient in
I5e44c1029ce160cb2798cfb8a535aa9f3311799a. These will be published to

  http://docs.openstack.org/developer/python-keystoneclient/using-sessions.html

once the version after 0.9.0 is released.

Let's add a brief example on how to use this API and reference the
keystoneclient docs.

Change-Id: Icbcef45f13c1f962c90aa3db9dde4360520166ff
2014-07-01 16:53:47 +01:00
JUN JIE NAN 77fe828870 Added v3 interfaces in reference doc
Added hosts, agents, flavors and so on into reference doc

Change-Id: I32198a0e65551f6ea3c67b72a8d7c6dff7da9f91
2014-01-03 13:57:56 +08:00
JUN JIE NAN 3582d6f1be Generate interfaces reference doc
Add gen_ref in conf.py to generate reference doc to avoid maintaining
these boilerplates.

Change-Id: I6683c41d39685dcb7f7a619a36210a987c9e9825
2014-01-03 13:51:08 +08:00
JUN JIE NAN f3d6f1d22c Fixed autodoc can't import/find class error
The right module name should be `novaclient.v1_1.servers' instead of
`novaclient'. Similar fix on `images', `flavors' and `exceptions'.

Removed `ipgroups' and `backup_schedules' since they do not exist any
more.

Closes-Bug: #1056478

Change-Id: Id35f9c275fb36f3651a0bb2b0eb03c43f0aaeec1
2013-12-18 15:56:50 +08:00
Clark Boylan ebceca9414 Move docs to doc.
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc/source and build results go in project/doc/build.

Change-Id: I868df12e3c15cc30043e782ce0a609b9574295cd
2012-06-11 14:18:48 -07:00