Skip to content

Commit

Permalink
More changes to the User Guide, including changes to common files
Browse files Browse the repository at this point in the history 
bug: #1110146

Change-Id: Ifb3e3f464baa611a99cc6a5b62907cdfe52856ad
author: diane fleming
  • Loading branch information
@dian4554
dian4554 committed Jun 19, 2013
1 parent f461639 commit 8163b71
Show file tree
Hide file tree
Showing 52 changed files with 1,812 additions and 852 deletions.
14 changes: 6 additions & 8 deletions doc/src/docbkx/basic-install/src/basic-install_architecture.xml
View file
Expand Up @@ -19,11 +19,10 @@
of the cloud except actually hosting virtual machines
or providing network services. See the "Compute Node"
and "Network Controller" for details about those
roles. This server will host the OpenStack Image
Service, the OpenStack Block Storage Service, the
OpenStack Identity Service, and the OpenStack
Dashboard. It will also run portions of the OpenStack
Compute service such as the API server, the scheduler,
roles. This server hosts the OpenStack Image
Service, Block Storage Service, Identity Service, and the
dashboard. It also runs portions of the OpenStack
Compute service, such as the API server, the scheduler,
conductor, console authenticator, and VNC service.
Finally, it hosts the API endpoint for the OpenStack
Network service. </para>
Expand All @@ -41,7 +40,7 @@
Network service agent (in this case, the Open vSwitch
plugin agent). This server also manages an
OpenStack-compatible hypervisor such as KVM or Xen.
This server will host the actual virtual machines
This server hosts the actual virtual machines
(instances). </para>
</listitem>
</itemizedlist>
Expand All @@ -56,8 +55,7 @@
Network setup can have up to four distinct physical data
center networks. Note that these networks can be combined and
re-used. For example, the Management, Data, and API networks
are commonly the same network. For simplicity, this will be
done in this guide.</para>
are commonly the same network. For simplicity, this guide shows this configuration.</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Management
Expand Down
6 changes: 3 additions & 3 deletions doc/src/docbkx/basic-install/src/basic-install_compute-common.xml
View file
Expand Up @@ -21,7 +21,7 @@
<para>Packages: <emphasis role="bold">OpenSSH-Server</emphasis></para>
</listitem>
</itemizedlist></para>
<para>Once installation has finished, the server will reboot.</para>
<para>Once installation has finished, the server reboots.</para>
</listitem>
<listitem>
<para os="ubuntu">Since the default OpenStack release in Ubuntu 12.04 LTS is older,
Expand All @@ -40,8 +40,8 @@
<listitem>
<para>Configure the network:</para>
<note>
<para>This will change later on in the guide
when Open vSwitch is configured</para>
<para>Later in this guide, this changes
when Open vSwitch is configured.</para>
</note>
<para os="ubuntu">
<itemizedlist>
Expand Down
2 changes: 1 addition & 1 deletion doc/src/docbkx/basic-install/src/basic-install_compute-intro.xml
View file
Expand Up @@ -4,7 +4,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="basic-install_compute-intro">
<title>Introduction</title>
<para>The Compute node will provide :
<para>The Compute node provides:
<itemizedlist>
<listitem>
<para>Hypervisor (KVM)</para>
Expand Down
12 changes: 6 additions & 6 deletions doc/src/docbkx/basic-install/src/basic-install_controller-common.xml
View file
Expand Up @@ -33,7 +33,7 @@
</itemizedlist>
</para>
<para>
Once installation has finished, the server will reboot.
Once installation has finished, the server reboots.
</para>
</listitem>
<listitem>
Expand Down Expand Up @@ -163,8 +163,8 @@ ONBOOT=yes
</para>
</listitem>
<listitem>
<para>Install NTP. NTP will ensure that the server has the correct time. This is important because if an OpenStack server's time is
not correct, it will be removed from the rest of the cloud.<itemizedlist>
<para>Install NTP. NTP ensures that the server has the correct time. This is important because if an OpenStack server's time is
not correct, it is removed from the rest of the cloud.<itemizedlist>
<listitem>
<para>
<screen os="ubuntu;deb"><prompt>#</prompt> <userinput>apt-get install ntp</userinput></screen>
Expand All @@ -187,14 +187,14 @@ ONBOOT=yes
<para>Install the packages: <screen os="ubuntu;deb"><prompt>#</prompt> <userinput>apt-get install python-mysqldb mysql-server</userinput></screen>
<screen os="rhel;fedora;centos"><prompt>#</prompt> <userinput>yum install mysql mysql-server MySQL-python</userinput></screen>
<note os="ubuntu;deb">
<para><literal>apt-get</literal> will
prompt you to set the MySQL root
<para><literal>apt-get</literal>
prompts you to set the MySQL root
password.</para>
</note>
</para>
</listitem>
<listitem>
<para>By default, MySQL will only accept
<para>By default, MySQL only accepts
connections from localhost. This needs changed
so that the compute nodes can access the
OpenStack Networking service. Database
Expand Down
4 changes: 2 additions & 2 deletions doc/src/docbkx/basic-install/src/basic-install_controller-glance.xml
View file
Expand Up @@ -5,8 +5,8 @@
xml:id="basic-install_controller-glance">
<title>OpenStack Image Service</title>
<para>The Image Service provides the cloud environment with a catalog of virtual machine "templates". These templates are used as the basis
of instances. For example, if the catalog contains an image for an Ubuntu 12.04 distribution, the users of the cloud will be able
to launch Ubuntu 12.04 instances.
of instances. For example, if the catalog contains an image for an Ubuntu 12.04 distribution, cloud users can
launch Ubuntu 12.04 instances.
<orderedlist>
<listitem>
<para>Install the Glance packages:
Expand Down
2 changes: 1 addition & 1 deletion doc/src/docbkx/basic-install/src/basic-install_controller-intro.xml
View file
Expand Up @@ -4,7 +4,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="basic-install_controller-intro">
<title>Introduction</title>
<para>The Controller node will provide :
<para>The Controller node provides:
<itemizedlist>
<listitem>
<para>Databases (with MySQL)</para>
Expand Down
4 changes: 2 additions & 2 deletions doc/src/docbkx/basic-install/src/basic-install_controller-keystone.xml
View file
Expand Up @@ -46,7 +46,7 @@ connection = mysql://keystone:password@localhost/keystone</programlisting></para
<itemizedlist>
<listitem>
<para>Create a file called <emphasis role="bold">~/openrc</emphasis>. This
file contains the OpenStack admin credentials that will be used when interacting with the OpenStack
file contains the OpenStack admin credentials that are used when interacting with the OpenStack
environment on the command line.
<programlisting>export OS_TENANT_NAME=admin
export OS_USERNAME=admin
Expand All @@ -70,7 +70,7 @@ export SERVICE_TOKEN=password</programlisting></para>
</itemizedlist>
</listitem>
<listitem>
<para>The following bash script will populate Keystone with some initial data:
<para>The following bash script populates Keystone with some initial data:
<itemizedlist>
<listitem><para>Projects: admin and services</para></listitem>
<listitem><para>Roles: admin, Member</para></listitem>
Expand Down
2 changes: 1 addition & 1 deletion doc/src/docbkx/basic-install/src/basic-install_controller-nova.xml
View file
Expand Up @@ -41,7 +41,7 @@ auth_version = v2.0</programlisting>
<para>Add the following to the <emphasis role="bold">/etc/nova/nova.conf</emphasis> file. This file is
the main configuration file of Nova. There is a large amount of configuration options
that can go in this file. This guide illustrates the minimum needed for a simple environment.
Note that the nova.conf file supplied by your distribution will have some options already set. Leave
Note that the nova.conf file supplied by your distribution has some options already set. Leave
them as-is.
<programlisting os="ubuntu">[DEFAULT]

Expand Down
2 changes: 1 addition & 1 deletion doc/src/docbkx/basic-install/src/basic-install_controller-quantum.xml
View file
Expand Up @@ -58,7 +58,7 @@ firewall_driver = quantum.agent.linux.iptables_firewall.OVSHybridIptablesFirewal
<emphasis role="bold">tunnel mode</emphasis> since you don't
have to configure your physical
switches for VLANs.</para>
<para os="centos;rhel;fedora">The Fedora kernel module for OpenVSwitch has been compiled without support for tunnels. To use gre tunnels the module will have to be recompiled.</para>
<para os="centos;rhel;fedora">The Fedora kernel module for OpenVSwitch has been compiled without support for tunnels. To use gre tunnels, the module must be recompiled.</para>
</note>
</listitem>
<listitem os="centos;rhel;fedora">
Expand Down
3 changes: 1 addition & 2 deletions doc/src/docbkx/basic-install/src/basic-install_intro.xml
View file
Expand Up @@ -25,8 +25,7 @@
<para>The OpenStack configuration files contain several commented
options. These options specify the default setting. You only
need to uncomment these lines if you are changing the setting
to a non-default value. Additionally, the only options that
will be shown throughout this guide are options that are being
to a non-default value. Additionally, this guide only shows options that are being
modified from their default value. </para>
<para>Finally, please be aware that the use of <literal>password</literal>
as a password throughout this guide is for simplicity and
Expand Down
5 changes: 2 additions & 3 deletions doc/src/docbkx/basic-install/src/basic-install_network-common.xml
View file
Expand Up @@ -20,7 +20,7 @@
<para>Packages: <emphasis role="bold">OpenSSH-Server</emphasis></para>
</listitem>
</itemizedlist></para>
<para>Once installation has finished, the server will reboot.</para>
<para>Once installation has finished, the server reboots.</para>
</listitem>
<listitem>
<para os="ubuntu">Since the default OpenStack release
Expand All @@ -44,8 +44,7 @@
<listitem>
<para>Edit <emphasis role="bold">/etc/network/interfaces</emphasis>:
<note>
<para>This will change later on in
the guide when Open vSwitch is
<para>Later in this guide, this changes when Open vSwitch is
configured.</para>
</note>
<programlisting># Internal Network
Expand Down
2 changes: 1 addition & 1 deletion doc/src/docbkx/basic-install/src/basic-install_network-intro.xml
View file
Expand Up @@ -4,7 +4,7 @@
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="basic-install_network-intro">
<title>Introduction</title>
<para>The Network node will provide:
<para>The Network node provides:
<itemizedlist>
<listitem>
<para>Virtual Bridging (Open-vSwitch + Quantum Agent) with tunneling</para>
Expand Down
10 changes: 5 additions & 5 deletions doc/src/docbkx/basic-install/src/basic-install_network-operating.xml
View file
Expand Up @@ -14,7 +14,7 @@
<itemizedlist>
<listitem>
<para>Create a file called <emphasis role="bold">~/openrc</emphasis>. This
file contains the OpenStack admin credentials that will be used when interacting with the OpenStack
file contains the OpenStack admin credentials that are used when interacting with the OpenStack
environment on the command line.
<programlisting>export OS_TENANT_NAME=admin
export OS_USERNAME=admin
Expand All @@ -38,7 +38,7 @@ export SERVICE_TOKEN=password</programlisting></para>
</itemizedlist>
</listitem>
<listitem>
<para>The following bash script will create an internal network for the "demo" project.
<para>The following bash script creates an internal network for the "demo" project.
<programlisting>#!/bin/bash
TENANT_NAME="demo"
TENANT_NETWORK_NAME="demo-net"
Expand All @@ -58,11 +58,11 @@ quantum router-interface-add $ROUTER_ID $TENANT_SUBNET_ID</programlisting></para
<section xml:id="configure-l3">
<title>L3 Configuration</title>
<para>The Quantum L3 service enables instances to have external network access. If this service is not configured, your instances
will only be able to communicate with each other. Please note that this configuration is highly dependant on your environment.
For example, make note of the <literal>subnet-create</literal> command below. You will need to verify your own network settings
can only communicate with each other. Note that this configuration is highly dependant on your environment.
For example, make note of the <literal>subnet-create</literal> command below. You must verify your own network settings
for the external subnet (<literal>10.0.0.0/24</literal> in this case) as well as an allocation pool. The allocation pool
is used to provide each Project with an IP address to access the external network. The pool consists of 50 IPs and therefore
only 50 projects will be able to get a gateway IP.</para>
only 50 projects can get a gateway IP.</para>
<itemizedlist>
<listitem>
<para>Create an external network:
Expand Down
2 changes: 1 addition & 1 deletion doc/src/docbkx/cli-guide/pom.xml
View file
Expand Up @@ -53,7 +53,7 @@

<webhelpDirname>cli-guide</webhelpDirname>
<includeDateInPdfFilename>0</includeDateInPdfFilename>
<pdfFilenameBase>cli-guide.pdf</pdfFilenameBase>
<pdfFilenameBase>cli-guide</pdfFilenameBase>
</configuration>
</execution>
<execution>
Expand Down
73 changes: 54 additions & 19 deletions doc/src/docbkx/common/about-dashboard.xml
View file
Expand Up @@ -2,22 +2,57 @@
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="about-the-dashboard">
<title>About the Dashboard</title>
<!--<?dbhtml stop-chunking?>-->
<para>The OpenStack dashboard, also known as <link
xlink:href="https://github.com/openstack/horizon/"
>horizon</link>, is a Web interface that allows cloud
administrators and users to manage various OpenStack resources
and services. The dashboard enables web-based interactions
with the OpenStack Compute cloud controller through the
OpenStack APIs. The following instructions show you an example
deployment that is configured with an Apache web server. </para>
<xi:include href="../common/dashboard-system-reqs.xml"/>
<xi:include href="../common/dashboard-install.xml"/>
<xi:include href="../common/dashboard-configure.xml"/>
<xi:include href="../common/dashboard-verify.xml"/>
<xi:include href="../common/dashboard_customizing.xml"/>
<xi:include href="../common/dashboard_sessions.xml"/>
<xi:include href="../common/dashboardlaunchinginstances.xml"/>
</section>
xml:id="about-dashboard">
<title>About the OpenStack dashboard</title>
<para>To install the OpenStack dashboard, complete the
following high-level steps: </para>
<orderedlist>
<listitem>
<para>Meet the system requirements for accessing the
dashboard. See <xref
linkend="dashboard-system-requirements"
/>.</para>
</listitem>
<listitem>
<para>Install the OpenStack Dashboard framework,
including Apache and related modules. See <xref
linkend="installing-openstack-dashboard"
/>.</para>
</listitem>
<listitem>
<para>Configure the dashboard.</para>
<para>Then, restart and run the Apache server.</para>
<para>See <xref linkend="configure-dashboard"
/>.</para>
</listitem>
<listitem>
<para>Verify your installation. See <xref
linkend="verify-dashboard"/>.</para>
</listitem>
</orderedlist>
<simplesect>
<title>Next steps:</title>
<para>After you install the dashboard, you can complete the following tasks:</para>
<itemizedlist>
<listitem>
<para>To customize your dashboard, see <xref
linkend="dashboard-custom-brand"/>.
</para>
</listitem>
<listitem>
<para>To set up session storage for the dashboard,
see <xref linkend="dashboard-sessions"
/>.</para>
</listitem>
<listitem>
<para>To deploy the
dashboard, see <link
xlink:href="http://docs.openstack.org/developer/horizon/topics/deployment.html"
>Deploying Horizon</link>.</para>
</listitem>
<listitem xml:id="launch_instances">
<para>To launch instances with the dashboard, see the
<citetitle>OpenStack User Guide</citetitle>.</para></listitem>
</itemizedlist>
</simplesect>
</section>

0 comments on commit 8163b71

Please sign in to comment.