From d2d57acbf59d04f7cc9c7a7ee34d5b2a8be3be1a Mon Sep 17 00:00:00 2001 From: Sean Dague Date: Thu, 10 Aug 2017 14:42:13 -0400 Subject: [PATCH] doc: Address review comments for main index Per comments in I6815958b2533d462a2e5d27e7be57440d9f4f40a and I5fdafd9f6cf07a19bf86a6343663dad410887dcb. Part of bp: doc-migration Change-Id: Iac833503b57386ab91fa86f8c48f0dd8039e5922 --- doc/source/index.rst | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index e20c74f8ae..f109b1413f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -23,16 +23,18 @@ What is nova? ============= Nova is the OpenStack project that provides a way to provision compute -instances (either VMs or Baremetal) on hardware or hypervisors. Nova runs as a -set of daemons on top of existing Linux servers to provide that service. +instances (aka virtual servers). Nova supports creating virtual machines, +baremetal servers (through the use of ironic), and has limited support for +system containers. Nova runs as a set of daemons on top of existing Linux +servers to provide that service. It requires the following additional OpenStack services for basic function: -* `Keystone `_: This provides - identity and authentication for all OpenSack services. -* `Glance `_: This provides the +* `Keystone `__: This provides + identity and authentication for all OpenStack services. +* `Glance `__: This provides the compute image repository. All compute instances launch from glance images. -* `Neutron `_: This is +* `Neutron `__: This is responsible for provisioning the virtual or physical networks that compute instances connect to on boot. @@ -83,7 +85,7 @@ resources will help you get started with consuming the API directly. compute 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 it's own deep dive. + specific block devices to computes. This deserves its own deep dive. For Operators ============= @@ -100,7 +102,11 @@ Installation .. TODO(sdague): links to all the rest of the install guide pieces. The detailed install guide for nova. A functioning nova will also require -having installed keystone, glance, and neutron. +having installed `keystone +`__, `glance +`__, and `neutron +`__. Please ensure that you +follow their install guides first. .. toctree:: :maxdepth: 2 @@ -128,10 +134,10 @@ 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. -* :doc:`Placement service `: Overview of the new 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. + WSGI container instead of the baked-in eventlet web server. Maintenance ----------- @@ -152,12 +158,12 @@ Once you are running nova, the following information is extremely useful. * :doc:`Aggregates `: Aggregates are a useful way of grouping hosts together for scheduling purposes. * :doc:`Filter Scheduler `: How the filter scheduler is - configured, and how that will impact where computes land in your + configured, and how that will impact where compute instances land in your environment. If you are seeing unexpected distribution of compute instances in your hosts, you'll want to dive into this configuration. * :doc:`Exposing custom metadata to compute instances `: How and when you might want to extend the basic metadata exposed to compute instances - (either via metadata server or config drive) for site local purposes. + (either via metadata server or config drive) for your specific purposes. Reference Material ------------------