Update nova content for Juno

I updated nova content in the installation guide for Juno as follows: 1) Removed prompts specific to MySQL because most distributions will use MariaDB. 2) Explicitly created endpoint with 'regionOne' region to avoid inconsistent defaults. 3) Replaced 'auth_*' keys with 'identity_uri' key. 4) Moved glance configuration to [glance] section. 5) Recommended enabling verbose logging. 6) Added example command output and updated existing command output. Change-Id: Iad5c20e6562bcab83c6f0d5efccab566b3c18eae
openstack · Sep 17, 2014 · fabfe1f · fabfe1f
1 parent 9991150
commit fabfe1f
Show file tree

Hide file tree

Showing 8 changed files with 119 additions and 68 deletions.
diff --git a/doc/install-guide/section_glance-install.xml b/doc/install-guide/section_glance-install.xml
@@ -162,9 +162,8 @@ flavor = keystone</programlisting>
           </note>
         </step>
         <step>
-          <para>In the <literal>[DEFAULT]</literal> section, we recommend
-            enabling verbose logging to assist with potential
-            troubleshooting:</para>
+          <para>(Optional) To assist with troubleshooting,
+            enable verbose logging in the <literal>[DEFAULT]</literal> section:</para>
           <programlisting language="ini">[DEFAULT]
 ...
 verbose = True</programlisting>

diff --git a/doc/install-guide/section_keystone-install.xml b/doc/install-guide/section_keystone-install.xml
@@ -87,9 +87,8 @@ connection = mysql://keystone:<replaceable>KEYSTONE_DBPASS</replaceable>@<replac
             password you chose for the database.</para>
         </step>
         <step>
-          <para>In the <literal>[DEFAULT]</literal> section, we recommend
-            enabling verbose logging to assist with potential
-            troubleshooting:</para>
+          <para>(Optional) To assist with troubleshooting,
+            enable verbose logging in the <literal>[DEFAULT]</literal> section:</para>
           <programlisting language="ini">[DEFAULT]
 ...
 verbose = True</programlisting>

diff --git a/doc/install-guide/section_neutron-ml2-compute-node.xml b/doc/install-guide/section_neutron-ml2-compute-node.xml
@@ -142,14 +142,14 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
 core_plugin = ml2
 service_plugins = router
 allow_overlapping_ips = True</programlisting>
-          <note>
-            <para>To assist with troubleshooting, add<literal>verbose
+        </step>
+        <step>
+            <para>(Optional) To assist with troubleshooting, add<literal>verbose
                 = True</literal> to the <literal>[DEFAULT]</literal>
               section in the
                 <filename>/etc/neutron/neutron.conf</filename>
               file.</para>
-          </note>
-        </step>
+          </step>
       </substeps>
     </step>
   </procedure>

diff --git a/doc/install-guide/section_neutron-ml2-controller-node.xml b/doc/install-guide/section_neutron-ml2-controller-node.xml
@@ -224,12 +224,11 @@ nova_admin_auth_url = http://<replaceable>controller</replaceable>:35357/v2.0</p
 core_plugin = ml2
 service_plugins = router
 allow_overlapping_ips = True</programlisting>
-          <note>
-            <para>We recommend adding <literal>verbose = True</literal> to
-              the <literal>[DEFAULT]</literal> section in
-              <filename>/etc/neutron/neutron.conf</filename> to assist with
-              troubleshooting.</para>
-          </note>
+        </step>
+        <step>
+          <para>(Optional) To assist with troubleshooting, add <literal>verbose = True</literal> to
+            the <literal>[DEFAULT]</literal> section in
+            <filename>/etc/neutron/neutron.conf</filename>.</para>
         </step>
       </substeps>
     </step>

diff --git a/doc/install-guide/section_neutron-ml2-network-node.xml b/doc/install-guide/section_neutron-ml2-network-node.xml
@@ -146,14 +146,14 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
 core_plugin = ml2
 service_plugins = router
 allow_overlapping_ips = True</programlisting>
-          <note>
-            <para>To assist with troubleshooting, add <literal>verbose
+        </step>
+        <step>
+            <para>(Optional) To assist with troubleshooting, add <literal>verbose
                 = True</literal> to the <literal>[DEFAULT]</literal>
               section in the
                 <filename>/etc/neutron/neutron.conf</filename>
               file.</para>
-          </note>
-        </step>
+          </step>
       </substeps>
     </step>
   </procedure>
@@ -169,13 +169,13 @@ allow_overlapping_ips = True</programlisting>
 ...
 interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver
 use_namespaces = True</programlisting>
-      <note>
-        <para>To assist with troubleshooting, add <literal>verbose =
+    </step>
+    <step>
+        <para>(Optional) To assist with troubleshooting, add <literal>verbose =
             True</literal> to the <literal>[DEFAULT]</literal> section
           in the <filename>/etc/neutron/l3_agent.ini</filename>
           file.</para>
-      </note>
-    </step>
+      </step>
   </procedure>
   <procedure>
     <title>To configure the DHCP agent</title>
@@ -191,12 +191,12 @@ use_namespaces = True</programlisting>
 interface_driver = neutron.agent.linux.interface.OVSInterfaceDriver
 dhcp_driver = neutron.agent.linux.dhcp.Dnsmasq
 use_namespaces = True</programlisting>
-      <note>
-        <para>To assist with troubleshooting, add <literal>verbose =
-            True</literal> to the <literal>[DEFAULT]</literal> section
-          in the <filename>/etc/neutron/dhcp_agent.ini</filename>
-          file.</para>
-      </note>
+    </step>
+    <step>
+      <para>(Optional) To assist with troubleshooting, add <literal>verbose =
+        True</literal> to the <literal>[DEFAULT]</literal> section
+        in the <filename>/etc/neutron/dhcp_agent.ini</filename>
+        file.</para>
     </step>
     <step>
       <para>Tunneling protocols such as
@@ -274,12 +274,12 @@ admin_user = neutron
 admin_password = <replaceable>NEUTRON_PASS</replaceable>
 nova_metadata_ip = <replaceable>controller</replaceable>
 metadata_proxy_shared_secret = <replaceable>METADATA_SECRET</replaceable></programlisting>
-      <note>
-        <para>To assist with troubleshooting, add <literal>verbose =
-            True</literal> to the <literal>[DEFAULT]</literal> section
-          in the <filename>/etc/neutron/metadata_agent.ini</filename>
-          file.</para>
-      </note>
+    </step>
+    <step>
+      <para>(Optional) To assist with troubleshooting, add <literal>verbose =
+        True</literal> to the <literal>[DEFAULT]</literal> section
+        in the <filename>/etc/neutron/metadata_agent.ini</filename>
+        file.</para>
     </step>
     <step>
       <note>

diff --git a/doc/install-guide/section_nova-compute-install.xml b/doc/install-guide/section_nova-compute-install.xml
@@ -52,32 +52,36 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
             <application>RabbitMQ</application>.</para>
         </step>
         <step>
-          <para>In the <literal>[keystone_authtoken</literal>] section,
+          <para>In the <literal>[keystone_authtoken]</literal> section,
             configure Identity service access:</para>
          <programlisting language="ini">
 [keystone_authtoken]
 ...
 auth_uri = http://<replaceable>controller</replaceable>:5000/v2.0
-auth_host = <replaceable>controller</replaceable>
-auth_port = 35357
-auth_protocol = http
+identity_uri = http://<replaceable>controller</replaceable>:35357
 admin_tenant_name = service
 admin_user = nova
 admin_password = <replaceable>NOVA_PASS</replaceable></programlisting>
           <para>Replace <replaceable>NOVA_PASS</replaceable> with the password
             you chose for the <literal>nova</literal> user in the Identity
             service.</para>
+          <note>
+            <para>Comment out any <literal>auth_host</literal>,
+              <literal>auth_port</literal>, and
+              <literal>auth_protocol</literal> options because the
+              <literal>identity_uri</literal> option replaces them.</para>
+          </note>
         </step>
         <step>
           <para>In the <literal>[DEFAULT]</literal> section, configure the
-            <literal>my_ip</literal> key:</para>
+            <literal>my_ip</literal> option:</para>
           <programlisting language="ini">[DEFAULT]
 ...
 my_ip = <replaceable>MANAGEMENT_INTERFACE_IP_ADDRESS</replaceable></programlisting>
           <para>Replace
             <replaceable>MANAGEMENT_INTERFACE_IP_ADDRESS</replaceable> with
             the IP address of the management network interface on your
-            first compute node, typically 10.0.0.31 in the
+            compute node, typically 10.0.0.31 for the first node in the
             <link linkend="architecture_example-architectures">example
             architecture</link>.</para>
         </step>
@@ -98,7 +102,7 @@ novncproxy_base_url = http://<replaceable>controller</replaceable>:6080/vnc_auto
           <para>Replace
             <replaceable>MANAGEMENT_INTERFACE_IP_ADDRESS</replaceable> with
             the IP address of the management network interface on your
-            first compute node, typically 10.0.0.31 in the
+            compute node, typically 10.0.0.31 for the first node in the
             <link linkend="architecture_example-architectures">example
             architecture</link>.</para>
           <note>
@@ -116,6 +120,13 @@ novncproxy_base_url = http://<replaceable>controller</replaceable>:6080/vnc_auto
 ...
 host = <replaceable>controller</replaceable></programlisting>
         </step>
+        <step>
+          <para>(Optional) To assist with troubleshooting,
+            enable verbose logging in the <literal>[DEFAULT]</literal> section:</para>
+          <programlisting language="ini">[DEFAULT]
+...
+verbose = True</programlisting>
+        </step>
       </substeps>
     </step>
   </procedure>

diff --git a/doc/install-guide/section_nova-controller-install.xml b/doc/install-guide/section_nova-controller-install.xml
@@ -21,19 +21,20 @@
         </step>
         <step>
           <para>Create the <literal>nova</literal> database:</para>
-          <screen><prompt>mysql></prompt> <userinput>CREATE DATABASE nova;</userinput></screen>
+          <screen><userinput>CREATE DATABASE nova;</userinput></screen>
         </step>
         <step>
           <para>Grant proper access to the <literal>nova</literal>
             database:</para>
-          <screen><prompt>mysql></prompt> <userinput>GRANT ALL PRIVILEGES ON nova.* TO 'nova'@'localhost' IDENTIFIED BY '<replaceable>NOVA_DBPASS</replaceable>';</userinput>
-<prompt>mysql></prompt> <userinput>GRANT ALL PRIVILEGES ON nova.* TO 'nova'@'%' IDENTIFIED BY '<replaceable>NOVA_DBPASS</replaceable>';</userinput></screen>
+          <screen><userinput>GRANT ALL PRIVILEGES ON nova.* TO 'nova'@'localhost' \
+  IDENTIFIED BY '<replaceable>NOVA_DBPASS</replaceable>';</userinput>
+<userinput>GRANT ALL PRIVILEGES ON nova.* TO 'nova'@'%' \
+  IDENTIFIED BY '<replaceable>NOVA_DBPASS</replaceable>';</userinput></screen>
           <para>Replace <replaceable>NOVA_DBPASS</replaceable> with a suitable
         password.</para>
         </step>
         <step>
-          <para>Exit the database access client:</para>
-          <screen><prompt>mysql></prompt> <userinput>exit</userinput></screen>
+          <para>Exit the database access client.</para>
         </step>
       </substeps>
     </step>
@@ -48,7 +49,16 @@
       <substeps>
         <step>
           <para>Create the <literal>nova</literal> user:</para>
-          <screen><prompt>$</prompt> <userinput>keystone user-create --name nova --pass <replaceable>NOVA_PASS</replaceable> --email <replaceable>EMAIL_ADDRESS</replaceable></userinput></screen>
+          <screen><prompt>$</prompt> <userinput>keystone user-create --name nova --pass <replaceable>NOVA_PASS</replaceable> --email <replaceable>EMAIL_ADDRESS</replaceable></userinput>
+<computeroutput>+----------+----------------------------------+
+| Property |              Value               |
++----------+----------------------------------+
+|  email   |         nova@example.com         |
+| enabled  |               True               |
+|    id    | 387dd4f7e46d4f72965ee99c76ae748c |
+|   name   |               nova               |
+| username |               nova               |
++----------+----------------------------------+</computeroutput></screen>
           <para>Replace <replaceable>NOVA_PASS</replaceable> with a suitable
             password and <replaceable>EMAIL_ADDRESS</replaceable> with
             a suitable e-mail address.</para>
@@ -58,10 +68,22 @@
             <literal>service</literal> tenant and <literal>admin</literal>
             role:</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>
-          <screen><prompt>$</prompt> <userinput>keystone service-create --name nova --type compute --description "OpenStack Compute"</userinput></screen>
+          <screen><prompt>$</prompt> <userinput>keystone service-create --name nova --type compute --description "OpenStack Compute"</userinput>
+<computeroutput>+-------------+----------------------------------+
+|   Property  |              Value               |
++-------------+----------------------------------+
+| description |        OpenStack Compute         |
+|   enabled   |               True               |
+|      id     | 6c7854f52ce84db795557ebc0373f6b9 |
+|     name    |               nova               |
+|     type    |             compute              |
++-------------+----------------------------------+</computeroutput></screen>
         </step>
       </substeps>
     </step>
@@ -71,7 +93,18 @@
   --service-id $(keystone service-list | awk '/ compute / {print $2}') \
   --publicurl http://<replaceable>controller</replaceable>:8774/v2/%\(tenant_id\)s \
   --internalurl http://<replaceable>controller</replaceable>:8774/v2/%\(tenant_id\)s \
-  --adminurl http://<replaceable>controller</replaceable>:8774/v2/%\(tenant_id\)s</userinput></screen>
+  --adminurl http://<replaceable>controller</replaceable>:8774/v2/%\(tenant_id\)s \
+  --region regionOne</userinput>
+<computeroutput>+-------------+-----------------------------------------+
+|   Property  |                  Value                  |
++-------------+-----------------------------------------+
+|   adminurl  | http://controller:8774/v2/%(tenant_id)s |
+|      id     |    c397438bd82c41198ec1a9d85cb7cc74     |
+| internalurl | http://controller:8774/v2/%(tenant_id)s |
+|  publicurl  | http://controller:8774/v2/%(tenant_id)s |
+|    region   |                regionOne                |
+|  service_id |    6c7854f52ce84db795557ebc0373f6b9     |
++-------------+-----------------------------------------+</computeroutput></screen>
     </step>
   </procedure>
   <procedure os="ubuntu;rhel;centos;fedora;sles;opensuse">
@@ -115,23 +148,26 @@ rabbit_password = <replaceable>RABBIT_PASS</replaceable></programlisting>
         <step>
           <para>In the <literal>[keystone_authtoken]</literal> section,
             configure Identity service access:</para>
-          <programlisting language="ini">
-[keystone_authtoken]
+          <programlisting language="ini">[keystone_authtoken]
 ...
 auth_uri = http://<replaceable>controller</replaceable>:5000/v2.0
-auth_host = <replaceable>controller</replaceable>
-auth_port = 35357
-auth_protocol = http
+identity_uri = http://<replaceable>controller</replaceable>:35357
 admin_tenant_name = service
 admin_user = nova
 admin_password = <replaceable>NOVA_PASS</replaceable></programlisting>
           <para>Replace <replaceable>NOVA_PASS</replaceable> with the password
             you chose for the <literal>nova</literal> user in the Identity
             service.</para>
+          <note>
+            <para>Comment out any <literal>auth_host</literal>,
+              <literal>auth_port</literal>, and
+              <literal>auth_protocol</literal> options because the
+              <literal>identity_uri</literal> option replaces them.</para>
+          </note>
         </step>
         <step>
           <para>In the <literal>[DEFAULT]</literal> section, configure the
-            <literal>my_ip</literal> key to use the management interface IP
+            <literal>my_ip</literal> option to use the management interface IP
             address of the controller node:</para>
           <programlisting language="ini">[DEFAULT]
 ...
@@ -147,11 +183,18 @@ vncserver_listen = 10.0.0.11
 vncserver_proxyclient_address = 10.0.0.11</programlisting>
         </step>
         <step>
-          <para>In the <literal>[DEFAULT]</literal> section, configure the
+          <para>In the <literal>[glance]</literal> section, configure the
             location of the Image Service:</para>
+          <programlisting language="ini">[glance]
+...
+host = <replaceable>controller</replaceable></programlisting>
+        </step>
+        <step>
+          <para>(Optional) To assist with troubleshooting,
+            enable verbose logging in the <literal>[DEFAULT]</literal> section:</para>
           <programlisting language="ini">[DEFAULT]
 ...
-glance_host = <replaceable>controller</replaceable></programlisting>
+verbose = True</programlisting>
         </step>
       </substeps>
     </step>

diff --git a/doc/install-guide/section_nova-verify.xml b/doc/install-guide/section_nova-verify.xml
@@ -20,15 +20,15 @@
       <para>List service components to verify successful launch of each
         process:</para>
       <screen><prompt>$</prompt> <userinput>nova service-list</userinput>
-<computeroutput>+------------------+-------------+----------+---------+-------+----------------------------+-----------------+
-| Binary           | Host        | Zone     | Status  | State | Updated_at                 | Disabled Reason |
-+------------------+-------------+----------+---------+-------+----------------------------+-----------------+
-| nova-cert        | controller  | internal | enabled | up    | 2014-06-29T22:23:16.000000 | -               |
-| nova-consoleauth | controller  | internal | enabled | up    | 2014-06-29T22:23:10.000000 | -               |
-| nova-scheduler   | controller  | internal | enabled | up    | 2014-06-29T22:23:14.000000 | -               |
-| nova-conductor   | controller  | internal | enabled | up    | 2014-06-29T22:23:11.000000 | -               |
-| nova-compute     | compute1    | nova     | enabled | up    | 2014-06-29T22:23:11.000000 | -               |
-+------------------+-------------+----------+---------+-------+----------------------------+-----------------+</computeroutput></screen>
+<computeroutput>+----+------------------+------------+----------+---------+-------+----------------------------+-----------------+
+| Id | Binary           | Host       | Zone     | Status  | State | Updated_at                 | Disabled Reason |
++----+------------------+------------+----------+---------+-------+----------------------------+-----------------+
+| 1  | nova-conductor   | controller | internal | enabled | up    | 2014-09-16T23:54:02.000000 | -               |
+| 2  | nova-consoleauth | controller | internal | enabled | up    | 2014-09-16T23:54:04.000000 | -               |
+| 3  | nova-scheduler   | controller | internal | enabled | up    | 2014-09-16T23:54:07.000000 | -               |
+| 4  | nova-cert        | controller | internal | enabled | up    | 2014-09-16T23:54:00.000000 | -               |
+| 5  | nova-compute     | compute1   | nova     | enabled | up    | 2014-09-16T23:54:06.000000 | -               |
++----+------------------+------------+----------+---------+-------+----------------------------+-----------------+</computeroutput></screen>
       <note>
         <para>This output should indicate four components enabled on the
         controller node one component enabled on the compute node.</para>