From 8b072d75322cd345f876b6333fba5cd4acd0e03d Mon Sep 17 00:00:00 2001 From: Sean Dague Date: Tue, 8 Aug 2017 10:43:56 -0400 Subject: [PATCH] rework index intro to describe nova The index previously was written for the developer docs, but this is more than developer docs now. That also means this is the general google landing page for people, so a basic "what is nova" is appropriate. Part of bp: doc-migration Change-Id: I5fdafd9f6cf07a19bf86a6343663dad410887dcb --- doc/source/index.rst | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index f7b14fb73e..4380860eba 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,28 +15,29 @@ License for the specific language governing permissions and limitations under the License. -========================================== -Welcome to Nova's developer documentation! -========================================== +======================== +OpenStack Compute (nova) +======================== -Nova is an OpenStack project designed to provide power massively scalable, on -demand, self service access to compute resources. +What is nova? +============= -The developer documentation provided here is continually kept up-to-date -based on the latest code, and may not represent the state of the project at -any specific prior release. +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. -.. note:: This is documentation for developers, if you are looking for more - general documentation including API, install, operator and user - guides see `docs.openstack.org`_ +It requires the following additional OpenStack services for basic function: -.. _`docs.openstack.org`: http://docs.openstack.org +* `Keystone `_: This provides + identity and authentication for all OpenSack services. +* `Glance `_: This provides the + compute image repository. All compute instances launch from glance images. +* `Neutron `_: This is + responsible for provisioning the virtual or physical networks that compute + instances connect to on boot. -This documentation is intended to help explain what the Nova developers think -is the current scope of the Nova project, as well as the architectural -decisions we have made in order to support that scope. We also document our -plans for evolving our architecture over time. Finally, we documented our -current development process and policies. +It can also integrate with other services to include: persistent block +storage, encrypted disks, and baremetal compute instances. For End Users =============