From 2fc7ba5fd032e8fdae7df70be0a7a7bd141f7948 Mon Sep 17 00:00:00 2001
From: liyingjun <liyingjun1988@gmail.com>
Date: Wed, 24 Dec 2014 14:55:08 +0800
Subject: [PATCH] Fixes a small typo

In the install-guide, the creating service endpoints part should
be 'Create the X service endpoints'. Also fixes some other
related consistency issues.

Change-Id: I0355801afe00e796287406315ecaa804b355e1c4
Closes-bug: #1405328
Co-Authored-By: Matt Kassawara <mkassawara@gmail.com>
backport: juno
---
 .../section_swift-controller-node.xml         | 15 ++++----
 .../section_ceilometer-controller.xml         | 26 ++++++-------
 .../section_cinder-controller-node.xml        | 37 +++++++++----------
 doc/install-guide/section_glance-install.xml  | 16 ++++----
 doc/install-guide/section_heat-install.xml    | 22 +++++------
 .../section_keystone-services.xml             |  7 ++--
 .../section_neutron-controller-node.xml       | 25 ++++++-------
 .../section_nova-controller-install.xml       | 17 ++++-----
 8 files changed, 77 insertions(+), 88 deletions(-)

diff --git a/doc/install-guide/object-storage/section_swift-controller-node.xml b/doc/install-guide/object-storage/section_swift-controller-node.xml
index 23f2915f55..41ef55a625 100644
--- a/doc/install-guide/object-storage/section_swift-controller-node.xml
+++ b/doc/install-guide/object-storage/section_swift-controller-node.xml
@@ -22,8 +22,8 @@
       it also offers an internal mechanism that allows it to operate without
       any other OpenStack services. However, for simplicity, this guide
       references the Identity service in <xref linkend="ch_keystone"/>. Before
-      you configure the Object Storage service, you must create Identity
-      service credentials including endpoints.</para>
+      you configure the Object Storage service, you must create service
+      credentials and API endpoints.</para>
     <note>
       <para>The Object Storage service does not use a SQL database on
         the controller node.</para>
@@ -33,7 +33,7 @@
         steps:</para>
       <substeps>
         <step>
-          <para>Create a <literal>swift</literal> user:</para>
+          <para>Create the <literal>swift</literal> user:</para>
           <screen><prompt>$</prompt> <userinput>keystone user-create --name swift --pass <replaceable>SWIFT_PASS</replaceable></userinput>
 <computeroutput>+----------+----------------------------------+
 | Property |              Value               |
@@ -48,16 +48,15 @@
             password.</para>
         </step>
         <step>
-          <para>Link the <literal>swift</literal> user to the
-            <literal>service</literal> tenant and <literal>admin</literal>
-            role:</para>
+          <para>Add the <literal>admin</literal> role to the
+            <literal>swift</literal> user:</para>
           <screen><prompt>$</prompt> <userinput>keystone user-role-add --user swift --tenant service --role admin</userinput></screen>
           <note>
             <para>This command provides no output.</para>
           </note>
         </step>
         <step>
-          <para>Create the <literal>swift</literal> service:</para>
+          <para>Create the <literal>swift</literal> service entity:</para>
           <screen><prompt>$</prompt> <userinput>keystone service-create --name swift --type object-store \
   --description "OpenStack Object Storage"</userinput>
 <computeroutput>+-------------+----------------------------------+
@@ -73,7 +72,7 @@
       </substeps>
     </step>
     <step>
-      <para>Create the Identity service endpoints:</para>
+      <para>Create the Object Storage service API endpoints:</para>
       <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
   --service-id $(keystone service-list | awk '/ object-store / {print $2}') \
   --publicurl 'http://<replaceable>controller</replaceable>:8080/v1/AUTH_%(tenant_id)s' \
diff --git a/doc/install-guide/section_ceilometer-controller.xml b/doc/install-guide/section_ceilometer-controller.xml
index cbe493e336..c48964d2b7 100644
--- a/doc/install-guide/section_ceilometer-controller.xml
+++ b/doc/install-guide/section_ceilometer-controller.xml
@@ -16,11 +16,11 @@
   <procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
     <title>To configure prerequisites</title>
     <para>Before you install and configure Telemetry, you must install
-      <application>MongoDB</application>, create a MongoDB database, and
-      create Identity service credentials including endpoints.</para>
+      <application>MongoDB</application>, create a MongoDB database,
+      service credentials, and API endpoints.</para>
     <step os="opensuse;sles">
       <para>Enable the Open Build Service repositories for MongoDB based on
-        your openSUSE  or SLES version:</para>
+        your openSUSE or SLES version:</para>
       <para>On openSUSE:</para>
       <screen><prompt>#</prompt> <userinput>zypper addrepo -f obs://server:database/openSUSE_13.1 Database</userinput></screen>
       <para>On SLES:</para>
@@ -104,7 +104,7 @@ Key Expires: Sat Dec 20 20:08:39 2014</programlisting>
       <screen><prompt>$</prompt> <userinput>source admin-openrc.sh</userinput></screen>
     </step>
     <step>
-      <para>To create the Identity service credentials:</para>
+      <para>To create the service credentials, complete these steps:</para>
       <substeps>
         <step>
           <para>Create the <literal>ceilometer</literal> user:</para>
@@ -113,26 +113,26 @@ Key Expires: Sat Dec 20 20:08:39 2014</programlisting>
             suitable password.</para>
         </step>
         <step>
-          <para>Link the <literal>ceilometer</literal> user to the
-            <literal>service</literal> tenant and <literal>admin</literal>
-            role:</para>
+          <para>Add the <literal>admin</literal> role to the
+            <literal>ceilometer</literal> user.</para>
          <screen><prompt>$</prompt> <userinput>keystone user-role-add --user ceilometer --tenant service --role admin</userinput></screen>
         </step>
         <step>
-          <para>Create the <literal>ceilometer</literal> service:</para>
+          <para>Create the <literal>ceilometer</literal> service
+            entity:</para>
           <screen><prompt>$</prompt> <userinput>keystone service-create --name ceilometer --type metering \
   --description "Telemetry"</userinput></screen>
         </step>
-        <step>
-          <para>Create the Identity service endpoints:</para>
-          <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
+      </substeps>
+    </step>
+    <step>
+      <para>Create the Telemetry service API endpoints:</para>
+      <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
   --service-id $(keystone service-list | awk '/ metering / {print $2}') \
   --publicurl http://<replaceable>controller</replaceable>:8777 \
   --internalurl http://<replaceable>controller</replaceable>:8777 \
   --adminurl http://<replaceable>controller</replaceable>:8777</userinput> \
   --region regionOne</screen>
-        </step>
-      </substeps>
     </step>
   </procedure>
   <procedure os="debian">
diff --git a/doc/install-guide/section_cinder-controller-node.xml b/doc/install-guide/section_cinder-controller-node.xml
index ed10e06d9d..9c233ef4bf 100644
--- a/doc/install-guide/section_cinder-controller-node.xml
+++ b/doc/install-guide/section_cinder-controller-node.xml
@@ -11,9 +11,8 @@
     volumes to instances.</para>
   <procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
     <title>To configure prerequisites</title>
-    <para>Before you install and configure the Block Storage service, you must
-      create a database and Identity service credentials including
-      endpoints.</para>
+    <para>Before you install and configure the Block Storage service, you
+      must create a database, service credentials, and API endpoints.</para>
     <step>
       <para>To create the database, complete these steps:</para>
       <substeps>
@@ -47,8 +46,7 @@
       <screen><prompt>$</prompt> <userinput>source admin-openrc.sh</userinput></screen>
     </step>
     <step>
-      <para>To create the Identity service credentials, complete these
-        steps:</para>
+      <para>To create the service credentials, complete these steps:</para>
       <substeps>
         <step>
           <para>Create a <literal>cinder</literal> user:</para>
@@ -66,16 +64,15 @@
             password.</para>
         </step>
         <step>
-          <para>Link the <literal>cinder</literal> user to the
-            <literal>service</literal> tenant and <literal>admin</literal>
-            role:</para>
+          <para>Add the <literal>admin</literal> role to the
+            <literal>cinder</literal> user:</para>
           <screen><prompt>$</prompt> <userinput>keystone user-role-add --user cinder --tenant service --role admin</userinput></screen>
           <note>
             <para>This command provides no output.</para>
           </note>
         </step>
         <step>
-          <para>Create the <literal>cinder</literal> services:</para>
+          <para>Create the <literal>cinder</literal> service entities:</para>
           <screen><prompt>$</prompt> <userinput>keystone service-create --name cinder --type volume \
   --description "OpenStack Block Storage"</userinput>
 <computeroutput>+-------------+----------------------------------+
@@ -99,13 +96,15 @@
 |     type    |             volumev2             |
 +-------------+----------------------------------+</computeroutput></screen>
           <note>
-            <para>The Block Storage service requires two different services
-              to support API versions 1 and 2.</para>
+            <para>The Block Storage service requires two different service
+              entities to support API versions 1 and 2.</para>
           </note>
         </step>
-        <step>
-          <para>Create the Block Storage service endpoints:</para>
-          <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
+      </substeps>
+    </step>
+    <step>
+      <para>Create the Block Storage service API endpoints:</para>
+      <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
   --service-id $(keystone service-list | awk '/ volume / {print $2}') \
   --publicurl http://<replaceable>controller</replaceable>:8776/v1/%\(tenant_id\)s \
   --internalurl http://<replaceable>controller</replaceable>:8776/v1/%\(tenant_id\)s \
@@ -137,12 +136,10 @@
 |    region   |                regionOne                |
 |  service_id |    16e038e449c94b40868277f1d801edb5     |
 +-------------+-----------------------------------------+</computeroutput></screen>
-          <note>
-            <para>The Block Storage service requires two different endpoints
-              to support API versions 1 and 2.</para>
-          </note>
-        </step>
-      </substeps>
+      <note>
+        <para>The Block Storage service requires two different endpoints
+          to support API versions 1 and 2.</para>
+      </note>
     </step>
   </procedure>
   <procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
diff --git a/doc/install-guide/section_glance-install.xml b/doc/install-guide/section_glance-install.xml
index c1c6e68f5b..81de85772b 100644
--- a/doc/install-guide/section_glance-install.xml
+++ b/doc/install-guide/section_glance-install.xml
@@ -16,8 +16,8 @@
   </note>
   <procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
     <title>To configure prerequisites</title>
-    <para>Before you install and configure the Image Service, you must create
-      a database and Identity service credentials including endpoints.</para>
+    <para>Before you install and configure the Image Service, you must
+      create a database, service credentials, and API endpoints.</para>
     <step>
       <para>To create the database, complete these steps:</para>
       <substeps>
@@ -51,8 +51,7 @@
       <screen><prompt>$</prompt> <userinput>source admin-openrc.sh</userinput></screen>
     </step>
     <step>
-      <para>To create the Identity service credentials, complete these
-        steps:</para>
+      <para>To create the service credentials, complete these steps:</para>
       <substeps>
         <step>
           <para>Create the <literal>glance</literal> user:</para>
@@ -70,16 +69,15 @@
             password.</para>
         </step>
         <step>
-          <para>Link the <literal>glance</literal> user to the
-            <literal>service</literal> tenant and <literal>admin</literal>
-            role:</para>
+          <para>Add the <literal>admin</literal> role to the
+            <literal>glance</literal> user:</para>
           <screen><prompt>$</prompt> <userinput>keystone user-role-add --user glance --tenant service --role admin</userinput></screen>
           <note>
             <para>This command provides no output.</para>
           </note>
         </step>
         <step>
-          <para>Create the <literal>glance</literal> service:</para>
+          <para>Create the <literal>glance</literal> service entity:</para>
           <screen><prompt>$</prompt> <userinput>keystone service-create --name glance --type image \
   --description "OpenStack Image Service"</userinput>
 <computeroutput>+-------------+----------------------------------+
@@ -95,7 +93,7 @@
       </substeps>
     </step>
     <step>
-      <para>Create the Identity service endpoints:</para>
+      <para>Create the Image Service API endpoints:</para>
       <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
   --service-id $(keystone service-list | awk '/ image / {print $2}') \
   --publicurl http://<replaceable>controller</replaceable>:9292 \
diff --git a/doc/install-guide/section_heat-install.xml b/doc/install-guide/section_heat-install.xml
index 45bdce3121..e8ee190caa 100644
--- a/doc/install-guide/section_heat-install.xml
+++ b/doc/install-guide/section_heat-install.xml
@@ -10,7 +10,7 @@
   <procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
     <title>To configure prerequisites</title>
     <para>Before you install and configure Orchestration, you must create a
-      database and Identity service credentials including endpoints.</para>
+      database, service credentials, and API endpoints.</para>
     <step>
       <para>To create the database, complete these steps:</para>
       <substeps>
@@ -44,8 +44,7 @@
       <screen><prompt>$</prompt> <userinput>source admin-openrc.sh</userinput></screen>
     </step>
     <step>
-      <para>To create the Identity service credentials, complete these
-        steps:</para>
+      <para>To create the service credentials, complete these steps:</para>
       <substeps>
         <step>
           <para>Create the <literal>heat</literal> user:</para>
@@ -63,9 +62,8 @@
             password.</para>
         </step>
         <step>
-          <para>Link the <literal>heat</literal> user to the
-            <literal>service</literal> tenant and <literal>admin</literal>
-            role:</para>
+          <para>Add the <literal>admin</literal> role to the
+            <literal>heat</literal> user:</para>
           <screen><prompt>$</prompt> <userinput>keystone user-role-add --user heat --tenant service --role admin</userinput></screen>
           <note>
             <para>This command provides no output.</para>
@@ -80,7 +78,7 @@
         </step>
         <step>
           <para>Create the <literal>heat</literal> and
-            <literal>heat-cfn</literal> services:</para>
+            <literal>heat-cfn</literal> service entities:</para>
           <screen><prompt>$</prompt> <userinput>keystone service-create --name heat --type orchestration \
   --description "Orchestration"</userinput>
 <computeroutput>+-------------+----------------------------------+
@@ -104,9 +102,11 @@
 |     type    |          cloudformation          |
 +-------------+----------------------------------+</computeroutput></screen>
         </step>
-        <step>
-          <para>Create the Identity service endpoints:</para>
-          <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
+      </substeps>
+    </step>
+    <step>
+      <para>Create the Orchestration service API endpoints:</para>
+      <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
   --service-id $(keystone service-list | awk '/ orchestration / {print $2}') \
   --publicurl http://<replaceable>controller</replaceable>:8004/v1/%\(tenant_id\)s \
   --internalurl http://<replaceable>controller</replaceable>:8004/v1/%\(tenant_id\)s \
@@ -138,8 +138,6 @@
 |    region   |            regionOne             |
 |  service_id | 297740d74c0a446bbff867acdccb33fa |
 +-------------+----------------------------------+</computeroutput></screen>
-        </step>
-      </substeps>
     </step>
   </procedure>
   <procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
diff --git a/doc/install-guide/section_keystone-services.xml b/doc/install-guide/section_keystone-services.xml
index 0b26041a94..2c712a661a 100644
--- a/doc/install-guide/section_keystone-services.xml
+++ b/doc/install-guide/section_keystone-services.xml
@@ -8,7 +8,8 @@
   <title>Create the service entity and API endpoint</title>
   <para>After you create tenants, users, and roles, you must create the
     <glossterm>service</glossterm> entity and
-    <glossterm>API endpoint</glossterm> for the Identity service.</para>
+    <glossterm baseform="API endpoint">API endpoints</glossterm> for the
+    Identity service.</para>
   <procedure>
     <title>To configure prerequisites</title>
     <step>
@@ -18,7 +19,7 @@
     </step>
   </procedure>
   <procedure>
-    <title>To create the service entity and API endpoint</title>
+    <title>To create the service entity and API endpoints</title>
     <step>
       <para>The Identity service manages a catalog of services in your
         OpenStack environment. Services use this catalog to locate other
@@ -52,7 +53,7 @@
         scalability. For simplicity, this configuration uses the management
         network for all endpoint variations and the
         <literal>regionOne</literal> region.</para>
-      <para>Create the API endpoint for the Identity service:</para>
+      <para>Create the Identity service API endpoints:</para>
       <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
   --service-id $(keystone service-list | awk '/ identity / {print $2}') \
   --publicurl http://<replaceable>controller</replaceable>:5000/v2.0 \
diff --git a/doc/install-guide/section_neutron-controller-node.xml b/doc/install-guide/section_neutron-controller-node.xml
index 0061e361ff..e0ad2cf629 100644
--- a/doc/install-guide/section_neutron-controller-node.xml
+++ b/doc/install-guide/section_neutron-controller-node.xml
@@ -7,8 +7,9 @@
   <title>Install and configure controller node</title>
   <procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
     <title>To configure prerequisites</title>
-    <para>Before you configure OpenStack Networking (neutron), you must create
-      a database and Identity service credentials including endpoints.</para>
+    <para>Before you configure the OpenStack Networking (neutron) service,
+      you must create a database, service credentials, and API
+      endpoints.</para>
     <step>
       <para>To create the database, complete these steps:</para>
       <substeps>
@@ -42,8 +43,7 @@
       <screen><prompt>$</prompt> <userinput>source admin-openrc.sh</userinput></screen>
     </step>
     <step>
-      <para>To create the Identity service credentials, complete these
-        steps:</para>
+      <para>To create the service credentials, complete these steps:</para>
       <substeps>
         <step>
           <para>Create the <literal>neutron</literal> user:</para>
@@ -61,16 +61,15 @@
             password.</para>
         </step>
         <step>
-          <para>Link the <literal>neutron</literal> user to the
-            <literal>service</literal> tenant and <literal>admin</literal>
-            role:</para>
+          <para>Add the <literal>admin</literal> role to the
+            <literal>neutron</literal> user:</para>
           <screen><prompt>$</prompt> <userinput>keystone user-role-add --user neutron --tenant service --role admin</userinput></screen>
           <note>
             <para>This command provides no output.</para>
           </note>
         </step>
         <step>
-          <para>Create the <literal>neutron</literal> service:</para>
+          <para>Create the <literal>neutron</literal> service entity:</para>
           <screen><prompt>$</prompt> <userinput>keystone service-create --name neutron --type network \
   --description "OpenStack Networking"</userinput>
 <computeroutput>+-------------+----------------------------------+
@@ -83,9 +82,11 @@
 |     type    |             network              |
 +-------------+----------------------------------+</computeroutput></screen>
         </step>
-        <step>
-          <para>Create the Identity service endpoints:</para>
-          <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
+      </substeps>
+    </step>
+    <step>
+      <para>Create the Networking service API endpoints:</para>
+      <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
   --service-id $(keystone service-list | awk '/ network / {print $2}') \
   --publicurl http://<replaceable>controller</replaceable>:9696 \
   --adminurl http://<replaceable>controller</replaceable>:9696 \
@@ -101,8 +102,6 @@
 |    region   |           regionOne              |
 |  service_id | 6369ddaf99a447f3a0d41dac5e342161 |
 +-------------+----------------------------------+</computeroutput></screen>
-        </step>
-      </substeps>
     </step>
   </procedure>
   <procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
diff --git a/doc/install-guide/section_nova-controller-install.xml b/doc/install-guide/section_nova-controller-install.xml
index 11bfd471fd..f931832424 100644
--- a/doc/install-guide/section_nova-controller-install.xml
+++ b/doc/install-guide/section_nova-controller-install.xml
@@ -9,9 +9,8 @@
     Compute service, code-named nova, on the controller node.</para>
   <procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
     <title>To configure prerequisites</title>
-    <para>Before you install and configure Compute, you must
-      create a database and Identity service credentials
-      including endpoints.</para>
+    <para>Before you install and configure the Compute service, you must
+      create a database, service credentials, and API endpoints.</para>
     <step>
       <para>To create the database, complete these steps:</para>
       <substeps>
@@ -47,8 +46,7 @@
       <screen><prompt>$</prompt> <userinput>source admin-openrc.sh</userinput></screen>
     </step>
     <step>
-      <para>To create the Identity service credentials, complete these
-        steps:</para>
+      <para>To create the service credentials, complete these steps:</para>
       <substeps>
         <step>
           <para>Create the <literal>nova</literal> user:</para>
@@ -67,16 +65,15 @@
            a suitable password.</para>
         </step>
         <step>
-          <para>Link the <literal>nova</literal> user to the
-            <literal>service</literal> tenant and <literal>admin</literal>
-            role:</para>
+          <para>Add the <literal>admin</literal> role to the
+            <literal>nova</literal> user:</para>
 <screen><prompt>$</prompt> <userinput>keystone user-role-add --user nova --tenant service --role admin</userinput></screen>
           <note>
             <para>This command provides no output.</para>
           </note>
         </step>
         <step>
-          <para>Create the <literal>nova</literal> service:</para>
+          <para>Create the <literal>nova</literal> service entity:</para>
 <screen><prompt>$</prompt> <userinput>keystone service-create --name nova --type compute \
   --description "OpenStack Compute"</userinput>
 <computeroutput>+-------------+----------------------------------+
@@ -93,7 +90,7 @@
       </substeps>
     </step>
     <step>
-      <para>Create the Compute service endpoints:</para>
+      <para>Create the Compute service API endpoints:</para>
       <screen><prompt>$</prompt> <userinput>keystone endpoint-create \
   --service-id $(keystone service-list | awk '/ compute / {print $2}') \
   --publicurl http://<replaceable>controller</replaceable>:8774/v2/%\(tenant_id\)s \