openstack/openstack-manuals
Code Issues Proposed changes

Merge "Fix usage of option and parameter"

Browse Source
This commit is contained in:
Jenkins 2015-04-27 01:30:36 +00:00 committed by Gerrit Code Review
commit d31223d437
14 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -151,7 +151,7 @@ openstack --os-username admin --os-password secrete --os-project-name admin proj
<para>You can also configure Identity authentication <para>You can also configure Identity authentication
middleware using the <option>admin_user</option> and middleware using the <option>admin_user</option> and
<option>admin_password</option> options.</para> <option>admin_password</option> options.</para>
<note><para>The <option>admin_token</option> parameter is deprecated, <note><para>The <option>admin_token</option> option is deprecated,
and no longer used for configuring auth_token middleware.</para></note> and no longer used for configuring auth_token middleware.</para></note>
<para>For services that have a separate paste-deploy .ini file, <para>For services that have a separate paste-deploy .ini file,
you can configure the authentication middleware in the you can configure the authentication middleware in the

2
doc/admin-guide-cloud/compute/section_compute-configure-ipv6.xml
View File

@ -49,7 +49,7 @@
<note> <note>
<para>You can add a fixed range for IPv6 addresses to the <command>nova network-create</command> <para>You can add a fixed range for IPv6 addresses to the <command>nova network-create</command>
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. <parameter>network-create</parameter> parameter.
</para> </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 the IPv6 global routing prefix by using the <para>You can set the IPv6 global routing prefix by using the

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

@ -276,7 +276,7 @@ router_id = 1064ad16-36b7-4c2f-86f0-daa2bcbd6b2a</programlisting>
<para>To enable the L3 agent to support multiple external <para>To enable the L3 agent to support multiple external
networks, edit the <filename>l3_agent.ini</filename> file networks, edit the <filename>l3_agent.ini</filename> file
and leave the <option>gateway_external_network_id</option> and leave the <option>gateway_external_network_id</option>
and <option>external_network_bridge</option> parameters unset:</para> and <option>external_network_bridge</option> options unset:</para>
<programlisting language="ini">handle_internal_only_routers = True <programlisting language="ini">handle_internal_only_routers = True
gateway_external_network_id = gateway_external_network_id =
external_network_bridge = </programlisting> external_network_bridge = </programlisting>
@ -353,7 +353,7 @@ external_network_bridge = </programlisting>
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
<parameter>--multi_host</parameter> option in nova-network.</para> <parameter>--multi_host</parameter> parameter 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

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

@ -823,7 +823,7 @@
pool is created with default provider for LBaaS service. You should configure pool is created with default provider for LBaaS service. You should configure
the default provider in the <literal>[service_providers]</literal> section of the default provider in the <literal>[service_providers]</literal> section of
<filename>neutron.conf</filename> file. If no default provider is specified <filename>neutron.conf</filename> file. If no default provider is specified
for LBaaS, the <parameter>--provider</parameter> option is required for pool for LBaaS, the <parameter>--provider</parameter> parameter is required for pool
creation.</para> creation.</para>
<screen><prompt>$</prompt> <userinput>neutron lb-pool-create --lb-method ROUND_ROBIN --name mypool --protocol HTTP --subnet-id <replaceable>SUBNET_UUID</replaceable> <parameter>--provider <replaceable>PROVIDER_NAME</replaceable></parameter></userinput></screen> <screen><prompt>$</prompt> <userinput>neutron lb-pool-create --lb-method ROUND_ROBIN --name mypool --protocol HTTP --subnet-id <replaceable>SUBNET_UUID</replaceable> <parameter>--provider <replaceable>PROVIDER_NAME</replaceable></parameter></userinput></screen>
</listitem> </listitem>

6
doc/admin-guide-cloud/telemetry/section_telemetry-data-collection.xml
View File

@ -495,7 +495,7 @@
<filename>event_pipeline.yaml</filename>, next to the <filename>event_pipeline.yaml</filename>, next to the
<filename>ceilometer.conf</filename> file. The meter pipeline and event pipeline <filename>ceilometer.conf</filename> file. The meter pipeline and event pipeline
configuration files can be set by the <option>pipeline_cfg_file</option> configuration files can be set by the <option>pipeline_cfg_file</option>
and <option>event_pipeline_cfg_file</option> parameters listed in the <link xlink:href= and <option>event_pipeline_cfg_file</option> options listed in the <link xlink:href=
"http://docs.openstack.org/juno/config-reference/content/ch_configuring-openstack-telemetry.html" "http://docs.openstack.org/juno/config-reference/content/ch_configuring-openstack-telemetry.html"
>Description of configuration options for api table</link> section in the >Description of configuration options for api table</link> section in the
<citetitle>OpenStack Configuration Reference</citetitle> respectively. Multiple pipelines <citetitle>OpenStack Configuration Reference</citetitle> respectively. Multiple pipelines
@ -713,7 +713,7 @@ sinks:
<title>Aggregator transformer</title> <title>Aggregator transformer</title>
<para>A transformer that sums up the incoming samples until enough samples have <para>A transformer that sums up the incoming samples until enough samples have
come in or a timeout has been reached.</para> come in or a timeout has been reached.</para>
<para>Timeout can be specified with the <option>retention_time</option> parameter. <para>Timeout can be specified with the <option>retention_time</option> option.
If we want to flush the aggregation after a set number of samples have been If we want to flush the aggregation after a set number of samples have been
aggregated, we can specify the size parameter.</para> aggregated, we can specify the size parameter.</para>
<para>The volume of the created sample is the sum of the volumes of samples that came <para>The volume of the created sample is the sum of the volumes of samples that came
@ -837,7 +837,7 @@ sinks:
<simplesect> <simplesect>
<title>Database dispatcher</title> <title>Database dispatcher</title>
<para>When the database dispatcher is configured as data store, you have the option to set <para>When the database dispatcher is configured as data store, you have the option to set
a <option>time_to_live</option> parameter (ttl) for samples. By default the time to a <option>time_to_live</option> option (ttl) for samples. By default the time to
live value for samples is set to -1, which means that they are kept in the database forever. live value for samples is set to -1, which means that they are kept in the database forever.
</para> </para>
<para>The time to live value is specified in seconds. Each sample has a time stamp, and the <para>The time to live value is specified in seconds. Each sample has a time stamp, and the

2
doc/admin-guide-cloud/telemetry/section_telemetry-data-retrieval.xml
View File

@ -188,7 +188,7 @@
</itemizedlist> </itemizedlist>
</para> </para>
<note> <note>
<para>The <option>aggregate.param</option> parameter is <para>The <option>aggregate.param</option> option is
required.</para> required.</para>
</note> </note>
</listitem> </listitem>

2
doc/config-reference/block-storage/section_fc-zoning.xml
View File

@ -91,7 +91,7 @@ cisco_sb_connector = cinder.zonemanager.drivers.cisco.cisco_fc_zone_client_cli.C
</para> </para>
<para>The Cisco Fibre Channel Zone Driver supports basic and enhanced zoning <para>The Cisco Fibre Channel Zone Driver supports basic and enhanced zoning
modes.The zoning VSAN must exist with an active zone set name which is modes.The zoning VSAN must exist with an active zone set name which is
same as the <option>fc_fabric_names</option> parameter. same as the <option>fc_fabric_names</option> option.
</para> </para>
</note> </note>
<section xml:id="cisco-zone-driver-sys-reqs"> <section xml:id="cisco-zone-driver-sys-reqs">

2
doc/config-reference/compute/section_rpc.xml
View File

@ -49,7 +49,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 <parameter>--qpid_hostname</parameter> option accepts a host <para>The <parameter>--qpid_hostname</parameter> parameter 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>

2
doc/config-reference/image-service/section_image-service-backend-vmware.xml
View File

@ -31,7 +31,7 @@
back end, use the SPBM feature.</para> back end, use the SPBM feature.</para>
</note></para> </note></para>
<para>In the <literal>glance_store</literal> section, set the <para>In the <literal>glance_store</literal> section, set the
<option>default_store</option> parameter to <option>default_store</option> option to
<userinput>vsphere</userinput>, as shown in this code <userinput>vsphere</userinput>, as shown in this code
sample:</para> sample:</para>
<programlisting language="ini">[glance_store] <programlisting language="ini">[glance_store]

2
doc/config-reference/networking/section_rpc-for-networking.xml
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 <parameter>--qpid_hostname</parameter> option accepts a host <para>The <parameter>--qpid_hostname</parameter> parameter accepts a host
name or IP address value.</para> name or IP address value.</para>
</note> </note>
<programlisting language="ini"> <programlisting language="ini">

2
doc/image-guide/section_glance-image-metadata.xml
View File

@ -16,7 +16,7 @@
<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 <parameter>--property <para>You can add metadata to Image service images by using the <parameter>--property
<replaceable>key</replaceable>=<replaceable>value</replaceable></parameter> option with the <replaceable>key</replaceable>=<replaceable>value</replaceable></parameter> parameter 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>

4
doc/install-guide/section_sahara-install.xml
View File

@ -38,14 +38,14 @@
<step> <step>
<para>Edit <filename>/etc/sahara/sahara.conf</filename> configuration file</para> <para>Edit <filename>/etc/sahara/sahara.conf</filename> configuration file</para>
<substeps> <substeps>
<step os="rhel;centos;fedora;opensuse;sles;ubuntu"><para>First, edit <option>connection</option> parameter in <step os="rhel;centos;fedora;opensuse;sles;ubuntu"><para>First, edit <option>connection</option> option in
the <literal>[database]</literal> section. The URL provided here the <literal>[database]</literal> section. The URL provided here
should point to an empty database. For instance, connection should point to an empty database. For instance, connection
string for MySQL database will be: string for MySQL database will be:
<programlisting language="ini">connection = mysql://sahara:<replaceable>SAHARA_DBPASS</replaceable>@<replaceable>controller</replaceable>/sahara</programlisting> <programlisting language="ini">connection = mysql://sahara:<replaceable>SAHARA_DBPASS</replaceable>@<replaceable>controller</replaceable>/sahara</programlisting>
</para></step> </para></step>
<step os="rhel;centos;fedora;opensuse;sles;ubuntu"><para>Switch to the <literal>[keystone_authtoken]</literal> <step os="rhel;centos;fedora;opensuse;sles;ubuntu"><para>Switch to the <literal>[keystone_authtoken]</literal>
section. The <option>auth_uri</option> parameter should point to section. The <option>auth_uri</option> option should point to
the public Identity API endpoint. <option>identity_uri</option> the public Identity API endpoint. <option>identity_uri</option>
should point to the admin Identity API endpoint. For example: should point to the admin Identity API endpoint. For example:
<programlisting language="ini">auth_uri = http://<replaceable>controller</replaceable>:5000/v2.0 <programlisting language="ini">auth_uri = http://<replaceable>controller</replaceable>:5000/v2.0

4
doc/networking-guide/section_networking_adv_agent.xml
View File

@ -273,7 +273,7 @@ router_id = 1064ad16-36b7-4c2f-86f0-daa2bcbd6b2a</programlisting>
<para>To enable the L3 agent to support multiple external <para>To enable the L3 agent to support multiple external
networks, edit the <filename>l3_agent.ini</filename> networks, edit the <filename>l3_agent.ini</filename>
file and leave the <option>gateway_external_network_id</option> file and leave the <option>gateway_external_network_id</option>
and <option>external_network_bridge</option> parameters and <option>external_network_bridge</option> options
unset:</para> unset:</para>
<programlisting language="ini">handle_internal_only_routers = True <programlisting language="ini">handle_internal_only_routers = True
gateway_external_network_id = gateway_external_network_id =
@ -351,7 +351,7 @@ router_id = 1064ad16-36b7-4c2f-86f0-daa2bcbd6b2a</programlisting>
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
<parameter>--multi_host</parameter> option in nova-network.</para> <parameter>--multi_host</parameter> parameter 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

2
doc/networking-guide/section_networking_adv_features.xml
View File

@ -824,7 +824,7 @@
pool is created with default provider for LBaaS service. You should configure pool is created with default provider for LBaaS service. You should configure
the default provider in the <literal>[service_providers]</literal> section of the default provider in the <literal>[service_providers]</literal> section of
<filename>neutron.conf</filename> file. If no default provider is specified <filename>neutron.conf</filename> file. If no default provider is specified
for LBaaS, the <parameter>--provider</parameter> option is required for pool for LBaaS, the <parameter>--provider</parameter> parameter is required for pool
creation.</para> creation.</para>
<screen><prompt>$</prompt> <userinput>neutron lb-pool-create --lb-method ROUND_ROBIN --name mypool --protocol HTTP --subnet-id <replaceable>SUBNET_UUID</replaceable> <parameter>--provider <replaceable>PROVIDER_NAME</replaceable></parameter></userinput></screen> <screen><prompt>$</prompt> <userinput>neutron lb-pool-create --lb-method ROUND_ROBIN --name mypool --protocol HTTP --subnet-id <replaceable>SUBNET_UUID</replaceable> <parameter>--provider <replaceable>PROVIDER_NAME</replaceable></parameter></userinput></screen>
</listitem> </listitem>