Commit Graph

105 Commits

Author SHA1 Message Date
Zuul a9741bcc77 Merge "doc: Add links to novaclient contributor guide" 2019-07-16 00:27:03 +00:00
Takashi NATSUME 09d24e5ffa doc: Add links to novaclient contributor guide
Add links to the document for adding a new microversion support
in python-novaclient.

Depends-On: https://review.opendev.org/667002
Change-Id: Ic58afe401464a0da2b19306e7cc6ce412f177b16
2019-07-09 17:33:47 -04:00
Takashi NATSUME c329397e9c doc: Replace a wiki link with API ref guide link
Replace the link to the NovaAPIRef wiki with
the link to the API reference guideline in the nova doc.

Change-Id: I211e828c54256391aea38e475171e92aac230e56
2019-07-09 17:26:26 -04:00
Zuul 0979ea2954 Merge "Add testing guide for down cells" 2019-06-06 18:50:50 +00:00
Stephen Finucane 8b9dad0b63 docs: Don't version links to reno docs
reno doesn't have stable branches and doesn't version its documentation.
There's no point versioning our links to same.

Change-Id: Id782d3b11715bc3211e7952fb01b42a659d06e36
Closes-Bug: #1830926
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-05-29 15:23:59 +00:00
zhufl 84afd12589 Change some URLs to point to better targets
This is to change some URLs to point to better or more accurate targets.

Change-Id: I1d450ba8bd2271a69f9380cc4d2b36ae3eefe09a
2019-05-13 00:52:23 +00:00
Dan Smith 82f6d61537 Update the contributor doc for macos
All the tox targets require postgres' pg_config to be runnable,
so that always needs installing from brew. Add that and a hint
about python3 from brew and tox from that python's pip.

Change-Id: Id26700bdea5443cb266b166b7b35eef3c8315451
2019-05-09 08:35:58 -07:00
Zuul a5c5f72cc0 Merge "Add post-release checklist items to the PTL guide" 2019-04-26 22:17:27 +00:00
ZhongShengping 7ecaa3fcf8 Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org
counterparts.

Change-Id: I3e0af55e0707f04428a422b973d016ad30c82a12
2019-04-24 13:59:57 +08:00
melanie witt 96b3199d41 Add post-release checklist items to the PTL guide
We forgot to add the database migration placeholders for Rocky:

  https://review.openstack.org/650964

So add the steps explicitly to the guide to help in the future.

Change-Id: If670a82cee59438f9bff9a962083ebf040b9a779
2019-04-08 22:11:52 +00:00
Matt Riedemann 47fd7e3324 Add testing guide for down cells
This adds a testing guide for creating a down cell
environment with a basic single-node devstack setup.

Change-Id: I8c021129a4df914f56193cca9ff136390a7240c3
2019-04-05 13:57:49 -04:00
Zuul 0b18e139d3 Merge "s,git://github.com/,https://git.openstack.org/," 2019-03-28 13:07:31 +00:00
Zuul afc1a06df2 Merge "Add a reference PTL guide to the contributor docs" 2019-03-27 02:25:34 +00:00
melanie witt 191cc474be Add a reference PTL guide to the contributor docs
This is a guide I used to help me throughout the cycle and I'm
proposing it to the docs, in case it might help someone.

Change-Id: I4f7600c908bf90395515f690b8eee0f9e7b0c9b0
2019-03-26 19:23:15 +00:00
Zuul 5cab04db0a Merge "Add description about sort order in API ref guideline" 2019-03-26 08:24:22 +00:00
Eric Fried 7220521b75 s,git://github.com/,https://git.openstack.org/,
...in a doc

...as (sort of) part of http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html

Change-Id: I008cbe8e6df4431ba813f2a6ca3274222a821acb
2019-03-25 08:48:40 -05:00
Takashi NATSUME 664cdfe932 Update contributor guide for Train
Update URLs for Train release.

Change-Id: I928085a813c50f7854fb706303bbcea8de2a34c3
2019-03-22 22:38:38 +09:00
Takashi NATSUME d078b95b59 Add description about sort order in API ref guideline
Add a description about sort order of response results in
the API reference guideline.

Change-Id: I458795a4f745a0699bc8de40aaa2b3c03c762422
Partial-Bug: #1793034
2019-03-22 06:33:21 +00:00
Matt Riedemann 5de08c0966 docs: cleanup driver parity scope section
This fixes some grammar issues, links to the interop
page and fixes a misuse of tenant.

Change-Id: I3ce0e130e3691240a625c67dfb6123bafe7f48b8
2019-03-15 08:01:19 -04:00
Zuul a37a035c9d Merge "Remove placement from contributor doc" 2019-02-21 13:23:59 +00:00
Adam Spiers 28a1116a09 Drop specific versions of openSUSE-based distributions
In the contributor documentation, don't reference specific
distribution versions since they'll inevitably get out of date, and
these instructions are valid for all releases in the last 5 years at
least, and are not likely to change any time soon.

Change-Id: I7e7391a8850cf8a9dda763d9b85242fbbbb42af7
2019-02-13 20:11:29 +00:00
Chris Dent 1e3ed770ef Remove placement from contributor doc
Placement has its own contributor documentation.

Change-Id: I13070ee66eb2ecce9ce68fd6e5f3f62743437c6a
2019-02-07 10:40:00 +00:00
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