openstack/openstack-manuals
Code Issues Proposed changes

[admin-guide-cloud] Fix an empty line in code-blocks

Browse Source 
In this patch
1.) Add a line between input and output of code-blocks
2.) Delete an extra lines in the file

Change-Id: I152fead1a3ca52f0da9e55b9258f1705d2461a6f
This commit is contained in:
venkatamahesh 2015-12-23 00:04:50 +05:30
parent b8e6183cd6
commit 690138ae1b
22 changed files with 95 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/admin-guide-cloud/source/blockstorage-troubleshoot.rst
View File

@ -20,4 +20,3 @@ Storage installation.
ts_no_emulator_x86_64.rst
ts_non_existent_host.rst
ts_non_existent_vlun.rst

8
doc/admin-guide-cloud/source/blockstorage_get_capabilities.rst
View File

@ -34,6 +34,7 @@ First, get a list of the services:
.. code-block:: console
$ cinder service-list
+------------------+-------------------+------+---------+-------+------+
| Binary | Host | Zone | Status | State | ... |
+------------------+-------------------+------+---------+-------+------+
@ -48,6 +49,7 @@ as listed below.
.. code-block:: console
$ cinder get-capabilities block1@ABC-driver
+---------------------+----------------------------------------------+
| Volume stats | Value |
+---------------------+----------------------------------------------+
@ -165,6 +167,7 @@ Create a public volume type by setting ``is_public`` field to ``True``:
.. code-block:: console
$ cinder type-create --description test1 --is-public True vol_Type1
+--------------------------------------+-----------+-------------+-----------+
| ID | Name | Description | Is_Public |
+--------------------------------------+-----------+-------------+-----------+
@ -176,6 +179,7 @@ Create a private volume type by setting ``is_public`` field to ``False``:
.. code-block:: console
$ cinder type-create --description test2 --is-public False vol_Type2
+--------------------------------------+-----------+-------------+-----------+
| ID | Name | Description | Is_Public |
+--------------------------------------+-----------+-------------+-----------+
@ -187,6 +191,7 @@ Get a list of the volume types:
.. code-block:: console
$ cinder type-list
+--------------------------------------+-------------+-------------+-----------+
| ID | Name | Description | Is_Public |
+--------------------------------------+-------------+-------------+-----------+
@ -200,6 +205,7 @@ Get a list of the projects:
.. code-block:: console
$ openstack project list
+----------------------------------+--------------------+
| ID | Name |
+----------------------------------+--------------------+
@ -221,6 +227,7 @@ List the access information about the given volume type:
.. code-block:: console
$ cinder type-access-list --volume-type vol_Type2
+--------------------------------------+----------------------------------+
| Volume_type_ID | Project_ID |
+--------------------------------------+----------------------------------+
@ -234,6 +241,7 @@ Remove volume type access for the given project:
$ cinder type-access-remove --volume-type vol_Type2 --project-id
c4860af62ffe465e99ed1bc08ef6082e
$ cinder type-access-list --volume-type vol_Type2
+----------------+------------+
| Volume_type_ID | Project_ID |
+----------------+------------+

5
doc/admin-guide-cloud/source/blockstorage_volume_migration.rst
View File

@ -42,8 +42,6 @@ First, list the available back-ends:
# cinder get-pools
.. code-block:: console
+----------+----------------------------------------------------+
| Property | Value |
+----------+----------------------------------------------------+
@ -77,8 +75,6 @@ Next, as the admin user, you can see the current status of the volume
$ cinder show 6088f80a-f116-4331-ad48-9afb0dfb196c
.. code-block:: console
+--------------------------------+--------------------------------------+
| Property | Value |
+--------------------------------+--------------------------------------+
@ -193,4 +189,3 @@ end, you find the logical volume
.. note::
Migrating volumes that have snapshots are currently not allowed.

1
doc/admin-guide-cloud/source/keystone_integrate_with_ldap.rst
View File

@ -161,4 +161,3 @@ service.
During the service restart, authentication and authorization are
unavailable.

1
doc/admin-guide-cloud/source/networking_multi-dhcp-agents.rst
View File

@ -166,6 +166,7 @@ To experiment, you need VMs and a neutron network:
+-------------------------------------+----------+--------+--------------+
$ neutron net-list
+-------------------------+------+--------------------------------------+
| id | name | subnets |
+-------------------------+------+--------------------------------------+

1
doc/admin-guide-cloud/source/objectstorage_auditors.rst
View File

@ -28,4 +28,3 @@ You can run the object-auditor once as follows:
This will run the object auditor on only the ``sda`` and ``sdb`` devices.
This parameter accepts a comma-separated list of values.

10
doc/admin-guide-cloud/source/shared_file_systems_cgroups.rst
View File

@ -45,6 +45,7 @@ specifying two comma-separated share types:
.. code-block:: console
$ manila cg-create --name cgroup1 --description "My first CG." --share-types my_type1,default --share-network my_share_net
+----------------------+--------------------------------------+
| Property | Value |
+----------------------+--------------------------------------+
@ -67,6 +68,7 @@ Check that consistency group is in available status:
.. code-block:: console
$ manila cg-show cgroup1
+----------------------+--------------------------------------+
| Property | Value |
+----------------------+--------------------------------------+
@ -91,6 +93,7 @@ group in ``available`` status:
.. code-block:: console
$ manila create nfs 1 --name "Share2" --description "My second share" --share-type default --share-network my_share_net --consistency-group cgroup1
+-----------------------------+--------------------------------------+
| Property | Value |
+-----------------------------+--------------------------------------+
@ -171,6 +174,7 @@ Create a snapshot of consistency group ``cgroup1``:
.. code-block:: console
$ manila cg-snapshot-create cgroup1 --name CG_snapshot1 --description "A snapshot of the first CG."
+----------------------+--------------------------------------+
| Property | Value |
+----------------------+--------------------------------------+
@ -188,6 +192,7 @@ Check the status of created consistency group snapshot:
.. code-block:: console
$ manila cg-snapshot-show CG_snapshot1
+----------------------+--------------------------------------+
| Property | Value |
+----------------------+--------------------------------------+
@ -219,6 +224,7 @@ group snapshot is ``Share2`` share:
.. code-block:: console
$ manila cg-snapshot-members CG_snapshot1
+--------------+------+----------------------------+----------------+--------------+--------------+
| Id | Size | Created_at | Share_protocol | Share_id | Share_type_id|
+--------------+------+----------------------------+----------------+--------------+--------------+
@ -231,6 +237,7 @@ group from it:
.. code-block:: console
$ manila cg-create --source-cgsnapshot-id 876ad24c-1efd-4607-a2b1-6a2c90034fa5 --name cgroup2 --description "A consistency group from a CG snapshot."
+----------------------+-----------------------------------------+
| Property | Value |
+----------------------+-----------------------------------------+
@ -253,6 +260,7 @@ Check the list of consistency group. There are two groups now:
.. code-block:: console
$ manila cg-list
+-------------------+---------+-----------------------------------------+-----------+
| id | name | description | status |
+-------------------+---------+-----------------------------------------+-----------+
@ -267,6 +275,7 @@ consistency group ``cgroup2`` from a snapshot with a member.
.. code-block:: console
$ manila list
+------+-------+-----+------------+----------+----------+-----------+--------------------------+
| ID | Name | Size| Share Proto| Status | Is Public| Share Type| Host |
+------+-------+-----+------------+----------+----------+-----------+--------------------------+
@ -287,6 +296,7 @@ Print detailed information about new share:
.. code-block:: console
$ manila show ba52454e-2ea3-47fa-a683-3176a01295e6
+-----------------------------+---------------------------------------------------------------+
| Property | Value |
+-----------------------------+---------------------------------------------------------------+

18
doc/admin-guide-cloud/source/shared_file_systems_crud_share.rst
View File

@ -119,6 +119,7 @@ Check share types that exist, run:
.. code-block:: console
$ manila type-list
+------+--------+-----------+------------------------------------+----------------------+
| ID | Name | is_default| required_extra_specs | optional_extra_specs |
+------+--------+-----------+------------------------------------+----------------------+
@ -131,6 +132,7 @@ protocol, and size 1 GB:
.. code-block:: console
$ manila create nfs 1 --name Share2 --description "My share" --share-type my_type
+-----------------------------+--------------------------------------+
| Property | Value |
+-----------------------------+--------------------------------------+
@ -164,6 +166,7 @@ New share ``Share2`` should have a status ``available``:
.. code-block:: console
$ manila show Share2
+-----------------------------+---------------------------------------------------------------+
| Property | Value |
+-----------------------------+---------------------------------------------------------------+
@ -239,6 +242,7 @@ Check share types that exist, run:
.. code-block:: console
$ manila type-list
+------+--------+-----------+-----------+----------------------------------+----------------------+
| ID | Name | Visibility| is_default| required_extra_specs | optional_extra_specs |
+------+--------+-----------+-----------+----------------------------------+----------------------+
@ -250,6 +254,7 @@ Check share networks that exist, run:
.. code-block:: console
$ manila share-network-list
+--------------------------------------+--------------+
| id | name |
+--------------------------------------+--------------+
@ -262,6 +267,7 @@ share type, NFS shared file system protocol, and size 1 GB:
.. code-block:: console
$ manila create nfs 1 --name "Share1" --description "My first share" --share-type default --share-network my_share_net --metadata aim=testing --public
+-----------------------------+--------------------------------------+
| Property | Value |
+-----------------------------+--------------------------------------+
@ -298,6 +304,7 @@ See the share in a share list:
.. code-block:: console
$ manila list
+----+-------+-----+------------+-----------+-------------------------------+----------------------+
| ID | Name | Size| Share Proto| Share Type| Export location | Host |
+----+-------+-----+------------+-----------+-------------------------------+----------------------+
@ -310,6 +317,7 @@ status share should have status ``available``:
.. code-block:: console
$ manila show Share1
+-----------------------------+-------------------------------------------+
| Property | Value |
+-----------------------------+-------------------------------------------+
@ -351,6 +359,7 @@ the share if you need:
$ manila update Share1 --description "My first share. Updated" --is-public False
$ manila show Share1
+-----------------------------+--------------------------------------------+
| Property | Value |
+-----------------------------+--------------------------------------------+
@ -433,6 +442,7 @@ Get all metadata key-value pairs of the share:
.. code-block:: console
$ manila metadata-show Share1
+----------+----------+
| Property | Value |
+----------+----------+
@ -446,6 +456,7 @@ You can update the metadata:
.. code-block:: console
$ manila metadata-update-all Share1 deadline=01/30/16
+----------+----------+
| Property | Value |
+----------+----------+
@ -470,6 +481,7 @@ include ``available``, ``error``, ``creating``, ``deleting``,
$ manila reset-state Share2 --state deleting
$ manila show Share2
+-----------------------------+-------------------------------------------+
| Property | Value |
+-----------------------------+-------------------------------------------+
@ -547,6 +559,7 @@ Print the list of all shares for all tenants:
.. code-block:: console
$ manila list --all-tenants
+------+-------+-----+------------+-------+-----------+-----------------------------+-------------+
| ID | Name | Size| Share Proto| Status| Share Type| Export location | Host |
+------+-------+-----+------------+-------+-----------+-----------------------------+-------------+
@ -562,6 +575,7 @@ run:
$ manila force-delete b6b0617c-ea51-4450-848e-e7cff69238c7
$ manila list
+------+-------+-----+------------+-------+-----------+-----------------------------+-------------+
| ID | Name | Size| Share Proto| Status| Share Type| Export location | Host |
+------+-------+-----+------------+-------+-----------+-----------------------------+-------------+
@ -616,6 +630,7 @@ type and ``10.254.0.4`` IP address:
.. code-block:: console
$ manila access-allow Share2 ip 10.254.0.4 --access-level rw
+--------------+--------------------------------------+
| Property | Value |
+--------------+--------------------------------------+
@ -664,6 +679,7 @@ Allow access to the share with ``user`` access type:
.. code-block:: console
$ manila access-allow Share2 user demo --access-level rw
+--------------+--------------------------------------+
| Property | Value |
+--------------+--------------------------------------+
@ -690,6 +706,7 @@ you list permissions for a share:
.. code-block:: console
$ manila access-list Share2
+--------------------------------------+-------------+------------+--------------+--------+
| id | access type | access to | access level | state |
+--------------------------------------+-------------+------------+--------------+--------+
@ -705,6 +722,7 @@ access rule list:
$ manila access-deny Share2 de715226-da00-4cfc-b1ab-c11f3393745e
$ manila access-list Share2
+--------------------------------------+-------------+-----------+--------------+-------+
| id | access type | access to | access level | state |
+--------------------------------------+-------------+-----------+--------------+-------+

2
doc/admin-guide-cloud/source/shared_file_systems_manage_and_unmanage_share.rst
View File

@ -78,6 +78,7 @@ To manage share, run:
.. code-block:: console
$ manila manage manila@cannes#CANNES nfs 10.254.0.7:/shares/share-d1a66eed-a724-4cbb-a886-2f97926bd3b3 --name Share --description "We manage share." --share_type for_managing
+-----------------------------+---------------------------------------------------------------+
| Property | Value |
+-----------------------------+---------------------------------------------------------------+
@ -111,6 +112,7 @@ Check that the share is available:
.. code-block:: console
$ manila show Share
+-----------------------------+---------------------------------------------------------------+
| Property | Value |
+-----------------------------+---------------------------------------------------------------+

11
doc/admin-guide-cloud/source/shared_file_systems_security_services.rst
View File

@ -42,6 +42,7 @@ Create a ``ldap`` security service:
.. code-block:: console
$ manila security-service-create ldap --dns-ip 8.8.8.8 --server 10.254.0.3 --name my_ldap_security_service
+-------------+--------------------------------------+
| Property | Value |
+-------------+--------------------------------------+
@ -65,6 +66,7 @@ To create ``kerberos`` security service, run:
.. code-block:: console
$ manila security-service-create kerberos --server 10.254.0.3 --user demo --password secret --name my_kerberos_security_service --description "Kerberos security service"
+-------------+--------------------------------------+
| Property | Value |
+-------------+--------------------------------------+
@ -89,6 +91,7 @@ To see the list of created security service use
.. code-block:: console
$ manila security-service-list
+--------------------------------------+------------------------------+--------+----------+
| id | name | status | type |
+--------------------------------------+------------------------------+--------+----------+
@ -110,6 +113,7 @@ new attribute ``share_networks`` with associated share network ID.
$ manila share-network-security-service-add share_net2 my_ldap_security_service
$ manila security-service-show my_ldap_security_service
+----------------+-------------------------------------------+
| Property | Value |
+----------------+-------------------------------------------+
@ -135,6 +139,7 @@ given share network. List security services for ``share_net2`` share network:
.. code-block:: console
$ manila share-network-security-service-list share_net2
+--------------------------------------+--------------------------+--------+------+
| id | name | status | type |
+--------------------------------------+--------------------------+--------+------+
@ -149,6 +154,7 @@ and see that a security service now has empty list of share networks:
$ manila share-network-security-service-remove share_net2 my_ldap_security_service
$ manila security-service-show my_ldap_security_service
+----------------+--------------------------------------+
| Property | Value |
+----------------+--------------------------------------+
@ -170,8 +176,9 @@ and see that a security service now has empty list of share networks:
Shared File Systems service allows you to update a security service fields
using :command:`manila security-service-update` command with optional
arguments such as ``--dns-ip``, ``--server``, ``--domain``, ``--user``,
``--password``, ``--name``, or ``--description``.
arguments such as :option:`--dns-ip`, :option:`--server`, :option:`--domain`,
:option:`--user`, :option:`--password`, :option:`--name`, or
:option:`--description`.
To remove a security service, that is not associated with any share networks,
run:

1
doc/admin-guide-cloud/source/shared_file_systems_share_management.rst
View File

@ -24,6 +24,7 @@ various network file storage devices, instead of the base implementation. That
is the real purpose of the Shared File Systems service in production.
.. toctree::
shared_file_systems_crud_share.rst
shared_file_systems_manage_and_unmanage_share.rst
shared_file_systems_share_resize.rst

5
doc/admin-guide-cloud/source/shared_file_systems_share_networks.rst
View File

@ -17,6 +17,7 @@ List networks in a tenant, run:
.. code-block:: console
$ neutron net-list
+--------------+---------+---------------------------------------+
| id | name | subnets |
+--------------+---------+---------------------------------------+
@ -61,6 +62,7 @@ To create a share network with private network and subnetwork, run:
.. code-block:: console
$ manila share-network-create --neutron-net-id 5ed5a854-21dc-4ed3-870a-117b7064eb21 --neutron-subnet-id 74dcfb5a-b4d7-4855-86f5-a669729428dc --name my_share_net --description "My first share network"
+-------------------+--------------------------------------+
| Property | Value |
+-------------------+--------------------------------------+
@ -88,6 +90,7 @@ Check network list, run:
.. code-block:: console
$ manila share-network-list
+--------------------------------------+--------------+
| id | name |
+--------------------------------------+--------------+
@ -102,6 +105,7 @@ list of networks. This network was created by Generic driver for inner usage.
.. code-block:: console
$ neutron net-list
+--------------+------------------------+------------------------------------+
| id | name | subnets |
+--------------+------------------------+------------------------------------+
@ -118,6 +122,7 @@ You also can see detailed information about the share network including
.. code-block:: console
$ neutron net-show manila_service_network
+---------------------------+--------------------------------------+
| Field | Value |
+---------------------------+--------------------------------------+

2
doc/admin-guide-cloud/source/shared_file_systems_share_resize.rst
View File

@ -24,6 +24,7 @@ To extend the share and check the result, run:
$ manila extend Share1 2
$ manila show Share1
+-----------------------------+-------------------------------------------+
| Property | Value |
+-----------------------------+-------------------------------------------+
@ -59,6 +60,7 @@ check the result, run:
$ manila shrink Share1 1
$ manila show Share1
+-----------------------------+-------------------------------------------+
| Property | Value |
+-----------------------------+-------------------------------------------+

4
doc/admin-guide-cloud/source/shared_file_systems_share_types.rst
View File

@ -86,6 +86,7 @@ can be public.
$ manila type-create netapp1 False --is_public True
$ manila type-list
+-----+--------+-----------+-----------+-----------------------------------+-----------------------+
| ID | Name | Visibility| is_default| required_extra_specs | optional_extra_specs |
+-----+--------+-----------+-----------+-----------------------------------+-----------------------+
@ -107,6 +108,7 @@ extra specifications:
.. code-block:: console
$ manila extra-specs-list
+-------------+---------+-------------------------------------+
| ID | Name | all_extra_specs |
+-------------+---------+-------------------------------------+
@ -135,6 +137,7 @@ Create a private type:
.. code-block:: console
$ manila type-create my_type1 True --is_public False
+-----+---------+-----------+-----------+----------------------------------+----------------------+
| ID | Name | Visibility| is_default| required_extra_specs | optional_extra_specs |
+-----+---------+-----------+-----------+----------------------------------+----------------------+
@ -160,6 +163,7 @@ Get information about access for a private share type ``my_type1``:
.. code-block:: console
$ manila type-access-list my_type1
+----------------------------------+
| Project_ID |
+----------------------------------+

4
doc/admin-guide-cloud/source/shared_file_systems_snapshots.rst
View File

@ -22,6 +22,7 @@ Create a snapshot from the share:
.. code-block:: console
$ manila snapshot-create Share1 --name Snapshot1 --description "Snapshot of Share1"
+-------------+--------------------------------------+
| Property | Value |
+-------------+--------------------------------------+
@ -47,6 +48,7 @@ Check that status of a snapshot is ``available``:
.. code-block:: console
$ manila snapshot-show Snapshot1
+-------------+--------------------------------------+
| Property | Value |
+-------------+--------------------------------------+
@ -68,6 +70,7 @@ Create a share from a snapshot and check whether it is available:
.. code-block:: console
$ manila create nfs 1 --name Share2 --metadata source=snapshot --description "Share from a snapshot." --snapshot-id 962e8126-35c3-47bb-8c00-f0ee37f42ddd
+-----------------------------+--------------------------------------+
| Property | Value |
+-----------------------------+--------------------------------------+
@ -97,6 +100,7 @@ Create a share from a snapshot and check whether it is available:
+-----------------------------+--------------------------------------+
$ manila show Share2
+-----------------------------+-------------------------------------------+
| Property | Value |
+-----------------------------+-------------------------------------------+

2
doc/admin-guide-cloud/source/telemetry-alarms.rst
View File

@ -231,6 +231,7 @@ brevity):
.. code-block:: console
$ ceilometer alarm-list
+----------+--------+-------------------+---------------------------------+
| Alarm ID | Name | State | Alarm condition |
+----------+--------+-------------------+---------------------------------+
@ -291,6 +292,7 @@ via the audit API:
.. code-block:: console
$ ceilometer alarm-history ALARM_ID
+------------------+-----------+---------------------------------------+
| Type | Timestamp | Detail |
+------------------+-----------+---------------------------------------+

1
doc/admin-guide-cloud/source/telemetry-data-collection.rst
View File

@ -516,6 +516,7 @@ following command should be invoked:
$ ceilometer sample-create -r 37128ad6-daaa-4d22-9509-b7e1c6b08697 \
-m memory.usage --meter-type gauge --meter-unit MB --sample-volume 48
+-------------------+--------------------------------------------+
| Property | Value |
+-------------------+--------------------------------------------+

7
doc/admin-guide-cloud/source/telemetry-data-retrieval.rst
View File

@ -214,6 +214,7 @@ be used:
.. code-block:: console
$ ceilometer meter-list
+------------------------+------------+------+------------------------------------------+----------------------------------+----------------------------------+
| Name | Type | Unit | Resource ID | User ID | Project ID |
+------------------------+------------+------+------------------------------------------+----------------------------------+----------------------------------+
@ -260,6 +261,7 @@ VM instance:
.. code-block:: console
$ ceilometer meter-list --query resource=bb52e52b-1e42-4751-b3ac-45c52d83ba07
+-------------------------+------------+-----------+--------------------------------------+----------------------------------+----------------------------------+
| Name | Type | Unit | Resource ID | User ID | Project ID |
+-------------------------+------------+-----------+--------------------------------------+----------------------------------+----------------------------------+
@ -289,6 +291,7 @@ the available query types. The request for all the samples of the
.. code-block:: console
$ ceilometer sample-list --meter cpu
+--------------------------------------+-------+------------+------------+------+---------------------+
| Resource ID | Meter | Type | Volume | Unit | Timestamp |
+--------------------------------------+-------+------------+------------+------+---------------------+
@ -312,6 +315,7 @@ collected samples. The following command can be executed to request the
$ ceilometer sample-list --meter cpu --query resource=bb52e52b-1e42-4751-
b3ac-45c52d83ba07
+--------------------------------------+------+------------+------------+------+---------------------+
| Resource ID | Name | Type | Volume | Unit | Timestamp |
+--------------------------------------+------+------------+------------+------+---------------------+
@ -354,6 +358,7 @@ and ``disk.read.bytes`` meters, the following command should be invoked:
$ ceilometer query-samples --filter '{"and": \
[{"=":{"resource":"bb52e52b-1e42-4751-b3ac-45c52d83ba07"}},{"or":[{"=":{"counter_name":"cpu"}}, \
{"=":{"counter_name":"disk.read.bytes"}}]}]}' --orderby '[{"timestamp":"asc"}]' --limit 6
+--------------------------------------+-----------------+------------+------------+------+---------------------+
| Resource ID | Meter | Type | Volume | Unit | Timestamp |
+--------------------------------------+-----------------+------------+------------+------+---------------------+
@ -375,6 +380,7 @@ following command can be executed:
.. code-block:: console
$ ceilometer event-list
+--------------------------------------+---------------+----------------------------+-----------------------------------------------------------------+
| Message ID | Event Type | Generated | Traits |
+--------------------------------------+---------------+----------------------------+-----------------------------------------------------------------+
@ -415,6 +421,7 @@ retrieve specific events:
$ ceilometer event-list -q 'event_type=compute.instance.exists; \
instance_type=m1.tiny'
+--------------------------------------+-------------------------+----------------------------+----------------------------------------------------------------------------------+
| Message ID | Event Type | Generated | Traits |
+--------------------------------------+-------------------------+----------------------------+----------------------------------------------------------------------------------+