summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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
* Add support for microversion v2.7213.0.0Lajos Katona2019-03-061-0/+4
| | | | | | | | | | | | | This microversion in Nova is added to support Neutron ports having resource request during server create to guarantee minimum bandwidth QoS. This is a behavior-only change in the compute API, there are no changes to the server create request or response schema. Change-Id: I1a39390015acd8703e8bab55af13f5c75ae226db Depends-On: https://review.openstack.org/636360 Partial-Bug: #1578989 See-Also: https://review.openstack.org/502306 (nova spec) See-Also: https://review.openstack.org/508149 (neutron spec)
* Merge "Add a note in "nova service-delete" help about deleting computes"Zuul2019-02-261-0/+6
|\
| * Add a note in "nova service-delete" help about deleting computesMatt Riedemann2019-01-151-0/+6
| | | | | | | | | | | | | | | | | | This mirrors the note in the API reference from change I68f2074814c3ae890888a5c75fd2870bb99f0e08 to the service-delete CLI help and docs. Change-Id: I191f6e6a4b7c6c456afbd33b0256842b043c772e Related-Bug: #1646255
* | API microversion 2.69: Handles Down CellsSurya Seetharaman2019-02-201-0/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This patch explicitly points out the change needed while forming the detailed lists for embedded flavor information. In those cases where the server response for nova list has the flavor key missing for the instances in the down cell, the servers will be skipped. Depends-On: https://review.openstack.org/591657/ Related to blueprint handling-down-cell Change-Id: I007d9a68309b0d3aa85a4edf5026043154d4f42a
* | Microversion 2.68: Remove 'forced' live migrations, evacuationsStephen Finucane2019-02-131-4/+4
| | | | | | | | | | | | | | | | | | | | | | Update the commands and Python API bindings to reflect the new microversion. The various evacuate microversion functions are DRY'd up along the way. Change-Id: Ibfc905292258ffde05800387e5d6bbad4823085c Signed-off-by: Stephen Finucane <sfinucan@redhat.com> Depends-On: https://review.openstack.org/#/c/634600/ Implements: blueprint remove-force-flag-from-live-migrate-and-evacuate
* | Remove deprecated novaclient.v2.contrib modules12.0.0Takashi NATSUME2019-02-071-2/+1
|/ | | | | | | | All modules of novaclient.v2.contrib have been removed. The 'only_contrib' parameter for the 'novaclient.client.discover_extensions' method is no longer valid. Change-Id: I6da83057dda1f27afe98a2412bc0815f100f34a4
* Replace MB with MiBTakashi NATSUME2018-10-221-5/+5
| | | | Change-Id: Ie5bd325d8e0f7e9af76c1ddae1d679b0e797c84b
* Recommend against using --force for evacuate/live migration11.1.0Matt Riedemann2018-10-171-10/+32
| | | | | | | | | | | | | | This copies the same warnings from the API reference change I85e7c2677f4d5eccc1e7f349de06960b53ef148d to the CLI help for the various evacuate/live migrate commands. It also mentions that if a host is not specified, one is selected by the scheduler (which is what we really want people doing). Given blueprint remove-force-flag-from-live-migrate-and-evacuate we really want to discourage people from using the --force flag. Change-Id: I15ef933cc09947e2bb3fb7bf17b15735171a9bec
* Add support for microversion 2.67: BDMv2 volume_typeMatt Riedemann2018-10-141-3/+7
| | | | | | | | | | | | | This adds the nova boot command and python API binding support for creating a server with block device mappings defined using a specific volume type. Depends-On: https://review.openstack.org/606398/ Depends-On: https://review.openstack.org/#/c/610349/ Part of blueprint boot-instance-specific-storage-backend Change-Id: I484ee065119b5783db212ea64efa60e87c40338c
* doc: Start using openstackdoctheme's extlink extensionTakashi NATSUME2018-10-094-7/+10
| | | | | | | | This ensures we have version-specific references to other projects [1]. [1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper Change-Id: I3b9db8b71c082dd5f8d0564a9cdfdb2fa6dc5ed6
* Merge "Update the CLI reference"Zuul2018-10-081-165/+199
|\
| * Update the CLI referenceTakashi NATSUME2018-10-021-165/+199
| | | | | | | | | | | | | | | | | | | | | | | | | | Update the CLI reference according to the latest CLIs. The CLI reference (doc/source/cli/nova.rst) has been imported from openstack-manuals since If19cfcafc90fddb930c124a5b9845d4eae1f6093. We can update the CLI reference synchronously with changing the CLIs currently. So remove the description of nova CLI version in the reference. Change-Id: Icb97def5e4d65a31add7c60c205d5f9f0dfc4520 Closes-Bug: #1795283
* | Update the contributor guideTakashi NATSUME2018-10-022-7/+13
|/ | | | | | | | | | Add missing tox targets in contributor/testing.rst. Replace the launchpad link to nova project with the launchpad link to python-novaclient project in contributor/index.rst. Change-Id: I1b3736f25e59669624331d8f86820a45181c6760 Closes-Bug: #1795353
* Merge "Add support changes-before for microversion 2.66"Zuul2018-09-251-7/+27
|\
| * Add support changes-before for microversion 2.66zhangbailin2018-09-241-7/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds the changes-before filter to the servers, os-instance-actions and os-migrations list for filtering resources which were last updated before or equal to the given time. The changes-before filter, like the changes-since filter, will return deleted server resources. Depends-On: https://review.openstack.org/599276/ Part of bp support-to-query-nova-resources-filter-by-changes-before Change-Id: I7c6ea00303374d605bda8ef1b62c5de1b4567696
* | docs: Add redirectsStephen Finucane2018-09-244-0/+20
|/ | | | | | | | | | | 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>
* Follow the new PTI for document buildTakashi NATSUME2018-09-133-3/+13
| | | | | | | | | | | | | - Follow new PTI for docs build - Add sphinxcontrib.apidoc to replace pbr autodoc REF: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: Ic66fe4d5488c7777439a416fbf86d37af807804d Closes-Bug: #1792115
* Improve the description of optional argumentsTakashi NATSUME2018-09-121-5/+5
| | | | | | | | | | 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 missing options in CLI referenceTakashi NATSUME2018-09-111-2/+38
| | | | | | | | | | | | | | | | | 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
* Merge "Add support for microversion 2.65"Zuul2018-07-211-0/+4
|\
| * Add support for microversion 2.65Matt Riedemann2018-07-181-0/+4
| | | | | | | | | | | | | | | | | | | | | | 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
* | Merge "Fix inconsistency"Zuul2018-07-191-2/+2
|\ \
| * | Fix inconsistencyChen2018-07-191-2/+2
| | | | | | | | | | | | | | | | | | Replace "of"s with "off"s to be consistent with the rest. Change-Id: I4a99e733f9ecdbc080f1158b8c90af888d619cdc
* | | Merge "Microversion 2.64 - Use new format policy in server group"Zuul2018-07-191-2/+10
|\ \ \ | | |/ | |/|
| * | Microversion 2.64 - Use new format policy in server groupYikun Jiang2018-07-181-2/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Rename --endpoint-override to --os-endpoint-overrideTakashi NATSUME2018-07-091-3/+3
|/ / | | | | | | | | | | | | | | | | | | | | | | 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
* | Merge "Fix trusted-image-certificate-id help text"Zuul2018-06-221-1/+1
|\ \
| * | Fix trusted-image-certificate-id help textBrianna Poulos2018-06-211-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Fix help text in server-group-createChen2018-06-221-1/+1
|/ / | | | | | | | | | | | | Only one policy is allowed in server-group-create. Change-Id: Id9cb6f96a5f8bcece1bcda88a97c6fb5f8a58bba Related-Bug: #1767287
* | Merge "Microversion 2.63 - Add trusted_image_certificates"Zuul2018-06-182-0/+32
|\ \
| * | Microversion 2.63 - Add trusted_image_certificatesJackie Truong2018-06-152-0/+32
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | Add CLI docs reference for flavor-updateMatt Riedemann2018-06-151-0/+23
|/ | | | | | | When the flavor-update command was added, we didn't have the CLI docs in-tree so this was missed. Change-Id: I3d5da9ac206d82b3fb3c51fa0872a3bae69d0a7e
* Add a note in the nova CLI reference about using OSCMatt Riedemann2018-06-051-0/+8
| | | | | | | | 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
* Import nova CLI reference from openstack-manualsMatt Riedemann2018-06-051-42/+3596
| | | | | | | | | | | | | | | | | | 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
* Replace GB with GiBTakashi NATSUME2018-04-041-5/+5
| | | | | | | | | 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