openstack/openstack-manuals
Code Issues Proposed changes

Standardize usage of client arguments (config-reference)

Browse Source 
Like documented at https://wiki.openstack.org/wiki/Documentation/Conventions#Client_arguments:_.22--option_ARGUMENT.22
we prefer to use '--option ARGUMENT'.

Change-Id: Iea99bbd253ee4ced00ab9983c00ebc805e6e7568
This commit is contained in:
Christian Berendt 2014-09-09 16:07:14 +02:00
parent 304e8f39c2
commit be95faee43
8 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/config-reference/block-storage/drivers/nfs-volume-driver.xml
View File

@ -114,7 +114,7 @@
<step> <step>
<para>You can now create volumes as you normally <para>You can now create volumes as you normally
would:</para> would:</para>
<screen><prompt>$</prompt> <userinput>nova volume-create --display-name=myvol 5</userinput> <screen><prompt>$</prompt> <userinput>nova volume-create --display-name myvol 5</userinput>
<prompt>#</prompt> <userinput>ls /var/lib/cinder/nfs/46c5db75dc3a3a50a10bfd1a456a9f3f</userinput> <prompt>#</prompt> <userinput>ls /var/lib/cinder/nfs/46c5db75dc3a3a50a10bfd1a456a9f3f</userinput>
<computeroutput>volume-a8862558-e6d6-4648-b5df-bb84f31c8935</computeroutput></screen> <computeroutput>volume-a8862558-e6d6-4648-b5df-bb84f31c8935</computeroutput></screen>
<para>This volume can also be attached and deleted <para>This volume can also be attached and deleted

4
doc/config-reference/block-storage/drivers/xen-sm-driver.xml
View File

@ -143,8 +143,8 @@
option.)</emphasis> option.)</emphasis>
</para> </para>
<programlisting> <programlisting>
--volume_driver="nova.volume.xensm.XenSMDriver" --volume_driver "nova.volume.xensm.XenSMDriver"
--use_local_volumes=False --use_local_volumes False
</programlisting> </programlisting>
</listitem> </listitem>
<listitem> <listitem>

12
doc/config-reference/compute/section_compute-cells.xml
View File

@ -184,14 +184,14 @@ rabbit_username=cell1_user
rabbit_password=cell1_passwd rabbit_password=cell1_passwd
rabbit_virtual_host=cell1_vhost</programlisting></para> rabbit_virtual_host=cell1_vhost</programlisting></para>
<para>You can run this in the API cell as <para>You can run this in the API cell as
root:<screen><prompt>#</prompt> <userinput>nova-manage cell create --name=cell1 --cell_type=child \ root:<screen><prompt>#</prompt> <userinput>nova-manage cell create --name cell1 --cell_type child \
--username=cell1_user --password=cell1_passwd --hostname=10.0.1.10 \ --username cell1_user --password cell1_passwd --hostname 10.0.1.10 \
--port=5673 --virtual_host=cell1_vhost --woffset=1.0 --wscale=1.0</userinput></screen></para> --port 5673 --virtual_host cell1_vhost --woffset 1.0 --wscale 1.0</userinput></screen></para>
<para>Repeat the previous steps for all child cells.</para> <para>Repeat the previous steps for all child cells.</para>
<para>In the child cell, run the following, as <para>In the child cell, run the following, as
root:<screen><prompt>#</prompt> <userinput>nova-manage cell create --name=api --cell_type=parent \ root:<screen><prompt>#</prompt> <userinput>nova-manage cell create --name api --cell_type parent \
--username=api_user --password=api_passwd --hostname=10.0.0.10 \ --username api_user --password api_passwd --hostname 10.0.0.10 \
--port=5672 --virtual_host=api_vhost --woffset=1.0 --wscale=1.0</userinput></screen></para> --port 5672 --virtual_host api_vhost --woffset 1.0 --wscale 1.0</userinput></screen></para>
<para>To customize the Compute cells, use the configuration <para>To customize the Compute cells, use the configuration
option settings documented in <xref option settings documented in <xref
linkend="config_table_nova_cells"/>.</para> linkend="config_table_nova_cells"/>.</para>

2
doc/config-reference/compute/section_hypervisor_hyper-v.xml
View File

@ -338,7 +338,7 @@ connection=mysql://nova:passwd@<replaceable>IP_ADDRESS</replaceable>/nova</progr
>http://technet.microsoft.com/en-us/library/cc772480.aspx</link></para> >http://technet.microsoft.com/en-us/library/cc772480.aspx</link></para>
<para>Once you have successfully created a virtual machine, you can then upload the image to <para>Once you have successfully created a virtual machine, you can then upload the image to
glance using the native glance-client:</para> glance using the native glance-client:</para>
<screen><prompt>C:\></prompt><userinput>glance image-create --name="<replaceable>VM_IMAGE_NAME</replaceable>" --is-public=False --container-format=bare --disk-format=vhd</userinput></screen> <screen><prompt>C:\></prompt><userinput>glance image-create --name "<replaceable>VM_IMAGE_NAME</replaceable>" --is-public False --container-format bare --disk-format vhd</userinput></screen>
</section> </section>
<section xml:id="running_compute-with-hyper-v"> <section xml:id="running_compute-with-hyper-v">
<title>Run Compute with Hyper-V</title> <title>Run Compute with Hyper-V</title>

16
doc/config-reference/compute/section_hypervisor_vmware.xml
View File

@ -684,8 +684,8 @@ datastore_regex=&lt;optional datastore regex&gt;</programlisting>
the following command creates a Monolithic Sparse image by the following command creates a Monolithic Sparse image by
setting <option>vmware_disktype</option> to setting <option>vmware_disktype</option> to
<literal>sparse</literal>:</para> <literal>sparse</literal>:</para>
<screen><prompt>$</prompt> <userinput>glance image-create --name="ubuntu-sparse" --disk-format=vmdk \ <screen><prompt>$</prompt> <userinput>glance image-create --name "ubuntu-sparse" --disk-format vmdk \
--container-format=bare \ --container-format bare \
--property vmware_disktype="sparse" \ --property vmware_disktype="sparse" \
--property vmware_ostype="ubuntu64Guest" &lt; ubuntuLTS-sparse.vmdk</userinput></screen> --property vmware_ostype="ubuntu64Guest" &lt; ubuntuLTS-sparse.vmdk</userinput></screen>
<note><para>Specifying <literal>thin</literal> does not <note><para>Specifying <literal>thin</literal> does not
@ -710,8 +710,8 @@ xlink:href="http://cloud-images.ubuntu.com/trusty/current/trusty-server-cloudimg
example of the Ubuntu Trusty image after the example of the Ubuntu Trusty image after the
<code>qemu-img</code> conversion, the command to upload the <code>qemu-img</code> conversion, the command to upload the
VMDK disk should be something like:</para> VMDK disk should be something like:</para>
<screen><prompt>$</prompt> <userinput>glance image-create --name trusty-cloud --is-public=False \ <screen><prompt>$</prompt> <userinput>glance image-create --name trusty-cloud --is-public False \
--container-format=bare --disk-format=vmdk \ --container-format bare --disk-format vmdk \
--property vmware_disktype="sparse" \ --property vmware_disktype="sparse" \
--property vmware_adaptertype="ide" &lt; \ --property vmware_adaptertype="ide" &lt; \
trusty-server-cloudimg-amd64-disk1.vmdk</userinput></screen> trusty-server-cloudimg-amd64-disk1.vmdk</userinput></screen>
@ -728,8 +728,8 @@ trusty-server-cloudimg-amd64-disk1.vmdk</userinput></screen>
<para>Assuming a preallocated disk type and an iSCSI lsiLogic <para>Assuming a preallocated disk type and an iSCSI lsiLogic
adapter type, the following command uploads the VMDK adapter type, the following command uploads the VMDK
disk:</para> disk:</para>
<screen><prompt>$</prompt> <userinput>glance image-create --name="ubuntu-thick-scsi" --disk-format=vmdk \ <screen><prompt>$</prompt> <userinput>glance image-create --name "ubuntu-thick-scsi" --disk-format vmdk \
--container-format=bare \ --container-format bare \
--property vmware_adaptertype="lsiLogic" \ --property vmware_adaptertype="lsiLogic" \
--property vmware_disktype="preallocated" \ --property vmware_disktype="preallocated" \
--property vmware_ostype="ubuntu64Guest" &lt; ubuntuLTS-flat.vmdk</userinput></screen> --property vmware_ostype="ubuntu64Guest" &lt; ubuntuLTS-flat.vmdk</userinput></screen>
@ -751,8 +751,8 @@ trusty-server-cloudimg-amd64-disk1.vmdk</userinput></screen>
correct hypervisor type. For VMware images, set the hypervisor correct hypervisor type. For VMware images, set the hypervisor
type to <literal>vmware</literal>. Other valid hypervisor type to <literal>vmware</literal>. Other valid hypervisor
types include: xen, qemu, kvm, lxc, uml, and hyperv.</para> types include: xen, qemu, kvm, lxc, uml, and hyperv.</para>
<screen><prompt>$</prompt> <userinput>glance image-create --name="ubuntu-thick-scsi" --disk-format=vmdk \ <screen><prompt>$</prompt> <userinput>glance image-create --name "ubuntu-thick-scsi" --disk-format vmdk \
--container-format=bare \ --container-format bare \
--property vmware_adaptertype="lsiLogic" \ --property vmware_adaptertype="lsiLogic" \
--property vmware_disktype="preallocated" \ --property vmware_disktype="preallocated" \
--property hypervisor_type="vmware" \ --property hypervisor_type="vmware" \

2
doc/config-reference/compute/section_xen-install.xml
View File

@ -169,7 +169,7 @@
Image Service with Image Service with
<literal>disk-format=iso</literal>, and boot <literal>disk-format=iso</literal>, and boot
them in OpenStack Compute:</para> them in OpenStack Compute:</para>
<screen><prompt>$</prompt> <userinput>glance image-create --name=fedora_iso --disk-format=iso --container-format=bare &lt; Fedora-16-x86_64-netinst.iso</userinput></screen> <screen><prompt>$</prompt> <userinput>glance image-create --name fedora_iso --disk-format iso --container-format bare &lt; Fedora-16-x86_64-netinst.iso</userinput></screen>
</step> </step>
</procedure> </procedure>
</section> </section>

4
doc/config-reference/image-service/section_image-service-ISO-support.xml
View File

@ -18,8 +18,8 @@
<para>In the Image Service, run the following <para>In the Image Service, run the following
command:</para> command:</para>
<screen><prompt>$</prompt> <userinput>glance image-create --name ubuntu.iso \ <screen><prompt>$</prompt> <userinput>glance image-create --name ubuntu.iso \
--is-public=True --container-format=bare \ --is-public True --container-format bare \
--disk-format=iso &lt; ubuntu-13.04-server-amd64.iso</userinput></screen> --disk-format iso &lt; ubuntu-13.04-server-amd64.iso</userinput></screen>
<para>In this command, <literal>ubuntu.iso</literal> is <para>In this command, <literal>ubuntu.iso</literal> is
the name for the ISO image after it is loaded to the the name for the ISO image after it is loaded to the
Image Service, and Image Service, and

4
doc/config-reference/object-storage/section_object-storage-features.xml
View File

@ -511,7 +511,7 @@ Sample represents 1.00% of the object partition space
<para>The following command uses an admin account that own the <para>The following command uses an admin account that own the
Reseller role to set a quota on the test account:</para> Reseller role to set a quota on the test account:</para>
<screen><prompt>$</prompt> <userinput>swift -A http://127.0.0.1:8080/auth/v1.0 -U admin:admin -K admin \ <screen><prompt>$</prompt> <userinput>swift -A http://127.0.0.1:8080/auth/v1.0 -U admin:admin -K admin \
--os-storage-url=http://127.0.0.1:8080/v1/AUTH_test post -m quota-bytes:10000</userinput></screen> --os-storage-url http://127.0.0.1:8080/v1/AUTH_test post -m quota-bytes:10000</userinput></screen>
<para>Here is the stat listing of an account where quota has <para>Here is the stat listing of an account where quota has
been set:</para> been set:</para>
<screen><prompt>$</prompt> <userinput>swift -A http://127.0.0.1:8080/auth/v1.0 -U test:tester -K testing stat</userinput> <screen><prompt>$</prompt> <userinput>swift -A http://127.0.0.1:8080/auth/v1.0 -U test:tester -K testing stat</userinput>
@ -523,7 +523,7 @@ Meta Quota-Bytes: 10000
X-Timestamp: 1374075958.37454 X-Timestamp: 1374075958.37454
X-Trans-Id: tx602634cf478546a39b1be-0051e6bc7a</computeroutput></screen> X-Trans-Id: tx602634cf478546a39b1be-0051e6bc7a</computeroutput></screen>
<para>This command removes the account quota:</para> <para>This command removes the account quota:</para>
<screen><prompt>$</prompt> <userinput>swift -A http://127.0.0.1:8080/auth/v1.0 -U admin:admin -K admin --os-storage-url=http://127.0.0.1:8080/v1/AUTH_test post -m quota-bytes:</userinput></screen> <screen><prompt>$</prompt> <userinput>swift -A http://127.0.0.1:8080/auth/v1.0 -U admin:admin -K admin --os-storage-url http://127.0.0.1:8080/v1/AUTH_test post -m quota-bytes:</userinput></screen>
</section> </section>
<section xml:id="object-storage-bulk-delete"> <section xml:id="object-storage-bulk-delete">
<title>Bulk delete</title> <title>Bulk delete</title>