This patch explains what scheduler hints are, gives an example
request, then links to the api-ref for details.
Co-Authored-By: Artom Lifshitz <alifshit@redhat.com>
Change-Id: I1c55b9a17e9d9f57d9ec1383680cccb6ae7fcfaf
Turns out we've a *lot* of disparate metadata systems. Attempt to both
link them somewhat through extensive cross-referencing and extract out
deployment-specific stuff from user-facing docs. Lots of changes here,
but in summary:
- Split out admin-focused content from the metadata API, config drive,
user data and vendordata docs.
- Merge the config drive, metadata service, vendordata and user-data
user docs, which are mostly talking about the same thing and are
fairly barren without the deployment components
- Make use of various oslo.config and Sphinx roles
Side note: I miss when we have tech writers to do this stuff for us :(
Change-Id: I4fb2b628bd93358a752e2397ae353221758e2984
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
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
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
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
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
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
Two things are updated here:
1. The SHUTOFF status from the API is for any stopped server,
regardless of whether or not it was stopped via the REST API
or the sync_instance_power_state periodic task in the compute.
2. Remove the mention of the "shutdown_terminate" flag since that
was only ever implemented in the legacy v2 API for EC2
compatibility and it wouldn't actually work now with the v2.1
server create schema anyway.
Change-Id: I97071be164d15298fa2a5a7374a8ba8235d188e4
Related-Bug: #1722403
server_concepts.rst contains some invalid JSON formats as samples.
This patch fixes them and improves the readability by adding some
spaces.
Change-Id: Ib51f9e1351fca51c15ffdcb98f42311b999f22f5
Error on warnings in building the API guide and fix any problem
encountered:
* tox.ini: Enable tread warnings as errors
* index.rst: Add unreferenced file extra_specs_and_properties as
hidden file so that it does not show up in index. It is still
built and will be referenced from other files.
* general_info.rst: Remove reference to non-existing file
* server_concept: Add missing empty line after code directives
Also fix a typo and remove extra EOL whitespace.
Change-Id: Ie766f8d2f7d82b7b5b02541b342f9829ca4550a0
How to trigger crash dump depends on hypervisors. NMI is not the only way to
implement the feature. This patch modifies description regarding this feature.
Change-Id: I77d10551650776c06ee4b413f1b027abf6620e83
Add description for server trigger crash dump operation
into api-guide.
Change-Id: I20492dbf9eab4f7fcab0864bb250b20f98b762e4
blueprint complete-todo-in-api-concept-doc
Add descriptions for server query options and add some
samples for the query options.
Implement blueprint complete-todo-in-api-concept-doc
Change-Id: Id23a19ecc30f1837f4755ec898ef0389dcf23a8f
there is no method on 'BAK extension appended with a time stamp'
if this comes from some Active engine, we should let active
engine to document it instead of generialize it in nova
blueprint complete-todo-in-api-concept-doc
Closes-Bug: 1525137
Change-Id: Ibb05dc57f9be81de335ca4935c4c7fa59971de13
nova allows injections of zip or binary files, the doc
should not say 'You cannot inject binary or zip files into a new build'
blueprint complete-todo-in-api-concept-doc
Change-Id: I09b80268545ea0071946aefd3a566441296436ec
Closes-Bug: 1525132
We have multiple concepts for configuring guest os. This patch
adds separated section for them, just like the 'move servers' section.
blueprint complete-todo-in-api-concept-doc
Change-Id: Ibbffdb00d1529a386f338da4776eb614891731c8
There are variety like "admin" or "administrator" on api-guide,
so this patch makes these words consistent for the readability.
Partially implements blueprint complete-todo-in-api-concept-doc
Change-Id: Id0a9444e5d48f62d6d02114f8668761647c2dae0
Zuul