Commit Graph

1353 Commits

Author SHA1 Message Date
Zuul e4c96de821 Merge "Import user-data page from openstack-manuals" 2017-10-26 01:04:50 +00:00
Zuul a921ebfd5c Merge "Import the config drive docs from openstack-manuals" 2017-10-26 01:04:44 +00:00
Matt Riedemann 3fc85389e5 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 59bd2f6adc 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 3f7995f586 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 fb4e6900e1 Merge "Remove doc todo related to bug/1506667" 2017-10-20 22:39:42 +00:00
Takashi NATSUME f4f17b364e Add 'delete_host' command in 'nova-manage cell_v2'
Add 'delete_host' command in 'nova-manage cell_v2'.
Add an optional 'force' option in 'nova-manage cell_v2 delete_cell'.
If specifying the 'force' option, a cell can be deleted
even if the cell has hosts.

Change-Id: I8cd7826c2c03687c6b85731519778f09d542b236
Closes-Bug: #1721179
2017-10-19 01:31:02 +00:00
Markus Zoeller 19f0acd960 docs: Explain the flow of the "serial console" feature
The serial console feature is a little unknown and it's a little
confusing at first. This change adds a doc to explain this better.

Change-Id: Ia5a336694aec95db29545e31b2c6b364dd825a15
2017-10-18 13:39:57 +00:00
Zuul 06b8ebd56c Merge "doc: Fix command output in scheduler document" 2017-10-17 01:56:17 +00:00
Zuul 4668026a56 Merge "doc: Rework man pages" 2017-10-16 19:05:59 +00:00
evikbas aff78ac53e doc: Fix command output in scheduler document
Change-Id: If2fe3dcac8d32d8a3f83f4db8e2a0b41ac15e888
Closes-Bug: #1723120
2017-10-16 09:21:11 +00:00
Balazs Gibizer 0d4c3cc65b Remove dead code of api.fault notification sending
Based on the description of the notify_on_api_faults config option [1]
and the code that uses it [2] nova sends and api.fault notification
if the nova-api service encounters an unhandle exception.
There is a FaultWrapper class [3] added to the  pipeline of the REST
request which catches every exception and calls the notification sending.

Based on some debugging in devstack this FaultWrapper never catches any
exception. Every REST API method is decorated with expected_errors
decorator [5] which as a last resort translate the unexpected exception
to HTTPInternalServerError. In the wsgi stack the actual REST api call is
guarded with ResourceExceptionHandler context manager [7] which translates
HTTPException to a Fault [8]. Then Fault is catched and translated to
the REST response [7]. This way the exception never propagates back to
the FaultWrapper and therefore the api.fault notification is never emitted.

Based on the git history of the expected_errors decorator this notification
was never emitted for v2.1 API and as the v2.0 API now supported with the
same codebase than v2.1 it is not emitted for v2.0 calls either. As nobody
reported a bug I assume that nobody tried to use this notification for a very
long time. Therefore instead of fixing this bug this patch propses to remove
the dead code.

See a bit more detailed description on the ML [9].

[1] https://github.com/openstack/nova/blob/0aeaa2bce8ad15bc2f28e00b30d688514b992e13/nova/conf/notifications.py#L49
[2] https://github.com/openstack/nova/blob/0aeaa2bce8ad15bc2f28e00b30d688514b992e13/nova/notifications/base.py#L84
[3] https://github.com/openstack/nova/blob/0aeaa2bce8ad15bc2f28e00b30d688514b992e13/nova/api/openstack/__init__.py#L78
[5] https://github.com/openstack/nova/blob/0aeaa2bce8ad15bc2f28e00b30d688514b992e13/nova/api/openstack/extensions.py#L325
[7] https://github.com/openstack/nova/blob/0aeaa2bce8ad15bc2f28e00b30d688514b992e13/nova/api/openstack/wsgi.py#L637
[8] https://github.com/openstack/nova/blob/0aeaa2bce8ad15bc2f28e00b30d688514b992e13/nova/api/openstack/wsgi.py#L418
[9] http://lists.openstack.org/pipermail/openstack-dev/2017-June/118639.html

Change-Id: I608b6ebdc69d31eb2a11ac6479fa4f2e8c20f7d1
Closes-Bug: #1699115
2017-10-09 17:29:40 +02:00
Stephen Finucane 3a6e1e2396 doc: Rework man pages
Rework the man pages by:

- Wording the synopsis sections similarly for all commands
- Not using upper-case section names, as this is unnecessary and results
  in worse HTML output
- Formatting code and file names as literals

The 'nova-idmapshift' man page is excluded as this utility will be
removed shortly.

Change-Id: I67914a757f9436461960a8d6b92d157f59ccad66
2017-10-09 16:08:40 +01:00
Matt Riedemann 7055b5305c Note TrustedFilter deprecation in docs
Change 82f16b88f3 deprecated
the TrustedFilter for removal in Queens, but there is an
entire document about using it which doesn't mention this,
so it's noted here.

Change-Id: I4f772a50cfdbc1f50759c67b234e5c7e29e81100
2017-10-05 18:47:40 -04:00
Jenkins a6eadd8e30 Merge "doc: Add documentation for cpu_realtime, cpu_realtime_mask" 2017-10-05 10:03:23 +00:00
Jenkins 792868cef4 Merge "[placement] Update the placement deployment instructions" 2017-10-04 20:26:56 +00:00
Jenkins 4e62b38fa1 Merge "Fix inconsistency of 'NOTE:' description" 2017-10-04 20:17:27 +00:00
Jenkins 659b63d84b Merge "fix nova accepting invalid availability zone name with ':'" 2017-10-04 18:54:23 +00:00
Stephen Finucane bd3a4d242f doc: Add documentation for cpu_realtime, cpu_realtime_mask
This wasn't documented anywhere but the spec [1]. Fix this.

We may want to provide a more in-depth overview of using RT features of
OpenStack, but that's a future work item.

[1] https://specs.openstack.org/openstack/nova-specs/specs/mitaka/implemented/libvirt-real-time.html

Change-Id: Id30bc8447a6b482ad114ec6ebd3d5dab20ca0e3a
Closes-Bug: #1715437
2017-10-04 09:43:22 +01:00
Ken'ichi Ohmichi bf090ab0d6 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 3a9afe608f [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
Takashi NATSUME 48eb371e62 Fix inconsistency of 'NOTE:' description
Use the 'note' directive.

TrivialFix
Change-Id: If342940f8cc64591778ad21ce6cccbe006c0145b
2017-09-28 16:28:49 +09:00
Jenkins ae4b5d0147 Merge "doc: make host aggregates examples more discoverable" 2017-09-28 03:28:18 +00:00
Matt Riedemann 7db0e3c2b6 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
Eric Fried 6e2d001597 _rollback_live_migration in live-migration seqdiag
Add the _rollback_live_migration call on the source as the first thing
that happens on failed driver.live_migration.

Change-Id: I5db474a072ad12d48f496dcc26c99ea73c90cb66
2017-09-27 09:16:08 -05:00
jolie c7b3a2457c Remove SCREEN_LOGDIR from devstack install setting
Screen support has been completely removed from devstack.
So we should remove this setting.

Change-Id: I574b5d5020edc87cebcc9e10daa9a12a493f9039
2017-09-26 16:27:29 +08:00
Jenkins f5031c3f56 Merge "Live Migration sequence diagram" 2017-09-26 06:45:51 +00:00
Eric Fried f839a97e0f 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
Jenkins ef0f6341f4 Merge "Add PowerVM hypervisor configuration doc" 2017-09-25 12:25:02 +00:00
Tetsuro Nakamura 38b25397e8 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 2f36a355f2 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
esberglu ba9f6a7dd7 Add PowerVM hypervisor configuration doc
This adds the hypervisor configuration documentation for using the
PowerVM nova compute driver.

Change-Id: Id96e8ac68d8d89d856f8defd2774aac3df2ccb34
2017-09-21 16:29:28 -05:00
Jenkins adb1d8b4a5 Merge "Update docs to include standardization of VM diagnostics" 2017-09-21 17:57:32 +00:00
Takashi NATSUME f20dec0db9 Fix hyperlinks in document
This patch is follow-up for
I48d7c77a6e0eaaf0efe66f848f45ae99007577e1.

The hyperlink style is fixed.
Add a note that it need be updated for os-xenapi latest version.
Add a reference to nova policies.

TrivialFix
Change-Id: I274fb6b7ea0bb2ea81faaa68d783edbaa8ed06c3
2017-09-21 15:01:05 +00:00
Jenkins a9355cae02 Merge "Add nova-manage db command for ironic flavor migrations" 2017-09-20 22:21:55 +00:00
Jenkins 3157aa65ff Merge "doc: Add documentation for emulator_thread_policy" 2017-09-20 15:18:11 +00:00
Jenkins aac56cb1df Merge "doc: Split flavors docs into admin and user guides" 2017-09-20 15:17:19 +00:00
Jenkins b73cd8658b Merge "conf: Rename two VNC options" 2017-09-20 14:27:20 +00:00
Jenkins d2474c8992 Merge "Fix a typo" 2017-09-20 13:46:47 +00:00
Stephen Finucane 0b77e3cdd8 doc: Add documentation for emulator_thread_policy
This wasn't documented anywhere but the spec [1]. Fix this.

We may want to provide a more in-depth overview of using RT features of
OpenStack, but that's a future work item.

[1] https://specs.openstack.org/openstack/nova-specs/specs/ocata/approved/libvirt-emulator-threads-policy.html

Change-Id: I8d79e1f1277fea9a070790a99bebcefe22bed433
Partial-Bug: #1715437
2017-09-20 14:06:43 +01:00
Stephen Finucane a76277f81a 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
Jenkins be7fb7fe7f Merge "Fix the ocata config-reference URLs" 2017-09-19 13:23:18 +00:00
Jenkins 20c4840f12 Merge "doc: Further cleanup of doc contributor guide" 2017-09-19 09:24:14 +00:00
Takashi NATSUME 2fce8a1396 Fix the ocata config-reference URLs
Replace the ocata config-reference URLs with
URLs in each project repo.

Change-Id: I48d7c77a6e0eaaf0efe66f848f45ae99007577e1
Closes-Bug: #1715545
2017-09-19 06:38:15 +00:00
chen 2aa12aed41 Fix a typo
Change-Id: I5635a8b2400c4a68e6b04ce03ceb8f3e8d772f54
2017-09-19 13:58:31 +08:00
Matt Riedemann 7d3553c079 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 88c31c8077 doc: Further cleanup of doc contributor guide
Change-Id: I03f00876fd8a51af487b18b8eb3f53454f81f0a2
2017-09-15 10:44:27 -06:00
Dan Smith 8f8982d8ef Add nova-manage db command for ironic flavor migrations
This adds `nova-manage db ironic_flavor_migration` which allows
pushing the migrations ahead of time, and without ironic or nova
services running.

This is a similar operation to online_data_migrations, but there is
a need to pass data that would normally be retrieved from ironic.
However, we want this to work offline and thus that data must be
provided locally. When fast-forwarding through the pike release,
ironic and nova-compute will never be started and thus we can't rely
on the online nature of the migration integrated into the ironic
driver.

Change-Id: I459bce472227ee08230d3120d9e2eb1bde635218
2017-09-15 00:30:23 -04:00
Jenkins a28b79adb3 Merge "doc: fix flavor notes" 2017-09-13 17:54:47 +00:00
Hesam Chobanlou fb3b47ea5b Update docs to include standardization of VM diagnostics
VM diagnostics has been updated with v2.48 to include a standard formatting.
This change will update the admin documentation to mention the new standard
formatting.

Change-Id: I2498ae5400ad0903f6084bacaf96f0b76731b5a3
Closes-bug: 1696033
2017-09-12 01:17:56 -04:00