Commit Graph

2249 Commits

Author SHA1 Message Date
Matt Riedemann e619354f7c Document CD mentality policy for nova contributors
The mentality of being able to continuously deliver nova
has been around since the beginning with Rackspace public
cloud trying to CD openstack as close to master as possible.
This has implications for how code series are structured,
reviewed and merged. For the most part this seems to be tribal
knowledge and we don't have anything very obvious in the nova
docs about it, and not all projects in openstack necessarily
subscribe to this mentality anymore, or do so grudgingly, but
it's worth documenting it in nova while still applied here.

Change-Id: Ieff87dbd748318f1b7f879a136ff25081dac321e
2019-11-01 11:52:07 -04:00
Matt Riedemann c5557f03da doc: link to nova code review guide from dev policies
The development policies section on code review was linking to the
generic openstack review guidelines but we have nova-specific
guidelines as well so this changes the policies page to link to the
nova code review guidelines, links the general guidelines into the
nova page, and also fixes a formatting issue in the nova code review
guidelines page.

Change-Id: I725570d0d737f18fe8b105dc8382c4abcfdef295
2019-11-01 11:34:13 -04:00
Zuul 46a02d5eb5 Merge "Default AZ for instance if cross_az_attach=False and checking from API" 2019-11-01 13:04:58 +00:00
Matt Riedemann 07a24dcef7 Default AZ for instance if cross_az_attach=False and checking from API
If we're booting from an existing volume but the instance is not being
created in a requested availability zone, and cross_az_attach=False,
we'll fail with a 400 since by default the volume is in the 'nova'
AZ and the instance does not have an AZ set - because one wasn't requested
and because it's not in a host aggregate yet.

This refactors that AZ validation during server create in the API to
do it before calling _validate_bdm so we get the pre-existing volumes
early and if cross_az_attach=False, we validate the volume zone(s) against
the instance AZ. If the [DEFAULT]/default_schedule_zone (for instances) is
not set and the volume AZ does not match the
[DEFAULT]/default_availability_zone then we put the volume AZ in the request
spec as if the user requested that AZ when creating the server.

Since this is a change in how cross_az_attach is used and how the instance
default AZ works when using BDMs for pre-existing volumes, the docs are
updated and a release note is added.

Note that not all of the API code paths are unit tested because the
functional test coverage does most of the heavy lifting for coverage.
Given the amount of unit tests that are impacted by this change, it is
pretty obvious that (1) many unit tests are mocking at too low a level and
(2) functional tests are better for validating these flows.

Closes-Bug: #1694844

Change-Id: Ib31ba2cbff0ebb22503172d8801b6e0c3d2aa68a
2019-10-31 10:08:46 -04:00
Dan Smith 829ccbe2bb Add image precaching docs for aggregates
Related to blueprint image-precache-support

Partial-Bug: #1847302
Change-Id: I7a57e5e09b2a1760a9c5aeac402911895dfce07d
2019-10-23 11:12:03 -07:00
Takashi NATSUME 976120cb20 Fix unit of hw_rng:rate_period
Replace seconds with milliseconds
in the description of hw_rng:rate_period.

* https://libvirt.org/formatdomain.html#elementsRng

Change-Id: I285f68c81b0587c6a197d4791b09234a1697f5e7
Closes-Bug: #1843542
2019-10-10 21:28:19 +00:00
Zuul b96b385a34 Merge "doc: link to user/index from main home page" 2019-10-09 09:55:36 +00:00
Zuul 2870c2e8cf Merge "doc: link to user/availability-zones from user home page" 2019-10-09 09:55:30 +00:00
Zuul 2a662b20b4 Merge "docs: Add redirects for '/user/aggregates'" 2019-10-09 09:55:24 +00:00
Matt Riedemann ec87830daf doc: link to user/index from main home page
We don't have a direct link from the main home page to the
user docs so this adds one.

Change-Id: I377f65ce78977be943d7a84b075623fd11613a99
2019-10-08 16:32:47 -04:00
Zuul 14f4a0b16b Merge "doc: fix formatting in mitigation-for-Intel-MDS-security-flaws" 2019-10-08 20:31:05 +00:00
Matt Riedemann 2e73dc2015 doc: link to user/availability-zones from user home page
This is a follow up to [1]. The user docs home page has a link
to the admin AZ guide but not a direct link to the user AZ guide
so that is added here.

[1] https://review.opendev.org/#/c/667133/10/doc/source/user/index.rst@75

Change-Id: I4acb120d2e347a43abc584107c7a19bb422af384
2019-10-08 16:30:17 -04:00
Stephen Finucane 93efca826f docs: Add redirects for '/user/aggregates'
These were missed in change If847b0085dbfb4c813d4a8d14d99346f8252bc19.

Change-Id: Iad18f355a20261313ddb3dafd302ed66ebca64bc
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-10-08 16:46:09 +00:00
Matt Riedemann 1ed2b2ac53 doc: fix formatting in mitigation-for-Intel-MDS-security-flaws
The bullet list was indented too far.

Change-Id: I615c20a6b2b54795dfbd991b0a51dbaaac543f36
2019-10-08 12:16:35 -04:00
Zuul 1983d76d6e Merge "docs: Remove a whole load of unused images, most remainder" 2019-10-08 16:06:49 +00:00
Zuul 43248b4c92 Merge "doc: Improve PDF document structure" 2019-10-08 16:06:39 +00:00
Zuul 7058fac53b Merge "Update contributor guide for Ussuri" 2019-10-08 12:14:39 +00:00
Akihiro Motoki 152d5c359c doc: Improve PDF document structure
This is a follow-up patch for https://review.opendev.org/676730.

In the TOC of the current PDF file [1], most contents related to
user and admin guides are located under "For Contributors" section.
This is weird. It happens because the latex builder constructs
the document tree based on "toctree" directives even though they
are marked as "hidden".

This commit reorganizes "toctree" per section.
The "toctree" directives must be placed at the end of
individual sections. Otherwise, content of a last section and
content just after "toctree" directive are concatenated
into a same section in the rendered LaTeX document.

This commit also improves the following as well:

* Specify "openany" as "extraclassoptions" to skip blank pages
  along with "oneside" to use same page style for odd and even pages.
* Set "tocdepth" and "secnumdepth" to 3 respectively.
  "tocdepth" controls the depth of TOC and "secnumdepth" controls
  the level of numbered sections in TOC.

Note that this commit does not reorganize file structure under doc/source.
I believe this should be done separately.

[1] https://docs.openstack.org/nova/latest/doc-nova.pdf

Change-Id: Ie9685e6a4798357d4979aa6b4ff8a03663a9c71c
Story: 2006100
Task: 35140
2019-10-08 11:06:00 +01:00
Stephen Finucane 5c5927a3d2 docs: Rewrite host aggregate, availability zone docs
These closely related features are the source of a disproportionate
number of bugs and a large amount of confusion among users. The spread
of information around multiple docs probably doesn't help matters.

Do what we've already done for the metadata service and remote consoles
and clean these docs up. There are a number of important changes:

- All documentation related to host aggregates and availability zones is
  placed in one of three documents, '/user/availability-zones',
  '/admin/aggregates' and '/admin/availability-zones'. (note that there
  is no '/user/aggregates' document since this is not user-facing)

- References to these features are updated to point to the new location

- A glossary is added. Currently this only contains definitions for host
  aggregates and availability zones

- nova CLI commands are replaced with their openstack CLI counterparts

- Some gaps in related documentation are closed

Change-Id: If847b0085dbfb4c813d4a8d14d99346f8252bc19
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-10-07 17:26:35 +01:00
Takashi NATSUME 6901be694c Update contributor guide for Ussuri
Update URLs for Ussuri release.
Remove some outdated descriptions.

Change-Id: Ibc3568483718da9ae4b2cf0568935cb0a86fa9fc
2019-10-07 12:24:39 +09:00
Zuul 68ed8d85e1 Merge "Update cells v2 up-call caveats doc" 2019-10-04 23:38:42 +00:00
Zuul c7b4048058 Merge "docs: Document global options for nova-manage" 2019-10-04 21:46:55 +00:00
Zuul 5ee7a7d5da Merge "docs: Update resize doc" 2019-10-03 19:44:57 +00:00
Zuul 94501c86fa Merge "docs: Document how to revert, confirm a cold migration" 2019-10-03 19:44:51 +00:00
melanie witt c4d6aabad1 Restore console proxy deployment info to cells v2 layout doc
This information was mistakenly removed when references to the
nova-consoleauth service were removed from the docs in change
Ie96e18ea7762b93b4116b35d7ebcfcbe53c55527.

Closes-Bug: #1846401

Change-Id: I08fa4650d190114775993e8094efbf46b984dfdc
2019-10-02 20:29:52 +00:00
Matt Riedemann a87fbdda9d Update cells v2 up-call caveats doc
With the fix for bug 1781286 for reschedules during server
create and resize/migrate, we can update the cells v2 docs
saying the up-call issue for that big is now fixed.

Change-Id: I9ff116de8b63c0fbfb880008718b1386178b1d1a
Related-Bug: #1781286
2019-10-02 13:44:23 -04:00
Stephen Finucane c24fbc3dc8 docs: Remove a whole load of unused images, most remainder
Thank God. The majority of the removed images are so crufty, it's
actually funny. I don't want to update them and it's unlikely anyone
else does either. The rest are just moved to be with their comrades in
the '_static/images' directory.

Change-Id: I91b34c85379a68be5e6a09ce48b11c0d3343f12b
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-10-02 17:36:21 +01:00
Zuul 2ec3b73f35 Merge "docs: Rework the PCI passthrough guides" 2019-09-27 09:28:40 +00:00
Zuul f57beba5ba Merge "docs: Correct 'nova-manage db sync' documentation" 2019-09-27 09:28:34 +00:00
Zuul 16b85a7ade Merge "docs: Note use of 'nova-manage db sync --config-file'" 2019-09-27 09:18:56 +00:00
Zuul e9872e83a2 Merge "doc: attaching virtual persistent memory to guests" 2019-09-26 11:27:53 +00:00
Zuul bd6a3931f1 Merge "Correct link to placement upgrade notes" 2019-09-25 23:11:37 +00:00
Zuul 518aa008b9 Merge "docs: Update CPU topologies guide to reflect the new PCPU world" 2019-09-25 23:11:15 +00:00
Zuul 8e99edbcf1 Merge "docs: Clarify everything CPU pinning" 2019-09-25 23:11:09 +00:00
LuyaoZhong 7ed5d81a36 doc: attaching virtual persistent memory to guests
Add a document for virtual persistent memory

Change-Id: Ieb8040cd51d322b920ba5525322004c76545b494
Partially-Implements: blueprint virtual-persistent-memory
2019-09-25 16:03:51 -05:00
Zuul 9ae3b0c8ed Merge "docs: Scrub available quotas" 2019-09-25 16:36:10 +00:00
Stephen Finucane 70a4054f86 docs: Update resize doc
- Remove references to configuration options (which end-users will not
  be able to set)
- Switch from the '--confirm' and '--revert' flags to the top-level
  commands
- You can't revert a failed resize so don't suggest otherwise
- Fix some wrapping

Change-Id: I934e7ca327ff4c9bb9b00d1df3323df05da956d9
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Depends-On: I733796d3bda6c3755a3d3548bbe695abb474a6a0
2019-09-25 13:36:26 +00:00
Stephen Finucane 775d89ed0f docs: Document how to revert, confirm a cold migration
This relies on the recently added 'openstack server migrate confirm' and
'openstack server migrate revert' commands.

Change-Id: I58d0a62aeeb4bb23a7ed3a8e9fe5ddb7f2dd3877
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Depends-On: I0cb6304c794bffaec785add9f7b8cf53ab28cacd
2019-09-25 13:36:10 +00:00
Stephen Finucane 50e60401ed docs: Update CPU topologies guide to reflect the new PCPU world
We don't need to do a whole lot here. The key things to note are that
some host level configuration is now necessary, that the 'isolate' CPU
thread policy behaves slightly differently, and that you can request
'PCPU' inventory explicitly instead of using 'hw:cpu_policy=dedicated'
or the image metadata equivalent.

Part of blueprint cpu-resources

Change-Id: Ic1f98ea8a7f6bdc86f2d6b4734774fa380f8cc10
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-25 14:30:23 +01:00
Stephen Finucane ca7c595729 docs: Clarify everything CPU pinning
The documentation for emulator threads leaves a lot to be desired, while
the hierarchy of the CPU thread pinning doesn't emphasise the dependency
of this feature on CPU pinning. Resolve both by tweaking or expanding
the wording of key paragraphs and modifying the header levels to nest
the CPU thread pinning and emulator thread pinning docs under the CPU
pinning docs.

Change-Id: Ife32a53b80b770e008dbe2091fbb88e6596d238b
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-25 14:29:45 +01:00
Chris Dent 98008e048c Correct link to placement upgrade notes
In the depends-on the upgrade notes in placement are moved to a
different URL. Because the link here in nova was to an anchor, not
a URL, a redirect on the placement side will not catch this, so
explicitly update the link.

Depends-On: https://review.opendev.org/683783
Change-Id: Ib07eacb9150bbb8b0726cfe06ae334c7a764955c
2019-09-25 10:26:44 +01:00
Zuul 0ce66605e1 Merge "Add evacuate vs rebuild contributor doc" 2019-09-24 16:51:23 +00:00
Stephen Finucane d5259abfe1 docs: Rework the PCI passthrough guides
Rewrite the document, making the following changes:

- Remove use of bullet points in favour of more descriptive steps
- Cross-reference various configuration options
- Emphasise that ``[pci] alias`` must be set on both controller and
  compute node
- Style nits, such as fixing the header style

Change-Id: I2ac7df7d235f0af25f5a99bc8f6abddbae2cb3af
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-24 17:33:31 +01:00
Stephen Finucane 01541f49b2 docs: Document global options for nova-manage
Document the config options for this, most of which come from
'oslo.config'. Only the '--remote_debug-host' and '--remote_debug-port'
options are not documented since they shouldn't be available for this
command (it's not a service) and will be removed in a later patch.

Change-Id: Ie321268cc56da04ff4111f7c34a29ba23d416e66
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-24 17:18:31 +01:00
Stephen Finucane 62ca2e7ed2 docs: Correct 'nova-manage db sync' documentation
In change I3fd9fe0317bcd1a59c366e60154b095e8df92327, we deprecated the
'--version' option in favour of a 'VERSION' positional. This was later
removed in change I7795e308497de66329f288b43ecfbf978d67ad75. Update the
docs to reflect this. 'nova-manage api_db sync' were already corrected
in change Ibc49f93b8bd51d9a050acde5ef3dc8aad91321ca and does not need
the same fix, though a minor tweak is included.

Change-Id: I2c0fb04fbc3f6d2074596894782ed3143b0c2338
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Closes-Bug: #1840807
2019-09-24 17:18:31 +01:00
Stephen Finucane de0cd7503e docs: Note use of 'nova-manage db sync --config-file'
I forget this every darn time I'm working on something that requires DB
migrations.

Change-Id: I6ca988793cf2bfc2d5938acc158fd94e61e06a92
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2019-09-24 17:18:27 +01:00
Zuul 597b34cd87 Merge "Add note about needing noVNC >= v1.1.0 with using ESX" 2019-09-23 17:24:00 +00:00
Matt Riedemann ddd7273ac3 Add evacuate vs rebuild contributor doc
People often get confused about the differences between
evacuate and rebuild operations, especially since the
conductor and compute methods are both called "rebuild_instance".
This change adds a contributor document which explains some
of the high and low level differences between the two operations.

Change-Id: I146fbc65237c4729ce3c28a4614589ba085dfce0
Closes-Bug: #1843439
2019-09-19 17:55:19 -04:00
melanie witt 2b23ee7a30 Add note about needing noVNC >= v1.1.0 with using ESX
As discussed on the following review:

  https://review.opendev.org/674916

this adds a note indicating that the version of noVNC needs to be at
least v1.1.0 in order for the nova-novncproxy to work with ESX/ESXi
hypervisors.

Related-Bug: #1822676

Change-Id: Ia4ba37b6d6a1e4b5c75e38f4bcc2bea1d9ba9560
2019-09-18 16:59:00 +00:00
Zuul 55439643ad Merge "Deprecate the XenAPIDriver" 2019-09-16 17:39:30 +00:00