openstack/nova - nova - OpenDev: Free Software Needs Free Tools

We're going to remove all the code, but first, remove the docs.
Part of blueprint remove-consoleauth
Change-Id: Ie96e18ea7762b93b4116b35d7ebcfcbe53c55527
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>

Added some descriptions and example about block device mapping in
api-guide, this will help the API user to better understand how to
provide block device mapping information in server request body.
Change-Id: I5a85d7f190f7cda160e1e13805d356a2d4303bf0

Change-Id: Id60d7a54e7bce49b938f9f10a0691b05613cbee0

This is to change some URLs to point to better or more accurate targets.
Change-Id: I1d450ba8bd2271a69f9380cc4d2b36ae3eefe09a

This patch adds a new parameter ``locked_reason`` to
``POST /servers/{server_id}/action`` request where the
action is lock. It enables the user to specify a reason when locking
a server.
The locked_reason will be exposed through ``GET servers/{server_id}``,
``GET /servers/detail``, ``POST /servers/{server_id}/action`` where
the action is rebuild and ``PUT servers/{server_id}`` requests' responses.
The InstanceActionNotification will emit the locked_reason
along with the other instance details. This patch hence changes the
payload object to include the "locked_reason" field.
Note that "locked" will be allowed as a valid filtering/sorting parameter
for ``GET /servers/detail`` and ``GET /servers`` from this new microversion.
Implements blueprint add-locked-reason
Change-Id: I46edd595e7417c584106487123774a73c6dbe65e

The server query parameters that are allowed for users are displayed
in a single paragraph which is difficult to parse and some of the
parameters are missing the microversions they are available from.
This problem exists in the server_concepts api-guide documentation
while its already in the list form in the servers api-reference
documentation. This patch basically copies the list over from the
api-guide.
Change-Id: I27c3d1882ab904933129bd3414ccded8c3c56b1e

blueprint: bandwidth-resource-provider
Depends-On: https://review.openstack.org/#/c/640390
Depends-On: https://review.openstack.org/#/c/621494
Change-Id: I166787e092e16857d20f89fba965be2a5509fb4b

Remove wrong description for auto resize confirm
in the API guide.
Move a description of a configuration option
'resize_confirm_window' from the API guide
to the admin configuration guide.
Add a description of automatic resize confirm
in the user guide.
Change-Id: If739877422d5743e221c57be53ed877475db0647
Closes-Bug: #1816859 

The down-cell microversion 2.69 just recently merged and it returns
links in the response for GET /servers/detail and GET /servers but not
for GET /servers/{server_id} which was an oversight because that API
returns links normally.
We should include the links key in the 'nova show' case as well and this
patch does exactly that.
Typically this would require a microversion change but given the code
merged recently and is not yet released we are just fixing this
oversight through this patch without a microversion bump.
Closes-Bug: #1818131
Change-Id: I2ce03df994f59c37b5ce3102c4e7165d17701798

The server-groups UUID add to response of 'GET /servers/{id}',
'PUT /servers/{server_id}" and rebuild API
'POST /servers/{server_id}/action'.
Change-Id: I4a2a584df56ece7beb8b12c0ce9b0e6b30237120
Implements: blueprint show-server-group
Co-authored-by: Gerry Kopec <Gerry.Kopec@windriver.com>
Signed-off-by: Yongli He <yongli.he@intel.com>

This patch adds the documentation around the work regarding
handling down cells that was introduced in v2.69.
Related to blueprint handling-down-cell
Change-Id: I78ed924a802307a992ff90e61ae7ff07c2cc39d1

This patch adds more explanations for the lock action
in the Compute API reference and the Compute API guide.
Change-Id: Iae4a42351d11d5caade9a1a299b06fed862a7da4
Partial-Bug: #1793034 

The 'locked' query parameter is not supported
in the "List Servers Detailed" API.
So replace examples using the 'locked' query parameter
with examples using another query parameters.
Change-Id: Ibcea6147dd6716ad544e7ac5fa0df17f8c397a28
Closes-Bug: #1801904 

Replace the 'NOTE' and 'TODO' words with
the note and todo directives in the Compute API guide.
Improve some format in the guide.
e.g. Fix unnecessary bold characters.
Change-Id: I7e9d6b8a5228886fd5de03d12482481d2b652666
Closes-Bug: #1558459 

In order to record the update history, use "git mv" to rename the
api-guide doc.
Depends-On: https://review.openstack.org/599276/
Part of bp support-to-query-nova-resources-filter-by-changes-before
Change-Id: I594dcead5edc222cb040cf11675fc76358e93ef8

This adds the changes-before filter to the servers,
os-instance-actions and os-migrations APIs 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.
Part of bp support-to-query-nova-resources-filter-by-changes-before
Change-Id: If91c179e3823c8b0da744a9363906b0f7b05c326

This fixes the weird formatting in the changes-since
guide along with splitting up the giant wall of text
so this is easier to consume.
Change-Id: Ia15d3b5e3e1e8279d9109ca9c54f213c3e7838bb

Scheduler hints are not really documented very well at all except
for being mentioned per scheduler filter in the admin configuration
guide, nor are they documented within relation to flavor extra
specs which are both used for impacting scheduling decisions and
are choices that a deployer has to make based on how they configure
their cloud.
This change adds a document about scheduler hints and how they are
similar to and different from flavor extra specs, including end
user discoverability and interoperability, and thoughts on which
should be used if writing a custom scheduler filter.
The TODO in the API guide is also resolved by linking to this
document.
Change-Id: Ib1f35baacf59efafb9e4bccfcc4f0025d99ad5b2

Closes-Bug: #1691871
Related-Bug: #1784826
Change-Id: Ifc6f1549d88a1b7d9f6e25c962c8a15dd8e180fb

There exist some none-ascii chars in doc, which may cause trouble
in displaying.
Change-Id: I1ebf83fb4e8cc853fd7f3065ecf420a064c9983f

This patch fixes the following:
 * The description says, "Here, a subset of metadata items
 are presented within the image." This is a server sample,
 not an image.
 * The sample itself has the wrong id in the "self" link and
 there are no metadata_links with a server object (probably
 a carry over from an image docs sample).
Change-Id: Idb1e5243d6d072e020e1532bec603e5cd219702e
Closes-Bug: #1737854 

include:
1) add additional links 2
2) remove deprecated info about volume APIs
3) add a note about host API deprecation
4) remove ec2 service in doc
Change-Id: I3b5be18edbeff9c404591015f769e1a6040ed57e

Part of blueprint convert-consoles-to-objects
Change-Id: I9bfa89d2d8fe2b5803b4e1478377e13dc3231b1c

This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.
[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper
Change-Id: Ifb99e727110c4904a85bc4a13366c2cae300b8df

Curly quotes(Chinese punctuation) usually input from Chinese input method.
When read from english context, it makes some confusion.
Change-Id: I6f95feebd46353b3234e189e8d41a0c11835eb9f

link api-guide to doc of nova.
Removed the TODO.
Change-Id: Ib7b9453535b43e5c5cec6ee252a5790fc278f0c0

The compute API guide section on instance faults
is updated to point out that server details contain
fault information for servers in ERROR or DELETED status
along with a simple non-admin scenario example.
Change-Id: Idc725a594b67b5f6e45c6f161f6e92c0601761a8
Closes-Bug: #1762842 

commit 43f91a87cb
enhanced the metadata doc, so we can adjust other links to
this new doc.
Change-Id: I35803472666e39f3e7d947e65760d97c0a7959bb

Sphinx's "smart quotes" feature will ensure these are replaced during
generation of docs.
Change-Id: I96412d86ac67c0dbaa0edb88815daa795e3cb1d8

Due to the migration of the OpenStack document library, some outdated
links were found during use, using https instead of http and pointing
to the right place.
Change-Id: I1e37e15643b4ff7a7b22b2c7c39eba76d0cbdb39

Currently, it redirects back to the same page.
Change-Id: Ia855ad2cfa1fdc42bffac07812799b032a0cc7ce
Partial-Bug: #1737854 

Change-Id: I3c6e04886ef478b8d4a52e9b3d073c5fa7d78094

Update and cleanup server query section in the API concept doc.
Change-Id: Id0e2cb31bd6234be169eac66bc97fd1635ef6704

Address TODOs in user_concepts section
Change-Id: Ibb604a0421f13066b88c75295abe91eb4a5a5d2e

Add description for vm_state and task_state in server status section.
Change-Id: I5791245c0faee052b6ad680fbe712c2dd16db063

Change-Id: I9b720d86533edf69ffe1b86d368611729579b1fd

Address todo in Metadata api section of api guide
Change-Id: Ieb68614a41918928dde86d2d866c593e8cc94cc4