diff --git a/doc/common-rst/cli_install_openstack_command_line_clients.rst b/doc/common-rst/cli_install_openstack_command_line_clients.rst index d8f7bba9db..b00a354b9f 100644 --- a/doc/common-rst/cli_install_openstack_command_line_clients.rst +++ b/doc/common-rst/cli_install_openstack_command_line_clients.rst @@ -57,7 +57,7 @@ command-line clients, and provides installation instructions as needed. | | | | | .. code-block:: console | | | | -| | # easy_install pip | +| | # easy_install pip | | | | | | **Microsoft Windows** | | | | @@ -68,7 +68,7 @@ command-line clients, and provides installation instructions as needed. | | | | | .. code-block:: console | | | | -| | C:\>easy_install pip | +| | C:\>easy_install pip | | | | | | Another option is to use the unofficial binary | | | installer provided by Christoph Gohlke | @@ -78,7 +78,7 @@ command-line clients, and provides installation instructions as needed. | | | | | .. code-block:: console | | | | -| | # apt-get install python-dev python-pip | +| | # apt-get install python-dev python-pip | | | | | | Note that extra dependencies may be required, per | | | operating system, depending on the package being | @@ -91,7 +91,7 @@ command-line clients, and provides installation instructions as needed. | | | | | .. code-block:: console | | | | -| | # yum install python-devel python-pip | +| | # yum install python-devel python-pip | | | | | | There are also packaged versions of the clients | | | available in `RDO `__ | @@ -110,15 +110,15 @@ command-line clients, and provides installation instructions as needed. | | | | | .. code-block:: console | | | | -| | # zypper addrepo -f obs://Cloud:OpenStack: \ | -| | Kilo/SLE_12 Kilo | +| | # zypper addrepo -f obs://Cloud:OpenStack: \ | +| | Kilo/SLE_12 Kilo | | | | | | Then install pip and use it to manage client | | | installation: | | | | | | .. code-block:: console | | | | -| | # zypper install python-devel python-pip | +| | # zypper install python-devel python-pip | | | | | | There are also packaged versions of the clients | | | available that enable zypper to install the clients | @@ -131,7 +131,7 @@ command-line clients, and provides installation instructions as needed. | | | | | .. code-block:: console | | | | -| | # zypper install python-devel python-pip | +| | # zypper install python-devel python-pip | | | | | | There are also packaged versions of the clients | | | available that enable zypper to install the clients | @@ -195,7 +195,7 @@ with ``pip``. .. code-block:: console - # pip install python-novaclient + # pip install python-novaclient Installing with pip ------------------- @@ -267,14 +267,14 @@ that can be installed without ``pip``. Upgrade or remove clients ~~~~~~~~~~~~~~~~~~~~~~~~~ -To upgrade a client, add the ``--upgrade`` option to the ``pip install`` -command: +To upgrade a client, add the :option:`--upgrade` option to the +:command:`pip install` command: .. code-block:: console # 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 diff --git a/doc/common-rst/cli_manage_images.rst b/doc/common-rst/cli_manage_images.rst index 690bbbeea6..78eb617353 100644 --- a/doc/common-rst/cli_manage_images.rst +++ b/doc/common-rst/cli_manage_images.rst @@ -21,62 +21,63 @@ List or get details for images (glance) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 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 - $ glance image-list - +----------+---------------------------------+-------------+------------------+----------+--------+ - | ID | Name | Disk Format | Container Format | Size | Status | - +----------+---------------------------------+-------------+------------------+----------+--------+ - | 397e7... | cirros-0.3.2-x86_64-uec | ami | ami | 25165824 | active | - | df430... | cirros-0.3.2-x86_64-uec-kernel | aki | aki | 4955792 | active | - | 3cf85... | cirros-0.3.2-x86_64-uec-ramdisk | ari | ari | 3714968 | active | - | 7e514... | myCirrosImage | ami | ami | 14221312 | active | - +----------+---------------------------------+-------------+------------------+----------+--------+ + $ glance image-list + +----------+---------------------------------+-------------+------------------+----------+--------+ + | ID | Name | Disk Format | Container Format | Size | Status | + +----------+---------------------------------+-------------+------------------+----------+--------+ + | 397e7... | cirros-0.3.2-x86_64-uec | ami | ami | 25165824 | active | + | df430... | cirros-0.3.2-x86_64-uec-kernel | aki | aki | 4955792 | active | + | 3cf85... | cirros-0.3.2-x86_64-uec-ramdisk | ari | ari | 3714968 | active | + | 7e514... | myCirrosImage | ami | ami | 14221312 | active | + +----------+---------------------------------+-------------+------------------+----------+--------+ .. code-block:: console - $ glance image-show myCirrosImage + $ glance image-show myCirrosImage - +---------------------------------------+--------------------------------------+ - | Property | Value | - +---------------------------------------+--------------------------------------+ - | Property 'base_image_ref' | 397e713c-b95b-4186-ad46-6126863ea0a9 | - | Property 'image_location' | snapshot | - | Property 'image_state' | available | - | Property 'image_type' | snapshot | - | Property 'instance_type_ephemeral_gb' | 0 | - | Property 'instance_type_flavorid' | 2 | - | Property 'instance_type_id' | 5 | - | Property 'instance_type_memory_mb' | 2048 | - | Property 'instance_type_name' | m1.small | - | Property 'instance_type_root_gb' | 20 | - | Property 'instance_type_rxtx_factor' | 1 | - | Property 'instance_type_swap' | 0 | - | Property 'instance_type_vcpu_weight' | None | - | Property 'instance_type_vcpus' | 1 | - | Property 'instance_uuid' | 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 | - | Property 'kernel_id' | df430cc2-3406-4061-b635-a51c16e488ac | - | Property 'owner_id' | 66265572db174a7aa66eba661f58eb9e | - | Property 'ramdisk_id' | 3cf852bd-2332-48f4-9ae4-7d926d50945e | - | Property 'user_id' | 376744b5910b4b4da7d8e6cb483b06a8 | - | checksum | 8e4838effa1969ad591655d6485c7ba8 | - | container_format | ami | - | created_at | 2013-07-22T19:45:58 | - | deleted | False | - | disk_format | ami | - | id | 7e5142af-1253-4634-bcc6-89482c5f2e8a | - | is_public | False | - | min_disk | 0 | - | min_ram | 0 | - | name | myCirrosImage | - | owner | 66265572db174a7aa66eba661f58eb9e | - | protected | False | - | size | 14221312 | - | status | active | - | updated_at | 2013-07-22T19:46:42 | - +---------------------------------------+--------------------------------------+ + +---------------------------------------+--------------------------------------+ + | Property | Value | + +---------------------------------------+--------------------------------------+ + | Property 'base_image_ref' | 397e713c-b95b-4186-ad46-6126863ea0a9 | + | Property 'image_location' | snapshot | + | Property 'image_state' | available | + | Property 'image_type' | snapshot | + | Property 'instance_type_ephemeral_gb' | 0 | + | Property 'instance_type_flavorid' | 2 | + | Property 'instance_type_id' | 5 | + | Property 'instance_type_memory_mb' | 2048 | + | Property 'instance_type_name' | m1.small | + | Property 'instance_type_root_gb' | 20 | + | Property 'instance_type_rxtx_factor' | 1 | + | Property 'instance_type_swap' | 0 | + | Property 'instance_type_vcpu_weight' | None | + | Property 'instance_type_vcpus' | 1 | + | Property 'instance_uuid' | 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 | + | Property 'kernel_id' | df430cc2-3406-4061-b635-a51c16e488ac | + | Property 'owner_id' | 66265572db174a7aa66eba661f58eb9e | + | Property 'ramdisk_id' | 3cf852bd-2332-48f4-9ae4-7d926d50945e | + | Property 'user_id' | 376744b5910b4b4da7d8e6cb483b06a8 | + | checksum | 8e4838effa1969ad591655d6485c7ba8 | + | container_format | ami | + | created_at | 2013-07-22T19:45:58 | + | deleted | False | + | disk_format | ami | + | id | 7e5142af-1253-4634-bcc6-89482c5f2e8a | + | is_public | False | + | min_disk | 0 | + | min_ram | 0 | + | name | myCirrosImage | + | owner | 66265572db174a7aa66eba661f58eb9e | + | protected | False | + | size | 14221312 | + | status | active | + | updated_at | 2013-07-22T19:46:42 | + +---------------------------------------+--------------------------------------+ When viewing a list of images, you can also use ``grep`` to filter the list, as follows: @@ -118,17 +119,17 @@ list, as follows: 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 - $ 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 - $ glance image-update imageName + $ glance image-update imageName The following list explains the optional arguments that you can use with the ``create`` and ``update`` commands to modify image properties. For @@ -145,7 +146,7 @@ Reference `__. ``--container-format CONTAINER_FORMAT`` 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`` The tenant who should own the image. The size of image data, in @@ -172,7 +173,7 @@ Reference `__. Hash of image data to use for verification. ``--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 configured image store. @@ -201,8 +202,8 @@ CentOS 6.3 image in qcow2 format and configure it for public access: .. code-block:: console - $ glance image-create --name centos63-image --disk-format qcow2 \ - --container-format bare --is-public True --file ./centos63.qcow2 + $ glance image-create --name centos63-image --disk-format qcow2 \ + --container-format bare --is-public True --file ./centos63.qcow2 The following example shows how to update an existing image with a properties that describe the disk bus, the CD-ROM bus, and the VIF @@ -210,15 +211,15 @@ model: .. code-block:: console - $ glance image-update \ - --property hw_disk_bus=scsi \ - --property hw_cdrom_bus=ide \ - --property hw_vif_model=e1000 \ - f16-x86_64-openstack-sda + $ glance image-update \ + --property hw_disk_bus=scsi \ + --property hw_cdrom_bus=ide \ + --property hw_vif_model=e1000 \ + f16-x86_64-openstack-sda Currently the libvirt virtualization tool determines the disk, CD-ROM, 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 (NIC) models. The disadvantage of this approach is that it is not possible to run operating systems that lack virtio drivers, for example, diff --git a/doc/common-rst/cli_manage_volumes.rst b/doc/common-rst/cli_manage_volumes.rst index 001d7fbe26..6543e16e0c 100644 --- a/doc/common-rst/cli_manage_volumes.rst +++ b/doc/common-rst/cli_manage_volumes.rst @@ -32,7 +32,7 @@ following example: $ 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. .. note:: @@ -147,7 +147,7 @@ Attach a volume to an instance .. code-block:: console - $ cinder show 573e024d-5235-49ce-8332-be1576d323f8 + $ cinder show 573e024d-5235-49ce-8332-be1576d323f8 The output shows that the volume is attached to the server with ID ``84c6e57d-a6b1-44b6-81eb-fcb36afd31b5``, is in the nova availability @@ -155,32 +155,32 @@ Attach a volume to an instance .. code-block:: console - +------------------------------+------------------------------------------+ - | Property | Value | - +------------------------------+------------------------------------------+ - | attachments | [{u'device': u'/dev/vdb', | - | | u'server_id': u'84c6e57d-a | - | | u'id': u'573e024d-... | - | | u'volume_id': u'573e024d... | - | availability_zone | nova | - | bootable | true | - | created_at | 2013-07-25T17:02:12.000000 | - | display_description | None | - | display_name | my-new-volume | - | id | 573e024d-5235-49ce-8332-be1576d323f8 | - | metadata | {} | - | os-vol-host-attr:host | devstack | - | os-vol-tenant-attr:tenant_id | 66265572db174a7aa66eba661f58eb9e | - | size | 8 | - | snapshot_id | None | - | source_volid | None | - | status | in-use | - | volume_image_metadata | {u'kernel_id': u'df430cc2..., | - | | u'image_id': u'397e713c..., | - | | u'ramdisk_id': u'3cf852bd..., | - | |u'image_name': u'cirros-0.3.2-x86_64-uec'}| - | volume_type | None | - +------------------------------+------------------------------------------+ + +------------------------------+------------------------------------------+ + | Property | Value | + +------------------------------+------------------------------------------+ + | attachments | [{u'device': u'/dev/vdb', | + | | u'server_id': u'84c6e57d-a | + | | u'id': u'573e024d-... | + | | u'volume_id': u'573e024d... | + | availability_zone | nova | + | bootable | true | + | created_at | 2013-07-25T17:02:12.000000 | + | display_description | None | + | display_name | my-new-volume | + | id | 573e024d-5235-49ce-8332-be1576d323f8 | + | metadata | {} | + | os-vol-host-attr:host | devstack | + | os-vol-tenant-attr:tenant_id | 66265572db174a7aa66eba661f58eb9e | + | size | 8 | + | snapshot_id | None | + | source_volid | None | + | status | in-use | + | volume_image_metadata | {u'kernel_id': u'df430cc2..., | + | | u'image_id': u'397e713c..., | + | | u'ramdisk_id': u'3cf852bd..., | + | |u'image_name': u'cirros-0.3.2-x86_64-uec'}| + | volume_type | None | + +------------------------------+------------------------------------------+ .. _Resize_a_volume: @@ -193,9 +193,9 @@ Resize a volume .. code-block:: console - $ 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: @@ -218,7 +218,7 @@ Resize a volume $ 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 ~~~~~~~~~~~~~~~ @@ -233,7 +233,7 @@ Delete a 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 ``deleting``: @@ -264,15 +264,15 @@ Transfer a volume ~~~~~~~~~~~~~~~~~ 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 authorization key to the volume recipient. The volume recipient, or new owner, accepts the transfer by using the ID and key. .. note:: - The procedure for volume transfer is intended for tenants (both the - volume donor and recipient) within the same cloud. + The procedure for volume transfer is intended for tenants (both the + volume donor and recipient) within the same cloud. Use cases include: @@ -319,26 +319,26 @@ Create a volume transfer request .. code-block:: console - +------------+--------------------------------------+ - | Property | Value | - +------------+--------------------------------------+ - | auth_key | b2c8e585cbc68a80 | - | created_at | 2013-10-14T15:20:10.121458 | - | id | 6e4e9aa4-bed5-4f94-8f76-df43232f44dc | - | name | None | - | volume_id | a1cdace0-08e4-4dc7-b9dc-457e9bcfe25f | - +------------+--------------------------------------+ + +------------+--------------------------------------+ + | Property | Value | + +------------+--------------------------------------+ + | auth_key | b2c8e585cbc68a80 | + | created_at | 2013-10-14T15:20:10.121458 | + | id | 6e4e9aa4-bed5-4f94-8f76-df43232f44dc | + | name | None | + | volume_id | a1cdace0-08e4-4dc7-b9dc-457e9bcfe25f | + +------------+--------------------------------------+ .. note:: - Optionally, you can specify a name for the transfer by using the - ``--display-name displayName`` parameter. + Optionally, you can specify a name for the transfer by using the + ``--display-name displayName`` parameter. .. note:: - While the ``auth_key`` property is visible in the output of - ``cinder transfer-create VOLUME_ID``, it will not be available in - subsequent ``cinder transfer-show TRANSFER_ID`` commands. + While the ``auth_key`` property is visible in the output of + ``cinder transfer-create VOLUME_ID``, it will not be available in + subsequent ``cinder transfer-show TRANSFER_ID`` commands. #. Send the volume transfer ID and authorization key to the new owner (for example, by email). @@ -392,8 +392,8 @@ Accept a volume transfer request .. note:: - If you do not have a sufficient quota for the transfer, the transfer - is refused. + If you do not have a sufficient quota for the transfer, the transfer + is refused. Delete a volume transfer ------------------------ diff --git a/doc/common-rst/cli_overview.rst b/doc/common-rst/cli_overview.rst index 23fa8c69ca..da488d649b 100644 --- a/doc/common-rst/cli_overview.rst +++ b/doc/common-rst/cli_overview.rst @@ -4,7 +4,7 @@ Overview Each OpenStack project provides a command-line client, which enables 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 commands within scripts to automate tasks. If you provide OpenStack diff --git a/doc/common-rst/cli_set_environment_variables_using_openstack_rc.rst b/doc/common-rst/cli_set_environment_variables_using_openstack_rc.rst index d22277404e..b59884fc86 100644 --- a/doc/common-rst/cli_set_environment_variables_using_openstack_rc.rst +++ b/doc/common-rst/cli_set_environment_variables_using_openstack_rc.rst @@ -15,10 +15,10 @@ with the OpenStack services that run in the cloud. .. note:: - Defining environment variables using an environment file is not a - common practice on Microsoft Windows. Environment variables are - usually defined in the :guilabel:`Advanced` tab of the :guilabel:`System - Properties` dialog box. + Defining environment variables using an environment file is not a + common practice on Microsoft Windows. Environment variables are + usually defined in the :menuselection:`Advanced > System Properties` + dialog box. Download and source the OpenStack RC file ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -82,20 +82,20 @@ project: .. note:: - You are not prompted for the password with this method. The password - lives in clear text format in the ``PROJECT-openrc.sh`` file. - Restrict the permissions on this file to avoid security problems. - You can also remove the ``OS_PASSWORD`` variable from the file, and - use the ``--password`` parameter with OpenStack client commands - instead. + You are not prompted for the password with this method. The password + lives in clear text format in the ``PROJECT-openrc.sh`` file. + Restrict the permissions on this file to avoid security problems. + You can also remove the ``OS_PASSWORD`` variable from the file, and + use the :option:`--password` parameter with OpenStack client commands + instead. .. note:: - You must set the ``OS_CACERT`` environment variable when using the - https protocol in the ``OS_AUTH_URL`` environment setting because - the verification process for the TLS (HTTPS) server certificate uses - the one indicated in the environment. This certificate will be used - when verifying the TLS (HTTPS) server certificate. + You must set the ``OS_CACERT`` environment variable when using the + https protocol in the ``OS_AUTH_URL`` environment setting because + the verification process for the TLS (HTTPS) server certificate uses + the one indicated in the environment. This certificate will be used + when verifying the TLS (HTTPS) server certificate. Override environment variable values ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -120,7 +120,7 @@ or command-line argument. It is not safe to specify the password using either of these methods. 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. To avoid storing the password in plain text, you can prompt for the diff --git a/doc/common-rst/get_started_block_storage.rst b/doc/common-rst/get_started_block_storage.rst index b5afee00d9..81e3188869 100644 --- a/doc/common-rst/get_started_block_storage.rst +++ b/doc/common-rst/get_started_block_storage.rst @@ -2,8 +2,8 @@ OpenStack Block Storage ======================= -The OpenStack Block Storage service (cinder) adds persistent storage to -a virtual machine. Block Storage provides an infrastructure for managing +The OpenStack Block Storage service (cinder) adds persistent storage +to a virtual machine. Block Storage provides an infrastructure for managing volumes, and interacts with OpenStack Compute to provide volumes for instances. The service also enables management of volume snapshots, and volume types. @@ -11,24 +11,24 @@ volume types. The Block Storage service consists of the following components: 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. cinder-volume Interacts directly with the Block Storage service, and processes - such as the cinder-scheduler. It also interacts with these processes - through a message queue. The cinder-volume service responds to read + such as the ``cinder-scheduler``. It also interacts with these processes + through a message queue. The ``cinder-volume`` service responds to read and write requests sent to the Block Storage service to maintain state. It can interact with a variety of storage providers through a driver architecture. cinder-scheduler daemon 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 - The cinder-backup service provides backing up volumes of any type to - a backup storage provider. Like the cinder-volume service, it can + The ``cinder-backup`` service provides backing up volumes of any type to + a backup storage provider. Like the ``cinder-volume`` service, it can interact with a variety of storage providers through a driver architecture. diff --git a/doc/common-rst/get_started_compute.rst b/doc/common-rst/get_started_compute.rst index 778a28e9ab..23090abcf8 100644 --- a/doc/common-rst/get_started_compute.rst +++ b/doc/common-rst/get_started_compute.rst @@ -4,10 +4,10 @@ OpenStack Compute Use OpenStack Compute to host and manage cloud computing systems. 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 Image service for disk and server images, and OpenStack +OpenStack Compute interacts with OpenStack Identity for authentication; +OpenStack Image service for disk and server images; and OpenStack dashboard for the user and administrative interface. Image access is limited by projects, and by users; quotas are limited per project (the 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. ``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 - nova-network installations. For details, see `Metadata + ``nova-network`` installations. For details, see `Metadata service `__ 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. ``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 - 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 - nova-compute service runs. For more information, see `Configuration + ``nova-compute`` service runs. For more information, see `Configuration Reference Guide `__. @@ -63,13 +63,13 @@ OpenStack Compute consists of the following areas and their components: ``euca-bundle-image``. Only needed for the EC2 API. ``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 setting up bridging interfaces or changing IPtables rules. ``nova-consoleauth`` daemon 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 against a single nova-consoleauth service in a cluster configuration. For information, see `About diff --git a/doc/common-rst/get_started_database_service.rst b/doc/common-rst/get_started_database_service.rst index f4ddbae907..e6d0a76aed 100644 --- a/doc/common-rst/get_started_database_service.rst +++ b/doc/common-rst/get_started_database_service.rst @@ -23,8 +23,8 @@ This example is a high-level process flow for using Database services: #. Install the Database service. #. Create an image for each type of database. For example, one for MySQL and one for MongoDB. - #. Use the ``trove-manage`` command to import images and offer them to - tenants. + #. Use the :command:`trove-manage` command to import images and offer them + to tenants. #. The OpenStack end user deploys the Database service using the following steps: diff --git a/doc/common-rst/get_started_file_storage.rst b/doc/common-rst/get_started_file_storage.rst index c497653195..aeaeabf36e 100644 --- a/doc/common-rst/get_started_file_storage.rst +++ b/doc/common-rst/get_started_file_storage.rst @@ -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: 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. manila-share Interacts directly with the Shared File Systems service and processes - such as the manila-scheduler. It also interacts with these processes - through a message queue. The manila-share service responds to read + such as the ``manila-scheduler``. It also interacts with these processes + through a message queue. The ``manila-share`` service responds to read and write requests sent to the Shared File Systems service to maintain state. It can interact with a variety of storage providers through a driver architecture. manila-scheduler daemon 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 Routes information between the Shared File Systems processes. diff --git a/doc/common-rst/get_started_orchestration.rst b/doc/common-rst/get_started_orchestration.rst index cd04565897..c4d9a5e1f4 100644 --- a/doc/common-rst/get_started_orchestration.rst +++ b/doc/common-rst/get_started_orchestration.rst @@ -7,7 +7,7 @@ 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, -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 auto-scaling, and nested stacks. This enables OpenStack core projects to receive a larger user base. @@ -18,16 +18,17 @@ directly or through custom plug-ins. The Orchestration service consists of the following components: ``heat`` command-line client - A CLI that communicates with the heat-api to run AWS CloudFormation - APIs. End developers can directly use the Orchestration REST API. + A CLI that communicates with the ``heat-api`` to run :term:`AWS` + CloudFormation APIs. End developers can directly use the Orchestration + REST API. ``heat-api`` component 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 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`` Orchestrates the launching of templates and provides events back to diff --git a/doc/common-rst/get_started_with_openstack.rst b/doc/common-rst/get_started_with_openstack.rst index 72e71b6834..3a115d0099 100644 --- a/doc/common-rst/get_started_with_openstack.rst +++ b/doc/common-rst/get_started_with_openstack.rst @@ -17,9 +17,10 @@ types of clouds, which aims to be simple to implement, massively scalable, and feature rich. Developers and cloud computing technologists 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 -application programming interface (API) that facilitates this +application programming interface +(:term:`API `) that facilitates this integration. Depending on your needs, you can install some or all services. diff --git a/doc/common-rst/nova_show_usage_statistics_for_hosts_instances.rst b/doc/common-rst/nova_show_usage_statistics_for_hosts_instances.rst index b0176b2683..051188a9d6 100644 --- a/doc/common-rst/nova_show_usage_statistics_for_hosts_instances.rst +++ b/doc/common-rst/nova_show_usage_statistics_for_hosts_instances.rst @@ -6,11 +6,11 @@ You can show basic statistics on resource usage for hosts and instances. .. note:: - For more sophisticated monitoring, see the - `ceilometer `__ project. You can - also use tools, such as `Ganglia `__ or - `Graphite `__, to gather more detailed - data. + For more sophisticated monitoring, see the + `ceilometer `__ project. You can + also use tools, such as `Ganglia `__ or + `Graphite `__, to gather more detailed + data. Show host usage statistics ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -83,48 +83,48 @@ Show instance usage statistics .. code-block:: console - $ nova list - +----------+----------------------+--------+------------+-------------+------------------+ - | ID | Name | Status | Task State | Power State | Networks | - +----------+----------------------+--------+------------+-------------+------------------+ - | 84c6e... | myCirrosServer | ACTIVE | None | Running | private=10.0.0.3 | - | 8a995... | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 | - +----------+----------------------+--------+------------+-------------+------------------+ + $ nova list + +----------+----------------------+--------+------------+-------------+------------------+ + | ID | Name | Status | Task State | Power State | Networks | + +----------+----------------------+--------+------------+-------------+------------------+ + | 84c6e... | myCirrosServer | ACTIVE | None | Running | private=10.0.0.3 | + | 8a995... | myInstanceFromVolume | ACTIVE | None | Running | private=10.0.0.4 | + +----------+----------------------+--------+------------+-------------+------------------+ #. Get diagnostic statistics: .. code-block:: console - $ nova diagnostics myCirrosServer - +------------------+----------------+ - | Property | Value | - +------------------+----------------+ - | vnet1_rx | 1210744 | - | cpu0_time | 19624610000000 | - | vda_read | 0 | - | vda_write | 0 | - | vda_write_req | 0 | - | vnet1_tx | 863734 | - | vnet1_tx_errors | 0 | - | vnet1_rx_drop | 0 | - | vnet1_tx_packets | 3855 | - | vnet1_tx_drop | 0 | - | vnet1_rx_errors | 0 | - | memory | 2097152 | - | vnet1_rx_packets | 5485 | - | vda_read_req | 0 | - | vda_errors | -1 | - +------------------+----------------+ + $ nova diagnostics myCirrosServer + +------------------+----------------+ + | Property | Value | + +------------------+----------------+ + | vnet1_rx | 1210744 | + | cpu0_time | 19624610000000 | + | vda_read | 0 | + | vda_write | 0 | + | vda_write_req | 0 | + | vnet1_tx | 863734 | + | vnet1_tx_errors | 0 | + | vnet1_rx_drop | 0 | + | vnet1_tx_packets | 3855 | + | vnet1_tx_drop | 0 | + | vnet1_rx_errors | 0 | + | memory | 2097152 | + | vnet1_rx_packets | 5485 | + | vda_read_req | 0 | + | vda_errors | -1 | + +------------------+----------------+ - Get summary statistics for each tenant: .. code-block:: console - $ nova usage-list - Usage from 2013-06-25 to 2013-07-24: - +----------------------------------+-----------+--------------+-----------+---------------+ - | Tenant ID | Instances | RAM MB-Hours | CPU Hours | Disk GB-Hours | - +----------------------------------+-----------+--------------+-----------+---------------+ - | b70d90d65e464582b6b2161cf3603ced | 1 | 344064.44 | 672.00 | 0.00 | - | 66265572db174a7aa66eba661f58eb9e | 3 | 671626.76 | 327.94 | 6558.86 | - +----------------------------------+-----------+--------------+-----------+---------------+ + $ nova usage-list + Usage from 2013-06-25 to 2013-07-24: + +----------------------------------+-----------+--------------+-----------+---------------+ + | Tenant ID | Instances | RAM MB-Hours | CPU Hours | Disk GB-Hours | + +----------------------------------+-----------+--------------+-----------+---------------+ + | b70d90d65e464582b6b2161cf3603ced | 1 | 344064.44 | 672.00 | 0.00 | + | 66265572db174a7aa66eba661f58eb9e | 3 | 671626.76 | 327.94 | 6558.86 | + +----------------------------------+-----------+--------------+-----------+---------------+