openstack/openstack-manuals
Code Issues Proposed changes

Merge "[common-rst] Improvements using rst markups"

Browse Source
This commit is contained in:
Jenkins 2015-12-14 06:50:53 +00:00 committed by Gerrit Code Review
commit 5802daf14c
12 changed files with 217 additions and 214 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -267,14 +267,14 @@ that can be installed without ``pip``.
Upgrade or remove clients Upgrade or remove clients
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
To upgrade a client, add the ``--upgrade`` option to the ``pip install`` To upgrade a client, add the :option:`--upgrade` option to the
command: :command:`pip install` command:
.. code-block:: console .. code-block:: console
# pip install --upgrade python-PROJECTclient # pip install --upgrade python-PROJECTclient
To remove the client, run the ``pip uninstall`` command: To remove the client, run the :command:`pip uninstall` command:
.. code-block:: console .. code-block:: console

13
doc/common-rst/cli_manage_images.rst
View File

@ -21,7 +21,8 @@ List or get details for images (glance)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To get a list of images and to then get further details about a single To get a list of images and to then get further details about a single
image, use ``glance image-list`` and ``glance image-show``. image, use :command:`glance image-list` and :command:`glance image-show`
commands.
.. code-block:: console .. code-block:: console
@ -118,13 +119,13 @@ list, as follows:
Create or update an image (glance) Create or update an image (glance)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To create an image, use ``glance image-create``: To create an image, use :command:`glance image-create`:
.. code-block:: console .. code-block:: console
$ glance image-create imageName $ glance image-create imageName
To update an image by name or ID, use ``glance image-update``: To update an image by name or ID, use :command:`glance image-update`:
.. code-block:: console .. code-block:: console
@ -145,7 +146,7 @@ Reference <http://docs.openstack.org/cli-reference/content/index.html>`__.
``--container-format CONTAINER_FORMAT`` ``--container-format CONTAINER_FORMAT``
The container format of the image. Acceptable formats are ami, ari, The container format of the image. Acceptable formats are ami, ari,
aki, bare, and ovf. aki, bare, docker, and ovf.
``--owner TENANT_ID --size SIZE`` ``--owner TENANT_ID --size SIZE``
The tenant who should own the image. The size of image data, in The tenant who should own the image. The size of image data, in
@ -172,7 +173,7 @@ Reference <http://docs.openstack.org/cli-reference/content/index.html>`__.
Hash of image data to use for verification. Hash of image data to use for verification.
``--copy-from IMAGE_URL`` ``--copy-from IMAGE_URL``
Similar to ``--location`` in usage, but indicates that the image Similar to :option:`--location` in usage, but indicates that the image
server should immediately copy the data and store it in its server should immediately copy the data and store it in its
configured image store. configured image store.
@ -218,7 +219,7 @@ model:
Currently the libvirt virtualization tool determines the disk, CD-ROM, Currently the libvirt virtualization tool determines the disk, CD-ROM,
and VIF device models based on the configured hypervisor type and VIF device models based on the configured hypervisor type
(``libvirt_type`` in ``/etc/nova/nova.conf``). For the sake of optimal (``libvirt_type`` in ``/etc/nova/nova.conf`` file). For the sake of optimal
performance, libvirt defaults to using virtio for both disk and VIF performance, libvirt defaults to using virtio for both disk and VIF
(NIC) models. The disadvantage of this approach is that it is not (NIC) models. The disadvantage of this approach is that it is not
possible to run operating systems that lack virtio drivers, for example, possible to run operating systems that lack virtio drivers, for example,

10
doc/common-rst/cli_manage_volumes.rst
View File

@ -32,7 +32,7 @@ following example:
$ cinder migrate volumeID destinationHost --force-host-copy True|False $ cinder migrate volumeID destinationHost --force-host-copy True|False
In this example, ``--force-host-copy True`` forces the generic In this example, :option:`--force-host-copy True` forces the generic
host-based migration mechanism and bypasses any driver optimizations. host-based migration mechanism and bypasses any driver optimizations.
.. note:: .. note::
@ -195,7 +195,7 @@ Resize a volume
$ nova volume-detach 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 573e024d-5235-49ce-8332-be1576d323f8 $ nova volume-detach 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 573e024d-5235-49ce-8332-be1576d323f8
The ``volume-detach`` command does not return any output. The :command:`volume-detach` command does not return any output.
#. List volumes: #. List volumes:
@ -218,7 +218,7 @@ Resize a volume
$ cinder extend 573e024d-5235-49ce-8332-be1576d323f8 10 $ cinder extend 573e024d-5235-49ce-8332-be1576d323f8 10
The ``extend`` command does not return any output. The :command:`extend` command does not return any output.
Delete a volume Delete a volume
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~
@ -233,7 +233,7 @@ Delete a volume
$ cinder delete my-new-volume $ cinder delete my-new-volume
The delete command does not return any output. The :command:`delete` command does not return any output.
#. List the volumes again, and note that the status of your volume is #. List the volumes again, and note that the status of your volume is
``deleting``: ``deleting``:
@ -264,7 +264,7 @@ Transfer a volume
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~
You can transfer a volume from one owner to another by using the You can transfer a volume from one owner to another by using the
``cinder transfer*`` commands. The volume donor, or original owner, :command:`cinder transfer*` commands. The volume donor, or original owner,
creates a transfer request and sends the created transfer ID and creates a transfer request and sends the created transfer ID and
authorization key to the volume recipient. The volume recipient, or new authorization key to the volume recipient. The volume recipient, or new
owner, accepts the transfer by using the ID and key. owner, accepts the transfer by using the ID and key.

2
doc/common-rst/cli_overview.rst
View File

@ -4,7 +4,7 @@ Overview
Each OpenStack project provides a command-line client, which enables Each OpenStack project provides a command-line client, which enables
you to access the project API through easy-to-use commands. For you to access the project API through easy-to-use commands. For
example, the Compute service provides a nova command-line client. example, the Compute service provides a ``nova`` command-line client.
You can run the commands from the command line, or include the You can run the commands from the command line, or include the
commands within scripts to automate tasks. If you provide OpenStack commands within scripts to automate tasks. If you provide OpenStack

8
doc/common-rst/cli_set_environment_variables_using_openstack_rc.rst
View File

@ -17,8 +17,8 @@ with the OpenStack services that run in the cloud.
Defining environment variables using an environment file is not a Defining environment variables using an environment file is not a
common practice on Microsoft Windows. Environment variables are common practice on Microsoft Windows. Environment variables are
usually defined in the :guilabel:`Advanced` tab of the :guilabel:`System usually defined in the :menuselection:`Advanced > System Properties`
Properties` dialog box. dialog box.
Download and source the OpenStack RC file Download and source the OpenStack RC file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -86,7 +86,7 @@ project:
lives in clear text format in the ``PROJECT-openrc.sh`` file. lives in clear text format in the ``PROJECT-openrc.sh`` file.
Restrict the permissions on this file to avoid security problems. Restrict the permissions on this file to avoid security problems.
You can also remove the ``OS_PASSWORD`` variable from the file, and You can also remove the ``OS_PASSWORD`` variable from the file, and
use the ``--password`` parameter with OpenStack client commands use the :option:`--password` parameter with OpenStack client commands
instead. instead.
.. note:: .. note::
@ -120,7 +120,7 @@ or command-line argument. It is not safe to specify the password using
either of these methods. either of these methods.
For example, when you specify your password using the command-line For example, when you specify your password using the command-line
client with the ``--os-password`` argument, anyone with access to your client with the :option:`--os-password` argument, anyone with access to your
computer can view it in plain text with the ``ps`` field. computer can view it in plain text with the ``ps`` field.
To avoid storing the password in plain text, you can prompt for the To avoid storing the password in plain text, you can prompt for the

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

@ -2,8 +2,8 @@
OpenStack Block Storage OpenStack Block Storage
======================= =======================
The OpenStack Block Storage service (cinder) adds persistent storage to The OpenStack Block Storage service (cinder) adds persistent storage
a virtual machine. Block Storage provides an infrastructure for managing to a virtual machine. Block Storage provides an infrastructure for managing
volumes, and interacts with OpenStack Compute to provide volumes for volumes, and interacts with OpenStack Compute to provide volumes for
instances. The service also enables management of volume snapshots, and instances. The service also enables management of volume snapshots, and
volume types. volume types.
@ -11,24 +11,24 @@ volume types.
The Block Storage service consists of the following components: The Block Storage service consists of the following components:
cinder-api cinder-api
Accepts API requests, and routes them to the cinder-volume for Accepts API requests, and routes them to the ``cinder-volume`` for
action. action.
cinder-volume cinder-volume
Interacts directly with the Block Storage service, and processes Interacts directly with the Block Storage service, and processes
such as the cinder-scheduler. It also interacts with these processes such as the ``cinder-scheduler``. It also interacts with these processes
through a message queue. The cinder-volume service responds to read through a message queue. The ``cinder-volume`` service responds to read
and write requests sent to the Block Storage service to maintain and write requests sent to the Block Storage service to maintain
state. It can interact with a variety of storage providers through a state. It can interact with a variety of storage providers through a
driver architecture. driver architecture.
cinder-scheduler daemon cinder-scheduler daemon
Selects the optimal storage provider node on which to create the Selects the optimal storage provider node on which to create the
volume. A similar component to the nova-scheduler. volume. A similar component to the ``nova-scheduler``.
cinder-backup daemon cinder-backup daemon
The cinder-backup service provides backing up volumes of any type to The ``cinder-backup`` service provides backing up volumes of any type to
a backup storage provider. Like the cinder-volume service, it can a backup storage provider. Like the ``cinder-volume`` service, it can
interact with a variety of storage providers through a driver interact with a variety of storage providers through a driver
architecture. architecture.

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

@ -4,10 +4,10 @@ OpenStack Compute
Use OpenStack Compute to host and manage cloud computing systems. Use OpenStack Compute to host and manage cloud computing systems.
OpenStack Compute is a major part of an Infrastructure-as-a-Service OpenStack Compute is a major part of an Infrastructure-as-a-Service
(IaaS) system. The main modules are implemented in Python. (:term:`IaaS`) system. The main modules are implemented in Python.
OpenStack Compute interacts with OpenStack Identity for authentication, OpenStack Compute interacts with OpenStack Identity for authentication;
OpenStack Image service for disk and server images, and OpenStack OpenStack Image service for disk and server images; and OpenStack
dashboard for the user and administrative interface. Image access is dashboard for the user and administrative interface. Image access is
limited by projects, and by users; quotas are limited per project (the limited by projects, and by users; quotas are limited per project (the
number of instances, for example). OpenStack Compute can scale number of instances, for example). OpenStack Compute can scale
@ -24,9 +24,9 @@ OpenStack Compute consists of the following areas and their components:
activities, such as running an instance. activities, such as running an instance.
``nova-api-metadata`` service ``nova-api-metadata`` service
Accepts metadata requests from instances. The nova-api-metadata Accepts metadata requests from instances. The ``nova-api-metadata``
service is generally used when you run in multi-host mode with service is generally used when you run in multi-host mode with
nova-network installations. For details, see `Metadata ``nova-network`` installations. For details, see `Metadata
service <http://docs.openstack.org/admin-guide-cloud/compute-networking-nova.html#metadata-service>`__ service <http://docs.openstack.org/admin-guide-cloud/compute-networking-nova.html#metadata-service>`__
in the OpenStack Cloud Administrator Guide. in the OpenStack Cloud Administrator Guide.
@ -49,11 +49,11 @@ OpenStack Compute consists of the following areas and their components:
determines on which compute server host it runs. determines on which compute server host it runs.
``nova-conductor`` module ``nova-conductor`` module
Mediates interactions between the nova-compute service and the Mediates interactions between the ``nova-compute`` service and the
database. It eliminates direct accesses to the cloud database made database. It eliminates direct accesses to the cloud database made
by the nova-compute service. The nova-conductor module scales by the ``nova-compute`` service. The ``nova-conductor`` module scales
horizontally. However, do not deploy it on nodes where the horizontally. However, do not deploy it on nodes where the
nova-compute service runs. For more information, see `Configuration ``nova-compute`` service runs. For more information, see `Configuration
Reference Guide <http://docs.openstack.org/liberty/config-reference/content/ Reference Guide <http://docs.openstack.org/liberty/config-reference/content/
section_conductor.html>`__. section_conductor.html>`__.
@ -63,13 +63,13 @@ OpenStack Compute consists of the following areas and their components:
``euca-bundle-image``. Only needed for the EC2 API. ``euca-bundle-image``. Only needed for the EC2 API.
``nova-network worker`` daemon ``nova-network worker`` daemon
Similar to the nova-compute service, accepts networking tasks from Similar to the ``nova-compute`` service, accepts networking tasks from
the queue and manipulates the network. Performs tasks such as the queue and manipulates the network. Performs tasks such as
setting up bridging interfaces or changing IPtables rules. setting up bridging interfaces or changing IPtables rules.
``nova-consoleauth`` daemon ``nova-consoleauth`` daemon
Authorizes tokens for users that console proxies provide. See Authorizes tokens for users that console proxies provide. See
nova-novncproxy and nova-xvpvncproxy. This service must be running ``nova-novncproxy`` and ``nova-xvpvncproxy``. This service must be running
for console proxies to work. You can run proxies of either type for console proxies to work. You can run proxies of either type
against a single nova-consoleauth service in a cluster against a single nova-consoleauth service in a cluster
configuration. For information, see `About configuration. For information, see `About

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

@ -23,8 +23,8 @@ This example is a high-level process flow for using Database services:
#. Install the Database service. #. Install the Database service.
#. Create an image for each type of database. For example, one for MySQL #. Create an image for each type of database. For example, one for MySQL
and one for MongoDB. and one for MongoDB.
#. Use the ``trove-manage`` command to import images and offer them to #. Use the :command:`trove-manage` command to import images and offer them
tenants. to tenants.
#. The OpenStack end user deploys the Database service using the following #. The OpenStack end user deploys the Database service using the following
steps: steps:

8
doc/common-rst/get_started_file_storage.rst
View File

@ -11,20 +11,20 @@ types as well as share snapshots if a driver supports snapshots.
The Shared File Systems service consists of the following components: The Shared File Systems service consists of the following components:
manila-api manila-api
Accepts API requests and routes them to the manila-share for Accepts API requests and routes them to the ``manila-share`` for
action. action.
manila-share manila-share
Interacts directly with the Shared File Systems service and processes Interacts directly with the Shared File Systems service and processes
such as the manila-scheduler. It also interacts with these processes such as the ``manila-scheduler``. It also interacts with these processes
through a message queue. The manila-share service responds to read through a message queue. The ``manila-share`` service responds to read
and write requests sent to the Shared File Systems service to maintain and write requests sent to the Shared File Systems service to maintain
state. It can interact with a variety of storage providers through a state. It can interact with a variety of storage providers through a
driver architecture. driver architecture.
manila-scheduler daemon manila-scheduler daemon
Selects the optimal storage provider node on which to create the Selects the optimal storage provider node on which to create the
share. A similar component to the cinder-scheduler. share. A similar component to the ``cinder-scheduler``.
Messaging queue Messaging queue
Routes information between the Shared File Systems processes. Routes information between the Shared File Systems processes.

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

@ -7,7 +7,7 @@ describing a cloud application by running OpenStack API calls to
generate running cloud applications. The software integrates other core generate running cloud applications. The software integrates other core
components of OpenStack into a one-file template system. The templates components of OpenStack into a one-file template system. The templates
allow you to create most OpenStack resource types, such as instances, allow you to create most OpenStack resource types, such as instances,
floating IPs, volumes, security groups and users. It also provides floating IPs, volumes, security groups, and users. It also provides
advanced functionality, such as instance high availability, instance advanced functionality, such as instance high availability, instance
auto-scaling, and nested stacks. This enables OpenStack core projects to auto-scaling, and nested stacks. This enables OpenStack core projects to
receive a larger user base. receive a larger user base.
@ -18,16 +18,17 @@ directly or through custom plug-ins.
The Orchestration service consists of the following components: The Orchestration service consists of the following components:
``heat`` command-line client ``heat`` command-line client
A CLI that communicates with the heat-api to run AWS CloudFormation A CLI that communicates with the ``heat-api`` to run :term:`AWS`
APIs. End developers can directly use the Orchestration REST API. CloudFormation APIs. End developers can directly use the Orchestration
REST API.
``heat-api`` component ``heat-api`` component
An OpenStack-native REST API that processes API requests by sending An OpenStack-native REST API that processes API requests by sending
them to the heat-engine over Remote Procedure Call (RPC). them to the ``heat-engine`` over :term:`Remote Procedure Call (RPC)`.
``heat-api-cfn`` component ``heat-api-cfn`` component
An AWS Query API that is compatible with AWS CloudFormation. It An AWS Query API that is compatible with AWS CloudFormation. It
processes API requests by sending them to the heat-engine over RPC. processes API requests by sending them to the ``heat-engine`` over RPC.
``heat-engine`` ``heat-engine``
Orchestrates the launching of templates and provides events back to Orchestrates the launching of templates and provides events back to

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

@ -17,9 +17,10 @@ types of clouds, which aims to be simple to implement, massively
scalable, and feature rich. Developers and cloud computing technologists scalable, and feature rich. Developers and cloud computing technologists
from around the world create the OpenStack project. from around the world create the OpenStack project.
OpenStack provides an Infrastructure-as-a-Service (IaaS) solution OpenStack provides an Infrastructure-as-a-Service (:term:`IaaS`) solution
through a set of interrelated services. Each service offers an through a set of interrelated services. Each service offers an
application programming interface (API) that facilitates this application programming interface
(:term:`API <Application Programming Interface (API)>`) that facilitates this
integration. Depending on your needs, you can install some or all integration. Depending on your needs, you can install some or all
services. services.