summaryrefslogtreecommitdiff
path: root/doc/source/reference
Commit message (Collapse)AuthorAgeFilesLines
* Merge "doc: Update version info"Zuul2023-05-111-2/+2
|\
| * doc: Update version infoStephen Finucane2023-04-171-2/+2
| | | | | | | | | | | | | | | | The patch to remove legacy migrations merged during the Bobcat cycle, not the Antelope cycle, so the docs need to be updated accordingly. Change-Id: I0d164ff1aaaab8d84116a0210f668330d2f86e7e Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | add hypervisor version weigherSean Mooney2023-04-201-0/+2
|/ | | | | implements: blueprint weigh-host-by-hypervisor-version Change-Id: I36b16a388383c26bdf432030bc9e28b2fd75d120
* db: Remove legacy migrationsStephen Finucane2023-02-011-4/+8
| | | | | | | | | sqlalchemy-migrate does not (and will not) support sqlalchemy 2.0. We need to drop these migrations to ensure we can upgrade our sqlalchemy version. Change-Id: I7756e393b78296fb8dbf3ca69c759d75b816376d Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* Fix typos in nova docsRajesh Tailor2022-09-235-8/+8
| | | | Change-Id: I7b6f8c198aa42f5ef3f8b158308b993b040454ec
* block_device: Add DriverImageBlockDevice to block_device_infoLee Yarwood2022-08-021-7/+2
| | | | Change-Id: I17e0758e3b77caebd4d142664a8367ab4601ebdf
* doc: Split up notifications documentStephen Finucane2022-02-092-370/+9
| | | | | | | | | | | | | This was actually three documents in one: - An admin doc detailing how to configure and use notifications - A contributor doc describing how to extend the versioned notifications - A reference doc listing available versioned notifications Split the doc up to reflect this Change-Id: I880f1c77387efcc3c1e147323b224e10156e0a52 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* Merge "docs: Follow-ups for cells v2, architecture docs"Zuul2022-02-071-0/+8
|\
| * docs: Follow-ups for cells v2, architecture docsStephen Finucane2022-02-031-0/+8
| | | | | | | | | | | | | | | | | | | | Based on review feedback on [1] and [2]. [1] If39db50fd8b109a5a13dec70f8030f3663555065 [2] I518bb5d586b159b4796fb6139351ba423bc19639 Change-Id: I44920f20213462a3abe743ccd38b356d6490a7b4 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* | Merge "docs: Add a new cells v2 document"Zuul2022-02-021-3/+1
|\ \ | |/
| * docs: Add a new cells v2 documentStephen Finucane2021-10-191-3/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | docs: Update libvirt distro support matrix for XenaLee Yarwood2021-11-181-56/+47
| | | | | | | | | | | | | | This is mostly distro updates as our MIN versions didn't change during the cycle. Change-Id: If30d75c8fa96aa6ed7f0483d791d1dea86f58c08
* | api: enable oslo.reports when using uWSGILucian Petrut2021-10-141-4/+27
|/ | | | | | | | | | | At the moment, oslo.reports is enabled when running nova-api standalone, but not when using uWSGI. We're now updating the uwsgi entry point as well to include the oslo.reports hook, which is extremely helpful when debugging deadlocks. Change-Id: I605f0e40417fe9b0a383cc8b3fefa1325f9690d9
* Merge "fup: Remove unused legacy block_device_info format"Zuul2021-08-251-12/+15
|\
| * fup: Remove unused legacy block_device_info formatLee Yarwood2021-08-201-12/+15
| | | | | | | | | | | | | | | | | | As announced on the ML [1] this change removes the now unused legacy format from the codebase and updates the reference docs. [1] http://lists.openstack.org/pipermail/openstack-discuss/2021-August/024116.html Change-Id: I3895b61b436b9bb882477d2d1b3f4907f03b3b1c
* | docs: Drop references to non-filter scheduler driversStephen Finucane2021-08-232-2/+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-173-90/+286
|/ | | | | | | | | | 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>
* Merge "Fix typos in minimum version policy docs"Zuul2021-06-291-7/+7
|\
| * Fix typos in minimum version policy docsPierre Riteau2021-06-111-7/+7
| | | | | | | | Change-Id: If0708fc3594f0e59954976831168c93d66514dd2
* | docs: Add releases to libvirt distro support matrixLee Yarwood2021-05-201-3/+23
|/ | | | | | This change adds Fedora 34, RHEL 8.4, SUSE Leap 15.3 and Ubuntu 21.04. Change-Id: Ifb5588126ac571fe7825f551d3a3dae63cdf6f7a
* docs: Move the LibvirtDistroSupportMatrix wiki page into our docsLee Yarwood2021-02-012-1/+306
| | | | | | | | | | | | | | This change moves the LibvirtDistroSupportMatrix [1] wiki page into the tree as a reference doc. The wiki page will be decommissioned once this change lands and is published. Some older distro information is removed to keep the table readable and a note is added to driver.py to ensure it updated with each version bump. [1] https://wiki.openstack.org/wiki/LibvirtDistroSupportMatrix Change-Id: Id49a4e400159130fbc676800aeca6b9746071a2e
* docs: Add reference docs for internal block device structuresLee Yarwood2021-01-222-0/+227
| | | | | | | | 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
* Add os-volume_attachments reference docsLee Yarwood2020-11-093-0/+71
| | | | | | | | This change adds a simple sequence diagram showing the flow of a volume attachment between the various services, using the libvirt driver as an example virt driver. Change-Id: I631ac9de3d48aa0ad849f6615d0ad2052cb63e80
* hacking: Modify checks for translated logsStephen Finucane2020-05-271-3/+2
| | | | | | | | | | | | | | | | The N319 check previously asserted that debug-level logs were not translated. Now that we've removed all log translations, we can generalize this to all logs. We reuse the same number since these numbers are really just metadata and not public contracts. This also allows us to update the N323 and N326 checks, which ensure we import the translation function, '_', wherever it's used and don't concatenate translated and non-translated strings. Since we're no longer translating logs and the '_LE', '_LW' and '_LI' symbols are no longer provided, we don't need to consider logs in either of these cases. Change-Id: I64d139ad660bc382e8b9d7c8cd03352b26aadafd Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* doc: Fix term mismatch warnings in glossaryTakashi Natsume2020-04-121-1/+1
| | | | | | | | | | | | The term role has became case sensitive since sphinx 3.0.1. It causes the following warnings and makes a check job fail. WARNING: term not in glossary: availability zone This patch fixes the issue. Change-Id: I1f993b503ef769da0950afa206d6ac4a54f903b4 Closes-Bug: #1872260
* doc: define boot from volume in the glossaryMatt Riedemann2020-01-081-0/+10
| | | | | | Define it and also link to the term in a few different docs. Change-Id: I6333deb2f6e85eba3c92128dab4e4b4d35355603
* FUP for docs nits in cross-cell-resize seriesMatt Riedemann2019-12-231-0/+17
| | | | | | | | | | | | | | | | Addresses review comments from: * https://review.opendev.org/#/c/638269/63/doc/source/admin/configuration/resize.rst * https://review.opendev.org/#/c/696212/6/doc/source/admin/configuration/cross-cell-resize.rst Also updates contributor/resize-and-cold-migrate since that is relatively new and biased toward same-cell resize and cold migrate. However, I chose to link the same-cell resize glossary term to that contributor doc rather than admin/configuration/resize because the admin doc is woefully bare. Part of blueprint cross-cell-resize Change-Id: I93b051252e34c8604cebea617c34e9299ac508d4
* Keep pre-commit inline with hacking and fix whitespaceMonty Taylor2019-12-121-3/+3
| | | | | | | | | | | | | | | | | | The flake8 hook for pre-commit installs its own flake8 which is not what hacking is pinned to. This results in a bunch of errors. By doing a local hook we can cause these to be the same. There are flake8 exclusions in tox.ini that need to be used in pre-commit. Also we should exclude svg files from the whitespace modifications, because who cares. Once those are fixed, running pre-commit -a fixes some whitespace issues. While the normal use isn't to run -a - if someone does make a patch that touches any of these they'll get erroneous unrelated errors compared to their lower work - so fix all of the existing issues, which are mostly space-at-end-of-line issues it seems. Change-Id: I78e753492e99c03b30a0a691db3bd75ee3d289c9
* Fix incorrect command examplesericxiett2019-11-261-8/+4
| | | | | | | | | The command of 'openstack resource provider show <HOST1_UUID>' does not return the uuid. This patch fixes it. Then following commands use 'host_id' instead of 'server_id'. Change-Id: I60298ea3b22d9dfec2cd7a3e9950ed04aedc6bf5 Closes-Bug: #1853745
* Merge "Give the policy vision document a facelift"Zuul2019-11-221-93/+128
|\
| * Give the policy vision document a faceliftLance Bragstad2019-03-191-93/+128
| | | | | | | | | | | | | | | | | | This document had a bunch of great content, but some of it has been addressed and other initiatives have changed the content or approach. This commit attempts to refresh this documentation so that developers can continue to use it to improve policy enforcement. Change-Id: Iac7a2157d625524932b94a5564723b440efd7344
* | FUP for Ib62ac0b692eb92a2ed364ec9f486ded05def39adMatt Riedemann2019-11-081-2/+2
| | | | | | | | | | | | | | | | This addresses some nits from that review related to the tense in the docs and no longer valid code comments in the resource tracker. Change-Id: Idde7ef4e91d516b8f225118862e36feda4c8a9d4
* | Drop compat for non-update_provider_tree code pathsMatt Riedemann2019-11-071-9/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | In Train [1] we deprecated support for compute drivers that did not implement the update_provider_tree method. That compat code is now removed along with the get_inventory method definition and (most) references to it. As a result there are more things we can remove but those will come in separate changes. [1] I1eae47bce08f6292d38e893a2122289bcd6f4b58 Change-Id: Ib62ac0b692eb92a2ed364ec9f486ded05def39ad
* | Merge "docs: Remove a whole load of unused images, most remainder"Zuul2019-10-081-1/+1
|\ \
| * | docs: Remove a whole load of unused images, most remainderStephen Finucane2019-10-021-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | | doc: Improve PDF document structureAkihiro Motoki2019-10-081-0/+43
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* | | docs: Rewrite host aggregate, availability zone docsStephen Finucane2019-10-073-2/+33
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Docs for isolated aggregates request filtershilpa2019-09-122-0/+106
| | | | | | | | | | | | | | | | Added reference documentation and release note to explain how filtering of hosts by isolate aggregates works. Change-Id: I8d8086973039308f9041a36463a834b5275708e3 Implements: blueprint placement-req-filter-forbidden-aggregates
* | doc: cleanup references to conductor docMatt Riedemann2019-09-052-0/+74
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The conductor doc is not really end user material, so this moves it under reference/, removes it from the user page and adds it to the reference index for internals. Also makes the contributor page link to the reference internals since it's kind of weird to have one contributor section that only mentions one thing but the internals under reference have a lot more of that kind of detail. Finally, a todo is added so we don't forget to update the reference internals about versioned objects at some point since that's always a point of confusion for people. Change-Id: I8d3dbce5334afaa3e1ca309b2669eff9933a0104
* | Switch some GitHub URLs to point to opendev.orgAdam Spiers2019-08-191-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Also update some outdated URLs at the same time, e.g. defcore is now interop. Unfortunately unlike GitHub, gitea doesn't yet support URLs with shortened SHA1s; however this is being worked on: https://github.com/go-gitea/gitea/issues/6450 Change-Id: I6e6b63619f1138cc961b61be548453361d01f73c
* | Update api-ref locationAndreas Jaeger2019-07-221-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The api documentation is now published on docs.openstack.org instead of developer.openstack.org. Update all links that are changed to the new location. Note that Neutron publishes to api-ref/network, not networking anymore. Note that redirects will be set up as well but let's point now to the new location. For details, see: http://lists.openstack.org/pipermail/openstack-discuss/2019-July/007828.html Change-Id: Id2cf3aa252df6db46575b5988e4937ecfc6792bb
* | doc: Fix a parameter of NotificationPublisherTakashi NATSUME2019-07-101-1/+1
| | | | | | | | | | | | | | | | | | | | | | The 'binary' parameter has been changed to the 'source' since I95b5b0826190d396efe7bfc017f6081a6356da65. But the notification document has not been updated yet. Replace the 'binary' parameter with the 'source' parameter. Change-Id: I141c90ac27d16f2e9c033bcd2f95ac08904a2f52 Closes-Bug: #1836005
* | Fix update_provider_tree signature in reference docsMatt Riedemann2019-06-251-2/+2
| | | | | | | | | | | | | | The migration guide for porting from old methods to upt was missing the allocations kwarg in the code samples. Change-Id: I43fd8d5eeb382d1e5472fa4e9a2f01bd0e4bf243
* | Merge "Change the default of notification_format to unversioned"Zuul2019-06-051-3/+1
|\ \
| * | Change the default of notification_format to unversionedBalazs Gibizer2019-06-041-3/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The default config `both` means that both the legacy and the versioned notifications are emitted. This was selected as default in the past when we thought that this will help the adoption of the versioned interface while we worked on to make that new interface in feature parity with the legacy. Even though the versioned notification interface is in feature parity with the legacy interface since Stein the projects consuming nova notifications do not have the resources to switch to the new interface. In the other hand having `both` as a default in an environtment where only the legacy notifications are consumed causes performance issues in the message bus hence the bug #1805659. The original plan was that we set the default to `versioned` when the interface reaches feature parity but as major consumers are not ready to switch we cannot do that. So the only option left is to set the default to `unversioned`. Related devstack patch: https://review.opendev.org/#/c/662849/ Closes-Bug: #1805659 Change-Id: I72faa356afffb7a079a9ce86fed1b463773a0507
* | | Link versioned notification talk into docsMatt Riedemann2019-05-231-0/+5
| | | | | | | | | | | | | | | | | | | | | This provides a link to gibi's talk from the Train summit on versioned notifications in to the reference docs. Change-Id: I5d0c1fb675bdf2cae699efd733048663e5828699
* | | Add Venn diagram showing taxonomy of traits and capabilitiesAdam Spiers2019-04-261-0/+27
|/ / | | | | | | | | | | | | | | | | | | | | This was put together while working on the mechanism for converting driver capabilities to traits in I15364d37fb7426f4eec00ca4eaf99bec50e964b6: https://review.openstack.org/538498 and may help other developers working on this area in the future. Change-Id: I395e386ee713769d4c105be0dd6e821382945866
* | Replace git.openstack.org URLs with opendev.org URLsZhongShengping2019-04-243-11/+11
| | | | | | | | | | | | | | Thorough replacement of git.openstack.org URLs with their opendev.org counterparts. Change-Id: I3e0af55e0707f04428a422b973d016ad30c82a12
* | Add docs on what not to include in notificationsMatt Riedemann2019-04-041-0/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Based on bug 1823104 it's clear we should have some explicit wording in the notification reference docs about what not to include in versioned notification payloads, so this change attempts to start that with the most obvious thing - don't expose access credentials to the nova deployment. This also adds a reminder to think about what is being added / mirrored from internal objects and determine if consumers really need it and if they aren't asking, opt to not including it until requested. Change-Id: I326aa39d963091282a5d0b70ba222abfe8ccfdac Related-Bug: #1823104
* | Merge "Remove "Fixing the Scheduler DB model" from schedule evolution doc"Zuul2019-03-201-11/+0
|\ \ | |/ |/|
View Lorry Controller Status