From 547cd3b3820981fddba5b220aaaca1761d2e8fec Mon Sep 17 00:00:00 2001 From: Chris Dent Date: Thu, 3 Jan 2019 12:50:23 +0000 Subject: [PATCH] Update nova docs front page for placement removal Remove links to internal placement documentation. Instead indicate that placement is required by nova, and point elsewhere. The depends-on adds placement install docs to the placement repo. Depends-On: https://review.openstack.org/628220 Change-Id: I9f0d52e7b46b270363946211cf6dc0c338981cb2 --- doc/source/index.rst | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index a95c35725064..acd4ed9ed462 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -36,6 +36,9 @@ It requires the following additional OpenStack services for basic function: compute instances launch from glance images. * :neutron-doc:`Neutron <>`: This is responsible for provisioning the virtual or physical networks that compute instances connect to on boot. +* :placement-doc:`Placement <>`: This is responsible for tracking inventory of + resources available in a cloud and assisting in choosing which provider of + those resources will be used when creating a virtual machine. It can also integrate with other services to include: persistent block storage, encrypted disks, and baremetal compute instances. @@ -78,15 +81,6 @@ resources will help you get started with consuming the API directly. `_. This provides the history of all those changes. Consider it a "what's new" in the compute API. -* `Placement API Reference `_: - The complete reference for the placement API, including all methods and - request / response parameters and their meaning. -* :placement-doc:`Placement API Microversion History - `: - The placement API evolves over time through `Microversions - `_. This - provides the history of all those changes. Consider it a "what's new" in the - placement API. * :doc:`Block Device Mapping `: One of the trickier parts to understand is the Block Device Mapping parameters used to connect specific block devices to computes. This deserves its own deep dive. @@ -114,8 +108,9 @@ Installation The detailed install guide for nova. A functioning nova will also require having installed :keystone-doc:`keystone `, :glance-doc:`glance -`, and :neutron-doc:`neutron `. Ensure that you follow -their install guides first. +`, :neutron-doc:`neutron `, and +:placement-doc:`placement `. Ensure that you follow their install +guides first. .. toctree:: :maxdepth: 2 @@ -143,8 +138,6 @@ the defaults from the :doc:`install guide ` will be sufficient. * :doc:`Cells v2 Planning `: For large deployments, Cells v2 allows sharding of your compute environment. Upfront planning is key to a successful Cells v2 layout. -* :placement-doc:`Placement service <>`: Overview of the placement service, - including how it fits in with the rest of nova. * :doc:`Running nova-api on wsgi `: Considerations for using a real WSGI container instead of the baked-in eventlet web server.