openstack/openstack-manuals
Code Issues Proposed changes

Standardize usage of client arguments (user-guide)

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: If0a33ca02cd499769d1540b74b1ab0a217c839d4
This commit is contained in:
Christian Berendt 2014-09-08 12:59:08 +02:00
parent 7fb70cfcfc
commit dcb8fa287e
4 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/user-guide/section_cli_heat.xml
View File

@ -29,8 +29,8 @@
xlink:href="https://github.com/openstack/heat-templates"
>example template file</link>, run the following
command:</para>
<screen><prompt>$</prompt> <userinput>heat stack-create mystack --template-file=/<replaceable>PATH_TO_HEAT_TEMPLATES</replaceable>/WordPress_Single_Instance.template</userinput>
<userinput>--parameters="InstanceType=m1.large;DBUsername=<replaceable>USERNAME</replaceable>;DBPassword=<replaceable>PASSWORD</replaceable>;KeyName=<replaceable>HEAT_KEY</replaceable>;LinuxDistribution=F17"</userinput></screen>
<screen><prompt>$</prompt> <userinput>heat stack-create mystack --template-file /<replaceable>PATH_TO_HEAT_TEMPLATES</replaceable>/WordPress_Single_Instance.template</userinput>
<userinput>--parameters "InstanceType=m1.large;DBUsername=<replaceable>USERNAME</replaceable>;DBPassword=<replaceable>PASSWORD</replaceable>;KeyName=<replaceable>HEAT_KEY</replaceable>;LinuxDistribution=F17"</userinput></screen>
<para>The <literal>--parameters</literal> values that
you specify depend on the parameters that are defined
in the template. If a website hosts the template file, you can specify the URL with the
@ -56,7 +56,7 @@
<command>template-validate</command>.
</para></note>
<para>To do so, run the following command:</para>
<screen><prompt>$</prompt> <userinput>heat template-validate --template-file=/<replaceable>PATH_TO_HEAT_TEMPLATES</replaceable>/WordPress_Single_Instance.template</userinput></screen>
<screen><prompt>$</prompt> <userinput>heat template-validate --template-file /<replaceable>PATH_TO_HEAT_TEMPLATES</replaceable>/WordPress_Single_Instance.template</userinput></screen>
<para>If validation fails, the response returns an
error message.</para>
</listitem>
@ -124,8 +124,8 @@
<para xml:id="heat-stack-update">To update an existing stack from a modified
template file, run a command like the following
command:</para>
<screen><prompt>$</prompt> <userinput>heat stack-update mystack --template-file=/path/to/heat/templates/WordPress_Single_Instance_v2.template</userinput>
<userinput>--parameters="InstanceType=m1.large;DBUsername=wp;DBPassword=verybadpassword;KeyName=heat_key;LinuxDistribution=F17"</userinput>
<screen><prompt>$</prompt> <userinput>heat stack-update mystack --template-file /path/to/heat/templates/WordPress_Single_Instance_v2.template</userinput>
<userinput>--parameters "InstanceType=m1.large;DBUsername=wp;DBPassword=verybadpassword;KeyName=heat_key;LinuxDistribution=F17"</userinput>
<computeroutput>+--------------------------------------+---------------+-----------------+----------------------+
| id | stack_name | stack_status | creation_time |
+--------------------------------------+---------------+-----------------+----------------------+

10
doc/user-guide/section_cli_nova_baremetal.xml
View File

@ -54,13 +54,13 @@
<para>When you create a bare-metal node, your PM address, user name, and
password should match those that are configured in your hardware's
BIOS/IPMI configuration.</para>
<screen><prompt>$</prompt> <userinput>nova baremetal-node-create --pm_address=PM_ADDRESS --pm_user=PM_USERNAME \
--pm_password=PM_PASSWORD $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff</userinput></screen>
<screen><prompt>$</prompt> <userinput>nova baremetal-node-create --pm_address PM_ADDRESS --pm_user PM_USERNAME \
--pm_password PM_PASSWORD $(hostname -f) 1 512 10 aa:bb:cc:dd:ee:ff</userinput></screen>
<para>The following example shows the command and results from creating
a node with the PM address <filename>1.2.3.4</filename>, the PM user name
<systemitem class="username">ipmi</systemitem>, and password <literal>ipmi</literal>.</para>
<screen><prompt>$</prompt> <userinput>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</userinput>
<screen><prompt>$</prompt> <userinput>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</userinput>
<computeroutput>+------------------+-------------------+
| Property | Value |
+------------------+-------------------+
@ -109,7 +109,7 @@
<para>Set the <parameter>--availability_zone</parameter> parameter to
specify which zone or node to use to start the server. Separate the zone
from the host name with a comma. For example:</para>
<screen><prompt>$</prompt> <userinput>nova boot --availability_zone=zone:<replaceable>HOST</replaceable>,<replaceable>NODE</replaceable></userinput></screen>
<screen><prompt>$</prompt> <userinput>nova boot --availability_zone zone:<replaceable>HOST</replaceable>,<replaceable>NODE</replaceable></userinput></screen>
<para><literal>host</literal> is optional for the
<literal>--availability_zone</literal> parameter. You can specify
simply <literal>zone:,node</literal>. You must still use the

6
doc/user-guide/section_cli_nova_config-drive.xml
View File

@ -111,21 +111,21 @@
<procedure>
<step>
<para>To enable the configuration drive, pass the
<literal>--config-drive=true</literal>
<literal>--config-drive true</literal>
parameter to the <command>nova boot</command>
command.</para>
<para>The following example enables the configuration drive and
passes user data, two files, and two key/value metadata
pairs, all of which are accessible from the configuration
drive:</para>
<screen><prompt>$</prompt> <userinput>nova boot --config-drive=true --image my-image-name --key-name mykey --flavor 1 --user-data ./my-user-data.txt myinstance --file /etc/network/interfaces=/home/myuser/instance-interfaces --file known_hosts=/home/myuser/.ssh/known_hosts --meta role=webservers --meta essential=false</userinput></screen>
<screen><prompt>$</prompt> <userinput>nova boot --config-drive true --image my-image-name --key-name mykey --flavor 1 --user-data ./my-user-data.txt myinstance --file /etc/network/interfaces=/home/myuser/instance-interfaces --file known_hosts=/home/myuser/.ssh/known_hosts --meta role=webservers --meta essential=false</userinput></screen>
<para>You can also configure the Compute service to always
create a configuration drive by setting the following option
in the <filename>/etc/nova/nova.conf</filename> file:</para>
<programlisting language="ini">force_config_drive=true</programlisting>
<note>
<para>If a user passes the
<literal>--config-drive=true</literal> flag to the
<literal>--config-drive true</literal> flag to the
<command>nova boot</command> command, an
administrator cannot disable the configuration
drive.</para>

2
doc/user-guide/section_cli_nova_floating_ips.xml
View File

@ -116,7 +116,7 @@
<note><para>If an instance is connected to multiple networks, you can associate a floating IP
address with a specific fixed IP address using the optional
<parameter>--fixed-address</parameter> parameter:</para>
<screen><prompt>$</prompt> <userinput>nova floating-ip-associate --fixed-address=<replaceable>FIXED_IP_ADDRESS</replaceable> <replaceable>INSTANCE_NAME_OR_ID</replaceable> <replaceable>FLOATING_IP_ADDRESS</replaceable></userinput></screen>
<screen><prompt>$</prompt> <userinput>nova floating-ip-associate --fixed-address <replaceable>FIXED_IP_ADDRESS</replaceable> <replaceable>INSTANCE_NAME_OR_ID</replaceable> <replaceable>FLOATING_IP_ADDRESS</replaceable></userinput></screen>
</note>
</step>
</procedure>