4299 Commits

Author SHA1 Message Date
Zuul
a8eb79804d Merge "docs: Add man pages for 'nova-policy'" 2021-04-21 18:05:08 +00:00
Stephen Finucane
bab3c8f3cb Remove references to 'sys.version_info'
We support Python 3.6 as a minimum now, making these checks no-ops.

Change-Id: I5ca2439c948687022f8d88df978bc7ee77199fcc
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-04-21 12:02:27 +01:00
Zuul
5ea4f712c5 Merge "docs: Correct typos in 'nova-manage cells_v2' docs" 2021-04-19 22:17:50 +00:00
Stephen Finucane
f8e68ddcd9 docs: Document location of nova.conf files
Turns out oslo.config actually supports executable-specific
configuration files as well as directories of configuration files. Who
knew?

Change-Id: Ifb71a45ed4df3c9cacd2193beed904f948f5cdc8
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-04-19 10:47:21 +01:00
Stephen Finucane
b5edc294a1 docs: Add man pages for 'nova-policy'
I don't actually grok what this does that 'oslopolicy-checker' couldn't
do, so perhaps we can deprecate this in the future. For now though,
simply document the thing. While we're here, we make some additional
related changes:

- Remove references to the 'policy.yaml' file for services that don't
  use policy (i.e. everything except the API services and, due to a bug,
  the nova-compute service).
- Update remaining references to the 'policy.yaml' file to include the
  'policy.d/' directory
- Update the help text for the '--api-name' and '--target' options of
  the 'nova-policy policy check' command to correct tense and better
  explain their purpose.

Also, yes, 'nova-policy policy check' is dumb. Don't blame me :)

Change-Id: I913b0de9ec40a615da7bf9981852edef4a88fecb
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Related-bug: #1675486
2021-04-19 10:47:17 +01:00
Zuul
18607a9bb7 Merge "Update contributor guide for Xena" 2021-04-16 15:31:14 +00:00
Stephen Finucane
9e5feb051c docs: Populate "See Also" section with meaningful links
Change-Id: I28dbbb22f1752081615722a3932394741654a9da
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-04-13 17:22:24 +01:00
Stephen Finucane
99e5a1ac9a docs: Document options for remaining nova-* commands
Most of these share the same collection of oslo.config and oslo.log
options so it makes sense to group them together. The only exception is
nova-rootwrap, which is a wrapper around the 'oslo_rootwrap.cmd.main'
module, which curiously does not use argparse and doesn't have any
options.

Change-Id: I393ff162be58700956fbab29ff6b9ba3cf5860a6
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-04-13 17:17:27 +01:00
Takashi Natsume
eaf6a828df Update contributor guide for Xena
Change-Id: I6415e6d62eabf4c178dc3ac0a2f606403b44ebe8
Signed-off-by: Takashi Natsume <takanattie@gmail.com>
2021-04-11 07:49:08 +00:00
Zuul
0a46979070 Merge "docs: Add CPU models guide" 2021-04-08 20:04:28 +00:00
Zuul
b6ae7c392b Merge "docs: Change 'add_stylesheet' to 'add_css_file'" 2021-04-08 20:04:04 +00:00
Zuul
50fdbc752a Merge "docs: Rewrite 'nova-manage libvirt' docs" 2021-04-01 11:57:40 +00:00
Zuul
47833ecb22 Merge "docs: Rewrite 'nova-manage placement' docs" 2021-04-01 11:56:47 +00:00
Zuul
56c85a1961 Merge "docs: Rewrite 'nova-manage api_db', 'cell_v2' docs" 2021-04-01 11:55:56 +00:00
Zuul
7c5a93482b Merge "docs: Rewrite 'nova-manage db' docs to use proper directives" 2021-04-01 11:54:48 +00:00
Zuul
fdd96de20d Merge "doc: Use a non-numerical anchor when referencing microversions" 2021-03-31 17:50:35 +00:00
Stephen Finucane
03ff08c7fe docs: Correct typos in 'nova-manage cells_v2' docs
Per review feedback.

Change-Id: Ib14c8901920a0844d22674b768bc543a10298c4b
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-31 12:01:17 +01:00
Stephen Finucane
96bf8a0ab5 docs: Correct typos in 'nova-manage db' docs
Per review feedback.

Change-Id: Id157e3614bfe9adca44e6ca0adc56e3ae9efee59
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-31 11:37:25 +01:00
Zuul
db80aa3d4b Merge "docs: Use proper headers in nova-manage man page" 2021-03-31 09:42:53 +00:00
Zuul
fbcfc3e544 Merge "docs: Clarify value for 'hw:cpu_realtime' extra spec" 2021-03-31 07:23:55 +00:00
Stephen Finucane
fe3a04be80 docs: Rewrite 'nova-manage libvirt' docs
Change-Id: Ice641a8ce2658e0df4eea08f527fe7813617218f
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-30 12:21:12 +01:00
Stephen Finucane
5f6aae3753 docs: Rewrite 'nova-manage placement' docs
Change-Id: Ie973de1eb411db6379b544987b55199913eb62b6
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-30 12:21:12 +01:00
Stephen Finucane
2f8ab439a7 docs: Rewrite 'nova-manage api_db', 'cell_v2' docs
Change-Id: I82c718cdf2134005d0a1639072cefe037da78f15
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-30 12:21:12 +01:00
Stephen Finucane
cefa8e0938 docs: Rewrite 'nova-manage db' docs to use proper directives
We have them. Let's use them. The resulting man pages aren't perfect,
but they're *much* better.

Change-Id: I84d54a246fecbd2f7d2950d6c6044f7cd1b8e9df
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2021-03-30 12:18:03 +01:00
Stephen Finucane
59e2b38c80 docs: Use proper headers in nova-manage man page
This is step one in improving the usability of these docs. The current
style makes it impossible to link to individual commands from the built
docs. There is a better way. Use headers along with code blocks to show
the actual command. This was mostly generated from a find-replace along
with some follow-up manual fixes.

Change-Id: Icd25006f31c8e34fe33d79779e0577dc78f96a24
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-30 11:23:44 +01:00
Stephen Finucane
5c396c19cf docs: Follow up for SEV doc
Based on sean-k-mooney's feedback.

Change-Id: Idc3c896c4872a2a431493589fd580bcd688ba567
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-30 11:16:38 +01:00
Zuul
d44ce25f15 Merge "docs: Add SEV guide" 2021-03-25 13:48:36 +00:00
Zuul
f4f0f8eea1 Merge "docs: Remove duplicated PCI passthrough extra spec info" 2021-03-25 13:47:27 +00:00
Zuul
232fa8bca1 Merge "docs: Remove duplicate TPM extra spec info" 2021-03-25 13:46:15 +00:00
Zuul
ad6882b45b Merge "docs: Add a real-time guide" 2021-03-25 13:45:03 +00:00
Zuul
a086a88cd1 Merge "docs: Add a resource limits guide" 2021-03-24 13:26:39 +00:00
Zuul
a337c1de91 Merge "docs: Add note about rescuing bfv instances with the 2.87 microversion" 2021-03-24 13:23:49 +00:00
Zuul
4d9b363be9 Merge "docs: Add version{added,changed} notes to the hw_machine_type guide" 2021-03-24 13:23:05 +00:00
Stephen Finucane
e89125a422 docs: Clarify value for 'hw:cpu_realtime' extra spec
Per review feedback.

Change-Id: I663ccd3ff737fb384e0b39f920c406367aea55e1
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-24 12:50:12 +00:00
Lee Yarwood
387a5753de doc: Use a non-numerical anchor when referencing microversions
As called out in the review for
Ib7b9f4fd7673525129c03dc2943deedd0c7ad81f the use of a numerical anchor
causes a sequence id to be used that can change over time in the
document and thus is not stable to reference externally.

This change simply switches to a non-numerical anchor ensuring that
sphinx generates a stable anchor we can always reference.

Change-Id: I550f7fd89a13e58031b0ddfbcb4f6a5239dbf335
2021-03-24 12:18:59 +00:00
Stephen Finucane
9dfac32959 docs: Add libvirt misc doc
A new dumping ground for libvirt'y things that can't easily be
categorized or placed elsewhere.

Change-Id: I6999b9d66e12e1df7970aff6ce63e5323de6be45
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Related-Bug: #1843542
2021-03-23 11:17:10 +00:00
Stephen Finucane
76549775fe docs: Change formatting of hypervisor config guides
Use the formatting established in the style guide. There's a lot of
out-of-date information in here, but that's a battle for another day.

Change-Id: Ieec2c8f450c05a2451179e3bdba77514f2cc956e
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:16:42 +00:00
Stephen Finucane
04b8693703 docs: Fold in MDS security flaw doc
There's no real need for this to exist as its own standalone document
now that we have a separate CPU models doc. Combine them.

Change-Id: I3a3e19b1f2660dd773fd3d47332abadc0c0e5c55
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:16:14 +00:00
Stephen Finucane
be03ca7be7 docs: Clarify host-model, host-passthrough differences
Based on review feedback from kashyap.

Change-Id: Ief5debad29c10a0903f70d68d5bee21b4c1424b0
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:15:32 +00:00
Stephen Finucane
ee1443bb3f docs: Add CPU models guide
More information taken out of the catchall KVM guide and put into its
own doc, where it belongs.

Change-Id: I4a03561368b945e3aacbef8011b46933cc1fcfd7
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:14:09 +00:00
Stephen Finucane
49767beaa9 docs: Add SEV guide
This was previously hidden in the hypervisor configuration guide. Make
it a top-level document.

Change-Id: If402522c859c1413f0d90912e357496a0a67c5cf
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:13:34 +00:00
Stephen Finucane
c5ebaef610 docs: Remove duplicated PCI passthrough extra spec info
There's also a PCI passthrough guide. Use that instead, allowing us to
remove the sections for various extra specs from the 'user/flavors'
guide:

- hw:pci_numa_affinity_policy
- pci_passthrough:alias

Change-Id: I5701d284c2cfdadf825f8e2f699651b3f8c0c9ab
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:13:01 +00:00
Stephen Finucane
94c03e8d66 docs: Remove duplicate TPM extra spec info
We have a perfectly good TPM guide. Enhance that, allowing us to remove
the special section dedicated to this from the generic flavor docs.

Change-Id: If484074c01595f747f9201b5ec12164779195b61
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:12:29 +00:00
Stephen Finucane
777c02485f docs: Add a real-time guide
This beefy patch closes a long-standing TODO and allows us to move yet
more information out of the flavors guide and into specific documents.
This, combined with existing documentation in place, means we can remove
the sections for various extra specs from the 'user/flavors' guide:

- hw:cpu_realtime            -> doc/source/admin/real-time.rst
- hw:cpu_realtime_mask       -> doc/source/admin/real-time.rst
- hw:emulator_threads_policy -> doc/source/admin/cpu-topologies.rst
- hw:cpu_policy              -> doc/source/admin/cpu-topologies.rst
- hw:cpu_thread_policy       -> doc/source/admin/cpu-topologies.rst
- hw:cpu_sockets             -> doc/source/admin/cpu-topologies.rst
- hw:cpu_cores               -> doc/source/admin/cpu-topologies.rst
- hw:cpu_threads             -> doc/source/admin/cpu-topologies.rst
- hw:cpu_max_sockets         -> doc/source/admin/cpu-topologies.rst
- hw:cpu_max_cores           -> doc/source/admin/cpu-topologies.rst
- hw:cpu_max_threads         -> doc/source/admin/cpu-topologies.rst
- hw:numa_nodes              -> doc/source/admin/cpu-topologies.rst
- hw:numa_cpus.N             -> doc/source/admin/cpu-topologies.rst
- hw:numa_mem.N              -> doc/source/admin/cpu-topologies.rst
- hw:mem_page_size           -> doc/source/admin/huge-pages.rst

Multiple improvements to the libvirt extra spec docs are included here,
for want of a better place to include them.

Change-Id: I02b044f8246f4a42481bb5f00259842692b29b71
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 11:11:52 +00:00
Stephen Finucane
8528eaa602 docs: Add a resource limits guide
This is mostly regurgitated information from the current flavors guide
but we take the opportunity to significantly expand upon what we've
already stated here.

Change-Id: I9ad798427bbc6451fd920d6c08357d6e1eaa5136
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-23 10:37:30 +00:00
Stephen Finucane
4f1b879a68 docs: Change 'add_stylesheet' to 'add_css_file'
We're seeing a warning in our docs build:

  nova/doc/ext/feature_matrix.py:578: RemovedInSphinx40Warning: The
  app.add_stylesheet() is deprecated. Please use app.add_css_file()
  instead.

Do as it says. This deprecation happened in Sphinx v1.8.0 [1] so there's
no need to bump our minimum version.

[1] https://github.com/sphinx-doc/sphinx/commit/3afc72fba4

Change-Id: I75d7b2e1a6771ebdb05972e29033505391587512
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-18 17:31:35 +00:00
Josephine Seifert
5d5ff82bab Add config parameter 'live_migration_scheme' to live migration with tls guide
This patch adds the config option 'live_migration_scheme = tls' to the
secure live migration guide.

To let the live migration use the qemu native tls, some configuration of
the compute nodes is needed. The guide describes this but misses the
'live_migration_scheme' config option.

It is necessary to set 'live_migration_scheme' to tls to use the
connection uri for encrypted traffic. Without this parameter everything
seems to work, but the unencrypted tcp-connection is still used for the
live migration.

Closes-Bug: #1919357
Change-Id: Ia5130d411706bf7e1c983156158011a3bc6d5cd6
2021-03-17 11:31:54 +01:00
Zuul
2dc26edfc5 Merge "docs: Document UEFI secure boot feature" 2021-03-16 11:49:51 +00:00
Stephen Finucane
f4c249c692 docs: Document UEFI secure boot feature
Introduce two new guides on UEFI and Secure Boot. In addition, update
the flavors guide to document the secure boot feature (though this doc
should really be removed in near term in favour of the auto-generated
docs, as noted inline).

Note that this change includes our first use of the ':nova:extra-spec:'
cross-reference role and highlights a small bug in that implementation.
This is resolved.

Blueprint: allow-secure-boot-for-qemu-kvm-guests
Change-Id: I4eb370b87ba8d0403c8c0ef038a909313a48d1d6
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2021-03-12 17:42:02 +00:00
Lee Yarwood
ff3fd84636 docs: Add note about rescuing bfv instances with the 2.87 microversion
This was somehow missed when we landed the stable rescue doc updates in
Iaa2f27ccb2a77102fde6b24b76c9d5ae54608cca.

Change-Id: Ib7b9f4fd7673525129c03dc2943deedd0c7ad81f
2021-03-11 09:43:18 +00:00