Use parameter instead of option for CLI parameters

Change-Id: Ie494e326d708da4382d76ea8840175d4bd9bc2fb
This commit is contained in:
Christian Berendt 2014-09-05 22:16:25 +02:00
parent 0a9a5c25c1
commit 49d09622ea
12 changed files with 25 additions and 25 deletions

View File

@ -67,7 +67,7 @@
<para>Create the snapshot; you can do this while <para>Create the snapshot; you can do this while
the volume is attached to an instance:</para> the volume is attached to an instance:</para>
<screen><prompt>#</prompt> <userinput>lvcreate --size 10G --snapshot --name volume-00000001-snapshot /dev/cinder-volumes/volume-00000001</userinput></screen> <screen><prompt>#</prompt> <userinput>lvcreate --size 10G --snapshot --name volume-00000001-snapshot /dev/cinder-volumes/volume-00000001</userinput></screen>
<para>Use the <option>--snapshot</option> <para>Use the <parameter>--snapshot</parameter>
configuration option to tell LVM that you want configuration option to tell LVM that you want
a snapshot of an already existing volume. The a snapshot of an already existing volume. The
command includes the size of the space command includes the size of the space

View File

@ -42,12 +42,12 @@
command. Specify <option>public</option> or <option>private</option> after the command. Specify <option>public</option> or <option>private</option> after the
<option>network-create</option> parameter.</para> <option>network-create</option> parameter.</para>
<screen><prompt>$</prompt> <userinput>nova network-create public --fixed-range-v4 <replaceable>FIXED_RANGE_V4</replaceable> --vlan <replaceable>VLAN_ID</replaceable> --vpn <replaceable>VPN_START</replaceable> --fixed-range-v6 <replaceable>FIXED_RANGE_V6</replaceable></userinput></screen> <screen><prompt>$</prompt> <userinput>nova network-create public --fixed-range-v4 <replaceable>FIXED_RANGE_V4</replaceable> --vlan <replaceable>VLAN_ID</replaceable> --vpn <replaceable>VPN_START</replaceable> --fixed-range-v6 <replaceable>FIXED_RANGE_V6</replaceable></userinput></screen>
<para>You can set IPv6 global routing prefix by using the <option>--fixed_range_v6</option> <para>You can set IPv6 global routing prefix by using the <parameter>--fixed_range_v6</parameter>
parameter. The default value for the parameter is <literal>fd00::/48</literal>.</para> parameter. The default value for the parameter is <literal>fd00::/48</literal>.</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>When you use <literal>FlatDHCPManager</literal>, the command uses the original <para>When you use <literal>FlatDHCPManager</literal>, the command uses the original
<option>--fixed_range_v6</option> value. For example:</para> <parameter>--fixed_range_v6</parameter> value. For example:</para>
<screen><prompt>$</prompt> <userinput>nova network-create public --fixed-range-v4 10.0.2.0/24 --fixed-range-v6 fd00:1::/48</userinput></screen> <screen><prompt>$</prompt> <userinput>nova network-create public --fixed-range-v4 10.0.2.0/24 --fixed-range-v6 fd00:1::/48</userinput></screen>
</listitem> </listitem>
<listitem> <listitem>

View File

@ -164,15 +164,15 @@
<para>Where:</para> <para>Where:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><option>--fixed-range-v4-</option> specifies the network subnet.</para> <para><parameter>--fixed-range-v4-</parameter> specifies the network subnet.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><option>--fixed-cidr</option> specifies a range of fixed IP addresses to <para><parameter>--fixed-cidr</parameter> specifies a range of fixed IP addresses to
allocate, and can be a subset of the <option>--fixed-range-v4</option> allocate, and can be a subset of the <parameter>--fixed-range-v4</parameter>
argument.</para> argument.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><option>--bridge</option> specifies the bridge device to which this network is <para><parameter>--bridge</parameter> specifies the bridge device to which this network is
connected on every compute node.</para> connected on every compute node.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>

View File

@ -365,14 +365,14 @@ external_network_bridge = br-ex-2</programlisting>
<title>Limitations</title> <title>Limitations</title>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis>No equivalent for nova-network <option>--multi_host</option> <para><emphasis>No equivalent for nova-network <parameter>--multi_host</parameter>
option</emphasis>. Nova-network has a model where the L3, NAT, and DHCP option</emphasis>. Nova-network has a model where the L3, NAT, and DHCP
processing happen on the compute node itself, rather than a dedicated networking processing happen on the compute node itself, rather than a dedicated networking
node. OpenStack Networking now support running multiple l3-agent and dhcp-agents node. OpenStack Networking now support running multiple l3-agent and dhcp-agents
with load being split across those agents, but the tight coupling of that with load being split across those agents, but the tight coupling of that
scheduling with the location of the VM is not supported in Icehouse. The Juno scheduling with the location of the VM is not supported in Icehouse. The Juno
release is expected to include an exact replacement for the release is expected to include an exact replacement for the
<option>--multi_host</option> option in nova-network.</para> <parameter>--multi_host</parameter> option in nova-network.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>Linux network namespace required on nodes running <systemitem <para><emphasis>Linux network namespace required on nodes running <systemitem

View File

@ -97,7 +97,7 @@
<listitem> <listitem>
<para><emphasis role="bold">Snapshots</emphasis>. A read-only point in time copy <para><emphasis role="bold">Snapshots</emphasis>. A read-only point in time copy
of a volume. The snapshot can be created from a volume that is currently in of a volume. The snapshot can be created from a volume that is currently in
use (through the use of <option>--force True</option>) or in an available use (through the use of <parameter>--force True</parameter>) or in an available
state. The snapshot can then be used to create a new volume through create state. The snapshot can then be used to create a new volume through create
from snapshot.</para> from snapshot.</para>
</listitem> </listitem>

View File

@ -50,7 +50,7 @@
<option>qpid_hostname</option> to the host name where the <option>qpid_hostname</option> to the host name where the
broker runs in the <filename>nova.conf</filename> file.</para> broker runs in the <filename>nova.conf</filename> file.</para>
<note> <note>
<para>The <option>--qpid_hostname</option> option accepts a host <para>The <parameter>--qpid_hostname</parameter> option accepts a host
name or IP address value.</para> name or IP address value.</para>
</note> </note>
<programlisting language="ini">qpid_hostname=hostname.example.com</programlisting> <programlisting language="ini">qpid_hostname=hostname.example.com</programlisting>

View File

@ -59,7 +59,7 @@ rpc_backend=neutron.openstack.common.rpc.impl_qpid
the broker runs in the <filename>neutron.conf</filename> the broker runs in the <filename>neutron.conf</filename>
file.</para> file.</para>
<note> <note>
<para>The <option>--qpid_hostname</option> option accepts a host <para>The <parameter>--qpid_hostname</parameter> option accepts a host
name or IP address value.</para> name or IP address value.</para>
</note> </note>
<programlisting language="ini"> <programlisting language="ini">

View File

@ -15,8 +15,8 @@
<note><para>Compute's <systemitem>ImagePropertiesFilter</systemitem> value is specified in the <note><para>Compute's <systemitem>ImagePropertiesFilter</systemitem> value is specified in the
<option>scheduler_default_filter</option> value in the <option>scheduler_default_filter</option> value in the
<filename>/etc/nova/nova.conf</filename> file.</para></note> <filename>/etc/nova/nova.conf</filename> file.</para></note>
<para>You can add metadata to Image Service images by using the <option>--property <para>You can add metadata to Image Service images by using the <parameter>--property
<replaceable>key</replaceable>=<replaceable>value</replaceable></option> option with the <replaceable>key</replaceable>=<replaceable>value</replaceable></parameter> option with the
<command>glance image-create</command> or <command>glance image-update</command> command. More <command>glance image-create</command> or <command>glance image-update</command> command. More
than one property can be specified. For example:</para> than one property can be specified. For example:</para>
<screen><prompt>$</prompt> <userinput>glance image-update <replaceable>img-uuid</replaceable> --property architecture=arm --property hypervisor_type=qemu</userinput></screen> <screen><prompt>$</prompt> <userinput>glance image-update <replaceable>img-uuid</replaceable> --property architecture=arm --property hypervisor_type=qemu</userinput></screen>

View File

@ -15,11 +15,11 @@
(endpoint) of the Identity service before you run (endpoint) of the Identity service before you run
<command>keystone</command> commands.</para> <command>keystone</command> commands.</para>
<para>You can pass the value of the administration token to the <para>You can pass the value of the administration token to the
<command>keystone</command> command with the <option>--os-token</option> <command>keystone</command> command with the <parameter>--os-token</parameter>
option or set the temporary <envar>OS_SERVICE_TOKEN</envar> environment option or set the temporary <envar>OS_SERVICE_TOKEN</envar> environment
variable. Similarly, you can pass the location of the Identity service variable. Similarly, you can pass the location of the Identity service
to the <command>keystone</command> command with the to the <command>keystone</command> command with the
<option>--os-endpoint</option> option or set the temporary <parameter>--os-endpoint</parameter> option or set the temporary
<envar>OS_SERVICE_ENDPOINT</envar> environment variable. This guide <envar>OS_SERVICE_ENDPOINT</envar> environment variable. This guide
uses environment variables to reduce command length.</para> uses environment variables to reduce command length.</para>
<para>For more information, see the <para>For more information, see the

View File

@ -362,14 +362,14 @@ external_network_bridge = br-ex-2</programlisting>
<title>Limitations</title> <title>Limitations</title>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis>No equivalent for nova-network <option>--multi_host</option> <para><emphasis>No equivalent for nova-network <parameter>--multi_host</parameter>
option</emphasis>. Nova-network has a model where the L3, NAT, and DHCP option</emphasis>. Nova-network has a model where the L3, NAT, and DHCP
processing happen on the compute node itself, rather than a dedicated networking processing happen on the compute node itself, rather than a dedicated networking
node. OpenStack Networking now support running multiple l3-agent and dhcp-agents node. OpenStack Networking now support running multiple l3-agent and dhcp-agents
with load being split across those agents, but the tight coupling of that with load being split across those agents, but the tight coupling of that
scheduling with the location of the VM is not supported in Icehouse. The Juno scheduling with the location of the VM is not supported in Icehouse. The Juno
release is expected to include an exact replacement for the release is expected to include an exact replacement for the
<option>--multi_host</option> option in nova-network.</para> <parameter>--multi_host</parameter> option in nova-network.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis>Linux network namespace required on nodes running <systemitem <para><emphasis>Linux network namespace required on nodes running <systemitem
@ -447,4 +447,4 @@ external_network_bridge = br-ex-2</programlisting>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
</section> </section>

View File

@ -9,7 +9,7 @@
<para>The swift client is simple to use, scalable, and flexible.</para><para>Use the swift client <option>-o</option> or <para>The swift client is simple to use, scalable, and flexible.</para><para>Use the swift client <option>-o</option> or
<option>-output</option> option to get short answers to <option>-output</option> option to get short answers to
questions about logs,</para> questions about logs,</para>
<para>You can use the <option>-o</option> or <option>--output</option> option with a <para>You can use the <parameter>-o</parameter> or <parameter>--output</parameter> option with a
single object download to redirect the command output to a single object download to redirect the command output to a
specific file or to STDOUT (<literal>-</literal>). The ability specific file or to STDOUT (<literal>-</literal>). The ability
to redirect the output to STDOUT enables you to pipe to redirect the output to STDOUT enables you to pipe
@ -112,7 +112,7 @@ Write ACL:</computeroutput></screen></step>
8 PUT-499</computeroutput></screen></step> 8 PUT-499</computeroutput></screen></step>
<step><para>Discover how many PUT requests are in each log file.</para> <step><para>Discover how many PUT requests are in each log file.</para>
<para>Use a bash for loop with awk and swift with <para>Use a bash for loop with awk and swift with
the <option>-o</option> or <option>--output</option> option and a the <parameter>-o</parameter> or <parameter>--output</parameter> option and a
hyphen (<literal>-</literal>) to discover how many hyphen (<literal>-</literal>) to discover how many
PUT requests are in each log file.</para> PUT requests are in each log file.</para>

View File

@ -139,7 +139,7 @@
<para>List the available security groups:</para> <para>List the available security groups:</para>
<note> <note>
<para>If you are an admin user, specify the <para>If you are an admin user, specify the
<option>--all-tenants</option> parameter <parameter>--all-tenants</parameter> parameter
to list groups for all tenants.</para> to list groups for all tenants.</para>
</note> </note>
<screen><prompt>$</prompt> <userinput>nova secgroup-list --all-tenants</userinput></screen> <screen><prompt>$</prompt> <userinput>nova secgroup-list --all-tenants</userinput></screen>
@ -249,15 +249,15 @@
<note> <note>
<para>You can also place arbitrary local files <para>You can also place arbitrary local files
into the instance file system at creation time into the instance file system at creation time
by using the <option>--file by using the <parameter>--file
&lt;dst-path=src-path&gt;</option> option. &lt;dst-path=src-path&gt;</parameter> option.
You can store up to five files. For example, You can store up to five files. For example,
if you have a special authorized keys file if you have a special authorized keys file
named named
<filename>special_authorized_keysfile</filename> <filename>special_authorized_keysfile</filename>
that you want to put on the instance rather that you want to put on the instance rather
than using the regular SSH key injection, you than using the regular SSH key injection, you
can use the <option>--file</option> option as can use the <parameter>--file</parameter> option as
shown in the following example:</para> shown in the following example:</para>
<screen><prompt>$</prompt> <userinput><?db-font-size 75%?>nova boot --image ubuntu-cloudimage --flavor 1 vm-name \ <screen><prompt>$</prompt> <userinput><?db-font-size 75%?>nova boot --image ubuntu-cloudimage --flavor 1 vm-name \
--file /root/.ssh/authorized_keys=special_authorized_keysfile</userinput></screen> --file /root/.ssh/authorized_keys=special_authorized_keysfile</userinput></screen>