openstack/openstack-manuals
Code Issues Proposed changes

Merge "Getting started chapter reorganisation"

Browse Source
This commit is contained in:
Jenkins 2015-07-21 14:53:13 +00:00 committed by Gerrit Code Review
commit ea654ec663
17 changed files with 82 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/common-rst/get_started_block_storage.rst
View File

@ -1,7 +1,6 @@
.. :orphan:
=======================
OpenStack Block Storage
-----------------------
=======================
The OpenStack Block Storage service (cinder) adds persistent storage to
a virtual machine. Block Storage provides an infrastructure for managing

5
doc/common-rst/get_started_compute.rst
View File

@ -1,7 +1,6 @@
.. :orphan:
=================
OpenStack Compute
-----------------
=================
Use OpenStack Compute to host and manage cloud computing systems.
OpenStack Compute is a major part of an Infrastructure-as-a-Service

5
doc/common-rst/get_started_conceptual_architecture.rst
View File

@ -1,7 +1,8 @@
.. :orphan:
.. _get_started_conceptual_architecture:
=======================
Conceptual architecture
~~~~~~~~~~~~~~~~~~~~~~~
=======================
The following diagram shows the relationships among the OpenStack
services:

6
doc/common-rst/get_started_dashboard.rst
View File

@ -1,7 +1,8 @@
.. :orphan:
.. _get_started_dashboard:
===================
OpenStack dashboard
-------------------
===================
The OpenStack dashboard is a modular `Django web
application <https://www.djangoproject.com/>`__ that provides a
@ -19,4 +20,3 @@ To use the administrator functionality for other services, it must also
connect to Admin API endpoints, which should not be accessible by
customers.

5
doc/common-rst/get_started_database_service.rst
View File

@ -1,7 +1,6 @@
.. :orphan:
==========================
OpenStack Database service
--------------------------
==========================
The Database service provides scalable and reliable cloud provisioning
functionality for both relational and non-relational database engines.

10
doc/common-rst/get_started_feedback.rst Normal file
View File

@ -0,0 +1,10 @@
========
Feedback
========
To provide feedback on documentation, join and use the
openstack-docs@lists.openstack.org mailing list at `OpenStack
Documentation Mailing
List <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>`__,
or `report a
bug <https://bugs.launchpad.net/openstack-manuals/+filebug>`__.

5
doc/common-rst/get_started_identity.rst
View File

@ -1,7 +1,6 @@
.. :orphan:
==================
OpenStack Identity
------------------
==================
The OpenStack Identity service performs the following functions:

15
doc/common-rst/get_started_image_service.rst
View File

@ -1,15 +1,12 @@
.. :orphan:
=======================
OpenStack Image service
-----------------------
=======================
The OpenStack Image service is central to Infrastructure-as-a-Service
(IaaS) as shown in Conceptual architecture. It accepts API requests for disk
or server images, and image metadata from end users or OpenStack Compute
components. It also supports the storage of disk or server images on various
repository types, including OpenStack Object Storage.
.. TODO (DC) On line 7, add link to get_started_conceptual_architecture.rst
(IaaS) as shown in :ref:`get_started_conceptual_architecture`. It accepts API
requests for disk or server images, and image metadata from end users or
OpenStack Compute components. It also supports the storage of disk or server
images on various repository types, including OpenStack Object Storage.
A number of periodic processes run on the OpenStack Image service to
support caching. Replication services ensure consistency and

19
doc/common-rst/get_started_logical_architecture.rst
View File

@ -1,18 +1,15 @@
.. :orphan:
====================
Logical architecture
~~~~~~~~~~~~~~~~~~~~
====================
To design, deploy, and configure OpenStack, administrators must
understand the logical architecture.
As shown in Conceptual architecture, OpenStack consists of several
independent parts, named the OpenStack services. All services authenticate
through a common Identity service. Individual services interact with each
other through public APIs, except where privileged administrator commands
are necessary.
.. TODO (DC) Add link to figure in get_started_conceptual_architecture.rst
As shown in :ref:`get_started_conceptual_architecture`, OpenStack consists of
several independent parts, named the OpenStack services. All services
authenticate through a common Identity service. Individual services interact
with each other through public APIs, except where privileged administrator
commands are necessary.
Internally, OpenStack services are composed of several processes. All
services have at least one API process, which listens for API requests,
@ -27,7 +24,7 @@ several message broker and database solutions, such as RabbitMQ, Qpid,
MySQL, MariaDB, and SQLite.
Users can access OpenStack via the web-based user interface implemented
by the OpenStack dashboard, via `command-line
by the :ref:`get_started_dashboard`, via `command-line
clients <http://docs.openstack.org/cli-reference/content>`__ and by
issuing API requests through tools like browser plug-ins or :command:`curl`.
For applications, `several SDKs <http://developer.openstack.org/#sdk>`__

5
doc/common-rst/get_started_object_storage.rst
View File

@ -1,7 +1,6 @@
.. :orphan:
========================
OpenStack Object Storage
------------------------
========================
The OpenStack Object Storage is a multi-tenant object storage system. It
is highly scalable and can manage large amounts of unstructured data at

5
doc/common-rst/get_started_openstack_networking.rst
View File

@ -1,7 +1,6 @@
.. :orphan:
====================
OpenStack Networking
--------------------
====================
OpenStack Networking (neutron) allows you to create and attach interface
devices managed by other OpenStack services to networks. Plug-ins can be

22
doc/common-rst/get_started_openstack_services.rst Normal file
View File

@ -0,0 +1,22 @@
==================
OpenStack services
==================
.. toctree::
:maxdepth: 2
get_started_compute.rst
get_started_storage_concepts.rst
get_started_object_storage.rst
get_started_block_storage.rst
get_started_openstack_networking.rst
get_started_dashboard.rst
get_started_identity.rst
get_started_image_service.rst
get_started_telemetry.rst
get_started_orchestration.rst
get_started_database_service.rst
get_started_sahara.rst
This section describes OpenStack services in detail.

7
doc/common-rst/get_started_orchestration.rst
View File

@ -1,10 +1,9 @@
.. :orphan:
==============================
OpenStack Orchestration module
------------------------------
==============================
The Orchestration module provides a template-based orchestration for
describing a cloud application, by running OpenStack API calls to
describing a cloud application by running OpenStack API calls to
generate running cloud applications. The software integrates other core
components of OpenStack into a one-file template system. The templates
allow you to create most OpenStack resource types, such as instances,

5
doc/common-rst/get_started_sahara.rst
View File

@ -1,7 +1,8 @@
.. :orphan:
=================================
OpenStack Data processing service
---------------------------------
=================================
The Data processing service for OpenStack (sahara) aims to provide users
with a simple means to provision data processing (Hadoop, Spark)
@ -9,7 +10,7 @@ clusters by specifying several parameters like Hadoop version, cluster
topology, node hardware details and a few more. After a user fills in
all the parameters, the Data processing service deploys the cluster in a
few minutes. Sahara also provides a means to scale already provisioned
clusters by adding/removing worker nodes on demand.
clusters by adding or removing worker nodes on demand.
The solution addresses the following use cases:

5
doc/common-rst/get_started_storage_concepts.rst
View File

@ -1,7 +1,6 @@
.. :orphan:
================
Storage concepts
----------------
================
The OpenStack stack uses the following storage types:

5
doc/common-rst/get_started_telemetry.rst
View File

@ -1,7 +1,6 @@
.. :orphan:
==========================
OpenStack Telemetry module
--------------------------
==========================
The Telemetry module performs the following functions:

71
doc/common-rst/get_started_with_openstack.rst
View File

@ -4,6 +4,14 @@
Get started with OpenStack
==========================
.. toctree::
:maxdepth: 2
get_started_conceptual_architecture.rst
get_started_logical_architecture.rst
get_started_openstack_services.rst
get_started_feedback.rst
The OpenStack project is an open source cloud computing platform for all
types of clouds, which aims to be simple to implement, massively
scalable, and feature rich. Developers and cloud computing technologists
@ -83,66 +91,3 @@ OpenStack architecture:
by specifying parameters like Hadoop version, cluster topology and nodes
hardware details.
.. include:: get_started_conceptual_architecture.rst
.. include:: get_started_logical_architecture.rst
.. toctree::
:hidden:
get_started_conceptual_architecture.rst
get_started_logical_architecture.rst
OpenStack services
~~~~~~~~~~~~~~~~~~
This section describes OpenStack services in detail.
.. include:: get_started_compute.rst
.. include:: get_started_storage_concepts.rst
.. include:: get_started_object_storage.rst
.. include:: get_started_block_storage.rst
.. include:: get_started_openstack_networking.rst
.. include:: get_started_dashboard.rst
.. include:: get_started_identity.rst
.. include:: get_started_image_service.rst
.. include:: get_started_telemetry.rst
.. include:: get_started_orchestration.rst
.. include:: get_started_database_service.rst
.. include:: get_started_sahara.rst
.. toctree::
:hidden:
get_started_compute.rst
get_started_storage_concepts.rst
get_started_object_storage.rst
get_started_block_storage.rst
get_started_openstack_networking.rst
get_started_dashboard.rst
get_started_identity.rst
get_started_image_service.rst
get_started_telemetry.rst
get_started_orchestration.rst
get_started_database_service.rst
get_started_sahara.rst
Feedback
~~~~~~~~
To provide feedback on documentation, join and use the
openstack-docs@lists.openstack.org mailing list at `OpenStack
Documentation Mailing
List <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>`__,
or `report a
bug <https://bugs.launchpad.net/openstack-manuals/+filebug>`__.