openstack/openstack-manuals
Code Issues Proposed changes

Small edits and a couple of tag fixes.

Browse Source 
Partial-Bug: #1121866

Change-Id: I074dc21aa2d189fde9bc14ddce394071f6acc5bd
This commit is contained in:
Summer Long 2014-01-10 16:07:10 +10:00
parent da069dc13f
commit c90f87d082
8 changed files with 42 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/common/section_cli_keystone_services.xml
View File

@ -56,20 +56,12 @@
+----------------------------------+----------+----------+---------------------------+</computeroutput></screen> +----------------------------------+----------+----------+---------------------------+</computeroutput></screen>
</step> </step>
<step> <step>
<para>To create a service, you use the following <para>To create a service, use the following command:</para>
command syntax:</para> <screen><prompt>$</prompt> <userinput>keystone service-create --name <replaceable>service_name</replaceable> --type <replaceable>service_type</replaceable> --description <replaceable>service_description</replaceable></userinput></screen>
<screen><prompt>$</prompt> <userinput>keystone help service-create</userinput></screen> <screen>Where:
<screen><computeroutput>usage: keystone service-create --name &lt;name> --type &lt;type> -<replaceable>service_name</replaceable> = Name of new service (must be unique)
[--description &lt;service-description>] -<replaceable>service_type</replaceable> = Service type (one of: identity, compute, network, image, or object-store)
-<replaceable>service_description</replaceable> = Description of service</screen>
Add service to Service Catalog.
Arguments:
--name &lt;name> Name of new service (must be unique)
--type &lt;type> Service type (one of: identity, compute, network,
image, or object-store)
--description &lt;service-description>
Description of service</computeroutput></screen>
<para>For example, to create a service named <para>For example, to create a service named
<literal>swift</literal> of type <literal>swift</literal> of type
<literal>object-store</literal>, run the <literal>object-store</literal>, run the
@ -85,7 +77,9 @@ Arguments:
+-------------+----------------------------------+</computeroutput></screen> +-------------+----------------------------------+</computeroutput></screen>
</step> </step>
<step> <step>
<para>To get details for a specified service:</para> <para>To get details for a specific service, run the following:</para>
<screen><prompt>$</prompt> <userinput>keystone service-get <replaceable>service_ID</replaceable></userinput></screen>
<para>For example:</para>
<screen><prompt>$</prompt> <userinput>keystone service-get 84c23f4b942c44c38b9c42c5e517cd9a</userinput></screen> <screen><prompt>$</prompt> <userinput>keystone service-get 84c23f4b942c44c38b9c42c5e517cd9a</userinput></screen>
<screen><computeroutput>+-------------+----------------------------------+ <screen><computeroutput>+-------------+----------------------------------+
| Property | Value | | Property | Value |

10
doc/common/section_cli_nova_quotas.xml
View File

@ -218,7 +218,7 @@
</procedure> </procedure>
<procedure> <procedure>
<title>To view quota values for an existing tenant (project)</title> <title>To view quota values for an existing tenant (project)</title>
<step><para>Place the tenant ID in a useable variable, as follows:</para> <step><para>Place the tenant ID in a usable variable, as follows:</para>
<screen><prompt>$</prompt> <userinput>tenant=$(keystone tenant-list | awk '/<replaceable>tenantName</replaceable>/ {print $2}')</userinput></screen> <screen><prompt>$</prompt> <userinput>tenant=$(keystone tenant-list | awk '/<replaceable>tenantName</replaceable>/ {print $2}')</userinput></screen>
</step> </step>
<step> <step>
@ -285,11 +285,11 @@
<title>View and update Compute quotas for a tenant user</title> <title>View and update Compute quotas for a tenant user</title>
<procedure> <procedure>
<title>To view quota values for a tenant user</title> <title>To view quota values for a tenant user</title>
<step><para>Place the user ID in a useable variable, as follows:</para> <step><para>Place the user ID in a usable variable, as follows:</para>
<screen><prompt>$</prompt> <userinput>tenantUser=$(keystone user-list | awk '/<replaceable>userName</replaceable>/ {print $2}')</userinput></screen> <screen><prompt>$</prompt> <userinput>tenantUser=$(keystone user-list | awk '/<replaceable>userName</replaceable>/ {print $2}')</userinput></screen>
</step> </step>
<step> <step>
<para>Place the user's tenant ID in a useable variable, as follows:</para> <para>Place the user's tenant ID in a usable variable, as follows:</para>
<screen><prompt>$</prompt> <userinput>tenant=$(keystone tenant-list | awk '/<replaceable>tenantName</replaceable>/ {print $2}')</userinput></screen> <screen><prompt>$</prompt> <userinput>tenant=$(keystone tenant-list | awk '/<replaceable>tenantName</replaceable>/ {print $2}')</userinput></screen>
</step> </step>
<step> <step>
@ -319,10 +319,10 @@
</procedure> </procedure>
<procedure> <procedure>
<title>To update quota values for a tenant user</title> <title>To update quota values for a tenant user</title>
<step><para>Place the user ID in a useable variable, as follows:</para> <step><para>Place the user ID in a usable variable, as follows:</para>
<screen><prompt>$</prompt> <userinput>tenantUser=$(keystone user-list | awk '/<replaceable>userName</replaceable>/ {print $2}')</userinput></screen> <screen><prompt>$</prompt> <userinput>tenantUser=$(keystone user-list | awk '/<replaceable>userName</replaceable>/ {print $2}')</userinput></screen>
</step> </step>
<step><para>Place the user's tenant ID in a useable variable, as follows:</para> <step><para>Place the user's tenant ID in a usable variable, as follows:</para>
<screen><prompt>$</prompt> <userinput>tenant=$(keystone tenant-list | awk '/<replaceable>userName</replaceable>/ {print $2}')</userinput></screen> <screen><prompt>$</prompt> <userinput>tenant=$(keystone tenant-list | awk '/<replaceable>userName</replaceable>/ {print $2}')</userinput></screen>
</step> </step>
<step> <step>

18
doc/common/section_dashboard_access.xml
View File

@ -39,7 +39,7 @@
<step> <step>
<para>In the address bar, type the host name or IP address <para>In the address bar, type the host name or IP address
for the dashboard:</para> for the dashboard:</para>
<screen><prompt>$</prompt> <userinput>https://<replaceable>IP_ADDRESS_OR_HOSTNAME</replaceable>/</userinput></screen> <screen><userinput>https://<replaceable>IP_ADDRESS_OR_HOSTNAME</replaceable>/</userinput></screen>
<note> <note>
<title>Certificate warning</title> <title>Certificate warning</title>
<para>If a certificate warning appears when you try to <para>If a certificate warning appears when you try to
@ -78,14 +78,15 @@
view and manage resources in that project.</para> view and manage resources in that project.</para>
<para>The <guilabel>Project</guilabel> tab displays the <para>The <guilabel>Project</guilabel> tab displays the
details of the selected project.</para> details of the selected project.</para>
<informalfigure xml:id="dashboard_project_user"> <figure xml:id="dashboard_project_user">
<title>Dashboard Projects</title>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata fileref="figures/dashboard-project-tab.png" <imagedata fileref="figures/dashboard-project-tab.png"
format="PNG" contentwidth="6in" width="6in"/> format="PNG" contentwidth="6in" width="6in"/>
</imageobject> </imageobject>
</mediaobject> </mediaobject>
</informalfigure> </figure>
<para>Access the following tabs:</para> <para>Access the following tabs:</para>
<para><guilabel>Manage Compute</guilabel> tab</para> <para><guilabel>Manage Compute</guilabel> tab</para>
<variablelist> <variablelist>
@ -125,7 +126,7 @@
<term><guilabel>Access &amp; <term><guilabel>Access &amp;
Security</guilabel></term> Security</guilabel></term>
<listitem> <listitem>
<para>Use these tabs to complete these <para>Use the following tabs to complete these
tasks:</para> tasks:</para>
<formalpara> <formalpara>
<title><guilabel>Security Groups</guilabel> <title><guilabel>Security Groups</guilabel>
@ -199,7 +200,8 @@
<para>Enables administrative users to view usage and manage <para>Enables administrative users to view usage and manage
instances, volumes, flavors, images, projects, users, instances, volumes, flavors, images, projects, users,
services, and quotas.</para> services, and quotas.</para>
<informalfigure xml:id="dashboard_admin_project_tab"> <figure xml:id="dashboard_admin_project_tab">
<title>Admin Tab</title>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata <imagedata
@ -207,7 +209,7 @@
format="PNG" contentwidth="6in" width="6in"/> format="PNG" contentwidth="6in" width="6in"/>
</imageobject> </imageobject>
</mediaobject> </mediaobject>
</informalfigure> </figure>
<para>Access the following categories to complete these tasks:</para> <para>Access the following categories to complete these tasks:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
@ -219,7 +221,7 @@
<varlistentry> <varlistentry>
<term><guilabel>Resource Usage</guilabel></term> <term><guilabel>Resource Usage</guilabel></term>
<listitem> <listitem>
<para>Use these tabs to view the following usages:</para> <para>Use the following tabs to view the following usages:</para>
<formalpara> <formalpara>
<title><guilabel>Global Disk Usage</guilabel> <title><guilabel>Global Disk Usage</guilabel>
tab</title> tab</title>
@ -316,7 +318,7 @@
<varlistentry> <varlistentry>
<term><guilabel>System Info</guilabel></term> <term><guilabel>System Info</guilabel></term>
<listitem> <listitem>
<para>Use these tabs to view the service info:</para> <para>Use the following tabs to view the service info:</para>
<formalpara> <formalpara>
<title><guilabel>Services</guilabel> tab</title> <title><guilabel>Services</guilabel> tab</title>
<para>View a list of the services.</para> <para>View a list of the services.</para>

4
doc/user-guide-admin/section_cli_cinder_quotas.xml
View File

@ -14,8 +14,8 @@
<col width="80%"/> <col width="80%"/>
<thead> <thead>
<tr> <tr>
<td>Property name</td> <th>Property name</th>
<td>Defines the number of</td> <th>Defines the number of</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>

6
doc/user-guide-admin/section_cli_nova_manage_projects_security.xml
View File

@ -172,7 +172,7 @@ export OS_TENANT_NAME=tenant01</programlisting>
<para>Delete the new security group, as follows:</para> <para>Delete the new security group, as follows:</para>
<screen><prompt>$</prompt> <userinput>nova secgroup-delete <replaceable>GroupName</replaceable></userinput></screen> <screen><prompt>$</prompt> <userinput>nova secgroup-delete <replaceable>GroupName</replaceable></userinput></screen>
<para>For example:</para> <para>For example:</para>
<screen><prompt>$</prompt> <userinput>nova secgroup-create global_http</userinput></screen> <screen><prompt>$</prompt> <userinput>nova secgroup-delete global_http</userinput></screen>
</step> </step>
</procedure> </procedure>
<procedure> <procedure>
@ -193,10 +193,10 @@ export OS_TENANT_NAME=tenant01</programlisting>
<para>Add a source group, as follows:</para> <para>Add a source group, as follows:</para>
<screen><prompt>$</prompt> <userinput>nova secgroup-add-group-rule <replaceable>secGroupName source-group ip-protocol from-port to-port</replaceable></userinput></screen> <screen><prompt>$</prompt> <userinput>nova secgroup-add-group-rule <replaceable>secGroupName source-group ip-protocol from-port to-port</replaceable></userinput></screen>
<para>For example:</para> <para>For example:</para>
<screen><prompt>$</prompt> <userinput>nova secgroup-add-group-rule cluster global-http tcp 22 22</userinput></screen> <screen><prompt>$</prompt> <userinput>nova secgroup-add-group-rule cluster global_http tcp 22 22</userinput></screen>
<para>The <code>cluster</code> rule allows ssh access from <para>The <code>cluster</code> rule allows ssh access from
any other instance that uses the any other instance that uses the
<code>global-http</code> group.</para> <code>global_http</code> group.</para>
</step> </step>
</procedure> </procedure>
</section> </section>

4
doc/user-guide-admin/section_dashboard_admin_manage_instances.xml
View File

@ -85,9 +85,9 @@
<para>Depending on the current state of the instance, <para>Depending on the current state of the instance,
you can choose to pause, un-pause, suspend, you can choose to pause, un-pause, suspend,
resume, soft or hard reboot, or terminate an resume, soft or hard reboot, or terminate an
instance.</para> instance (items in red are disabled).</para>
<figure> <figure>
<title>Dashboard&mdash;Actions</title> <title>Dashboard&mdash;Instance Actions</title>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata <imagedata

13
doc/user-guide-admin/section_dashboard_admin_manage_projects_users.xml
View File

@ -166,14 +166,17 @@
project, </para> project, </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
<mediaobject> <figure xml:id="cloud_dash_users_list">
<imageobject> <title>Edit the Users List</title>
<imagedata <mediaobject>
<imageobject>
<imagedata
fileref="figures/cloud_dash_users_list.png" fileref="figures/cloud_dash_users_list.png"
format="PNG" contentwidth="6in" width="6in" format="PNG" contentwidth="6in" width="6in"
/> />
</imageobject> </imageobject>
</mediaobject> </mediaobject>
</figure>
</step> </step>
<step> <step>
<para>To assign a user to the current project, click <para>To assign a user to the current project, click

6
doc/user-guide-admin/section_dashboard_admin_manage_volumes.xml
View File

@ -21,9 +21,9 @@
xlink:href="http://docs.openstack.org/user-guide/content/" xlink:href="http://docs.openstack.org/user-guide/content/"
><citetitle>OpenStack End User ><citetitle>OpenStack End User
Guide</citetitle></link>.</para> Guide</citetitle></link>.</para>
<para>As an administrative user, you can manage volumes and volume <para>As an administrative user, you can manage volumes and volume types for users in various
types for users in various projects. You can create and delete projects. You can create and delete volume types, and you can view and delete
volumes types, and you can view and delete volumes.</para> volumes.</para>
<section xml:id="dashboard_create_volume_types"> <section xml:id="dashboard_create_volume_types">
<title>Create a volume type</title> <title>Create a volume type</title>
<procedure> <procedure>