summaryrefslogtreecommitdiff
path: root/doc/source/user
Commit message (Collapse)AuthorAgeFilesLines
* Support multiple config file with mod_wsgiSean Mooney2022-12-071-4/+10
| | | | | | | | | | | | | | | | | | | | Unlike uwsgi, apache mod_wsgi does not support passing commandline arguments to the python wsgi script it invokes. As a result while you can pass --config-file when hosting the api and metadata wsgi applications with uwsgi there is no way to use multiple config files with mod_wsgi. This change mirrors how this is supported in keystone today by intoducing a new OS_NOVA_CONFIG_FILES env var to allow operators to optional pass a ';' delimited list of config files to load. This change also add docs for this env var and the existing undocumented OS_NOVA_CONFIG_DIR. Closes-Bug: 1994056 Change-Id: I8e3ccd75cbb7f2e132b403cb38022787c2c0a37b
* Fix typos in nova docsRajesh Tailor2022-09-232-3/+3
| | | | Change-Id: I7b6f8c198aa42f5ef3f8b158308b993b040454ec
* Add API support for rebuilding BFV instancesDan Smith2022-08-311-0/+20
| | | | | | | | | | | | | This adds a microversion and API support for triggering a rebuild of volume-backed instances by leveraging cinder functionality to do so. Implements: blueprint volume-backed-server-rebuild Closes-Bug: #1482040 Co-Authored-By: Rajat Dhasmana <rajatdhasmana@gmail.com> Change-Id: I211ad6b8aa7856eb94bfd40e4fdb7376a7f5c358
* Adds img_config_drive in nova users docsAmit Uniyal2022-08-051-0/+11
| | | | | | | | Added img_config_drive property usuage in nova users config drive docs Closes-Bug: #1879066 Change-Id: I56be0b6cda51447813c0a97b01ccb48d0c898c20
* Remove the PowerVM driverStephen Finucane2022-08-023-104/+0
| | | | | | | | | | | | | | The PowerVM driver was deprecated in November 2021 as part of change Icdef0a03c3c6f56b08ec9685c6958d6917bc88cb. As noted there, all indications suggest that this driver is no longer maintained and may be abandonware. It's been some time and there's still no activity here so it's time to abandon this for real. This isn't as tied into the codebase as the old XenAPI driver was, so removal is mostly a case of deleting large swathes of code. Lovely. Change-Id: Ibf4f36136f2c65adad64f75d665c00cf2de4b400 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Merge "docs: Add new architecture guide"Zuul2022-02-032-135/+9
|\
| * docs: Add new architecture guideStephen Finucane2021-10-192-135/+9
| | | | | | | | | | | | | | | | | | | | | | | | | | As with the cells v2 docs before this, we have a number of architecture focused documents in tree. The 'user/architecture' guide is relatively up-to-date but is quite shallow, while the 'admin/arch' guide is in-depth but almost a decade out-of-date, with references to things like nova's in-built block storage service. Replace most of the latter with more up-to-date information and the merge the former into it, before renaming the file to 'admin/architecture'. Change-Id: I518bb5d586b159b4796fb6139351ba423bc19639 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | Merge "docs: Add a new cells v2 document"Zuul2022-02-024-1175/+4
|\ \ | |/
| * docs: Add a new cells v2 documentStephen Finucane2021-10-194-1175/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We currently have three cells v2 documents in-tree: - A 'user/cellsv2-layout' document that details the structure or architecture of a cells v2 deployment (which is to say, any modern nova deployment) - A 'user/cells' document, which is written from a pre-cells v2 viewpoint and details the changes that cells v2 *will* require and the benefits it *would* bring. It also includes steps for upgrading from pre-cells v2 (that is, pre-Pike) deployment or a deployment with cells v1 (which we removed in Train and probably broke long before) - An 'admin/cells' document, which doesn't contain much other than some advice for handling down cells Clearly there's a lot of cruft to be cleared out as well as some centralization of information that's possible. As such, we combine all of these documents into one document, 'admin/cells'. This is chosen over 'users/cells' since cells are not an end-user-facing feature. References to cells v1 and details on upgrading from pre-cells v2 deployments are mostly dropped, as are some duplicated installation/configuration steps. Formatting is fixed and Sphinx-isms used to cross reference config option where possible. Finally, redirects are added so that people can continue to find the relevant resources. The result is (hopefully) a one stop shop for all things cells v2-related that operators can use to configure and understand their deployments. Change-Id: If39db50fd8b109a5a13dec70f8030f3663555065 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | Update Interop docMartin Kopec2021-11-081-1/+1
|/ | | | | | | | The commit replaces DefCore committee (a former name) by Interop Working Group (the current name) and updates a few more old interop references. Change-Id: I578a21d610b5b680b4549bf34e1857307a1b8e74
* docs: Drop references to non-filter scheduler driversStephen Finucane2021-08-233-642/+2
| | | | | | | | Take the opportunity to clean up the docs quite a bit, ultimately combining two disparate guides on the scheduler into one. Change-Id: Ia72d39b4774d93793b381359b554c717dc9a6994 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* docs: Add documentation on database migrationsStephen Finucane2021-08-172-365/+0
| | | | | | | | | | Alembic does lots of new things. Provide docs for how to use this. We also improve upgrade docs slightly, removing references to ancient reviews that are no longer really helpful as well as calling out our N -> N+1 constraint. Change-Id: I3760b82ce3bd71aa0a760d7137d69dfa3f29dc1d Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* db: Move remaining 'nova.db.sqlalchemy' modulesStephen Finucane2021-08-091-1/+1
| | | | | | | | The two remaining modules, 'api_models' and 'api_migrations', are moved to the new 'nova.db.api' module. Change-Id: I138670fe36b07546db5518f78c657197780c5040 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* Merge "db: Move main DB migrations"Zuul2021-08-061-1/+1
|\
| * db: Move main DB migrationsStephen Finucane2021-07-051-1/+1
| | | | | | | | | | | | | | | | We place these in a 'legacy_migrations' directory, as we will soon be adding alembic-based migrations in a 'migration' directory. Change-Id: Ib927e4c48f59a467a913875111ffbf64ffe0de90 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | Merge "docs: Add libvirt misc doc"Zuul2021-07-271-97/+0
|\ \
| * | docs: Add libvirt misc docStephen Finucane2021-03-231-97/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | docs: Replace 'nova boot' with 'openstack server create'Stephen Finucane2021-07-071-241/+260
| |/ |/| | | | | | | | | | | | | | | | | | | Replace references to novaclient with OSC in the boot from volume guide. This is essentially a revert of commit aa3964118, which was a revert of an earlier attempt at doing this that fell down because it didn't reflect the changes in CLI parameters between the different tools. Change-Id: Ic99440dd618243517f64506e3da88885fc2c44c9 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | docs: Remove duplicate ToC entryStephen Finucane2021-05-311-1/+0
| | | | | | | | | | Change-Id: Idf9c2cb27b3421174b686ca97233281ea7168970 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | Merge "doc: Use a non-numerical anchor when referencing microversions"Zuul2021-03-311-1/+1
|\ \
| * | doc: Use a non-numerical anchor when referencing microversionsLee Yarwood2021-03-241-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | Merge "docs: Add SEV guide"Zuul2021-03-251-12/+0
|\ \ \ | | |/ | |/|
| * | docs: Add SEV guideStephen Finucane2021-03-231-12/+0
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge "docs: Remove duplicated PCI passthrough extra spec info"Zuul2021-03-251-73/+0
|\ \ \ | |/ /
| * | docs: Remove duplicated PCI passthrough extra spec infoStephen Finucane2021-03-231-73/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge "docs: Remove duplicate TPM extra spec info"Zuul2021-03-251-23/+0
|\ \ \ | |/ /
| * | docs: Remove duplicate TPM extra spec infoStephen Finucane2021-03-231-23/+0
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge "docs: Add a real-time guide"Zuul2021-03-251-291/+0
|\ \ \ | |/ /
| * | docs: Add a real-time guideStephen Finucane2021-03-231-291/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge "docs: Add a resource limits guide"Zuul2021-03-241-209/+0
|\ \ \ | |/ /
| * | docs: Add a resource limits guideStephen Finucane2021-03-231-209/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | Merge "docs: Add note about rescuing bfv instances with the 2.87 microversion"Zuul2021-03-241-0/+7
|\ \ \ | |/ / |/| / | |/
| * docs: Add note about rescuing bfv instances with the 2.87 microversionLee Yarwood2021-03-111-0/+7
| | | | | | | | | | | | | | This was somehow missed when we landed the stable rescue doc updates in Iaa2f27ccb2a77102fde6b24b76c9d5ae54608cca. Change-Id: Ib7b9f4fd7673525129c03dc2943deedd0c7ad81f
* | Merge "docs: Document UEFI secure boot feature"Zuul2021-03-161-88/+100
|\ \
| * | docs: Document UEFI secure boot featureStephen Finucane2021-03-121-88/+100
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | pci: implement the 'socket' NUMA affinity policyArtom Lifshitz2021-03-101-1/+20
|/ | | | | | | | | | This patch enables the 'socket' PCI NUMA affinity policy. The PCI manager gets a new method to implement it, and the libvirt driver starts reporting the necessary trait, enabling it to receive instances with the 'socket' policy. Implements: blueprint pci-socket-affinity Change-Id: Ia875c9c3542ef4138d0d7a2c26c0cf49dcca0761
* Merge "libvirt: Drop support for Xen"Zuul2021-01-275-95/+1
|\
| * libvirt: Drop support for XenStephen Finucane2021-01-225-95/+1
| | | | | | | | | | | | | | | | | | | | This hasn't been validated upstream and there doesn't appear to be anyone using it. It's time to drop support for this. This is mostly test and documentation damage, though there is some other cleanup going on, like the removal of the essentially noop 'pick_disk_driver_name' helper. Change-Id: I73305e82da5d8da548961b801a8e75fb0e8c4cf1 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | Merge "libvirt: Drop support for UML"Zuul2021-01-271-4/+0
|\ \ | |/
| * libvirt: Drop support for UMLStephen Finucane2021-01-221-4/+0
| | | | | | | | | | | | | | | | This has not been tested in the gate for a long time and was only added to enable CI in the early days of OpenStack. Time to bid adieu. Change-Id: I7a157f37d2a67e1174a1725fd579c761d81a09b1 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | docs: Add reference docs for internal block device structuresLee Yarwood2021-01-221-2/+5
|/ | | | | | | | It's time to shine a light on this area of the codebase ahead of some much required cleanup. This documentation is based on an email sent almost 5 years ago but is still accurate today. Change-Id: I66cc2c5549833f269872748fb1532438f9ba8489
* Docs: correct cpu_thread_policy explanationArtom Lifshitz2020-12-021-10/+7
| | | | | | | | | | With the landing of the cpu-resources series in train [1], the hw:cpu_thread_policy extra spec has a different effect than before. Correct our documentation. [1] https://review.opendev.org/q/topic:bp/cpu-resources Change-Id: I338408b01b1d2328035dd92d2588710a20aba323
* docs: Make JSON validStephen Finucane2020-10-231-22/+3
| | | | | | | | | | | | | | | | Pygments 2.7.x is stricter in how it validates JSON escapes, aligning it closer with the spec [1]. Turns out we have some invalid JSON in our docs, meaning builds are now failing with the following error: doc/source/user/metadata.rst:262: WARNING: Could not lex literal_block as "json". Highlighting skipped. Resolve this. [1] https://github.com/pygments/pygments/commit/9514e794e0c2a5c7c048df97fcfef4a099e05ac3 Change-Id: Ic50e29e9c7817744ad0b4f9de309aa3e96a09505 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* Merge "docs: fix aggregate weight multiplier property names"Zuul2020-09-221-8/+8
|\
| * docs: fix aggregate weight multiplier property namesMark Goddard2020-08-241-8/+8
| | | | | | | | | | | | | | | | | | | | The documentation states that property names for aggregate weight multipliers should be prefixed with 'filter_scheduler.', however in reality they should not. This change fixes this in the documentation. Change-Id: I3adabb052a859cccf59655c91cc366fbe1cf8386
* | Merge "docs: Remove references to XenAPI driver"Zuul2020-09-104-96/+6
|\ \
| * | docs: Remove references to XenAPI driverStephen Finucane2020-08-314-96/+6
| | | | | | | | | | | | | | | | | | | | | | | | Not as many of these as I thought there would be. Also, yes, the change to 'nova.conf.compute' is a doc change :) Change-Id: I27626984ce94544bd81d998c5fdf141875faec92 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | | Merge "doc: Add IPv6 metadata address"Zuul2020-09-041-2/+18
|\ \ \ | |/ / |/| |
| * | doc: Add IPv6 metadata addressBence Romsics2020-08-041-2/+18
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | The metadata service is going to be accessible over IPv6 too when the following Neutron feature merges (still in Victoria, I hope): https://bugs.launchpad.net/neutron/+bug/1460177 However all end-user facing metadata documentation is in Nova, so unless we want to refactor/move this, let me propose this doc change here. Change-Id: I7e67680090da003e01e106be47b7a807164fecb3 Partial-Bug: #1460177
* | Merge "docs: Add docs for vTPM support"Zuul2020-08-262-0/+49
|\ \
View Lorry Controller Status