summaryrefslogtreecommitdiff
path: root/doc/test
Commit message (Collapse)AuthorAgeFilesLines
* doc: Remove useless contributor/api-2 docStephen Finucane2022-03-231-1/+2
| | | | | | | | There's nothing of use in here. A section on creating extensions for the API is removed since this is no longer a thing. Change-Id: I18a6f642c046051cd6084ab920d78f27887ca13d Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
* docs: Add new architecture guideStephen Finucane2021-10-191-2/+5
| | | | | | | | | | | | | 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>
* docs: Add a new cells v2 documentStephen Finucane2021-10-191-3/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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: Drop references to non-filter scheduler driversStephen Finucane2021-08-231-2/+4
| | | | | | | | 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-171-1/+2
| | | | | | | | | | 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>
* docs: Fold in MDS security flaw docStephen Finucane2021-03-231-0/+1
| | | | | | | | 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>
* Remove 'nova-xvpvncproxy'Stephen Finucane2019-12-231-1/+0
| | | | | | | | | | | | | | | | This legacy service is no longer used and was deprecated during the Stein cycle [1]. It's time to say adios and remove them in their entirety. This is pretty straightforward, with the sole exception of schema for the 'remote-consoles' API, which has to continue supporting requests for type 'xvpvnc' even if we can't fulfil those requests now. [1] https://review.opendev.org/#/c/610076/ Part of blueprint remove-xvpvncproxy Depends-On: https://review.opendev.org/695853 Change-Id: I2f7f2379d0cd54e4d0a91008ddb44858cfc5a4cf Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Merge "doc: remove admin/manage-users"Zuul2019-11-261-0/+1
|\
| * doc: remove admin/manage-usersMatt Riedemann2019-11-251-0/+1
| | | | | | | | | | | | | | | | | | | | The majority if this doc was talking about ec2 concepts which haven't been in nova for a looooong time so this change just deletes the doc and moves the one useful piece into another part of the admin guide and links to the keystone docs. Change-Id: I8d7c9c244767645a5d63716842eaf19ca6ab1a45
* | docs: Rewrite quotas documentationStephen Finucane2019-11-231-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Yet another one of these. This time around, we make the following changes: - Put admin-focused stuff in '/admin', and user-focused docs in '/user' - Merge the '/admin/quotas2' document into the '/admin/quotas' document - Update references to novaclient to use openstackclient if possible and include a TODO if not - s/tenant/project/ Note that there is some duplication between the user and admin docs here. That's necessary since, for example, showing a user's quotas is also something an admin will want to do. Change-Id: I733515cf0f939fe95203ff0b09df2709daee108c Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | Merge "Remove 'nova-console' service, 'console' RPC API"Zuul2019-11-221-1/+0
|\ \ | |/ |/|
| * Remove 'nova-console' service, 'console' RPC APIStephen Finucane2019-11-221-1/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This legacy service was only compatible with the XenServer driver and has effectively been replaced by the noVNC console proxy service. Remove the service. The API that provided remote access to this service, 'os-consoles', was removed in a previous change. Note that 'os-remote-consoles' is unrelated and therefore is not removed, though it will now reject requests for XVP VNC consoles. This was previously discussed and agreed on openstack-dev [1] and openstack-discuss [1]. Part of blueprint remove-xvpvncproxy [1] http://lists.openstack.org/pipermail/openstack-dev/2018-October/135413.html [2] http://lists.openstack.org/pipermail/openstack-discuss/2019-April/005369.html Change-Id: Ib1ff32f04b16af7981471f67c8e0bf04e6ecb6be Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | docs: Replacing underscores with dashesStephen Finucane2019-11-151-0/+1
| | | | | | | | | | | | | | | | | | Not the first time we've done this [1]. Probably not the last. [1] I5c99ff6b04ee97bac210a0d6762015225775c5ee Change-Id: I9fc70df93af73b56ac9155d8d402b153d2af9f4e Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* | docs: Remove 'adv-config', 'system-admin' subdocsStephen Finucane2019-11-151-0/+2
|/ | | | | | | | | | | These made things significantly less discoverable from the admin guide and resulted in some duplication of links. Better to just flatten things. Things are pretty much copy-pasted save for the removal of a reference to the long-dead nova-objectstore service and the addition of a TODO to provide overviews of other services. Change-Id: Ibf2b6979318cf3f0a0519f66acbc279b2ce80968 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* docs: Add redirects for '/user/aggregates'Stephen Finucane2019-10-081-0/+1
| | | | | | | These were missed in change If847b0085dbfb4c813d4a8d14d99346f8252bc19. Change-Id: Iad18f355a20261313ddb3dafd302ed66ebca64bc Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* docs: Rework all things metadata'yStephen Finucane2019-06-201-3/+7
| | | | | | | | | | | | | | | | | | | | | Turns out we've a *lot* of disparate metadata systems. Attempt to both link them somewhat through extensive cross-referencing and extract out deployment-specific stuff from user-facing docs. Lots of changes here, but in summary: - Split out admin-focused content from the metadata API, config drive, user data and vendordata docs. - Merge the config drive, metadata service, vendordata and user-data user docs, which are mostly talking about the same thing and are fairly barren without the deployment components - Make use of various oslo.config and Sphinx roles Side note: I miss when we have tech writers to do this stuff for us :( Change-Id: I4fb2b628bd93358a752e2397ae353221758e2984 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* docs: Remove references to nova-consoleauthStephen Finucane2019-06-171-1/+0
| | | | | | | | | We're going to remove all the code, but first, remove the docs. Part of blueprint remove-consoleauth Change-Id: Ie96e18ea7762b93b4116b35d7ebcfcbe53c55527 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
* Remove cells v1 (for the most part) from the docsMatt Riedemann2019-02-131-1/+1
| | | | | | | | | | | | | | | | | | | | | | As discussed in the mailing list [1] since cells v1 has been deprecated since Pike and the biggest user of it (CERN as far as we know) moved to cells v2 in Queens, we can start rolling back the cells v1 specific documentation to avoid confusing people new to nova about what cells is and making them understand there was an optional v1. There are still a few mentions of cells v1 left in here for things like adding a new cell which need to be re-written and for that I've left a todo. Users can still get at cells v1 specific docs from published stable branches and/or rebuilding the docs from before this change. [1] http://lists.openstack.org/pipermail/openstack-discuss/2019-February/002569.html Change-Id: Idaa04a88b6883254cad9a8c6665e1c63a67e88d3
* Redirect user/placement to placement docsChris Dent2018-12-191-0/+1
| | | | | | | | | | The placement api-ref had a link to user/placement.html in nova. That is being fixed in Ibfe016f25a29b6810ea09c5d03a01dbf3c53371f but the link is now loose in the internets, using the 'latest' prefix, so we want to make sure that what is currently showing as a 404 goes somewhere useful, in this case the top of the placement docs. Change-Id: Ib75547ac655e614441dec5e1bcc7784c2b6a070c
* Remove unnecessary redirectTakashi NATSUME2018-09-281-1/+0
| | | | | | | | | | The cli/nova-idmapshift.html has been removed since Ibce28d20d166da154833376cf51f1877b829925e. Remove the redirect to cli/nova-idmapshift.html because it is useless currently. Change-Id: I57e6285475a31af49a3791c00d5d61deb64438bc
* [doc]remove nova-cert leftover in docjichen2018-05-031-1/+0
| | | | | | | commit f2121f5880d10a2dd1b085575d0f2a60dd2b1512 cleaned up nova-cert, this patched removed remainings in doc Change-Id: I0adf653976ccda77d56a752d3b4408c57621a428
* doc: merge numa.rst to cpu-topologies.rstTetsuro Nakamura2018-02-101-0/+1
| | | | | | | | | The explanation of NUMA topology feature of nova exited in both numa.rst and cpu-topologies.rst under doc/source/admin/. This patch merges them for cleaning up. Change-Id: I35e23b2e1ac55c74faf4f0542498e45f2957e4d3
* add whereto for testing redirect rulesDoug Hellmann2017-10-301-0/+72
Use whereto to test that the redirect rules do what we expect. The test coverage is a bit minimal for now, but should be useful as an example of how it can be extended. The test files in the openstack-manuals repo provide some other examples. Depends-On: I36003d3525dcc9fef8e5f008ecabb2b2ac78088e Change-Id: Ia14bfa6c89fd04844842d727d11ff8874ec7fc2a Signed-off-by: Doug Hellmann <doug@doughellmann.com>