Commit Graph

83 Commits

Author SHA1 Message Date
Takashi NATSUME 64f97177c5 Follow up for "Add API ref guideline for body text"
This patch is a follow-up for
Ib03b562ffe189f24293eb77dd0c0ed5ec679172a.

Change-Id: I7a8a8d64dfc49b1e15135259388285ceeae2fb2c
2019-01-07 05:51:35 +00:00
Takashi NATSUME 09fc91a070 Add descriptions about microversions
This patch is a follow-up patch
for I3e1ca88cac3a52a8b44e26f051a51a6db77a3231.

Add descriptions about microversions in the parameter section
in the API reference guideline.

Change-Id: I266d44cf96945445115b843aacbc29083e21bd8e
2018-12-16 23:29:50 +00:00
Zuul ab7917c88a Merge "Add API ref guideline for body text" 2018-12-15 14:12:04 +00:00
Zuul 2c7aa78980 Merge "Move nova-cells-v1 to experimental queue" 2018-12-11 01:23:35 +00:00
Takashi NATSUME 2a3e7affea Add API ref guideline for body text
Add guideline for body text in the API reference.

Change-Id: Ib03b562ffe189f24293eb77dd0c0ed5ec679172a
Partial-Bug: #1793034
2018-12-09 23:46:13 +00:00
Zuul 662bec726d Merge "Remove Placement API reference" 2018-12-09 08:26:05 +00:00
Zuul 5ca357c100 Merge "Use links to placement docs in nova docs" 2018-12-08 10:05:43 +00:00
Matt Riedemann e02fbb53d5 Move nova-cells-v1 to experimental queue
Cells v1 has been deprecated since Pike. CERN
has been running with cells v2 since Queens.
The cells v1 job used to be the only thing that
ran with nova-network, but we switched the job
to use neutron in Rocky:

  I9de6b710baffdffcd1d7ab19897d5776ef27ae7e

The cells v1 job also suffers from intermittent
test failures, like with snapshot tests.

Given the deprecated nature of cells v1 we should
just move it to the experimental queue so that it
can be run on-demand if desired but does not gate
on all nova changes, thus further moving along its
eventual removal.

This change also updates the cells v1 status doc
and adds some documentation about the different
job queues that nova uses for integration testing.

Change-Id: I74985f1946fffd0ae4d38604696d0d4656b6bf4e
Closes-Bug: #1807407
2018-12-07 10:59:37 -05:00
ZhongShengping ba0502182e Update mailinglist from dev to discuss
openstack-dev was decomissioned this night in https://review.openstack.org/621258
Update openstack-dev to openstack-discuss

Change-Id: If51f5d5eb710e06216f6d6981a70d70b6b5783cc
2018-12-05 09:44:35 +08:00
Takashi NATSUME 311110e81b Remove Placement API reference
The placement project has published the API reference
in its own repository and the related jobs for the nova project
has been removed since Ia4680f24d78af1260f2f0106a458b78a079c1287.

So remove the files and definitions related to
the placement API reference in the nova repository.

Change-Id: Ia43b958a28e7e763e7ecb29e06f8d21d2b9a850f
2018-11-28 03:38:41 +00:00
Takashi NATSUME 7dd7d9a5fa Use links to placement docs in nova docs
Placement documents have been published since
I667387ec262680af899a628520c107fa0d4eec24.

So use links to placement documents
https://docs.openstack.org/placement/latest/
in nova documents.

Change-Id: I218a6d11fea934e8991e41b4b36203c6ba3e3dbf
2018-11-26 05:39:56 +00:00
Zuul b3c3b8a5b8 Merge "Add a link to the doc contrib guide" 2018-11-10 01:30:23 +00:00
Takashi NATSUME e023146ad6 Add a link to the doc contrib guide
Add a link to the
"How to document your OpenStack API service" section
of the documentation contributor guide
in the nova API reference guideline.

Change-Id: I0d2889b63528c4d39820011746d92732440499e9
2018-11-07 13:19:30 +09:00
Nguyen Hai Truong f8de2d9788 [Trivial Fix] Correct spelling error of "should" and "resource"
Small modification to correct spelling mistake.

Change-Id: I4bf378e5316ecc48f66eefae4f45d5a505adc305
Signed-off-by: Nguyen Hai Truong <truongnh@vn.fujitsu.com>
2018-11-01 19:28:37 -07:00
Takashi NATSUME 8ad33f35a4 Add API ref guideline for examples
Add guideline for JSON request/response body examples
in the API reference.

Change-Id: I2dcc2fc1a16cc5dcba7879518a2b101df3576304
2018-10-25 07:46:48 +00:00
Gary Kotton 21a70f7db5 Docs: update link for remote debugging
The section on remote debugging points to a blog post that not longer
exists. This updates the invalid link.

The patch also adds in some new lines and bullets.
TrivialFix

Change-Id: I8b29f402f148bc11279a2c34aeea266956180bc1
2018-09-04 01:37:17 -07:00
Matt Riedemann 243ba85130 Deprecate Core/Ram/DiskFilter
The time has come.

These filters haven't been necessary since Ocata [1]
when the filter scheduler started using placement
to filter on VCPU, DISK_GB and MEMORY_MB. The
only reason to use them with any in-tree scheduler
drivers is if using the CachingScheduler which doesn't
use placement, but the CachingScheduler itself has
been deprecated since Pike [2]. Furthermore, as of
change [3] in Stein, the ironic driver no longer
reports vcpu/ram/disk inventory for ironic nodes
which will make these filters filter out ironic nodes
thinking they don't have any inventory. Also, as
noted in [4], the DiskFilter does not account for
volume-backed instances and may incorrectly filter
out a host based on disk inventory when it would
otherwise be OK if the instance is not using local
disk.

The related aggregate filters are left intact for
now, see blueprint placement-aggregate-allocation-ratios.

[1] Ie12acb76ec5affba536c3c45fbb6de35d64aea1b
[2] Ia7ff98ff28b7265058845e46b277317a2bfc96d2
[3] If2b8c1a76d7dbabbac7bb359c9e572cfed510800
[4] I9c2111f7377df65c1fc3c72323f85483b3295989

Change-Id: Id62136d293da55e4bb639635ea5421a33b6c3ea2
Related-Bug: #1787910
2018-08-24 19:32:27 -04:00
Takashi NATSUME e811a75e24 Update contributor guide for Stein
Update contributor guide for Stein.
Update URLs and fix broken URLs.
Also link to the TC doc for PTL contact information
where the PTL is mentioned.

Co-Authored-By: Melanie Witt <melwittt@gmail.com>
Change-Id: I3ef0b14eb0a8f1ed904354b8bdcc775093706cb0
2018-08-17 12:09:15 +09:00
Takashi NATSUME 6f4ec5419d Add the guideline to write API reference
Adapted from the wiki:
https://wiki.openstack.org/wiki/NovaAPIRef

Compute API reference:
https://developer.openstack.org/api-ref/compute/

Placement API reference:
https://developer.openstack.org/api-ref/placement/

Change-Id: I78ded463142fc50af3b77721500ed190448632c7
2018-08-08 12:15:15 -04:00
Zuul 3dc4e61f6e Merge "Update process doc to be more generic about point of contact" 2018-07-13 00:30:18 +00:00
melanie witt d76c54a70e Update process doc to be more generic about point of contact
The docs currently name a past PTL by IRC nick -- update it to be
more generic so we don't have to update it every time the PTL
changes.

Change-Id: I31dbf0ee4f7650389e824c25c3aea7529d63eaa0
2018-07-12 17:23:03 +00:00
Chris Dent cc7f4ea724 Update some placement docs to reflect modern times
This change provides a small number of updates to the placement user and
contributor documentation to reflect some of the things that have
changed recently. This is by no means complete, but is an improvement
over what was there.

Partial-Bug: #1778227

Change-Id: Ia348cd3c99b1a5104e15595fdebc83e1ca582a98
2018-07-11 01:33:28 +00:00
XiaojueGuan 20d7e9a1cf Update links in README
Change the outdated links to the latest links in README

Change-Id: I8e48261cbf8c64ff7eaadec60cbed4813c17bd56
2018-06-12 16:35:31 +08:00
Zuul 2d3b204d38 Merge "Add contributor docs on deprecating and removing compute REST APIs" 2018-06-06 21:01:04 +00:00
Zuul e093eea01d Merge "Fix some wrong urls in doc" 2018-06-05 23:01:15 +00:00
tianhui 098051d224 Fix some wrong urls in doc
The url in the doc is wrong and need change it to the correct

Change-Id: Ifd56d5b9f4e111997779e633b0f484f3cb08e421
2018-06-05 08:39:33 +00:00
tianhui dd713a04ff Fix bug to doc
There is a wrong url in the doc and turn it right

Change-Id: I0af13090525ca7c2f1fd6e7d3cc3c7c578d398f7
2018-06-05 14:44:17 +08:00
Zuul d741f624c8 Merge "doc: Start using openstackdoctheme's extlink extension" 2018-05-30 15:21:12 +00:00
Matt Riedemann d5202b5561 Add contributor docs on deprecating and removing compute REST APIs
Deprecating APIs with microversions is a long-established pattern
at this point, but the docs don't mention it at all, so this
adds a short description of what happens there.

We removed the os-certificates and os-cloudpipe APIs in Pike
and the os-fping API in Rocky, and there is a pattern to removal
also, so this adds detailed documentation on the steps involved
in removing a deprecated API.

Change-Id: I9fdb9ce78c45d27d3c7f55fcbda0f763dfb66d66
2018-05-14 10:12:40 -04:00
Zuul 4fa05ab6d4 Merge "[Doc]Link policies file into api" 2018-05-11 01:51:27 +00:00
jichen 936f765b85 [Doc]Link policies file into api
Link policies file into api.

Change-Id: I0afb7e850ad7064138ad2b69d0fa900d40f3efbe
2018-05-09 17:22:37 +08:00
Stephen Finucane dd1a416bc9 doc: Start using openstackdoctheme's extlink extension
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
2018-05-03 14:34:47 +01:00
Chris Dent 6efbed5e70 Fix link in placement contributor doc
A todo in the contributor/placement.rst slipped through the review
cracks and meant a bad link to 'link to spec once it merges' is in the
docs. This fixes it with the correct link to the spec.

Change-Id: I13daf9576dcb1229409826b4c4eac28c8bb1e23f
2018-04-20 12:27:40 +01:00
Zuul b1dcfd8159 Merge "Provide framework for setting placement error codes" 2018-04-20 00:33:21 +00:00
jichen e285070ec7 Fix doc link for api
doc link has an issue.
Trivial Fix

Change-Id: I949711ebfc51a09bbdc344fa0e242b924e66a29f
2018-04-16 11:14:16 +08:00
Chris Dent bd9f24b7aa Provide framework for setting placement error codes
The API-sig has a guideline[1] for including error codes in error
responses to help distinguish errors with the same status code
from one another. This change provides a simplest-thing-that-could-
possibly-work solution to make that go.

This solution comes about after a few different constraints and attempts:

* We would prefer to go on using the existing webob.exc exceptions, not
  make subclasses.
* We already have a special wrapper around our wsgi apps to deal with
  setting the json_error_formatter.
* Though webob allows custom Request and Response objects, it uses the
  default Response object as the parent of the HTTP exceptions.
* The Response object accepts kwargs, but only if they can be associated
  with known attributes on the class. Since we can't subclass...
* The json_error_formatter method is not passed the raw exception, but
  it does get the current WSGI environ
* The webob.exc classes take a 'comment' kwarg that is not used, but
  is also not passed to the json_error_formatter.

Therefore, when we raise an exception, we can set 'comment' to a code
and then assign that comment to a well known field in the environ and if
that environ is set in json_error_formatter, we can set 'code' in the
output.

This is done in a new microversion, 1.23. Every response gets a default
code 'placement.undefined_code' from 1.23 on. Future development will
add specific codes where required. This change adds a stub code for
inventory in use when doing a PUT to .../inventories but the name
may need improvement.

[1] http://specs.openstack.org/openstack/api-wg/guidelines/errors.html

Implements blueprint placement-api-error-handling

Change-Id: I9a833aa35d474caa35e640bbad6c436a3b16ac5e
2018-04-14 13:45:54 +01:00
Chris Dent d7145270c3 [placement] Add to contributor docs about handler testing
A recent IRC conversation [1] discussed that there are generally no tests
for the placement handler code (the wsgi methods that respond to each
URI and HTTP method). This change adds a paragraph to point out that
this is mostly intentional and that when they get complex it would
be a good idea to extract a method.

[1] http://eavesdrop.openstack.org/irclogs/%23openstack-nova/%23openstack-nova.2018-03-28.log.html#t2018-03-28T13:00:40

Change-Id: I09774c123068e42e6a828fc37455dc5d374486b9
2018-03-30 11:30:52 +01:00
Zuul 4bfcac8baa Merge "Update contributor guide for Rocky" 2018-03-16 20:15:18 +00:00
Chris Dent eb637b9de7 Update contributor/placement.rst to contemporary reality
This udpates the placement contributor documentation to reflect the
current state of affairs. Ininitially this was just going to be an
update to reflect that the oslo versioned objects had moved. However,
while reviewing the rest of the doc it became clear there were other
issues that should be resolved. Doing so in one shot helps to maintain
the continuity of the document and doing it piecemeal means it is less
likely to happen.

Change-Id: Ia8d4861799e27a30108dd465d15828c5a1943819
2018-03-14 09:58:29 +00:00
Takashi NATSUME c69470ba8f Update contributor guide for Rocky
TrivialFix
Change-Id: I2e489fae6e86b3017b35c64514caca7bb4044053
2018-03-07 08:16:06 +09:00
Zuul db82a00a60 Merge "Fix the format file name" 2018-02-07 02:19:41 +00:00
Zuul 107fef8992 Merge "Document testing guide for new API contributions" 2017-12-27 11:37:13 +00:00
Matt Riedemann 749f1ecbc5 Document testing guide for new API contributions
This fills in the TODOs for the unit, functional and
docs part of the API contributor guide.

Since we don't rely on the DocImpact tag in the commit
message for API changes (that tag results in a nova bug
and was meant mostly for making changes to docs external
to the nova repo, which is no longer the case), this
changes that section to just talk about the in-tree docs
that should be updated for API changes.

Change-Id: I9ca423c09185d2e3733357fd47aaba82d716eea4
2017-12-22 08:52:15 -05:00
Chris Dent 13e3aff7f1 Provide example for placement last-modified header of now
In the comments to I8f0c3006d1bb97d228f73256c58a79235cd12670, a request
for clarification was made on when the last-modified header should
be "now". This adds an example to help things a bit more clear.

Change-Id: I301f17bc7aad9f0037d2b13aa6e493ac9a6abb80
2017-12-20 15:22:49 +00:00
Zuul e502f0d073 Merge "doc: add note about fixing admin-only APIs without a microversion" 2017-12-19 21:07:14 +00:00
Zuul 6a09908757 Merge "doc: link in some Sydney summit content" 2017-12-14 14:26:19 +00:00
Chris Dent 413d50e78e [placement] Add info about last-modified to contrib docs
Add some instructions on how and when to add last-modified headers
when creating a new handler in the placement API.

Change-Id: I8f0c3006d1bb97d228f73256c58a79235cd12670
2017-12-12 15:53:26 +00:00
Matt Riedemann e6498e6ef1 doc: add note about fixing admin-only APIs without a microversion
This is a follow up to change I947e927802f755ccb25a91efd82cac895779d19e
to document the decision and agreements made in that change about fixing
obvious regression bugs in admin-only APIs without a microversion.

Change-Id: I4051cb465c509db63620ee727654f7c896fab1e8
Related-Bug: #1733886
2017-12-12 10:07:28 -05:00
Matt Riedemann 1772abbb52 doc: link in some Sydney summit content
This adds some links to talks from the Sydney summit to the docs
for cells v2, bug triage, and the metadata service.

While adding a "References" section to the metadata docs, I figured
it was also useful to link to a blog post from mikal about vendordata
since it also includes code samples.

Change-Id: Ifc47a5472db37f5526004d2e00751365a026975a
2017-12-07 22:27:50 -05:00
Zuul 96cf7ed401 Merge "Do not use “-y” for package install" 2017-12-01 04:50:37 +00:00