From b19006120f6739661b11aabb6e114d7d6af65443 Mon Sep 17 00:00:00 2001 From: Christian Berendt Date: Mon, 18 Apr 2016 23:55:02 -0500 Subject: [PATCH] [install] improve the service entry pages Change-Id: If676fc50f0e2dafa4c9f396b8e8d60ff867125f0 --- doc/install-guide/source/cinder.rst | 4 +++- doc/install-guide/source/glance.rst | 2 +- doc/install-guide/source/heat.rst | 5 +++-- doc/install-guide/source/horizon.rst | 20 ++++++-------------- doc/install-guide/source/manila.rst | 3 ++- doc/install-guide/source/neutron.rst | 15 ++++++++------- doc/install-guide/source/swift.rst | 11 ++++++----- 7 files changed, 29 insertions(+), 31 deletions(-) diff --git a/doc/install-guide/source/cinder.rst b/doc/install-guide/source/cinder.rst index fe2da09e12..c80b280ddf 100644 --- a/doc/install-guide/source/cinder.rst +++ b/doc/install-guide/source/cinder.rst @@ -12,14 +12,16 @@ Block Storage service cinder-verify.rst cinder-next-steps.rst -The OpenStack Block Storage service provides block storage devices +The Block Storage service (cinder) provides block storage devices to guest instances. The method in which the storage is provisioned and consumed is determined by the Block Storage driver, or drivers in the case of a multi-backend configuration. There are a variety of drivers that are available: NAS/SAN, NFS, iSCSI, Ceph, and more. + The Block Storage API and scheduler services typically run on the controller nodes. Depending upon the drivers used, the volume service can run on controllers, compute nodes, or standalone storage nodes. + For more information, see the `Configuration Reference `__. diff --git a/doc/install-guide/source/glance.rst b/doc/install-guide/source/glance.rst index c5546e662d..dd53f5ba72 100644 --- a/doc/install-guide/source/glance.rst +++ b/doc/install-guide/source/glance.rst @@ -8,7 +8,7 @@ Image service glance-install.rst glance-verify.rst -The OpenStack Image service (glance) enables users to discover, +The Image service (glance) enables users to discover, register, and retrieve virtual machine images. It offers a :term:`REST ` API that enables you to query virtual machine image metadata and retrieve an actual image. diff --git a/doc/install-guide/source/heat.rst b/doc/install-guide/source/heat.rst index 9c9e975229..3b01e28e51 100644 --- a/doc/install-guide/source/heat.rst +++ b/doc/install-guide/source/heat.rst @@ -9,5 +9,6 @@ Orchestration service heat-verify.rst heat-next-steps.rst -The Orchestration service (heat) uses a heat orchestration -template (HOT) to create and manage cloud resources. +The Orchestration service (heat) uses a +`Heat Orchestration Template (HOT) `_ +to create and manage cloud resources. diff --git a/doc/install-guide/source/horizon.rst b/doc/install-guide/source/horizon.rst index baf8efa1b1..9fb09e483f 100644 --- a/doc/install-guide/source/horizon.rst +++ b/doc/install-guide/source/horizon.rst @@ -2,22 +2,14 @@ Dashboard ========= -The OpenStack Dashboard, also known as -`horizon `__ -is a web interface that enables cloud administrators -and users to manage various OpenStack resources and services. - -The Dashboard enables web-based interactions with the -OpenStack Compute cloud controller through the OpenStack APIs. - -Horizon enables you to customize the brand of the dashboard. - -Horizon provides a set of core classes and reusable templates and tools. - -This example deployment uses an Apache web server. - .. toctree:: horizon-install.rst horizon-verify.rst horizon-next-steps.rst + +The Dashboard (horizon) is a web interface that enables cloud +administrators and users to manage various OpenStack resources +and services. + +This example deployment uses an Apache web server. diff --git a/doc/install-guide/source/manila.rst b/doc/install-guide/source/manila.rst index b78c32d1bf..55525abc60 100644 --- a/doc/install-guide/source/manila.rst +++ b/doc/install-guide/source/manila.rst @@ -12,11 +12,12 @@ Shared File Systems service manila-verify.rst manila-next-steps.rst -The OpenStack Shared File Systems service provides coordinated access to +The Shared File Systems service (manila) provides coordinated access to shared or distributed file systems. The method in which the share is provisioned and consumed is determined by the Shared File Systems driver, or drivers in the case of a multi-driver configuration. There are a variety of drivers that support NFS, CIFS, HDFS and/or protocols as well. + The Shared File Systems API and scheduler services typically run on the controller nodes. Depending upon the drivers used, the share service can run on controllers, compute nodes, or storage nodes. diff --git a/doc/install-guide/source/neutron.rst b/doc/install-guide/source/neutron.rst index afcbc560f8..165f29bdde 100644 --- a/doc/install-guide/source/neutron.rst +++ b/doc/install-guide/source/neutron.rst @@ -4,13 +4,6 @@ Networking service ================== -This chapter explains how to install and configure the OpenStack Networking -service (neutron) using the :ref:`provider networks ` or -:ref:`self-service networks ` option. For more information about -the Networking service including virtual networking components, layout, and -traffic flows, see the -`Networking Guide `__. - .. toctree:: :maxdepth: 1 @@ -20,3 +13,11 @@ traffic flows, see the neutron-compute-install.rst neutron-verify.rst neutron-next-steps.rst + +This chapter explains how to install and configure the Networking +service (neutron) using the :ref:`provider networks ` or +:ref:`self-service networks ` option. + +For more information about the Networking service including virtual +networking components, layout, and traffic flows, see the +`Networking Guide `__. diff --git a/doc/install-guide/source/swift.rst b/doc/install-guide/source/swift.rst index 15f06b5b00..083889a4a5 100644 --- a/doc/install-guide/source/swift.rst +++ b/doc/install-guide/source/swift.rst @@ -4,11 +4,6 @@ Object Storage service ====================== -The OpenStack Object Storage services (swift) work together to provide -object storage and retrieval through a :term:`REST API `. -Your environment must at least include the Identity service (keystone) -prior to deploying Object Storage. - .. toctree:: :maxdepth: 1 @@ -19,3 +14,9 @@ prior to deploying Object Storage. swift-finalize-installation.rst swift-verify.rst swift-next-steps.rst + +The Object Storage services (swift) work together to provide +object storage and retrieval through a :term:`REST API `. + +Your environment must at least include the Identity service (keystone) +prior to deploying Object Storage.