openstack/openstack-manuals
Code Issues Proposed changes

[common] cleanup RST syntax

Browse Source 
* remove usage of 'linenos'
* use 'code-block' instead of 'code'
* use 'code-block' instead of '::'

Change-Id: Ifcacc4917b185ad5c23b8aa00882bb8263f370c5
This commit is contained in:
Christian Berendt 2015-10-09 15:03:26 +02:00 committed by Christian Berendt
parent 9f927b4461
commit d96a4e676f
10 changed files with 417 additions and 343 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/common-rst/cli_discover_version_number_for_a_client.rst
View File

@ -2,17 +2,16 @@
Discover the version number for a client
========================================
Run the following command to discover the version number for a client::
Run the following command to discover the version number for a client:
$ PROJECT --version
.. code-block:: console
$ PROJECT --version
For example, to see the version number for the ``nova`` client, run the
following command::
following command:
$ nova --version
.. code-block:: console
The version number (2.15.0 in the example) is returned.
.. code::
2.15.0
$ nova --version
2.31.0

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

@ -55,7 +55,7 @@ command-line clients, and provides installation instructions as needed.
| | |
| | **MacOS** |
| | |
| | .. code:: |
| | .. code-block:: console |
| | |
| | # easy_install pip |
| | |
@ -66,7 +66,7 @@ command-line clients, and provides installation instructions as needed.
| | use the ``easy_install`` command from the setuptools|
| | package: |
| | |
| | .. code:: |
| | .. code-block:: console |
| | |
| | C:\>easy_install pip |
| | |
@ -76,7 +76,7 @@ command-line clients, and provides installation instructions as needed.
| | |
| | **Ubuntu and Debian** |
| | |
| | .. code:: |
| | .. code-block:: console |
| | |
| | # apt-get install python-dev python-pip |
| | |
@ -89,7 +89,7 @@ command-line clients, and provides installation instructions as needed.
| | A packaged version enables you to use yum to install|
| | the package: |
| | |
| | .. code:: |
| | .. code-block:: console |
| | |
| | # yum install python-devel python-pip |
| | |
@ -108,7 +108,7 @@ command-line clients, and provides installation instructions as needed.
| | enables you to use or zypper to install the package.|
| | First, add the Open Build Service repository: |
| | |
| | .. code:: |
| | .. code-block:: console |
| | |
| | # zypper addrepo -f obs://Cloud:OpenStack: \ |
| | Kilo/SLE_12 Kilo |
@ -116,7 +116,7 @@ command-line clients, and provides installation instructions as needed.
| | Then install pip and use it to manage client |
| | installation: |
| | |
| | .. code:: |
| | .. code-block:: console |
| | |
| | # zypper install python-devel python-pip |
| | |
@ -129,7 +129,7 @@ command-line clients, and provides installation instructions as needed.
| | You can install pip and use it to manage client |
| | installation: |
| | |
| | .. code:: |
| | .. code-block:: console |
| | |
| | # zypper install python-devel python-pip |
| | |
@ -185,7 +185,7 @@ Common OpenStack client supporting multiple services:
The following example shows the command for installing the nova client
with ``pip``.
.. code::
.. code-block:: console
# pip install python-novaclient
@ -200,13 +200,17 @@ or remove a package.
Install each client separately by using the following command:
- For Mac OS X or Linux::
- For Mac OS X or Linux:
# pip install python-PROJECTclient
.. code-block:: console
- For Microsoft Windows::
# pip install python-PROJECTclient
C:\>pip install python-PROJECTclient
- For Microsoft Windows:
.. code-block:: console
C:\>pip install python-PROJECTclient
.. _Installing_from_packages:
@ -218,41 +222,55 @@ that can be installed without ``pip``.
- On Red Hat Enterprise Linux, CentOS, or Fedora, use ``yum`` to install
the clients from the packaged versions available in
`RDO <https://www.rdoproject.org/>`__::
`RDO <https://www.rdoproject.org/>`__:
# yum install python-PROJECTclient
.. code-block:: console
# yum install python-PROJECTclient
- For Ubuntu or Debian, use ``apt-get`` to install the clients from the
packaged versions::
packaged versions:
.. code-block:: console
# apt-get install python-PROJECTclient
- For openSUSE, use ``zypper`` to install the clients from the distribution
packages service::
packages service:
# zypper install python-PROJECTclient
.. code-block:: console
# zypper install python-PROJECTclient
- For SUSE Linux Enterprise Server, use ``zypper`` to install the clients from
the distribution packages in the Open Build Service. First, add the Open
Build Service repository::
Build Service repository:
# zypper addrepo -f obs://Cloud:OpenStack:Kilo/SLE_12 Kilo
.. code-block:: console
Then you can install the packages::
# zypper addrepo -f obs://Cloud:OpenStack:Kilo/SLE_12 Kilo
# zypper install python-PROJECTclient
Then you can install the packages:
.. code-block:: console
# zypper install python-PROJECTclient
Upgrade or remove clients
~~~~~~~~~~~~~~~~~~~~~~~~~
To upgrade a client, add the ``--upgrade`` option to the ``pip install``
command::
command:
# pip install --upgrade python-PROJECTclient
.. code-block:: console
To remove the client, run the ``pip uninstall`` command::
# pip install --upgrade python-PROJECTclient
# pip uninstall python-PROJECTclient
To remove the client, run the ``pip uninstall`` command:
.. code-block:: console
# pip uninstall python-PROJECTclient
What's next
~~~~~~~~~~~

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

@ -23,7 +23,7 @@ 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``.
.. code::
.. code-block:: console
$ glance image-list
+----------+---------------------------------+-------------+------------------+----------+--------+
@ -35,7 +35,7 @@ image, use ``glance image-list`` and ``glance image-show``.
| 7e514... | myCirrosImage | ami | ami | 14221312 | active |
+----------+---------------------------------+-------------+------------------+----------+--------+
.. code::
.. code-block:: console
$ glance image-show myCirrosImage
@ -79,12 +79,14 @@ image, use ``glance image-list`` and ``glance image-show``.
+---------------------------------------+--------------------------------------+
When viewing a list of images, you can also use ``grep`` to filter the
list, as follows::
list, as follows:
$ glance image-list | grep 'cirros'
| 397e713c-b95b-4186-ad46-612... | cirros-0.3.2-x86_64-uec | ami | ami | 25165824 | active |
| df430cc2-3406-4061-b635-a51... | cirros-0.3.2-x86_64-uec-kernel | aki | aki | 4955792 | active |
| 3cf852bd-2332-48f4-9ae4-7d9... | cirros-0.3.2-x86_64-uec-ramdisk | ari | ari | 3714968 | active |
.. code-block:: console
$ glance image-list | grep 'cirros'
| 397e713c-b95b-4186-ad46-612... | cirros-0.3.2-x86_64-uec | ami | ami | 25165824 | active |
| df430cc2-3406-4061-b635-a51... | cirros-0.3.2-x86_64-uec-kernel | aki | aki | 4955792 | active |
| 3cf852bd-2332-48f4-9ae4-7d9... | cirros-0.3.2-x86_64-uec-ramdisk | ari | ari | 3714968 | active |
.. note::
@ -95,33 +97,36 @@ list, as follows::
- ``filesystem_store_metadata_file = filePath``, where filePath points to a JSON file that defines the mount point for OpenStack images on your system and a unique ID. For example:
.. code-block:: json
:linenos:
[{
"id": "2d9bb53f-70ea-4066-a68b-67960eaae673",
"mountpoint": "/var/lib/glance/images/"
}]
After you restart the Image service, you can use the following syntax to view the image's location information::
After you restart the Image service, you can use the following syntax to view the image's location information:
$ glance --os-image-api-version 2 image-show imageID
.. code-block:: console
For example, using the image ID shown above, you would issue the command as follows::
$ glance --os-image-api-version 2 image-show imageID
$ glance --os-image-api-version 2 image-show 2d9bb53f-70ea-4066-a68b-67960eaae673
For example, using the image ID shown above, you would issue the command as follows:
.. code-block:: console
$ glance --os-image-api-version 2 image-show 2d9bb53f-70ea-4066-a68b-67960eaae673
Create or update an image (glance)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To create an image, use ``glance image-create``:
.. code::
.. code-block:: console
$ glance image-create imageName
To update an image by name or ID, use ``glance image-update``:
.. code::
.. code-block:: console
$ glance image-update imageName
@ -194,7 +199,7 @@ Reference <http://docs.openstack.org/cli-reference/content/index.html>`__.
The following example shows the command that you would use to upload a
CentOS 6.3 image in qcow2 format and configure it for public access:
.. code::
.. code-block:: console
$ glance image-create --name centos63-image --disk-format qcow2 \
--container-format bare --is-public True --file ./centos63.qcow2
@ -203,7 +208,7 @@ 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
model:
.. code::
.. code-block:: console
$ glance image-update \
--property hw_disk_bus=scsi \

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

@ -26,9 +26,11 @@ Possible use cases for data migration include:
- Free up space in a thinly-provisioned back end.
Migrate a volume with the :command:`cinder migrate` command, as shown in the
following example::
following example:
$ cinder migrate volumeID destinationHost --force-host-copy True|False
.. code-block:: console
$ cinder migrate volumeID destinationHost --force-host-copy True|False
In this example, ``--force-host-copy True`` forces the generic
host-based migration mechanism and bypasses any driver optimizations.
@ -45,67 +47,75 @@ Create a volume
This example creates a my-new-volume volume based on an image.
#. List images, and note the ID of the image that you want to use for your
volume::
volume:
$ nova image-list
.. code-block:: console
+-----------------------+---------------------------------+--------+--------------------------+
| ID | Name | Status | Server |
+-----------------------+---------------------------------+--------+--------------------------+
| 397e713c-b95b-4186... | cirros-0.3.2-x86_64-uec | ACTIVE | |
| df430cc2-3406-4061... | cirros-0.3.2-x86_64-uec-kernel | ACTIVE | |
| 3cf852bd-2332-48f4... | cirros-0.3.2-x86_64-uec-ramdisk | ACTIVE | |
| 7e5142af-1253-4634... | myCirrosImage | ACTIVE | 84c6e57d-a6b1-44b6-81... |
| 89bcd424-9d15-4723... | mysnapshot | ACTIVE | f51ebd07-c33d-4951-87... |
+-----------------------+---------------------------------+--------+--------------------------+
$ nova image-list
+-----------------------+---------------------------------+--------+--------------------------+
| ID | Name | Status | Server |
+-----------------------+---------------------------------+--------+--------------------------+
| 397e713c-b95b-4186... | cirros-0.3.2-x86_64-uec | ACTIVE | |
| df430cc2-3406-4061... | cirros-0.3.2-x86_64-uec-kernel | ACTIVE | |
| 3cf852bd-2332-48f4... | cirros-0.3.2-x86_64-uec-ramdisk | ACTIVE | |
| 7e5142af-1253-4634... | myCirrosImage | ACTIVE | 84c6e57d-a6b1-44b6-81... |
| 89bcd424-9d15-4723... | mysnapshot | ACTIVE | f51ebd07-c33d-4951-87... |
+-----------------------+---------------------------------+--------+--------------------------+
#. List the availability zones, and note the ID of the availability zone in
which you want to create your volume::
which you want to create your volume:
$ cinder availability-zone-list
.. code-block:: console
+------+-----------+
| Name | Status |
+------+-----------+
| nova | available |
+------+-----------+
$ cinder availability-zone-list
+------+-----------+
| Name | Status |
+------+-----------+
| nova | available |
+------+-----------+
#. Create a volume with 8 gibibytes (GiB) of space, and specify the
availability zone and image::
availability zone and image:
$ cinder create 8 --display-name my-new-volume --image-id 397e713c-b95b-4186-ad46-6126863ea0a9 --availability-zone nova
.. code-block:: console
$ cinder create 8 --display-name my-new-volume --image-id 397e713c-b95b-4186-ad46-6126863ea0a9 --availability-zone nova
+---------------------+--------------------------------------+
| Property | Value |
+---------------------+--------------------------------------+
| attachments | [] |
| availability_zone | nova |
| bootable | false |
| created_at | 2013-07-25T17:02:12.472269 |
| display_description | None |
| display_name | my-new-volume |
| id | 573e024d-5235-49ce-8332-be1576d323f8 |
| image_id | 397e713c-b95b-4186-ad46-6126863ea0a9 |
| metadata | {} |
| size | 8 |
| snapshot_id | None |
| source_volid | None |
| status | creating |
| volume_type | None |
+---------------------+--------------------------------------+
+---------------------+--------------------------------------+
| Property | Value |
+---------------------+--------------------------------------+
| attachments | [] |
| availability_zone | nova |
| bootable | false |
| created_at | 2013-07-25T17:02:12.472269 |
| display_description | None |
| display_name | my-new-volume |
| id | 573e024d-5235-49ce-8332-be1576d323f8 |
| image_id | 397e713c-b95b-4186-ad46-6126863ea0a9 |
| metadata | {} |
| size | 8 |
| snapshot_id | None |
| source_volid | None |
| status | creating |
| volume_type | None |
+---------------------+--------------------------------------+
#. To verify that your volume was created successfully, list the available
volumes::
volumes:
$ cinder list
.. code-block:: console
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| 573e024d-523... | available | my-new-volume | 8 | None | true | |
| bd7cf584-45d... | available | my-bootable-vol | 8 | None | true | |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
$ cinder list
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| 573e024d-523... | available | my-new-volume | 8 | None | true | |
| bd7cf584-45d... | available | my-bootable-vol | 8 | None | true | |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
If your volume was created successfully, its status is ``available``. If
its status is ``error``, you might have exceeded your quota.
@ -116,24 +126,26 @@ Attach a volume to an instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#. Attach your volume to a server, specifying the server ID and the volume
ID::
ID:
$ nova volume-attach 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 573e024d-5235-49ce-8332-be1576d323f8 /dev/vdb
.. code-block:: console
+----------+--------------------------------------+
| Property | Value |
+----------+--------------------------------------+
| device | /dev/vdb |
| serverId | 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 |
| id | 573e024d-5235-49ce-8332-be1576d323f8 |
| volumeId | 573e024d-5235-49ce-8332-be1576d323f8 |
+----------+--------------------------------------+
$ nova volume-attach 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 573e024d-5235-49ce-8332-be1576d323f8 /dev/vdb
+----------+--------------------------------------+
| Property | Value |
+----------+--------------------------------------+
| device | /dev/vdb |
| serverId | 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 |
| id | 573e024d-5235-49ce-8332-be1576d323f8 |
| volumeId | 573e024d-5235-49ce-8332-be1576d323f8 |
+----------+--------------------------------------+
Note the ID of your volume.
#. Show information for your volume:
.. code::
.. code-block:: console
$ cinder show 573e024d-5235-49ce-8332-be1576d323f8
@ -141,7 +153,7 @@ Attach a volume to an instance
``84c6e57d-a6b1-44b6-81eb-fcb36afd31b5``, is in the nova availability
zone, and is bootable.
.. code::
.. code-block:: console
+------------------------------+------------------------------------------+
| Property | Value |
@ -179,31 +191,32 @@ Resize a volume
To detach the volume from your server, pass the server ID and volume ID
to the following command:
.. code::
.. code-block:: console
$ nova volume-detach 84c6e57d-a6b1-44b6-81eb-fcb36afd31b5 573e024d-5235-49ce-8332-be1576d323f8
The ``volume-detach`` command does not return any output.
#. List volumes::
#. List volumes:
$ cinder list
.. code-block:: console
.. code::
+----------------+-----------+-----------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+----------------+-----------+-----------------+------+-------------+----------+-------------+
| 573e024d-52... | available | my-new-volume | 8 | None | true | |
| bd7cf584-45... | available | my-bootable-vol | 8 | None | true | |
+----------------+-----------+-----------------+------+-------------+----------+-------------+
$ cinder list
+----------------+-----------+-----------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+----------------+-----------+-----------------+------+-------------+----------+-------------+
| 573e024d-52... | available | my-new-volume | 8 | None | true | |
| bd7cf584-45... | available | my-bootable-vol | 8 | None | true | |
+----------------+-----------+-----------------+------+-------------+----------+-------------+
Note that the volume is now available.
#. Resize the volume by passing the volume ID and the new size (a value
greater than the old one) as parameters::
greater than the old one) as parameters:
$ cinder extend 573e024d-5235-49ce-8332-be1576d323f8 10
.. code-block:: console
$ cinder extend 573e024d-5235-49ce-8332-be1576d323f8 10
The ``extend`` command does not return any output.
@ -214,38 +227,38 @@ Delete a volume
To detach the volume from your server and check for the list of existing
volumes, see steps 1 and 2 in Resize_a_volume_.
Delete the volume using either the volume name or ID::
Delete the volume using either the volume name or ID:
$ cinder delete my-new-volume
.. code-block:: console
$ cinder delete my-new-volume
The delete command does not return any output.
#. List the volumes again, and note that the status of your volume is
``deleting``::
``deleting``:
$ cinder list
.. code-block:: console
.. code::
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| 573e024d-523... | deleting | my-new-volume | 8 | None | true | |
| bd7cf584-45d... | available | my-bootable-vol | 8 | None | true | |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
$ cinder list
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| 573e024d-523... | deleting | my-new-volume | 8 | None | true | |
| bd7cf584-45d... | available | my-bootable-vol | 8 | None | true | |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
When the volume is fully deleted, it disappears from the list of
volumes::
volumes:
$ cinder list
.. code-block:: console
.. code::
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| bd7cf584-45d... | available | my-bootable-vol | 8 | None | true | |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
$ cinder list
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
| bd7cf584-45d... | available | my-bootable-vol | 8 | None | true | |
+-----------------+-----------+-----------------+------+-------------+----------+-------------+
Transfer a volume
~~~~~~~~~~~~~~~~~
@ -273,35 +286,38 @@ Use cases include:
Create a volume transfer request
--------------------------------
#. While logged in as the volume donor, list the available volumes::
#. While logged in as the volume donor, list the available volumes:
$ cinder list
.. code-block:: console
.. code::
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| 72bfce9f-cac... | error | None | 1 | None | false | |
| a1cdace0-08e... | available | None | 1 | None | false | |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
$ cinder list
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| 72bfce9f-cac... | error | None | 1 | None | false | |
| a1cdace0-08e... | available | None | 1 | None | false | |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
#. As the volume donor, request a volume transfer authorization code for a
specific volume::
specific volume:
$ cinder transfer-create volumeID
.. code-block:: console
$ cinder transfer-create volumeID
The volume must be in an ``available`` state or the request will be
denied. If the transfer request is valid in the database (that is, it
has not expired or been deleted), the volume is placed in an
``awaiting transfer`` state. For example::
``awaiting transfer`` state. For example:
$ cinder transfer-create a1cdace0-08e4-4dc7-b9dc-457e9bcfe25f
.. code-block:: console
$ cinder transfer-create a1cdace0-08e4-4dc7-b9dc-457e9bcfe25f
The output shows the volume transfer ID in the ``id`` row and the
authorization key.
.. code::
.. code-block:: console
+------------+--------------------------------------+
| Property | Value |
@ -327,29 +343,27 @@ Create a volume transfer request
#. Send the volume transfer ID and authorization key to the new owner (for
example, by email).
#. View pending transfers::
#. View pending transfers:
$ cinder transfer-list
.. code-block:: console
.. code::
+--------------------------------------+--------------------------------------+------+
| ID | VolumeID | Name |
+--------------------------------------+--------------------------------------+------+
| 6e4e9aa4-bed5-4f94-8f76-df43232f44dc | a1cdace0-08e4-4dc7-b9dc-457e9bcfe25f | None |
+--------------------------------------+--------------------------------------+------+
$ cinder transfer-list
+--------------------------------------+--------------------------------------+------+
| ID | VolumeID | Name |
+--------------------------------------+--------------------------------------+------+
| 6e4e9aa4-bed5-4f94-8f76-df43232f44dc | a1cdace0-08e4-4dc7-b9dc-457e9bcfe25f | None |
+--------------------------------------+--------------------------------------+------+
#. After the volume recipient, or new owner, accepts the transfer, you can
see that the transfer is no longer available::
see that the transfer is no longer available:
$ cinder transfer-list
.. code-block:: console
.. code::
+----+-----------+------+
| ID | Volume ID | Name |
+----+-----------+------+
+----+-----------+------+
$ cinder transfer-list
+----+-----------+------+
| ID | Volume ID | Name |
+----+-----------+------+
+----+-----------+------+
Accept a volume transfer request
--------------------------------
@ -357,23 +371,24 @@ Accept a volume transfer request
#. As the volume recipient, you must first obtain the transfer ID and
authorization key from the original owner.
#. Accept the request::
#. Accept the request:
$ cinder transfer-accept transferID authKey
.. code-block:: console
For example::
$ cinder transfer-accept transferID authKey
$ cinder transfer-accept 6e4e9aa4-bed5-4f94-8f76-df43232f44dc b2c8e585cbc68a80
For example:
.. code::
.. code-block:: console
+-----------+--------------------------------------+
| Property | Value |
+-----------+--------------------------------------+
| id | 6e4e9aa4-bed5-4f94-8f76-df43232f44dc |
| name | None |
| volume_id | a1cdace0-08e4-4dc7-b9dc-457e9bcfe25f |
+-----------+--------------------------------------+
$ cinder transfer-accept 6e4e9aa4-bed5-4f94-8f76-df43232f44dc b2c8e585cbc68a80
+-----------+--------------------------------------+
| Property | Value |
+-----------+--------------------------------------+
| id | 6e4e9aa4-bed5-4f94-8f76-df43232f44dc |
| name | None |
| volume_id | a1cdace0-08e4-4dc7-b9dc-457e9bcfe25f |
+-----------+--------------------------------------+
.. note::
@ -383,62 +398,58 @@ Accept a volume transfer request
Delete a volume transfer
------------------------
#. List available volumes and their statuses::
#. List available volumes and their statuses:
$ cinder list
.. code-block:: console
.. code::
$ cinder list
+-------------+-----------------+--------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-------------+-----------------+--------------+------+-------------+----------+-------------+
| 72bfce9f... | error | None | 1 | None | false | |
| a1cdace0... |awaiting-transfer| None | 1 | None | false | |
+-------------+-----------------+--------------+------+-------------+----------+-------------+
+-------------+-----------------+--------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-------------+-----------------+--------------+------+-------------+----------+-------------+
| 72bfce9f... | error | None | 1 | None | false | |
| a1cdace0... |awaiting-transfer| None | 1 | None | false | |
+-------------+-----------------+--------------+------+-------------+----------+-------------+
#. Find the matching transfer ID:
#. Find the matching transfer ID::
.. code-block:: console
$ cinder transfer-list
$ cinder transfer-list
+--------------------------------------+--------------------------------------+------+
| ID | VolumeID | Name |
+--------------------------------------+--------------------------------------+------+
| a6da6888-7cdf-4291-9c08-8c1f22426b8a | a1cdace0-08e4-4dc7-b9dc-457e9bcfe25f | None |
+--------------------------------------+--------------------------------------+------+
.. code::
#. Delete the volume:
+--------------------------------------+--------------------------------------+------+
| ID | VolumeID | Name |
+--------------------------------------+--------------------------------------+------+
| a6da6888-7cdf-4291-9c08-8c1f22426b8a | a1cdace0-08e4-4dc7-b9dc-457e9bcfe25f | None |
+--------------------------------------+--------------------------------------+------+
.. code-block:: console
#. Delete the volume::
$ cinder transfer-delete transferID
$ cinder transfer-delete transferID
For example:
.. code::
.. code-block:: console
$ cinder transfer-delete a6da6888-7cdf-4291-9c08-8c1f22426b8a
$ cinder transfer-delete a6da6888-7cdf-4291-9c08-8c1f22426b8a
#. Verify that transfer list is now empty and that the volume is again
available for transfer::
available for transfer:
$ cinder transfer-list
.. code-block:: console
.. code::
$ cinder transfer-list
+----+-----------+------+
| ID | Volume ID | Name |
+----+-----------+------+
+----+-----------+------+
+----+-----------+------+
| ID | Volume ID | Name |
+----+-----------+------+
+----+-----------+------+
.. code-block:: console
.. code::
$ cinder list
.. code::
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| 72bfce9f-ca... | error | None | 1 | None | false | |
| a1cdace0-08... | available | None | 1 | None | false | |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
$ cinder list
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| 72bfce9f-ca... | error | None | 1 | None | false | |
| a1cdace0-08... | available | None | 1 | None | false | |
+-----------------+-----------+--------------+------+-------------+----------+-------------+

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

@ -42,9 +42,11 @@ On any shell from which you want to run OpenStack commands, source the
``PROJECT-openrc.sh`` file for the respective project.
In the following example, the ``demo-openrc.sh`` file is sourced for
the demo project::
the demo project:
$ source demo-openrc.sh
.. code-block:: console
$ source demo-openrc.sh
When you are prompted for an OpenStack password, enter the password for
the user who downloaded the ``PROJECT-openrc.sh`` file.
@ -56,23 +58,27 @@ Alternatively, you can create the ``PROJECT-openrc.sh`` file from
scratch, if you cannot download the file from the dashboard.
In a text editor, create a file named ``PROJECT-openrc.sh`` and add
the following authentication information::
the following authentication information:
export OS_USERNAME=username
export OS_PASSWORD=password
export OS_TENANT_NAME=projectName
export OS_AUTH_URL=https://identityHost:portNumber/v2.0
# The following lines can be omitted
export OS_TENANT_ID=tenantIDString
export OS_REGION_NAME=regionName
export OS_CACERT=/path/to/cacertFile
.. code-block:: shell
export OS_USERNAME=username
export OS_PASSWORD=password
export OS_TENANT_NAME=projectName
export OS_AUTH_URL=https://identityHost:portNumber/v2.0
# The following lines can be omitted
export OS_TENANT_ID=tenantIDString
export OS_REGION_NAME=regionName
export OS_CACERT=/path/to/cacertFile
On any shell from which you want to run OpenStack commands, source the
``PROJECT-openrc.sh`` file for the respective project. In this
example, you source the ``admin-openrc.sh`` file for the admin
project::
project:
$ source admin-openrc.sh
.. code-block:: console
$ source admin-openrc.sh
.. note::
@ -99,9 +105,11 @@ environment variable settings by using the options that are listed at
the end of the ``help`` output of the various client commands. For
example, you can override the ``OS_PASSWORD`` setting in the
``PROJECT-openrc.sh`` file by specifying a password on a
:command:`openstack` command, as follows::
:command:`openstack` command, as follows:
$ openstack --os-password PASSWORD service list
.. code-block:: console
$ openstack --os-password PASSWORD service list
Where ``PASSWORD`` is your password.

130
doc/common-rst/dashboard_customizing.rst
View File

@ -11,15 +11,19 @@ Once you have the dashboard installed you can customize the way it looks
and feels to suit your own needs.
.. note::
The OpenStack dashboard by default on Ubuntu installs the
``openstack-dashboard-ubuntu-theme`` package.
If you do not want to use this theme you can remove it and its
dependencies using the following command::
dependencies using the following command:
# apt-get remove --auto-remove openstack-dashboard-ubuntu-theme
.. code-block:: console
# apt-get remove --auto-remove openstack-dashboard-ubuntu-theme
.. note::
This guide focuses on the ``local_settings.py`` file, stored in
``/openstack-dashboard/openstack_dashboard/local/``.
@ -42,66 +46,78 @@ Logo and site colors
#. Change the colors and image file names as appropriate, though the
relative directory paths should be the same. The following example file
shows you how to customize your CSS file::
shows you how to customize your CSS file:
/*
* New theme colors for dashboard that override the defaults:
* dark blue: #355796 / rgb(53, 87, 150)
* light blue: #BAD3E1 / rgb(186, 211, 225)
*
* By Preston Lee <plee@tgen.org>
*/
h1.brand {
background: #355796 repeat-x top left;
border-bottom: 2px solid #BAD3E1;
}
h1.brand a {
background: url(../img/my_cloud_logo_small.png) top left no-repeat;
}
#splash .login {
background: #355796 url(../img/my_cloud_logo_medium.png) no-repeat center 35px;
}
#splash .login .modal-header {
border-top: 1px solid #BAD3E1;
}
.btn-primary {
background-image: none !important;
background-color: #355796 !important;
border: none !important;
box-shadow: none;
}
.btn-primary:hover,
.btn-primary:active {
border: none;
box-shadow: none;
background-color: #BAD3E1 !important;
text-decoration: none;
}
.. code-block:: css
#. Open the following HTML template in an editor of your choice::
/*
* New theme colors for dashboard that override the defaults:
* dark blue: #355796 / rgb(53, 87, 150)
* light blue: #BAD3E1 / rgb(186, 211, 225)
*
* By Preston Lee <plee@tgen.org>
*/
h1.brand {
background: #355796 repeat-x top left;
border-bottom: 2px solid #BAD3E1;
}
h1.brand a {
background: url(../img/my_cloud_logo_small.png) top left no-repeat;
}
#splash .login {
background: #355796 url(../img/my_cloud_logo_medium.png) no-repeat center 35px;
}
#splash .login .modal-header {
border-top: 1px solid #BAD3E1;
}
.btn-primary {
background-image: none !important;
background-color: #355796 !important;
border: none !important;
box-shadow: none;
}
.btn-primary:hover,
.btn-primary:active {
border: none;
box-shadow: none;
background-color: #BAD3E1 !important;
text-decoration: none;
}
/usr/share/openstack-dashboard/openstack_dashboard/templates/_stylesheets.html
#. Open the following HTML template in an editor of your choice:
.. code-block:: console
/usr/share/openstack-dashboard/openstack_dashboard/templates/_stylesheets.html
#. Add a line to include your newly created style sheet. For example
``custom.css``::
``custom.css``:
<link href='{{ STATIC_URL }}bootstrap/css/bootstrap.min.css' media='screen' rel='stylesheet' />
<link href='{{ STATIC_URL }}dashboard/css/{% choose_css %}' media='screen' rel='stylesheet' />
<link href='{{ STATIC_URL }}dashboard/css/custom.css' media='screen' rel='stylesheet' />
.. code-block:: html
<link href='{{ STATIC_URL }}bootstrap/css/bootstrap.min.css' media='screen' rel='stylesheet' />
<link href='{{ STATIC_URL }}dashboard/css/{% choose_css %}' media='screen' rel='stylesheet' />
<link href='{{ STATIC_URL }}dashboard/css/custom.css' media='screen' rel='stylesheet' />
#. Restart Apache:
On Ubuntu::
On Ubuntu:
# service apache2 restart
.. code-block:: console
On Fedora, RHEL, CentOS::
# service apache2 restart
# service httpd restart
On Fedora, RHEL, CentOS:
On openSUSE::
.. code-block:: console
# service apache2 restart
# service httpd restart
On openSUSE:
.. code-block:: console
# service apache2 restart
#. To view your changes reload your dashboard. If necessary go back
and modify your CSS file as appropriate.
@ -109,9 +125,11 @@ Logo and site colors
HTML title
~~~~~~~~~~
#. Set the HTML title, which appears at the top of the browser window, by
adding the following line to ``local_settings.py``::
adding the following line to ``local_settings.py``:
SITE_BRANDING = "Example, Inc. Cloud"
.. code-block:: python
SITE_BRANDING = "Example, Inc. Cloud"
#. Restart Apache for this change to take effect.
@ -119,9 +137,11 @@ Logo link
~~~~~~~~~
#. The logo also acts as a hyperlink. The default behavior is to redirect
to ``horizon:user_home``. To change this, add the following attribute to
``local_settings.py``::
``local_settings.py``:
SITE_BRANDING_LINK = "http://example.com"
.. code-block:: python
SITE_BRANDING_LINK = "http://example.com"
#. Restart Apache for this change to take effect.
@ -129,8 +149,10 @@ Help URL
~~~~~~~~
#. By default the help URL points to http://docs.openstack.org. Change this
by editing the following attribute to the URL of your choice in
``local_settings.py``::
``local_settings.py``:
'help_url': "http://openstack.mycompany.org"
.. code-block:: python
'help_url': "http://openstack.mycompany.org"
#. Restart Apache for this change to take effect.

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

@ -35,7 +35,9 @@ This example is a high-level process flow for using Database services:
followed by the :command:`trove show` command to get the IP address of
it.
#. Access the Database service instance using typical database access
commands. For example, with MySQL::
commands. For example, with MySQL:
.. code-block:: console
$ mysql -u myuser -p -h TROVE_IP_ADDRESS mydb

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

@ -20,11 +20,7 @@ server role.
support <https://github.com/kanaka/noVNC/wiki/Browser-support>`__.
#. In the address bar, enter the host name or IP address for the
dashboard.
.. code::
https://ipAddressOrHostName/
dashboard, for example ``https://ipAddressOrHostName/``.
.. note::

56
doc/common-rst/nova_show_usage_statistics_for_hosts_instances.rst
View File

@ -18,33 +18,37 @@ Show host usage statistics
The following examples show the host usage statistics for a host called
``devstack``.
- List the hosts and the nova-related services that run on them::
- List the hosts and the nova-related services that run on them:
$ nova host-list
+-----------+-------------+----------+
| host_name | service | zone |
+-----------+-------------+----------+
| devstack | conductor | internal |
| devstack | compute | nova |
| devstack | cert | internal |
| devstack | network | internal |
| devstack | scheduler | internal |
| devstack | consoleauth | internal |
+-----------+-------------+----------+
.. code-block:: console
$ nova host-list
+-----------+-------------+----------+
| host_name | service | zone |
+-----------+-------------+----------+
| devstack | conductor | internal |
| devstack | compute | nova |
| devstack | cert | internal |
| devstack | network | internal |
| devstack | scheduler | internal |
| devstack | consoleauth | internal |
+-----------+-------------+----------+
- Get a summary of resource usage of all of the instances running on
the host::
the host:
$ nova host-describe devstack
+----------+----------------------------------+-----+-----------+---------+
| HOST | PROJECT | cpu | memory_mb | disk_gb |
+----------+----------------------------------+-----+-----------+---------+
| devstack | (total) | 2 | 4003 | 157 |
| devstack | (used_now) | 3 | 5120 | 40 |
| devstack | (used_max) | 3 | 4608 | 40 |
| devstack | b70d90d65e464582b6b2161cf3603ced | 1 | 512 | 0 |
| devstack | 66265572db174a7aa66eba661f58eb9e | 2 | 4096 | 40 |
+----------+----------------------------------+-----+-----------+---------+
.. code-block:: console
$ nova host-describe devstack
+----------+----------------------------------+-----+-----------+---------+
| HOST | PROJECT | cpu | memory_mb | disk_gb |
+----------+----------------------------------+-----+-----------+---------+
| devstack | (total) | 2 | 4003 | 157 |
| devstack | (used_now) | 3 | 5120 | 40 |
| devstack | (used_max) | 3 | 4608 | 40 |
| devstack | b70d90d65e464582b6b2161cf3603ced | 1 | 512 | 0 |
| devstack | 66265572db174a7aa66eba661f58eb9e | 2 | 4096 | 40 |
+----------+----------------------------------+-----+-----------+---------+
The ``cpu`` column shows the sum of the virtual CPUs for instances
running on the host.
@ -77,7 +81,7 @@ Show instance usage statistics
#. List instances:
.. code::
.. code-block:: console
$ nova list
+----------+----------------------+--------+------------+-------------+------------------+
@ -89,7 +93,7 @@ Show instance usage statistics
#. Get diagnostic statistics:
.. code::
.. code-block:: console
$ nova diagnostics myCirrosServer
+------------------+----------------+
@ -114,7 +118,7 @@ Show instance usage statistics
- Get summary statistics for each tenant:
.. code::
.. code-block:: console
$ nova usage-list
Usage from 2013-06-25 to 2013-07-24:

35
doc/common-rst/support-compute.rst
View File

@ -53,9 +53,11 @@ including a complete report of the service's current state, and is sent to
For example, if you redirect error output to ``nova-api-err.log``
using :command:`nova-api 2>/var/log/nova/nova-api-err.log`,
resulting in the process ID 8675, you can then run::
resulting in the process ID 8675, you can then run:
# kill -USR1 8675
.. code-block:: console
# kill -USR1 8675
This command triggers the Guru Meditation report to be printed to
``/var/log/nova/nova-api-err.log``.
@ -142,9 +144,11 @@ Next, check the log file for the instance in the ``/var/log/libvirt/qemu``
directory to see if it exists and has any useful error messages in it.
Finally, from the ``/var/lib/nova/instances`` directory for the instance,
see if this command returns an error::
see if this command returns an error:
# virsh create libvirt.xml
.. code-block:: console
# virsh create libvirt.xml
**Empty log output for Linux instances**
@ -158,9 +162,11 @@ This occurs when the Compute service attempts to retrieve the log output
of the instance via a serial console while the instance itself is not
configured to send output to the console. To rectify this, append the
following parameters to kernel arguments specified in the instance's boot
loader::
loader:
console=tty0 console=ttyS0,115200n8
.. code-block:: ini
console=tty0 console=ttyS0,115200n8
Upon rebooting, the instance will be configured to send output to the Compute
service.
@ -173,15 +179,20 @@ Reset the state of an instance
If an instance remains in an intermediate state, such as ``deleting``, you
can use the :command:`nova reset-state` command to manually reset the state
of an instance to an error state. You can then delete the instance. For example::
of an instance to an error state. You can then delete the instance. For
example:
$ nova reset-state c6bbbf26-b40a-47e7-8d5c-eb17bf65c485
$ nova delete c6bbbf26-b40a-47e7-8d5c-eb17bf65c485
.. code-block:: console
$ nova reset-state c6bbbf26-b40a-47e7-8d5c-eb17bf65c485
$ nova delete c6bbbf26-b40a-47e7-8d5c-eb17bf65c485
You can also use the :option:`--active` parameter to force the instance back
to an active state instead of an error state. For example::
to an active state instead of an error state. For example:
$ nova reset-state --active c6bbbf26-b40a-47e7-8d5c-eb17bf65c485
.. code-block:: console
$ nova reset-state --active c6bbbf26-b40a-47e7-8d5c-eb17bf65c485
.. _problems-with-injection:
@ -194,7 +205,6 @@ If instances do not boot or boot slowly, investigate file injection as a cause.
To disable injection in libvirt, set the following in ``nova.conf``:
.. code-block:: ini
:linenos:
[libvirt]
inject_partition = -2
@ -222,7 +232,6 @@ You can turn off the live snapshotting mechanism by setting up its value to
``True`` in the ``[workarounds]`` section of the ``nova.conf`` file:
.. code-block:: ini
:linenos:
[workarounds]
disable_libvirt_livesnapshot = True