Skip to content

Commit

Permalink
Updated to add a cover and minor edits
Browse files Browse the repository at this point in the history 
Change-Id: I8d8e79f5dd372ed209120b00b8ae05aade049120
author: diane fleming
  • Loading branch information
@dian4554
dian4554 committed May 2, 2013
1 parent f633c2c commit 8ba58e2
Show file tree
Hide file tree
Showing 9 changed files with 234 additions and 155 deletions.
30 changes: 13 additions & 17 deletions doc/src/docbkx/basic-install/pom.xml
View file
Expand Up @@ -71,8 +71,6 @@
<pdfUrl>basic-install-${release.path.name}.pdf</pdfUrl>
<highlightSource>false</highlightSource>
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
<sectionAutolabel>0</sectionAutolabel>
<sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>
</configuration>
</execution>
<execution>
Expand All @@ -88,19 +86,18 @@
<disqusShortname>os-basicinstall</disqusShortname>
<enableGoogleAnalytics>1</enableGoogleAnalytics>
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
<generateToc>
appendix toc,title
article/appendix nop
article toc,title
book title,figure,table,example,equation
chapter toc,title
part toc,title
preface toc,title
qandadiv toc
qandaset toc
reference toc,title
set toc,title
</generateToc>
<generateToc> appendix toc,title
article/appendix nop
article toc,title
book toc,title,figure,table,example,equation
chapter toc,title
section toc
part toc,title
preface nop
qandadiv toc
qandaset toc
reference toc,title
set toc,title </generateToc>
<!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections-->
<sectionAutolabel>0</sectionAutolabel>
<sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel>
Expand Down Expand Up @@ -144,6 +141,5 @@
</configuration>
</plugin>
</plugins>
</build>

</build>
</project>
81 changes: 40 additions & 41 deletions doc/src/docbkx/basic-install/src/basic-install_architecture.xml
View file
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
<chapter 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="basic-install_architecture">
Expand All @@ -10,57 +10,56 @@
</imageobject>
<!-- Edit link: http://docs.google.com/drawings/d/19qtlB_EeG9TM_jpeX5DprHRd9ShngXgfpt_t5mlrUMo/edit -->
</mediaobject></figure>
<para>This guide creates three different OpenStack servers:</para>
<para>This guide creates the following types of OpenStack
servers:</para>
<itemizedlist>
<listitem>
<para><emphasis role="bold">The Cloud
Controller</emphasis>: this server provides all
functionality 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, conductor, console authenticator, and VNC
service. Finally, it hosts the API endpoint for the
OpenStack Network service. </para>
Controller</emphasis>. Provides all functionality
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,
conductor, console authenticator, and VNC service.
Finally, it hosts the API endpoint for the OpenStack
Network service. </para>
</listitem>
<listitem>
<para><emphasis role="bold">The Network
Controller</emphasis>: this server provides the
bulk of the OpenStack Network services such as DHCP,
layer 2 switching, layer 3 routing, floating IPs
(which this guide does not configure), and metadata
connectivity. </para>
Controller</emphasis>. Provides the bulk of the
OpenStack Network services such as DHCP, layer 2
switching, layer 3 routing, floating IPs (which this
guide does not configure), and metadata connectivity. </para>
</listitem>
<listitem>
<para><emphasis role="bold">Compute Node</emphasis>: a
Compute Node runs the OpenStack Compute service as
well as the OpenStack 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 (instances). </para>
<para><emphasis role="bold">Compute Node</emphasis>. Runs
the OpenStack Compute service as well as the OpenStack
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
(instances). </para>
</listitem>
</itemizedlist>
<para>It is important to note that OpenStack provides great
flexibility with regard to how its individual services can be
hosted. For example, the services that run on the Network
Controller can easily be installed on the Cloud Controller. As
another example, the OpenStack Image service can be installed
on its own server (or many servers to provide a more highly
available service). </para>

<note><para>OpenStack provides great flexibility with regard to how its
individual services can be hosted. For example, the services
that run on the Network Controller can easily be installed on
the Cloud Controller. As another example, the OpenStack Image
service can be installed on its own server (or many servers to
provide a more highly available service). </para>
</note>
<para>With regard to cloud networking, a standard OpenStack
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>
<itemizedlist>
<listitem>
<itemizedlist>
<listitem>
<para><emphasis role="bold">Management
network</emphasis>. Used for internal
communication between OpenStack components. The IP
Expand All @@ -76,10 +75,10 @@
</listitem>
<listitem>
<para><emphasis role="bold">External
network</emphasis>. Used to provide VMs with
Internet access in some deployment scenarios. The IP
addresses on this network should be reachable by
anyone on the Internet.  </para>
network</emphasis>. Provides VMs with Internet
access in some deployment scenarios. The IP addresses
on this network should be reachable by anyone on the
Internet.  </para>
</listitem>
<listitem>
<para><emphasis role="bold">API
Expand All @@ -94,4 +93,4 @@
block. </para>
</listitem>
</itemizedlist>
</section>
</chapter>
5 changes: 2 additions & 3 deletions doc/src/docbkx/basic-install/src/basic-install_conclusion.xml
View file
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
<chapter 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="basic-install_conclusion">
Expand All @@ -12,5 +12,4 @@
as you want. If you need more specific help, please
read the official documentation of each project or
write a post to an OpenStack mailing list.</para>

</section>
</chapter>
3 changes: 1 addition & 2 deletions doc/src/docbkx/basic-install/src/basic-install_controller.xml
View file
Expand Up @@ -12,6 +12,5 @@
<xi:include href="basic-install_controller-nova.xml" />
<xi:include href="basic-install_controller-cinder.xml" />
<xi:include href="basic-install_controller-quantum.xml" />
<xi:include href="basic-install_controller-dashboard.xml" />

<xi:include href="basic-install_controller-dashboard.xml" />
</section>
11 changes: 11 additions & 0 deletions doc/src/docbkx/basic-install/src/basic-install_installation.xml
View file
@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter 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="basic-install_procs">
<title>Install</title>
<xi:include href="basic-install_requirements.xml"/>
<xi:include href="basic-install_controller.xml" />
<xi:include href="basic-install_network.xml"/>
<xi:include href="basic-install_compute.xml"/>
</chapter>
45 changes: 27 additions & 18 deletions doc/src/docbkx/basic-install/src/basic-install_intro.xml
View file
@@ -1,14 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
<preface 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="basic-install_intro">
<title>Introduction</title>
<para>This document helps anyone who wants to deploy OpenStack
Grizzly for development purposes with <phrase os="ubuntu"
>Ubuntu 12.04 LTS (using the Ubuntu Cloud
Archive)</phrase><phrase os="rhel;centos;fedora">Fedora 18
(using the fedora-openstack-grizzly repo)</phrase>.</para>
<?dbhtml stop-chunking?>
<title>Preface</title>
<para>This document helps you deploy OpenStack Grizzly for
development purposes with <phrase os="ubuntu">Ubuntu 12.04 LTS
(using the Ubuntu Cloud Archive)</phrase><phrase
os="rhel;centos;fedora">Fedora 18 (using the
fedora-openstack-grizzly repo)</phrase>.</para>
<note os="ubuntu">
<para>The Grizzly version is available on the current
Ubuntu development series, which is 13.04 (Raring
Expand All @@ -19,21 +20,29 @@
</note>
<para>We are going to install a three-node setup with one
controller, one network and one compute node.</para>
<para>Of course, you can setup as many computes nodes as you want. This document is a good start
for beginners in OpenStack who want to install a testing infrastructure.</para>

<para>Of course, you can setup as many computes nodes as you want.
Use this document to learn to install a testing infrastructure.</para>
<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
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
testing purposes. Please ensure you use proper passwords when configuring your OpenStack environment in production.
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
testing purposes. Please ensure you use proper passwords when
configuring your OpenStack environment in production.
</para>

<para>At this time, this guide does not cover floating IPs.</para>

</section>
<para>At this time, this guide does not cover floating IPs.</para>
<section xml:id="doc_change_history">
<title>Document Change History</title>
<para>This version of the guide replaces and
obsoletes all previous versions. The following table
describes the latest changes:
The most recent
changes:</para>
<?rax revhistory?>
<!-- Table generated in output from revision element in the book element -->
</section>
</preface>

0 comments on commit 8ba58e2

Please sign in to comment.