openstack/openstack-manuals
Code Issues Proposed changes

Standardize usage of client arguments (admin-guide-cloud)

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: Idfc1124b1261a4b74fbdab524d92e54ef75662bb
This commit is contained in:
Christian Berendt 2014-09-09 09:34:03 +02:00
parent 6f7757deb8
commit 04781c89ea
7 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/admin-guide-cloud/ch_identity_mgmt.xml
View File

@ -153,22 +153,22 @@ pipeline = [...] json_body stats_reporting ec2_extension [...] admin_service</pr
export OS_SERVICE_ENDPOINT=http://127.0.0.1:5000/v2.0/
export OS_SERVICE_TOKEN=secrete_token
keystone user-list
keystone tenant-create --name=demo
keystone tenant-create --name demo
# Using token auth flags
keystone --os-token=secrete --os-endpoint=http://127.0.0.1:5000/v2.0/ user-list
keystone --os-token=secrete --os-endpoint=http://127.0.0.1:5000/v2.0/ tenant-create --name=demo
keystone --os-token secrete --os-endpoint http://127.0.0.1:5000/v2.0/ user-list
keystone --os-token secrete --os-endpoint http://127.0.0.1:5000/v2.0/ tenant-create --name=demo
# Using user + password + tenant_name env variables
export OS_USERNAME=admin
export OS_PASSWORD=secrete
export OS_TENANT_NAME=admin
keystone user-list
keystone tenant-create --name=demo
keystone tenant-create --name demo
# Using user + password + tenant_name flags
keystone --username=admin --password=secrete --tenant_name=admin user-list
keystone --username=admin --password=secrete --tenant_name=admin tenant-create --name=demo</programlisting>
keystone --username admin --password secrete --tenant_name admin user-list
keystone --username admin --password secrete --tenant_name admin tenant-create --name demo</programlisting>
</section>
<section xml:id="auth-token-middleware-with-username-and-password">
<title>Authentication middleware with user name and

14
doc/admin-guide-cloud/compute/section_compute-networking-nova.xml
View File

@ -160,7 +160,7 @@
</note>
<para>For flat and flat DHCP modes, use the following command to create a network:</para>
<screen><prompt>$</prompt> <userinput>nova network-create vmnet \
--fixed-range-v4=10.0.0.0/16 --fixed-cidr=10.0.20.0/24 --bridge=br100</userinput></screen>
--fixed-range-v4 10.0.0.0/16 --fixed-cidr 10.0.20.0/24 --bridge br100</userinput></screen>
<para>Where:</para>
<itemizedlist>
<listitem>
@ -208,7 +208,7 @@
<systemitem>dnsmasq</systemitem> logging output can be useful for troubleshooting if
VM instances boot successfully but are not reachable over the network.</para>
<para>A network administrator can run <code>nova-manage fixed reserve
--address=<replaceable>IP_ADDRESS</replaceable></code> to specify the starting
--address <replaceable>IP_ADDRESS</replaceable></code> to specify the starting
point IP address
(<replaceable>n</replaceable>.<replaceable>n</replaceable>.<replaceable>n</replaceable>.<replaceable>n</replaceable>)
to reserve with the DHCP server. This reservation only affects which IP address the VMs
@ -469,7 +469,7 @@ echo 'Extra user data here'</computeroutput></screen>
instances. Use the <command>nova-manage floating create</command> command to add
entries to this list.</para>
<para>For example:</para>
<screen><prompt>#</prompt> <userinput>nova-manage floating create --pool=nova --ip_range=68.99.26.170/31</userinput></screen>
<screen><prompt>#</prompt> <userinput>nova-manage floating create --pool nova --ip_range 68.99.26.170/31</userinput></screen>
<para>You can use the following <command>nova-manage</command> commands to perform
floating IP operations:</para>
<itemizedlist>
@ -478,7 +478,7 @@ echo 'Extra user data here'</computeroutput></screen>
<para>Lists the floating IP addresses in the pool.</para>
</listitem>
<listitem>
<screen><prompt>#</prompt> <userinput>nova-manage floating create --pool=<replaceable>POOL_NAME</replaceable> --ip_range=<replaceable>CIDR</replaceable></userinput></screen>
<screen><prompt>#</prompt> <userinput>nova-manage floating create --pool <replaceable>POOL_NAME</replaceable> --ip_range <replaceable>CIDR</replaceable></userinput></screen>
<para>Creates specific floating IPs for either a single address or a
subnet.</para>
</listitem>
@ -515,7 +515,7 @@ echo 'Extra user data here'</computeroutput></screen>
<para>To determine the project ID, you must have administrative rights. You can disassociate
the project from the network with a scrub command and the project ID as the final
parameter:</para>
<screen><prompt>#</prompt> <userinput>nova-manage project scrub --project=<replaceable>ID</replaceable></userinput></screen>
<screen><prompt>#</prompt> <userinput>nova-manage project scrub --project <replaceable>ID</replaceable></userinput></screen>
</section>
<section xml:id="section_use-multi-nics">
<title>Multiple interfaces for your instances (multinic)</title>
@ -572,8 +572,8 @@ echo 'Extra user data here'</computeroutput></screen>
<title>Use the multinic feature</title>
<para>In order to use the multinic feature, first create two networks, and attach them
to your tenant (still named 'project' on the command line):
<screen><prompt>$</prompt> <userinput>nova network-create first-net --fixed-range-v4=20.20.0.0/24 --project-id=$your-project</userinput>
<prompt>$</prompt> <userinput>nova network-create second-net --fixed-range-v4=20.20.10.0/24 --project-id=$your-project</userinput> </screen>
<screen><prompt>$</prompt> <userinput>nova network-create first-net --fixed-range-v4 20.20.0.0/24 --project-id $your-project</userinput>
<prompt>$</prompt> <userinput>nova network-create second-net --fixed-range-v4 20.20.10.0/24 --project-id $your-project</userinput> </screen>
Now every time you spawn a new instance, it gets two IP addresses from the
respective DHCP servers:</para>
<screen><prompt>$</prompt> <userinput>nova list</userinput>

2
doc/admin-guide-cloud/networking/section_networking-adv-config.xml
View File

@ -291,7 +291,7 @@ gateway_external_network_id = 2118b11c-011e-4fa5-a6f1-2ca34d372c35
external_network_bridge = br-ex</programlisting>
<screen><prompt>$</prompt> <userinput>python /opt/stack/neutron/bin/neutron-l3-agent
--config-file /etc/neutron/neutron.conf
--config-file=/etc/neutron/l3_agent.ini</userinput></screen>
--config-file /etc/neutron/l3_agent.ini</userinput></screen>
<para>For the second (or later) agent, invoke it with the following
<filename>l3_agent.ini</filename> where the
<option>handle_internal_only_routers</option> option is set to

4
doc/admin-guide-cloud/networking/section_networking-config-identity.xml
View File

@ -76,12 +76,12 @@ catalog.$Region.network.name = Network Service</programlisting>
<substeps>
<step>
<para>Create the <literal>admin</literal> role:</para>
<screen><prompt>$</prompt> <userinput>ADMIN_ROLE=$(get_id keystone role-create --name=admin)
<screen><prompt>$</prompt> <userinput>ADMIN_ROLE=$(get_id keystone role-create --name admin)
</userinput></screen>
</step>
<step>
<para>Create the <literal>neutron</literal> user:</para>
<screen><prompt>$</prompt> <userinput>NEUTRON_USER=$(get_id keystone user-create --name=neutron --pass="$NEUTRON_PASSWORD" --email=demo@example.com --tenant-id service)
<screen><prompt>$</prompt> <userinput>NEUTRON_USER=$(get_id keystone user-create --name neutron --pass "$NEUTRON_PASSWORD" --email demo@example.com --tenant-id service)
</userinput></screen>
</step>
<step>

8
doc/admin-guide-cloud/networking/section_networking-scenarios.xml
View File

@ -43,7 +43,7 @@ bridge_mappings = physnet2:br-eth1</programlisting>
<prompt>$</prompt> <userinput>neutron net-create --tenant-id $tenant public01 \
--provider:network_type flat \
--provider:physical_network physnet1 \
--router:external=True</userinput>
--router:external True</userinput>
<prompt>$</prompt> <userinput>neutron subnet-create --tenant-id $tenant --name public01_subnet01 \
--gateway 10.64.201.254 public01 10.64.201.0/24 --disable-dhcp</userinput>
<prompt>$</prompt> <userinput>neutron router-gateway-set router01 public01</userinput></screen></para>
@ -322,7 +322,7 @@ bridge_mappings = physnet1:br-ex,physnet2:br-eth1</programlisting>
<prompt>$</prompt> <userinput>neutron net-create --tenant-id $tenant public01 \
--provider:network_type flat \
--provider:physical_network physnet1 \
--router:external=True</userinput>
--router:external True</userinput>
<prompt>$</prompt> <userinput>neutron subnet-create --tenant-id $tenant --name public01_subnet01 \
--gateway 10.64.201.254 public01 10.64.201.0/24 --disable-dhcp</userinput></screen></para>
<para>Under the <literal>tenantA</literal> user tenant, create the tenant router and set
@ -490,7 +490,7 @@ physical_interface_mappings = physnet2:eth1</programlisting>
<prompt>$</prompt> <userinput>neutron net-create --tenant-id $tenant public01 \
--provider:network_type flat \
--provider:physical_network physnet1 \
--router:external=True</userinput>
--router:external True</userinput>
<prompt>$</prompt> <userinput>neutron subnet-create --tenant-id $tenant --name public01_subnet01 \
--gateway 10.64.201.254 public01 10.64.201.0/24 --disable-dhcp</userinput>
<prompt>$</prompt> <userinput>neutron router-gateway-set router01 public01</userinput></screen></para>
@ -598,7 +598,7 @@ physical_interface_mappings = physnet2:eth1</programlisting>
<prompt>$</prompt> <userinput>neutron net-create --tenant-id $tenant public01 \
--provider:network_type flat \
--provider:physical_network physnet1 \
--router:external=True</userinput>
--router:external True</userinput>
<prompt>$</prompt> <userinput>neutron subnet-create --tenant-id $tenant --name public01_subnet01 \
--gateway 10.64.201.254 public01 10.64.201.0/24 --disable-dhcp</userinput></screen></para>
<para>Under the <literal>tenantA</literal> user tenant, create the tenant router and set

10
doc/admin-guide-cloud/networking/section_networking-use.xml
View File

@ -371,9 +371,9 @@
<para>The cloud administrator can run any <command>neutron</command> command on behalf
of tenants by specifying an Identity <option>tenant_id</option> in the command, as
follows:</para>
<screen><prompt>$</prompt> <userinput>neutron net-create --tenant-id=<replaceable>TENANT_ID</replaceable> <replaceable>NETWORK_NAME</replaceable></userinput></screen>
<screen><prompt>$</prompt> <userinput>neutron net-create --tenant-id <replaceable>TENANT_ID</replaceable> <replaceable>NETWORK_NAME</replaceable></userinput></screen>
<para>For example:</para>
<screen><prompt>$</prompt> <userinput>neutron net-create --tenant-id=5e4bbe24b67a4410bc4d9fae29ec394e net1</userinput></screen>
<screen><prompt>$</prompt> <userinput>neutron net-create --tenant-id 5e4bbe24b67a4410bc4d9fae29ec394e net1</userinput></screen>
<note>
<para>To view all tenant IDs in Identity, run the following command as an Identity
Service admin user:</para>
@ -458,16 +458,16 @@
<td><para>Searches for ports with a <option>device_id</option> that matches
the Compute instance UUID. See <xref linkend="network_compute_note"
/>.</para></td>
<td><screen><prompt>$</prompt> <userinput>neutron port-list --device_id=<replaceable>VM_ID</replaceable></userinput></screen></td>
<td><screen><prompt>$</prompt> <userinput>neutron port-list --device_id <replaceable>VM_ID</replaceable></userinput></screen></td>
</tr>
<tr>
<td>Searches for ports, but shows only the <option>mac_address</option> of
the port.</td>
<td><screen><prompt>$</prompt> <userinput>neutron port-list --field mac_address --device_id=<replaceable>VM_ID</replaceable></userinput></screen></td>
<td><screen><prompt>$</prompt> <userinput>neutron port-list --field mac_address --device_id <replaceable>VM_ID</replaceable></userinput></screen></td>
</tr>
<tr>
<td>Temporarily disables a port from sending traffic.</td>
<td><screen><prompt>$</prompt> <userinput>neutron port-update <replaceable>PORT_ID</replaceable> --admin_state_up=False</userinput></screen></td>
<td><screen><prompt>$</prompt> <userinput>neutron port-update <replaceable>PORT_ID</replaceable> --admin_state_up False</userinput></screen></td>
</tr>
</tbody>
</table>

14
doc/admin-guide-cloud/networking/section_networking_adv_features.xml
View File

@ -393,7 +393,7 @@
<para>Creates external networks.</para>
</td>
<td>
<screen><prompt>#</prompt> <userinput>neutron net-create public --router:external=True</userinput>
<screen><prompt>#</prompt> <userinput>neutron net-create public --router:external True</userinput>
<prompt>$</prompt> <userinput>neutron subnet-create public 172.16.1.0/24</userinput></screen>
</td>
</tr>
@ -402,7 +402,7 @@
<para>Lists external networks.</para>
</td>
<td>
<screen><prompt>$</prompt> <userinput>neutron net-list -- --router:external=True</userinput></screen>
<screen><prompt>$</prompt> <userinput>neutron net-list -- --router:external True</userinput></screen>
</td>
</tr>
<tr>
@ -467,7 +467,7 @@
the VM NIC to which the floating IP should map.</para>
</td>
<td>
<screen><prompt>$</prompt> <userinput>neutron port-list -c id -c fixed_ips -- --device_id=<replaceable>INSTANCE_ID</replaceable></userinput></screen>
<screen><prompt>$</prompt> <userinput>neutron port-list -c id -c fixed_ips -- --device_id <replaceable>INSTANCE_ID</replaceable></userinput></screen>
<para>This port must be on an Networking subnet that is attached to a
router uplinked to the external network used to create the floating
IP. Conceptually, this is because the router must be able to perform
@ -509,7 +509,7 @@
<para>Finds floating IP for a specified VM port.</para>
</td>
<td>
<screen><prompt>$</prompt> <userinput>neutron floatingip-list -- --port_id=ZZZ</userinput></screen>
<screen><prompt>$</prompt> <userinput>neutron floatingip-list -- --port_id ZZZ</userinput></screen>
</td>
</tr>
<tr>
@ -1261,7 +1261,7 @@
<para>Associates a queue with a network.</para>
</td>
<td>
<screen><prompt>$</prompt> <userinput>neutron net-create network --queue_id=<replaceable>QUEUE_ID</replaceable></userinput></screen>
<screen><prompt>$</prompt> <userinput>neutron net-create network --queue_id <replaceable>QUEUE_ID</replaceable></userinput></screen>
</td>
</tr>
<tr>
@ -1350,10 +1350,10 @@
<title>VMware NSX L3 extension operations</title>
<para>Create external network and map it to a specific NSX gateway
service:</para>
<screen><prompt>$</prompt> <userinput>neutron net-create public --router:external=True --provider:network_type l3_ext \
<screen><prompt>$</prompt> <userinput>neutron net-create public --router:external True --provider:network_type l3_ext \
--provider:physical_network <replaceable>L3_GATEWAY_SERVICE_UUID</replaceable></userinput></screen>
<para>Terminate traffic on a specific VLAN from a NSX gateway service:</para>
<screen><prompt>$</prompt> <userinput>neutron net-create public --router:external=True --provider:network_type l3_ext \
<screen><prompt>$</prompt> <userinput>neutron net-create public --router:external True --provider:network_type l3_ext \
--provider:physical_network <replaceable>L3_GATEWAY_SERVICE_UUID</replaceable> --provider:segmentation_id <replaceable>VLAN_ID</replaceable></userinput></screen>
</section>
</section>