These were missed for some reason. Let's add them now.
While we're here, we add the '-d DOCTREE_DIR' argument to our
'sphinx-build' call to handle Sphinx 1.8's change in behavior for where
doctrees are output.
Change-Id: I5c862a74f92a44bf5248f858e26826eef76c11f0
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This patch is a follow-up patch for
Ib4ce831a5031459d350fa73601e878e7b319640f.
Improve the description of optional arguments
in the CLI reference and help text.
Change-Id: I6313b8a584385daa7e9fbd558d431faa43015449
Add the following missing options in the CLI reference.
* nova instance-action-list
- marker
- limit
- changes-since
* nova migration-list
- marker
- limit
- changes-since
Change-Id: Ib4ce831a5031459d350fa73601e878e7b319640f
Closes-Bug: #1791125
There are no functional changes for this, just bumping
the supported client-side version and updating docs.
Depends-On: https://review.openstack.org/573136/
Part of blueprint abort-live-migration-in-queued-status
Change-Id: Ie0777dbe4d82892ec75b353f6b13ee2d2c5db72c
Added support for microversion 2.64, which includes the
following changes:
- The ``--rule`` option is added to the
``nova server-group-create`` CLI that enables user to create
server group with specific policy rules.
- Remove ``metadata`` column in the output of
``nova server-group-create``, ``nova server-group-get``,
``nova server-group-list``.
- Remove ``policies`` column, , add ``policy`` and ``rules``
columns in the output of ``nova server-group-create``,
``nova server-group-get``, ``nova server-group-list``.
Depends-On: 3cd26f1e68b09ba7925e794ac8912566c239b6df
blueprint: complex-anti-affinity-policies
Change-Id: I903f4b5544806b9d3c8bac529448abbc9dd3cee9
The ``--endpoint-override`` command line argument has been deprecated.
It is renamed to ``--os-endpoint-override`` to avoid misinterpreting
command line arguments.
It defaults to the ``OS_ENDPOINT_OVERRIDE`` environment variable.
The deprecated ``--bypass-url`` command line argument has been removed.
Change-Id: Ic8a6559cd62d46b837fa9c04b482a46ceba829db
Closes-Bug: #1778536
Fix the help text for nova boot to include that a parameter
is expected for trusted-image-certificate-id. Also update the
UnsupportedAttribute error to mention the env variable to
reduce confusion.
Change-Id: Ic5980b610e5fd97d3a858a2a513e2863657f36c2
This change adds a `--trusted-image-certificate-id` option to the
`nova boot` and `nova rebuild` commands. This option takes in a
a single trusted certificate ID. The option may be used multiple times
to specify multiple trusted certificate IDs, which will be
used to validate certificates in the image signature verification
process. If ID values are not specified using this option, the value of
the newly added OS_TRUSTED_IMAGE_CERTIFICATE_IDS environment variable
will be used instead. This value will be converted into a list before
being passed on.
The ``nova rebuild`` command also gets a new
``--trusted-image-certificates-unset`` option to unset/reset the
trusted image certificates in a server during rebuild. This is
similar to unsetting key_name and user_data during rebuild.
Corresponding `trusted_image_certificates` kwarg has been added to the
server create and rebuild Python API bindings.
Co-Authored-By: Brianna Poulos <Brianna.Poulos@jhuapl.edu>
Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com>
Change-Id: I235541a689732826950c7b2a510d5835211120c3
Implements: blueprint nova-validate-certificates
We want to eventually ween people off the nova CLI and
get them to use the unified openstack CLI, so this adds
a note about that.
Change-Id: Ia854d2b83b489f67e514a6c066fe1bdc9549f9d3
This replaces the old CLI reference main page for
the various nova commands with the more complete
CLI reference that was in the openstack-manuals
report based on the "before-migration" tag in
that repo, which was the tag before the centralized
docs were dropped in Pike and should have been
moved into per-project repos, in this case
python-novaclient.
The command reference in here is a bit old and
should be cleaned up, but this is better than
what we have today, which is nothing.
Change-Id: If19cfcafc90fddb930c124a5b9845d4eae1f6093
Closes-Bug: #1775281
In documents and comments, 'GB' (gigabyte) is used.
Strictly 'GiB' (gibibyte) should be used.
So replace 'GB' with 'GiB'.
Change-Id: Ic03f202d4fe357bc6400275abdccd4b37521f4a3
Closes-Bug: #1521791
nova image-list has been deprecated in python-novaclient, so
the documentation should be updated.
Change-Id: Iacd9e0e6c99ef0e5c40c716d0aa56ba0f2972fc3
Closes-Bug: #1737074
Some URLs are broken, so fix them.
The other URLs are redirect to new URLs,
so replace them with new ones.
Change-Id: Ida2fd70ad0d7b029fadfe91be14d7180b9b5b8d1
Closes-Bug: #1707104
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
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
Since the description of the individual API calls have been moved to
the API Reference, the API Guide is more or less what the "overview"
in the original guide was. Therefore I just pointed to the guide, and
removed the phrase "-- the overview, at least --".
Change-Id: I8b1cb6a7ea4469a91f0dfe69d26f4ffec178ed43
Closes-Bug: 1678591
Signed-off-by: Simon Leinen <simon.leinen@gmail.com>
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate the
setting from the old warnerrors one.
There are only three related fixes required.
Change-Id: I84b020c18a8a1c7c11a35bacd61523bbb094abe4
Autogenerate the nova client python API module list rather than having
to remember to add new modules; use exclude to blacklist modules that
shouldn't be included in autodoc.
Change-Id: I051a7094f3b536f1e9a939af87e3fc89554fb375
In doc/source/conf.py, there are some missing files
(modules) to generate API references.
So add them.
Change-Id: I39689a31084e0cdbfdcad66c723a87de009a08f7
Closes-Bug: #1651043
The following files have been removed in
I09a6501603667350f49b1b1fa130353a6d5272a2.
* novaclient/v2/volume_types.py
* novaclient/v2/volume_snapshots.py
But doc/source/conf.py has not been fixed.
So fix it.
And return parameter format in novaclient/v2/hosts.py
is fixed.
Change-Id: Icd3c5aed776df291141b8c3df4d64aa234e4ed88
Closes-Bug: #1648007
The instructions for deprecating commands predated reno
so this change updates them a bit to be current with our
processes now. Also adds a reminder to update the help
text/description of a command to mark it deprecated.
Change-Id: I530399ba9cf6c50bd0dbb06f231aee61466eebd6
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
The CLI Reference files has been moved, update the link.
Replace link to API Quick Start with link to API reference for nova.
Change-Id: Ic933d44cddc24702648c69498e632efefda7bf88
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
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
The nova server liberty version is changing from 2015.2 to 12.0.0 and
the 2016.1 'M' release will be 13.0.0 so update the deprecation warnings
in the docs and code using those versions.
Depends on nova change 192406.
Change-Id: I6a35fa0dda798fad93b804d00a46af80f08d475c
* Remove releases (File removed in e334096aa3a4badb2930c766cb4b42bbcc9ac107)
* Add link to man page
* Fix some docstring formatting
Change-Id: Iec67a6d32f0365e514394c1e3eb7d8e4ae6aff65
Since we haven't removed deprecated commands before, add some
documentation to the devref on the process for this type of change.
Change-Id: Iff6f5df372bec524757b84747c7a95bbf6412c35
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
After wanting to do a rather simple thing -- figure out of the
"timeout" argument to nodepool was a int or a float, it lead me down
the rabbit-hole to python-novaclient.
It turns out the timeout does get passed through to requests as a
float so that mystery was solved.
But the "Client" class seems to be missing from the documentation as
it's not included in the class list. So add that and also at least
document the types of the arguments.
However, then I noticd that this wasn't showing up; turns out sphinx
requires "autoclass_content = both" if you want it to document
__init__() functions. Several other classes had their init args
documented but they weren't showing up because of this.
Change-Id: I8f44e92f2a0f25a75926b1813a8b374e79b4f5db
