summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Replace old URLs with new onesTakashi Natsume2022-06-241-1/+1
| | | | | Change-Id: I66d76bed4ec19ef7517d88de20fcc32fea635261 Signed-off-by: Takashi Natsume <takanattie@gmail.com>
* docs: Update docs to reflect deprecation statusStephen Finucane2022-04-064-14/+25
| | | | | Change-Id: I56b862305b31916cef143494050e5e08b1ac70b1 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* Microversion 2.90 - Configurable hostnamesxena-em17.6.0Stephen Finucane2021-09-021-2/+24
| | | | | | Change-Id: Icd4362a07196e59bafcdfaff44323ce1386d4f55 Signed-off-by: Stephen Finucane <stephenfin@redhat.com> Depends-On: https://review.opendev.org/c/openstack/nova/+/778550/
* Add link to PDF documentAndreas Jaeger2020-05-182-1/+2
| | | | | | | | Switch to openstackdocstheme 2.2.0 that can link to PDF document, enable this with setting openstackdocs_pdf_link. Depends-On: https://review.opendev.org/728938 Change-Id: I103a90d4fa101fd261b2b1a86d0a42b9591accc9
* Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-152-12/+7
| | | | | | | | | | | | | | Switch to openstackdocstheme 2.1.2 and reno 3.1.0 versions. Using these versions will allow parallelizing building of documents. Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames. A couple of variables are also not needed anymore, remove them. Remove duplicated variables. Depends-On: https://review.opendev.org/728432 Change-Id: Icb604b31150a1ad6c29a9a4a934ed13f8a0b4976
* doc: Update Testing documentTakashi Natsume2020-04-251-3/+3
| | | | | | | | | | The default tox target environments has been changed from Python 3.7 to 3.8 since I093085cf6e85a66f80559eba62f9edf684f5dbea. Update the 'Testing' document. Change-Id: I33b32eb1d88225ae7ad44cbae28edc5c5f9c4925
* [Community goal] Update contributor documentationGhanshyam Mann2020-04-232-6/+60
| | | | | | | | | | | | | | | | | | | As the Ussuri goal we have an OpenStack project wide contributing documentation template [1]. pyhton-novaclient use its own bug or feature tracking LP and core team is also not exactly same as nova so adding its own contributor guide with keeping common links from nova with python-novaclient specific information. Also the top level CONTRIBUTING.rst template has been changed in the cookiecutter repo[2]. So this patch updates the CONTRIBUTING.rst according to the new template. [1] https://opendev.org/openstack/cookiecutter/src/branch/master/%7b%7bcookiecutter.repo_name%7d%7d/doc/source/contributor/contributing.rst [2] https://review.opendev.org/#/c/696001 Change-Id: Idd35fdf54a92a4a000d0d7776884682c8722854b Story: #2007236 Task: #38541
* Merge "[Trivial] FUP: Enhanced description for 'server list --config-drive' ↵Zuul2020-04-101-0/+2
|\ | | | | | | help"
| * [Trivial] FUP: Enhanced description for 'server list --config-drive' helpzhangbailin2020-04-101-0/+2
| | | | | | | | | | | | | | This commit mainly address comments in [1]. [1]https://review.opendev.org/#/c/718349/4/doc/source/cli/nova.rst@2321 Change-Id: I6010adbc895b4e2438f9f0729e3c89f37a69c8f8
* | FUP: Add volume-update CLI pre V285 testszhangbailin2020-04-101-1/+3
|/ | | | | | | | | This commit mainly to fix some comments from [1]. [1]https://review.opendev.org/#/c/712651/19/novaclient/tests/unit/v2/test_shell.py@4001 Blueprint: destroy-instance-with-datavolume Change-Id: Id809f22d0da2cdedf33a2c0df202f3953fd01673
* Microversion 2.85: Change volume-update CLIzhangbailin2020-04-091-8/+21
| | | | | | | | | | | | | This commit add a new CLI ``nova volume-update [--[no-]delete-on-termination] <server> <src_volume> <dest_volume>`` to update 'delete_on_termination' for an attached volume, that the user can decide whether to delete attached volumes when destroying the server. Depends-On: https://review.opendev.org/#/c/711194/ Change-Id: I1fc64fb6e6611c92c6b72265e1bf4b32e9c45f0a Blueprint: destroy-instance-with-datavolume
* Make 'server list --config-drive' a boolean optionStephen Finucane2020-04-081-5/+8
| | | | | | | | | | | | Instead of passing through whatever the user provides and exposing this bug in the REST API, simply make the opt a boolean one in expectation of a day where the API issues have been resolved. This also introduces machinery necessary to use more of these types of opts in the future. Change-Id: I9033540ac65ac0ee7337f16bdd002060652092ea Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* Microversion 2.83 - Add more filters for the nova list commandVictor Coutellier2020-04-071-2/+35
| | | | | | | | | | | | | | | | | | | Add these new filters, admin-only until microversion 2.82: - availability-zone - config-drive - key-name - power-state - task-state - vm-state - progress Existing user filter will be available to non admin since microversion 2.83. Part of blueprint non-admin-filter-instance-by-az Change-Id: Id2b5e600c0a41790830823031b20983808cb5ace
* Random cleanupsStephen Finucane2020-02-211-21/+3
| | | | | | | | Remove some cruft from Sphinx config files, drop the use of 'u' prefixed strings, which are unnecessary in Python 3, and generally tidy stuff up. Change-Id: Ib0f33576e160ec842d7fc82b4fcfee99829623d7 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* doc: Update Testing documentTakashi NATSUME2019-11-261-9/+3
| | | | | | | | | Python 2 support has been dropped since If678d77b8da69121b0075bfbc4216531be25da6a. Update the 'Testing' document. Change-Id: Ic263943b1d6110925b9c9849c01b0d52d41a8351
* doc: Fix supported version descriptionsTakashi NATSUME2019-11-061-1/+6
| | | | | | | | Fix the version that the 'nova server-topology' command was added. Add some missing descriptions about supported versions. Change-Id: I32f9eca87c90211b0172b040649aad105298846b Closes-Bug: #1851443
* Add aggregate-cache-images command and client routinesDan Smith2019-10-181-0/+22
| | | | | | | | | | This adds the ability to request image precache support for an aggregate in support of the matching server feature. Related to blueprint image-precache-support Depends-On: https://review.opendev.org/#/c/687140 Change-Id: Id354ccfa99e500a598685e6b794c12160ea2a990
* Microversion 2.80: Add user_id/project_id to migration-list APIzhangbailin2019-10-161-0/+10
| | | | | | | | | | | | | | Add ``user_id`` and ``project_id`` to the ``GET /os-migrations`` API, and it can called ``--user-id <user_id>`` and/or ``--project-id <project_id>`` by ``nova migration-list`` CLI. Showing the ``user_id`` and ``project_id`` when using api_version>=2.80 with the server-migration-list or server-migration-show APIs. Depends-On: https://review.opendev.org/#/c/674243/ Part of blueprint add-user-id-field-to-the-migrations-table Change-Id: I11343ca265ab2b6b6f46877897d8223ef340c258
* PDF documentation buildAkihiro Motoki2019-10-118-20/+23
| | | | | | | | | Also reorganizes the document structure to match both HTML and PDF docs. Story: 2006100 Task: 35143 Change-Id: Ie3f38e2ecf52e6a6cbd52bb36196e6f589f1ca0f
* Merge "Clarify --migration-type migration value as cold migration"Zuul2019-10-091-0/+3
|\
| * Clarify --migration-type migration value as cold migrationMatt Riedemann2019-08-261-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This is a follow up to a review discussion [1] where the "migration" value for the --migration-type option is for a cold migration. This change just updates docs and help strings. An alternative is changing "migration" as a valid value to "cold-migration" (or accept both) and under the covers treat "cold-migration" as "migration" for the actual API call. [1] https://review.opendev.org/#/c/675117/3/novaclient/v2/shell.py@5430 Related to blueprint more-migration-list-filters Change-Id: I6baa6af8731252e3c4976db06f0ca9cdfcb5e2f1
* | Remove cells v1 and extension commands and APIsTakashi NATSUME2019-10-041-55/+0
| | | | | | | | | | | | | | | | | | | | | | | | The following CLIs and their backing API bindings which have been deprecated since 20.0.0 Train release have now been removed. - list-extensions - cell-capacities - cell-show Change-Id: I8e6edf1e4c1bf12d51ed993363129b4f4c3aa36c
* | Add a check for --config-drive option on nova bootTakashi NATSUME2019-09-181-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | A value of the '--config-drive' option must be a boolean value on the 'nova boot' command because nova accepts a boolean value only for the 'config_drive' parameter. So add a check for the '--config-drive' option on the 'nova boot' command. Fix a description for 'config_drive' parameter in the 'create' method of the novaclient.v2.ServerManager class. Change-Id: Ic6e65139302fbb662fb6ba60e73633dad8ffb72e Closes-Bug: #1825061
* | doc: Add support microversions for optionsTakashi NATSUME2019-09-101-0/+2
| | | | | | | | | | | | | | | | | | Add descriptions of support microversions for the '--marker' option and the '--limit' option in the 'nova hypervisor-list' command in the CLI reference. Change-Id: Ie25e848b51fd0220e318393db123c97b4a642091 Closes-Bug: #1616450
* | Microversion 2.79: Add delete_on_termination to volume-attach API15.1.0zhangbailin2019-09-091-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Support add 'delete_on_termination' field to the voume attach API to support configuring whether to delete the data volume when the server is destroyed. * Updating the ``nova volume-attachments`` command to show the ``delete_on_termination`` value if 2.79 or greater is used. * The '--delete-on-termination' option is added to the `nova volume-attach` CLI. Depends-On: https://review.opendev.org/#/c/673133/ Part of blueprint support-delete-on-termination-in-server-attach-volume Change-Id: I8dcf2fd21a2fd99ca4e05bd953fbbe026be3a619
* | Microversion 2.78 - show server topologyYongli He2019-09-061-0/+23
| | | | | | | | | | | | | | | | | | | | | | Add support microversion 2.78 which adds server topology information in the output of the following new command: nova server-topology Depends-on: https://review.opendev.org/#/c/621476/ Change-Id: I6467d52d2528a37348458baf4842b571a97f3ed2 Implements: blueprint show-server-numa-topology
* | Merge "Microversion 2.77: Support Specifying AZ to unshelve"15.0.0Zuul2019-08-291-1/+7
|\ \ | |/ |/|
| * Microversion 2.77: Support Specifying AZ to unshelvezhangbailin2019-08-281-1/+7
| | | | | | | | | | | | | | | | | | | | | | This patch adds a new parameter ``--availability-zone`` to ``nova unshelve`` command. This can help users to specify an ``availability_zone`` to unshelve a shelve offloaded server from 2.77 microversion. Depends-On: https://review.opendev.org/#/c/663851/ Implements: blueprint support-specifying-az-when-restore-shelved-server Change-Id: I8bce8f430bc54f03bacc105e37fc8b3bbf2432c2
* | Add --migration-type and --source-compute to migration-listMatt Riedemann2019-08-081-3/+27
|/ | | | | | | | | | | | | | | | | | The GET /os-migrations API take a migration_type and source_compute filter parameter on the request since the v2.0 API. This adds support for specifying those parameters in the "nova migration-list" CLI and related MigrationManager.list() python API binding methods. A functional test is added which will cover the new options on all three of the decorated do_migration_list shell methods with lower bounds on 2.1, 2.59 and 2.66. Since the only type of migration we can safely generate in a single-node CI job is a resize the test does a resize. As such, _pick_alternate_flavor is moved into the base test class for re-use. Implements blueprint more-migration-list-filters Change-Id: I4be9a06df3e0d40d3990d067ce112247a81b45b4
* docs: clarify nova migration-list --host optionMatt Riedemann2019-08-071-1/+1
| | | | | | | | | | The GET /os-migrations API takes both a host and source_compute filter parameter. The former filters on either the source or destination compute, so this change clarifies that in the command help for the --host option. Change-Id: I078add63896c7455be7e3672b7172debb962a5e2
* Update api-ref locationAndreas Jaeger2019-07-221-1/+1
| | | | | | | | | | | | | | The api documentation is now published on docs.openstack.org instead of developer.openstack.org. Update all links that are changed to the new location. Note that redirects will be set up as well but let's point now to the new location. For details, see: http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html Change-Id: I53120e2ff3ae337a55c4cd0904bc9ad1dd54d082
* Bump the openstackdocstheme extension to 1.20zhangyangyang2019-07-201-1/+0
| | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: Icd8404026ff5a73129a22b6c89b5cfd6c57432fb
* doc: Clarify versioned wrapped methodTakashi NATSUME2019-07-161-2/+2
| | | | | | | The 'versioned wrapped shell method' is a bit unclear. So fix it and add more description for it. Change-Id: Ie50453b73adf1df5a77a582cc40612c5213c04d5
* Merge "Add a guide to add a new microversion support"Zuul2019-07-153-0/+73
|\
| * Add a guide to add a new microversion supportTakashi NATSUME2019-07-093-0/+73
| | | | | | | | | | | | Add a contributor guide for adding a new microversion support. Change-Id: I5e7699b6afbecf1e22cdc059a36832c144fc8e2f
* | Merge "Add host and hypervisor_hostname to create servers"14.2.0Zuul2019-07-121-0/+10
|\ \ | |/ |/|
| * Add host and hypervisor_hostname to create serverszhu.boxiang2019-07-081-0/+10
| | | | | | | | | | | | | | | | | | | | Adds the --host and --hypervisor-hostname options to the nova boot command and related python API bindings. Depends-On: https://review.opendev.org/#/c/645520/ Change-Id: If16d00b75f4d5f2b96aa6e3f32a973108049d928 Blueprint: add-host-and-hypervisor-hostname-flag-to-create-server
* | Blacklist sphinx 2.1.0 (autodoc bug)pengyuesheng2019-07-011-1/+1
|/ | | | | | | See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details Depend-On: https://review.opendev.org/#/c/663060/ Change-Id: I3594f05a2eb189395d4b691c47e1e0764fa0fe44
* Fix duplicate object description errorTakashi NATSUME2019-06-191-0/+1
| | | | | | | | Add a directive option flag :noindex: in reference/api/index.rst. Change-Id: Ifa5cf9820be29f498c218105272837cac50cb643 Closes-Bug: #1833327
* Bump openstackdocstheme to 1.30.0翟小君2019-06-041-1/+1
| | | | | | ...to pick up many improvements, including the return of table borders. Change-Id: I59c62ad129462c94bc4cc815101fb31ff062d2e3
* Add a description of --on-shared-storageTakashi NATSUME2019-05-271-1/+5
| | | | | | | | Add a description of --on-shared-storage option in the 'nova evacuate' command in the CLI reference. Change-Id: I4069b804b434b70ee6d0098831af748e47913ce3 Closes-Bug: #1829932
* Cap sphinx for py2 and drop keyring dependency14.0.0zhangbailin2019-05-151-1/+2
| | | | | | | | | | | Sphinx 2.0.0 dropped Python 2.7 support. This is aligned with [1] in requirements project. [1]Change-Id If558f184c959e4b63b56dec3ca1571d1034cfe5c keyring is also removed since it hasn't been used since change I62188e73a48f6878ce920a3b4724dba101564aef. Change-Id: Ib632c327637ba1161a8c07605fd3ef327f5606ee
* Merge "[Docs] Update client docs to add reason and locked options"Zuul2019-05-141-1/+16
|\
| * [Docs] Update client docs to add reason and locked optionsSurya Seetharaman2019-05-141-1/+16
| | | | | | | | | | | | | | | | | | | | This patch adds information about the ``locked`` filter/sorting key and the ``reason`` options that were added in https://review.opendev.org/#/c/648659/. Related to blueprint add-locked-reason Change-Id: I11cc4bd7cee0f03d4398f91bb3790c4c681061f4
* | Tiny fix of documentationchenxing2019-05-071-1/+1
| | | | | | | | Change-Id: Ida6e6ec6919e4c2303200ff66fdc0a094c7d90d1
* | Merge "Drop py35 tests"Zuul2019-04-261-4/+4
|\ \ | |/ |/|
| * Drop py35 testszhangyangyang2019-04-221-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | Drop py35 tests because all the integration testing has been moved to Bionic. See the following URL for more details. http://lists.openstack.org/pipermail/openstack-discuss/2019-April/005097.html Co-Authored-By: Takashi Natsume <natsume.takashi@lab.ntt.co.jp> Change-Id: Ied64e92d5833ed11e1213c42994cfebeaa2ace6a Signed-off-by: zhangyangyang <zhangyangyang@unionpay.com>
* | Updates for OpenDev transitionTakashi NATSUME2019-04-233-5/+5
|/ | | | | | | | | | | | | Replace 'git.openstack.org' with 'opendev.org' in contributor/index.rst. Update URLs in other places as well though there are redirects. See the following URLs for more details: http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html Change-Id: Ifb9f4274d2fd0fa81e7501fe176eeead3acd0e3e
* Add test for console-log and docs for bug 1746534Matt Riedemann2019-04-111-0/+27
| | | | | | | | | | | | | | | | | | | | | We had no unit test coverage for the console-log command so this adds a simple test. It unfortunately does not recreate the original UnicodeEncodeError bug though, but it gives us some test coverage anyway. This change also adds docs on how to resolve bug 1746534 by configuring the environment for UTF-8 as noted in the revert change Iaeec1e74262a35f3de3c81f7013835a6aa6f9029. The documentation added here is shamelessly copied from Click [1] which was found via the PEP 538 docs [2]. [1] https://click.palletsprojects.com/en/5.x/python3/#python-3-surrogate-handling [2] https://www.python.org/dev/peps/pep-0538/ Change-Id: Ic7059260dfc031ea1b08d2b8a7cec684bbe7dfa5 Related-Bug: #1823287 Related-Bug: #1746534
* Remove deprecated optionsTakashi NATSUME2019-03-211-8/+4
| | | | | | | | | Remove the following deprecated options. * --endpoint-override * --instance-name ('nova list' command) Change-Id: Ic6a78f04a98c1616750e6ecd6225f2750c214dd7
View Lorry Controller Status