265 Commits

Author SHA1 Message Date
Zuul
758c3f954a Merge "install-guide: Make formatting of console consistent" 2018-02-13 21:42:41 +00:00
Zuul
61c0ae5b6f Merge "doc: merge numa.rst to cpu-topologies.rst" 2018-02-13 21:30:36 +00:00
Nicolas Bock
6699867b20 install-guide: Make formatting of console consistent
The formatting of the console commands is inconsistent between the
endpoint creation of the `compute` and the `placement` services. This
change reformats the commands.

Change-Id: I18f1cb8d5b3335d03e20c955c3c901b8dc1a8129
2018-02-13 14:00:08 -07:00
Tetsuro Nakamura
366b48218b doc: merge numa.rst to cpu-topologies.rst
The explanation of NUMA topology feature of nova exited in both
numa.rst and cpu-topologies.rst under doc/source/admin/.

This patch merges them for cleaning up.

Change-Id: I35e23b2e1ac55c74faf4f0542498e45f2957e4d3
2018-02-10 17:50:16 +09:00
Takashi NATSUME
e55c09f28b Remove a duplicate colon
In 'Writing to the API' section of nova doc index page(*),
there is the 'Compute API Guide::' item.
It should be 'Compute API Guide:'.

* https://docs.openstack.org/nova/latest/#writing-to-the-api

TrivialFix
Change-Id: I59455c9783baccbf6ca7c6cf9da7f040f235de14
2018-02-08 18:30:22 +09:00
Zuul
dae515b719 Merge "Fix the format file name" 2018-02-07 02:19:41 +00:00
Zuul
5baa0828cf Merge "Fix SUSE Install Guide: Placement port" 2018-02-05 10:03:45 +00:00
Zuul
1dea834dba Merge "doc: placement upgrade notes for queens" 2018-02-02 09:55:58 +00:00
Matt Riedemann
abb3a7afba doc: placement upgrade notes for queens
This adds a mention of the nova-scheduler service requiring
placement 1.17 and also links to the placement upgrade notes
from the more general upgrade notes, since we are now firmly
in a place where placement needs to be upgraded before nova.

Since we consider placement global, this removes the 1.14
note about nova-compute since we assume that if you're going
to upgrade placement to get 1.17 for the scheduler, and control
services should be upgraded before computes, then the computes
are going to get a new enough placement service automatically.

Change-Id: I06937c7642dca4a1932cbbf46569acc9c58e44a6
2018-02-01 17:17:57 -05:00
Matt Riedemann
ef3a360096 Migrate "launch instance" user guide docs
This imports the "launch instance" end user guide docs from
the openstack-manuals repo. As part of the docs migration
in Pike, these were forgotten. The copied contents come from
the stable/ocata branch of openstack-manuals, and therefore
likely need some updating, but that could be done in follow up
changes. This is an initial import to (1) publish the content
again somewhere and (2) fix broken links in the cinder docs
for booting from volume.

Change-Id: Ie039322660fd0e2e0403843448379b78114c425b
Partial-Bug: #1714017
Related-Bug: #1711267
2018-02-01 14:28:18 -05:00
Andreas Jaeger
8956214ada Fix SUSE Install Guide: Placement port
The bug report says all:
"There is a mismatch configuration for placement.
 In the controller configuration, the guide suggests endpoints creation
 pointing to port 8778, however in the default file provided in SLES 12
 SP3, the port used is 8780."

Fix documentation to match sample file.

Change-Id: Ib4c881058b9b90ba136ff223064c113e63f98379
Closes-Bug: #1741329
2018-01-26 08:06:45 +01:00
Chris Dent
acabf42032 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
528c3b10cb Merge "Update nova-status and docs for nova-compute requiring placement 1.14" 2017-12-19 22:23:47 +00:00
Matt Riedemann
22b282e95b Update nova-status and docs for nova-compute requiring placement 1.14
With change I2f367b06e683ed7c815dd9e0536a46e5f0a27e6c, nova-compute
now unconditionally requires Placement 1.14 to be available (the
client side code doesn't check to see if 1.14 is available before
trying to use it).

This change updates the nova-status check for the minimum required
version of Placement and also starts the "Queens" section of the
Placement upgrade notes docs.

Change-Id: I37415e384d375bc9b548a0223f787a9236286bb0
2017-12-13 15:18:27 -05:00
Chris Dent
8605ec994a [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
Zuul
58df9def2e Merge "Update document related to host aggregate" 2017-11-28 15:26:28 +00:00
Luong Anh Tuan
7ab9bcc069 Fix the format file name
The file name should be marked follow [1]
as consistent with their semantic meaning.

[1] https://docs.openstack.org/doc-contrib-guide/rst-conv/inline-markups.html#file-name-and-path

Change-Id: Ic18d0563412650d3b42c2ed5c07e69f309877cb9
2017-11-27 11:43:41 +07:00
Zuul
88cf0e6c83 Merge "[placement] Fix a wrong redirection in placement doc" 2017-11-21 12:23:07 +00:00
Takashi NATSUME
b134aeb579 Update document related to host aggregate
The arguments of nova CLI commands related to host aggregate
(I93f44a12b6d5a91b448f6f8d238311d58bf40c01) are fixed.
The host APIs have been deprecated since microversion 2.43.
So remove description related to nova host commands.
And add description about nova hypervisor commands.

Change-Id: Ibf78865844da6f007b610f12430df4866076f00b
Closes-Bug: #1726658
2017-11-21 02:01:40 +00:00
Takashi NATSUME
934b4f871c [placement] Fix a wrong redirection in placement doc
Change-Id: I9f404838c36618f5d632c6fb77b69287263f2611
2017-11-06 23:44:05 +00:00
Eric Fried
f522ba7109 placement: Contributor doc microversion checklist
I put out a new placement microversion [1] and initially missed updating
the API reference documentation [2].  I'd like to say it would have
helped if the checklist in the Microversion section of the contributor
doc had been up to date, except I didn't even know about that document
at the time.  Anyway, this change set adds that bullet - and I'll know
to refer to it next time.

[1] https://review.openstack.org/499826
[2] https://review.openstack.org/515748

Change-Id: Id0329d9824eeb1d210defe0567286372b72cb1cf
2017-10-31 15:07:57 -05:00
Zuul
d3cea0645b Merge "Import user-data page from openstack-manuals" 2017-10-26 01:04:50 +00:00
Zuul
67953bd414 Merge "Import the config drive docs from openstack-manuals" 2017-10-26 01:04:44 +00:00
Matt Riedemann
04e0ee80f9 Import user-data page from openstack-manuals
This imports the "provide-user-data-to-instances" page
from the old openstack-manuals user guide.

Since we don't have a glossary, the :term: link is removed
and replaced with just giving the glossary definition as
the first part of the doc.

Change-Id: Iae70d9b53d6cefb3bcb107fe68499cccb71fc15e
Partial-Bug: #1714017
2017-10-24 12:22:34 -04:00
Matt Riedemann
b921c85ac9 Import the config drive docs from openstack-manuals
As part of the docs migration from openstack-manuals to
nova in the pike release we missed the config-drive docs.

This change does the following:

1. Imports the config-drive doc into the user guide.
2. Fixes a broken link to the metadata service in the doc.
3. Removes a note about liberty being the current release.
4. Adds a link in the API reference parameters to actually
   point at the document we have in tree now, which is
   otherwise not very discoverable as the main index does
   not link to this page (or the user index for that matter).

Partial-Bug: #1714017
Closes-Bug: #1720873

Change-Id: I1d54e1f5a1a94e9821efad99b7fa430bd8fece0a
2017-10-24 12:22:11 -04:00
Michael Still
adbf397164 Move the idmapshift binary into privsep.
I can't see any evidence that anyone else uses our nova-idmapshift
binary, and it adds a lot of complexity (flags we never call for
example). Move the code we do actually use into the privsep
directory and simplify our calls to it. Remove the extra binary
from our install and documentation.

Change-Id: Ibce28d20d166da154833376cf51f1877b829925e
blueprint: hurrah-for-privsep
2017-10-24 18:50:23 +11:00
Zuul
51e669df6f Merge "Remove doc todo related to bug/1506667" 2017-10-20 22:39:42 +00:00
Jenkins
8f29f768e2 Merge "[placement] Update the placement deployment instructions" 2017-10-04 20:26:56 +00:00
Jenkins
689e644944 Merge "fix nova accepting invalid availability zone name with ':'" 2017-10-04 18:54:23 +00:00
Ken'ichi Ohmichi
6c8c6e08f3 Remove doc todo related to bug/1506667
As the bug report 1506667, the bug has been fixed already since 2016-11-22.
In addition, the bug is just kind of reminder to avoid forgetting to
include example config files of upstream in ubuntu packages.
That[1] makes readers confused, so let's just remove it.

[1]: https://docs.openstack.org/nova/pike/install/controller-install-ubuntu.html#install-and-configure-components

Change-Id: I793d58dbc6bad097c772f7715430e75d74521253
Related-bug: #1506667
2017-10-03 17:15:04 -07:00
Chris Dent
274d2b620e [placement] Update the placement deployment instructions
The web-server-deployment section of placement.rst has been updated
to provide additional links to information and reflect the fact that
placement is now using uwsgi and mod_proxy_uwsgi in devstack. This
does not provide a full set of installations instructions. This is
somewhat intentional:

* there are many ways to deploy a wsgi application and we'd like the
  packagers and deployers to choose a way that works best for them,
  not impose one, and there's no way for us to document them all. It
  is better to point to resources that explain some of the options
  and allow people to inform themselves so they can make informed
  choices
* we're no longer that keen on the mod_wsgi, but it tends to be the
  easiest to document (fewer moving parts)
* the uwsgi+systemd method in devstack, while great, is abstracted
  enough that the moving parts are not entirely visible and is one
  of several ways for that scenario

Change-Id: Ief07c313e012df63558de632047258e8e11736c1
Related-Bug: #1692375
2017-09-28 14:47:08 +00:00
Matt Riedemann
b6cc150871 doc: make host aggregates examples more discoverable
When one is looking for an explanation and examples of
how to associate host aggregates to flavors, it's useful
to be able to point to that from the more top-level
aggregates page, which is linked from the main home page.

This change links from that to a somewhat buried reference
doc on host aggregates, which is actually really useful here.

Change-Id: I9e03c6649afd9a7aa816b9af1d931f9e0cffb94a
2017-09-27 14:58:37 -04:00
Jenkins
a0b6a55aa9 Merge "Live Migration sequence diagram" 2017-09-26 06:45:51 +00:00
Eric Fried
41f86214a2 Live Migration sequence diagram
Based on mriedem's hand-drawn version [1] (but not as pretty).

[1] https://photos.google.com/share/AF1QipNpWVQKU8GK4_9wxVbiRJUqJnMzqPcBh6DvjVyBPIjjmi6ZU8r9TleQNo6pV1t9SA?key=NUl3OUFGYkRFTE8tMHhSX0lfc0Y1eEdoeHo4SUhn

Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com>

Change-Id: I63046079cd3135b4b19c0c6745075f090d04e396
2017-09-25 16:19:44 +00:00
Tetsuro Nakamura
03243beeac fix nova accepting invalid availability zone name with ':'
Nova has a legacy hack to allow admins to specify hosts via an
availability zone using az:host:node. That means ':' cannot be
included in the name of an availability zone itself.

However, the aggregate API accepts requests which have
availability zone names including ':'.

This patch checks the availabilty zone name when aggregate is
created or updated and raises an error if it contains ':'.

Change-Id: I9b0d8e8d4b3ab2cb3d578c22fa259e0e7c0d325b
Closes-Bug: #1695861
2017-09-24 15:12:43 +09:00
Stephen Finucane
4087514dcf docs: Rename cellsv2_layout -> cellsv2-layout
Underscores make for really ugly URLs and every other document here is
now using hyphens for this very reason. Let's try to keep that going.

Change-Id: I5c99ff6b04ee97bac210a0d6762015225775c5ee
2017-09-22 15:56:44 +01:00
Jenkins
7442a8c989 Merge "doc: Split flavors docs into admin and user guides" 2017-09-20 15:17:19 +00:00
Jenkins
f764415128 Merge "conf: Rename two VNC options" 2017-09-20 14:27:20 +00:00
Stephen Finucane
f612acd32f doc: Split flavors docs into admin and user guides
There are currently two docs describing flavors in 'admin', which
contain a lot of overlapping information. Fix this by keeping the
configuration guide (how to create, delete, modify flavors) in
'admin', while moving the reference-style parts into 'user'. We
cross-reference the two internally.

Given that large chunks of this needed to be rewritten, we've taken the
opportunity to fix a poor description for the RXTX factor, closing a
longstanding bug in the process.

Change-Id: Ia57c93ef1e72ccf134ba6fc7fcb85ab228d68a47
Closes-Bug: #1688054
2017-09-20 14:06:41 +01:00
Matt Riedemann
a877bf8d00 doc: rename the Indices and Tables section
We haven't had a doc wide index or mod index in this
section on the main page for a long time, so it's a
weird title for just having a link to the search page.

This renames the section title, describes the link and
also links to the openstack-wide docs search page.

Change-Id: Idf63e6035841c8ff0ec1aa9bd2994fedf53555b1
2017-09-15 12:53:24 -04:00
Stephen Finucane
669d5c75cd doc: Add configuration index page
Change-Id: Ic318e04be73639de7d26e53e1f0b152d9803fd2f
2017-09-06 14:40:17 +01:00
Stephen Finucane
a83e491eb1 doc: Add user index page
The idea is that each guide should be self contained, even though we can
link between them. Enforce this by duplicating a lot of the content from
the main index page to the user index page.

Change-Id: I160fed0f1b507eba7958666bf38f4138b0f62b3a
2017-09-06 14:40:17 +01:00
Stephen Finucane
d78f527a1b conf: Rename two VNC options
Make the lives of operators easier by using consistent opt naming for
similar features.

Change-Id: Ic05c2c8364e015f6878b0bc25449216624568ad5
2017-09-04 17:22:16 +01:00
Matt Riedemann
21fe32d080 doc: link to versioned notification samples from main index
Notifications are essentially another API for end users, but
it can be hard to find the list of existing notifications or
their samples which are buried deep down via contributors >
technical reference deep dive > notitfications. If I'm an
end user, I'd like to just see them in the same set of links
on the main page as the API, under the "For End Users" section.

Change-Id: If3ca21b080d06a291ed27c9bcd84a566164c3b70
2017-09-01 14:10:14 -04:00
Matt Riedemann
4c1f2b1b83 doc: link to placement api-ref and history docs from main index
Now that we have a placement api-ref getting published, we
should link to it like we do for the compute api-ref. This
also links in the placement microversion history for consistency.

Change-Id: Id0c70486c5a72a4d6794d80d350a45a5f356ca37
2017-09-01 14:10:14 -04:00
Eric Fried
1aa57ede98 [placement] Update user doc with api-ref link
The Placement API user guide [1] mentions a not-yet-available REST API
reference which has since become available [2]; update with the link.

[1] https://docs.openstack.org/nova/pike/user/placement.html#api-reference
[2] https://developer.openstack.org/api-ref/placement/

Closes-Bug: #1714284
Change-Id: Ic368327aa4a81f4217aecb4af3d9358502676234
2017-08-31 10:30:03 -05:00
Stephen Finucane
b7e2e4d3f7 Monkey patch the blockdiag extension
The blockdiag extension currently provides poor support for word
wrapping.  While a PR has been filed, the project appears to be dormant
and it's likely going to be a while (if ever) before it gets merged. As
such, it's easier to carry our own, monkey patched version of the
plugin.

Change-Id: Iac2f8cadc688334e07ad46c5af1870b568c56e73
Co-Authored-By: Eric Fried <efried@us.ibm.com>
2017-08-24 15:27:55 +00:00
Stephen Finucane
3b52049378 docs: Document the scheduler workflow
There have been some major changes to how scheduling works in Nova
during the Pike and Queens cycles. This documents these design changes
so that this new, more complex workflow is clearly spelled out.

Co-Authored-By: Ed Leafe <ed@leafe.com>

Change-Id: I15121d8fe9b715c0aec39dee4bfdf25ced42b481
2017-08-24 15:18:11 +00:00
Sean Dague
77c95d22ae doc: Address review comments for main index
Per comments in I6815958b2533d462a2e5d27e7be57440d9f4f40a and
I5fdafd9f6cf07a19bf86a6343663dad410887dcb.

Part of bp: doc-migration

Change-Id: Iac833503b57386ab91fa86f8c48f0dd8039e5922
2017-08-21 16:18:28 -04:00
Jenkins
6be42c6247 Merge "Add documentation for documentation contributions" 2017-08-16 19:54:35 +00:00