openstack/openstack-manuals
Code Issues Proposed changes

[user-guide] Add an empty line between input and output

Browse Source 
In this patch
1.) Add a new line between input and output of "code-block"s
2.) Combined the input and output into one "code-block"
3.) Delete extra lines in the files

Change-Id: I9801d293fedaa90543c02885ef3cb79aaeb50106
Implements: blueprint user-guides-reorganised
This commit is contained in:
venkatamahesh 2015-12-22 19:53:40 +05:30
parent b8e6183cd6
commit 0196e7f51e
19 changed files with 59 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/user-guide/source/backup_db.rst
View File

@ -77,6 +77,7 @@ This example shows you how to back up and restore a MySQL database.
.. code-block:: console
$ trove backup-list
+--------------------------------------+--------------------------------------+---------+-----------+-----------+---------------------+
| id | instance_id | name | status | parent_id | updated |
+--------------------------------------+--------------------------------------+---------+-----------+-----------+---------------------+

4
doc/user-guide/source/cli_ceilometer.rst
View File

@ -96,6 +96,7 @@ stack and the :command:`ceilometer` client to measure resources.
.. code-block:: console
$ ceilometer alarm-list
+--------------------------------------+------------------------------+-------------------+---------+------------+----------------------------------+
| Alarm ID | Name | State | Enabled | Continuous | Alarm condition |
+--------------------------------------+------------------------------+-------------------+---------+------------+----------------------------------+
@ -108,6 +109,7 @@ stack and the :command:`ceilometer` client to measure resources.
.. code-block:: console
$ ceilometer meter-list
+-------------+------------+----------+--------------------------------------+----------------------------------+----------------------------------+
| Name | Type | Unit | Resource ID | User ID | Project ID |
+-------------+------------+----------+--------------------------------------+----------------------------------+----------------------------------+
@ -121,6 +123,7 @@ stack and the :command:`ceilometer` client to measure resources.
.. code-block:: console
$ ceilometer sample-list -m cpu_util
+--------------------------------------+----------+-------+---------------+------+---------------------+
| Resource ID | Name | Type | Volume | Unit | Timestamp |
+--------------------------------------+----------+-------+---------------+------+---------------------+
@ -132,6 +135,7 @@ stack and the :command:`ceilometer` client to measure resources.
.. code-block:: console
$ ceilometer statistics -m cpu_util
+--------+---------------------+---------------------+-------+---------------+---------------+---------------+---------------+----------+---------------------+---------------------+
| Period | Period Start | Period End | Count | Min | Max | Sum | Avg | Duration | Duration Start | Duration End |
+--------+---------------------+---------------------+-------+---------------+---------------+---------------+---------------+----------+---------------------+---------------------+

3
doc/user-guide/source/cli_change_the_size_of_your_server.rst
View File

@ -10,6 +10,7 @@ Change the size of a server by changing its flavor.
.. code-block:: console
$ nova show myCirrosServer
+-------------------------------------+-------------------------------------+
| Property | Value |
+-------------------------------------+-------------------------------------+
@ -48,6 +49,7 @@ Change the size of a server by changing its flavor.
.. code-block:: console
$ nova flavor-list
+-----+-----------+-----------+------+-----------+------+-------+-------------+----------+
| ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public|
+-----+-----------+-----------+------+-----------+------+-------+-------------+----------+
@ -93,6 +95,7 @@ Change the size of a server by changing its flavor.
.. code-block:: console
$ nova list
+----------------------+----------------+--------+-----------------------------------------+
| ID | Name | Status | Networks |
+----------------------+----------------+--------+-----------------------------------------+

6
doc/user-guide/source/cli_create_and_manage_stacks.rst
View File

@ -15,7 +15,7 @@ types, such as instances, floating IP addresses, volumes, security
groups, and users. The resources, once created, are referred to as
stacks.
The template languages are described in `the Template
The template languages are described in the `Template
Guide <http://docs.openstack.org/developer/heat/template_guide/index.html>`__
in the `Heat developer
documentation <http://docs.openstack.org/developer/heat/>`__.
@ -76,6 +76,7 @@ number of commands.
.. code-block:: console
$ heat stack-list
+------------------+---------------+-----------------+----------------------+
| id | stack_name | stack_status | creation_time |
+------------------+---------------+-----------------+----------------------+
@ -95,6 +96,7 @@ number of commands.
.. code-block:: console
$ heat resource-list mystack
+---------------------+--------------------+-----------------+----------------------+
| logical_resource_id | resource_type | resource_status | updated_time |
+---------------------+--------------------+-----------------+----------------------+
@ -122,6 +124,7 @@ number of commands.
.. code-block:: console
$ heat event-list mystack
+---------------------+----+------------------------+-----------------+----------------------+
| logical_resource_id | id | resource_status_reason | resource_status | event_time |
+---------------------+----+------------------------+-----------------+----------------------+
@ -147,6 +150,7 @@ like the following command:
$ heat stack-update mystack --template-file \
/path/to/heat/templates/WordPress_Single_Instance_v2.template \
--parameters "InstanceType=m1.large;DBUsername=wp;DBPassword=verybadpassword;KeyName=heat_key;LinuxDistribution=F17"
+--------------------------------------+---------------+-----------------+----------------------+
| id | stack_name | stack_status | creation_time |
+--------------------------------------+---------------+-----------------+----------------------+

2
doc/user-guide/source/cli_delete_an_instance.rst
View File

@ -9,6 +9,7 @@ When you no longer need an instance, you can delete it.
.. code-block:: console
$ nova list
+-------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+-------------+----------------------+--------+------------+-------------+------------------+
@ -33,6 +34,7 @@ When you no longer need an instance, you can delete it.
.. code-block:: console
$ nova list
+-------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+-------------+----------------------+--------+------------+-------------+------------------+

5
doc/user-guide/source/cli_manage_bare_metal_nodes.rst
View File

@ -62,6 +62,7 @@ with the PM address ``1.2.3.4``, the PM user name ipmi, and password
$ nova baremetal-node-create --pm_address 1.2.3.4 --pm_user ipmi \
--pm_password ipmi $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff
+------------------+-------------------+
| Property | Value |
+------------------+-------------------+
@ -88,6 +89,7 @@ interface's MAC address.
.. code-block:: console
$ nova baremetal-interface-add 1 aa:bb:cc:dd:ee:ff
+-------------+-------------------+
| Property | Value |
+-------------+-------------------+
@ -108,6 +110,7 @@ network control via Neutron and OpenFlow.
.. code-block:: console
$ nova boot --image my-baremetal-image --flavor my-baremetal-flavor test
+-----------------------------+--------------------------------------+
| Property | Value |
+-----------------------------+--------------------------------------+
@ -140,6 +143,7 @@ UUID of the instance that runs on it:
.. code-block:: console
$ nova baremetal-node-list
+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+
| ID | Host | CPUs | Memory_MB | Disk_GB | MAC Address | VLAN | PM Address | PM Username | PM Password | Terminal Port |
+----+--------+------+-----------+---------+-------------------+------+------------+-------------+-------------+---------------+
@ -155,6 +159,7 @@ bare-metal node:
.. code-block:: console
$ nova baremetal-node-show 1
+------------------+--------------------------------------+
| Property | Value |
+------------------+--------------------------------------+

18
doc/user-guide/source/cli_manage_instances_hosts.rst
View File

@ -12,14 +12,14 @@ starting instances, and terminating instances. This section also
discusses node management tasks.
.. toctree::
:maxdepth: 2
:maxdepth: 2
cli_manage_ip_addresses.rst
cli_change_the_size_of_your_server.rst
cli_stop_and_start_an_instance.rst
cli_search_instance_with_ip_address.rst
cli_reboot_an_instance.rst
cli_delete_an_instance.rst
cli_access_instance_through_a_console.rst
cli_manage_bare_metal_nodes.rst
cli_manage_ip_addresses.rst
cli_change_the_size_of_your_server.rst
cli_stop_and_start_an_instance.rst
cli_search_instance_with_ip_address.rst
cli_reboot_an_instance.rst
cli_delete_an_instance.rst
cli_access_instance_through_a_console.rst
cli_manage_bare_metal_nodes.rst

5
doc/user-guide/source/cli_manage_ip_addresses.rst
View File

@ -34,6 +34,7 @@ To list all pools that provide floating IP addresses, run:
.. code-block:: console
$ nova floating-ip-pool-list
+--------+
| name |
+--------+
@ -52,6 +53,7 @@ run:
.. code-block:: console
$ nova floating-ip-list
+--------------+--------------------------------------+----------+--------+
| Ip | Instance Id | Fixed Ip | Pool |
+--------------+--------------------------------------+----------+--------+
@ -77,6 +79,7 @@ You can assign a floating IP address to a project and to an instance.
.. code-block:: console
$ nova floating-ip-create
+--------------+-------------+----------+--------+
| IP | Instance Id | Fixed IP | Pool |
+--------------+-------------+----------+--------+
@ -99,6 +102,7 @@ You can assign a floating IP address to a project and to an instance.
.. code-block:: console
$ nova list
+---------------------+------+---------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+---------------------+------+---------+------------+-------------+------------------+
@ -123,6 +127,7 @@ You can assign a floating IP address to a project and to an instance.
.. code-block:: console
$ nova list
+------------------+------+--------+------------+-------------+-------------------------------+
| ID | Name | Status | Task State | Power State | Networks |
+------------------+------+--------+------------+-------------+-------------------------------+

38
doc/user-guide/source/cli_manage_shares.rst
View File

@ -16,8 +16,6 @@ Create a share network
$ manila share-network-create --name mysharenetwork --description "My Manila network" --neutron-net-id 394246ed-d3fd-4a30-a456-7042ce3429b9 --neutron-subnet-id 8f56d97d-8495-4a5b-8544-9ae4ee9390fc
.. code-block:: console
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
@ -42,8 +40,6 @@ Create a share network
$ manila share-network-list
.. code-block:: console
+--------------------------------------+----------------+
| id | name |
+--------------------------------------+----------------+
@ -59,8 +55,6 @@ Create a share
$ manila create --name myshare --description "My Manila share" --share-network ccd6b453-8b05-4508-bbce-93bfe660451f NFS 1
.. code-block:: console
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
@ -89,8 +83,6 @@ Create a share
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
@ -119,8 +111,6 @@ Create a share
$ manila list
.. code-block:: console
+--------------------------------------+---------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
| ID | Name | Size | Share Proto | Status | Is Public | Share Type | Export location | Host |
+--------------------------------------+---------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
@ -136,8 +126,6 @@ Allow access
$ manila access-allow 2fe736d1-08ac-46f9-a482-8f224405f2a7 ip 192.100.00.168
.. code-block:: console
+--------------+--------------------------------------+
| Property | Value |
+--------------+--------------------------------------+
@ -160,8 +148,6 @@ Allow access
$ manila access-list 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+--------------------------------------+-------------+----------------+--------------+--------+
| id | access type | access to | access level | state |
+--------------------------------------+-------------+----------------+--------------+--------+
@ -185,8 +171,6 @@ Deny access
$ manila access-list 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+----+-------------+-----------+--------------+-------+
| id | access type | access to | access level | state |
+----+-------------+-----------+--------------+-------+
@ -203,8 +187,6 @@ Create snapshot
$ manila snapshot-create --name mysnapshot --description "My Manila snapshot" 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+-------------+--------------------------------------+
| Property | Value |
+-------------+--------------------------------------+
@ -225,8 +207,6 @@ Create snapshot
$ manila snapshot-list
.. code-block:: console
+--------------------------------------+--------------------------------------+-----------+------------+------------+
| ID | Share ID | Status | Name | Share Size |
+--------------------------------------+--------------------------------------+-----------+------------+------------+
@ -242,8 +222,6 @@ Create share from snapshot
$ manila create --snapshot-id 1a411703-baef-495f-8e9c-b60e68f2e657 --share-network ccd6b453-8b05-4508-bbce-93bfe660451f --name mysharefromsnap NFS 1
.. code-block:: console
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
@ -273,8 +251,6 @@ Create share from snapshot
$ manila list
.. code-block:: console
+--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
| ID | Name | Size | Share Proto | Status | Is Public | Share Type | Export location | Host |
+--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
@ -288,8 +264,6 @@ Create share from snapshot
$ manila show bcc5b2a7-862b-418a-9607-5d669619d652
.. code-block:: console
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
@ -326,8 +300,6 @@ Delete share
$ manila list
.. code-block:: console
+--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
| ID | Name | Size | Share Proto | Status | Is Public | Share Type | Export location | Host |
+--------------------------------------+-----------------+------+-------------+-----------+-----------+------------+---------------------------------------------------------------+--------------------------------+
@ -346,8 +318,6 @@ Delete snapshot
$ manila snapshot-list
.. code-block:: console
+--------------------------------------+--------------------------------------+-----------+------------+------------+
| ID | Share ID | Status | Name | Share Size |
+--------------------------------------+--------------------------------------+-----------+------------+------------+
@ -386,8 +356,6 @@ Extend share
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
@ -415,8 +383,6 @@ Extend share
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
@ -453,8 +419,6 @@ Shrink share
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+
@ -482,8 +446,6 @@ Shrink share
$ manila show 2fe736d1-08ac-46f9-a482-8f224405f2a7
.. code-block:: console
+-------------------+---------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------+

7
doc/user-guide/source/cli_nova_launch_instance_from_volume.rst
View File

@ -57,6 +57,7 @@ system.
.. code-block:: console
$ cinder create --display-name my-volume 8
+--------------------------------+--------------------------------------+
| Property | Value |
+--------------------------------+--------------------------------------+
@ -86,6 +87,7 @@ system.
.. code-block:: console
$ cinder list
+-----------------+-----------+-----------+------+-------------+----------+-------------+
| ID | Status | Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+-----------+------+-------------+----------+-------------+
@ -100,6 +102,7 @@ system.
$ nova boot --flavor 2 --image 98901246-af91-43d8-b5e6-a4506aa8f369 \
--block-device source=volume,id=d620d971-b160-4c4e-8652-2513d74e2080,dest=volume,shutdown=preserve \
myInstanceWithVolume
+--------------------------------------+--------------------------------------------+
| Property | Value |
+--------------------------------------+--------------------------------------------+
@ -148,6 +151,7 @@ the volume to boot an instance.
.. code-block:: console
$ nova image-list
+-----------------+---------------------------------+--------+--------+
| ID | Name | Status | Server |
+-----------------+---------------------------------+--------+--------+
@ -164,6 +168,7 @@ the volume to boot an instance.
.. code-block:: console
$ nova flavor-list
+-----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
| ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public |
+-----+-----------+-----------+------+-----------+------+-------+-------------+-----------+
@ -226,6 +231,7 @@ the volume to boot an instance.
$ nova boot --flavor 2 \
--block-device source=image,id=484e05af-a14d-4567-812b-28122d1c2260,dest=volume,size=10,shutdown=preserve,bootindex=0 \
myInstanceFromVolume
+--------------------------------------+--------------------------------+
| Property | Value |
+--------------------------------------+--------------------------------+
@ -267,6 +273,7 @@ the volume to boot an instance.
.. code-block:: console
$ cinder list
+-------------+--------+--------------+------+-------------+----------+-------------+
| ID | Status | Display Name | Size | Volume Type | Bootable | Attached to |
+-------------+--------+--------------+------+-------------+----------+-------------+

3
doc/user-guide/source/cli_nova_launch_instance_using_ISO_image.rst
View File

@ -18,6 +18,7 @@ with the following parameters to boot an instance.
--block-device source=blank,dest=volume,size=10,shutdown=preserve \
--nic net-id = NETWORK_UUID \
--flavor 2 INSTANCE_NAME
+--------------------------------------+--------------------------------------------+
| Property | Value |
+--------------------------------------+--------------------------------------------+
@ -92,6 +93,7 @@ using ISO image actually functional.
.. code-block:: console
$ cinder list
+-----------------+-----------+--------------+------+-------------+----------+-------------+
| ID | Status | Name | Size | Volume Type | Bootable | Attached to |
+-----------------+-----------+--------------+------+-------------+----------+-------------+
@ -108,6 +110,7 @@ using ISO image actually functional.
$ cinder upload-to-image VOLUME_UUID IMAGE_NAME
$ glance image-list
+-------------------+------------+-------------+------------------+------------+--------+
| ID | Name | Disk Format | Container Format | Size | Status |
+-------------------+------------+-------------+------------------+------------+--------+

1
doc/user-guide/source/cli_search_instance_with_ip_address.rst
View File

@ -14,6 +14,7 @@ The following example shows the results of a search on ``10.0.0.4``.
.. code-block:: console
$ nova list --ip 10.0.0.4
+------------------+----------------------+--------+------------+-------------+------------------+
| ID | Name | Status | Task State | Power State | Networks |
+------------------+----------------------+--------+------------+-------------+------------------+

4
doc/user-guide/source/cli_use_snapshots_to_migrate_instances.rst
View File

@ -33,6 +33,7 @@ Create a snapshot of the instance
.. code-block:: console
$ nova list
+--------------------------------------+------------+--------+------------------------------+
| ID | Name | Status | Networks |
+--------------------------------------+------------+--------+------------------------------+
@ -47,6 +48,7 @@ Create a snapshot of the instance
.. code-block:: console
$ nova list
+--------------------------------------+------------+---------+------------------+
| ID | Name | Status | Networks |
+--------------------------------------+------------+---------+------------------+
@ -66,6 +68,7 @@ Create a snapshot of the instance
.. code-block:: console
$ nova image-list
+--------------------------------------+---------------------------------+--------+--------+
| ID | Name | Status | Server |
+--------------------------------------+---------------------------------+--------+--------+
@ -85,6 +88,7 @@ Download the snapshot as an image
.. code-block:: console
$ nova image-list
+-------------------+-------------------+--------+--------------------------------------+
| ID | Name | Status | Server |
+-------------------+-------------------+--------+--------------------------------------+

3
doc/user-guide/source/create_db.rst
View File

@ -80,6 +80,7 @@ Create and access a database
.. code-block:: console
$ nova flavor-create mysql-minimum 6 512 5 1
+----+---------------+-----------+------+-----------+------+-------+-------------+-----------+
| ID | Name | Memory_MB | Disk | Ephemeral | Swap | VCPUs | RXTX_Factor | Is_Public |
+----+---------------+-----------+------+-----------+------+-------+-------------+-----------+
@ -113,6 +114,7 @@ Create and access a database
$ trove create mysql_instance_1 6 --size 5 --databases myDB \
--users userA:password --datastore_version mysql-5.5 \
--datastore mysql
+-------------------+---------------------------------------------------------------------------------------t------------------------------------------------------------------------------------------------------------------+
| Property | Value |
+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -135,6 +137,7 @@ Create and access a database
.. code-block:: console
$ trove list
+--------------------------------------+------------------+-----------+-------------------+--------+-----------+------+
| id | name | datastore | datastore_version | status | flavor_id | size |
+--------------------------------------+------------------+-----------+-------------------+--------+-----------+------+

10
doc/user-guide/source/intro-user.rst
View File

@ -8,7 +8,9 @@ within the limits set by administrators.
The examples in this guide show you how to perform tasks by using the
following methods:
* OpenStack dashboard. Use this web-based graphical interface, code named `horizon <https://git.openstack.org/cgit/openstack/horizon>`__, to view, create, and manage resources.
* OpenStack dashboard. Use this web-based graphical interface, code named
`horizon <https://git.openstack.org/cgit/openstack/horizon>`__, to view,
create, and manage resources.
* OpenStack command-line clients. Each core OpenStack project has a
command-line client that you can use to run simple commands to view,
@ -18,9 +20,9 @@ following methods:
You can modify these examples for your specific use cases.
In addition to these ways of interacting with a cloud, you can access
the OpenStack APIs directly or indirectly through `cURL <http://curl.haxx.se>`__ commands or
open SDKs. You can automate access or build tools to manage resources
and services by using the native OpenStack APIs or the EC2
the OpenStack APIs directly or indirectly through `cURL <http://curl.haxx.se>`__
commands or open SDKs. You can automate access or build tools to manage
resources and services by using the native OpenStack APIs or the EC2
compatibility API.
To use the OpenStack APIs, it helps to be familiar with HTTP/1.1,

1
doc/user-guide/source/manage_db_config.rst
View File

@ -141,6 +141,7 @@ Bulk-configure a database or databases
Welcome to the MySQL monitor. Commands end with ; or \g.
...
mysql> show variables like 'sync_binlog';
+---------------+-------+
| Variable_name | Value |
+---------------+-------+

1
doc/user-guide/source/set_up_clustering.rst
View File

@ -170,4 +170,3 @@ Each cluster includes at least one query router and one config server.
Query routers and config servers count against your quota. When you
delete a cluster, the system deletes the associated query router(s) and
config server(s).

1
doc/user-guide/source/set_up_replication.rst
View File

@ -110,4 +110,3 @@ Set up replication
.. code-block:: console
$ trove detach-replica INSTANCE_ID_OF_REPLICA

2
doc/user-guide/source/trove-manage-db.rst
View File

@ -16,5 +16,3 @@ handling complex administrative tasks.
manage_db_config.rst
set_up_replication.rst
set_up_clustering.rst