-
Notifications
You must be signed in to change notification settings - Fork 260
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create a new guide for Basic Install
This commit is a collection of the following commits related to the basic install guide in master branch. - af7dd74 Create a new guide for Basic Install - ae65b27 Fix small errors with several documents - d084653 Add Network Controller + Improve Quantum Part - 3bddf51 Adds post processing instruction to basic install pom.xml - 939c50a Bug fixes for Basic Install reported in comments - da78b4f Fix bug #1091859 - a1db24b Fix bug #1091988 - a20138c Fix Bug #1092424 - fac3c1e Brush up Quantum part of basic install guide Change-Id: Ib37b0f1818ead064551fdd0884845fcaa6367ec8
- Loading branch information
Showing
28 changed files
with
1,547 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> | ||
|
|
||
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <groupId>org.openstack.docs</groupId> | ||
| <artifactId>openstack-basic-install</artifactId> | ||
| <version>1.0.0-SNAPSHOT</version> | ||
| <packaging>jar</packaging> | ||
| <name>OpenStack Basic Install Guide</name> | ||
|
|
||
| <properties> | ||
| <!-- This is set by Jenkins according to the branch. --> | ||
| <release.path.name>folsom</release.path.name> | ||
| <comments.enabled>1</comments.enabled> | ||
| <operating.system>apt</operating.system> | ||
| <!-- This is set by Jenkins to run twice for each similar operating system group --> | ||
| <profile.os>ubuntu</profile.os> | ||
| </properties> | ||
|
|
||
| <!-- ################################################ --> | ||
| <!-- USE "mvn clean generate-sources" to run this POM --> | ||
| <!-- ################################################ --> | ||
| <profiles> | ||
| <profile> | ||
| <id>Rackspace Research Repositories</id> | ||
| <activation> | ||
| <activeByDefault>true</activeByDefault> | ||
| </activation> | ||
| <repositories> | ||
| <repository> | ||
| <id>rackspace-research</id> | ||
| <name>Rackspace Research Repository</name> | ||
| <url>http://maven.research.rackspacecloud.com/content/groups/public/</url> | ||
| </repository> | ||
| </repositories> | ||
| <pluginRepositories> | ||
| <pluginRepository> | ||
| <id>rackspace-research</id> | ||
| <name>Rackspace Research Repository</name> | ||
| <url>http://maven.research.rackspacecloud.com/content/groups/public/</url> | ||
| </pluginRepository> | ||
| </pluginRepositories> | ||
| </profile> | ||
| </profiles> | ||
|
|
||
| <build> | ||
| <resources> | ||
| <resource> | ||
| <directory>target/docbkx/pdf</directory> | ||
| <excludes> | ||
| <exclude>**/*.fo</exclude> | ||
| </excludes> | ||
| </resource> | ||
| </resources> | ||
| <plugins> | ||
|
|
||
| <plugin> | ||
| <groupId>com.rackspace.cloud.api</groupId> | ||
| <artifactId>clouddocs-maven-plugin</artifactId> | ||
| <version>1.5.1</version> | ||
| <executions> | ||
| <execution> | ||
| <id>goal1</id> | ||
| <goals> | ||
| <goal>generate-pdf</goal> | ||
| </goals> | ||
| <phase>generate-sources</phase> | ||
| <configuration> | ||
| <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> | ||
| <id>goal2</id> | ||
| <goals> | ||
| <goal>generate-webhelp</goal> | ||
| </goals> | ||
| <phase>generate-sources</phase> | ||
| <configuration> | ||
| <!-- These parameters only apply to webhelp --> | ||
| <pdfUrl>basic-install-${release.path.name}.pdf</pdfUrl> | ||
| <enableDisqus>1</enableDisqus> | ||
| <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> | ||
| <!-- The following elements sets the autonumbering of sections in output for chapter numbers but no numbered sections--> | ||
| <sectionAutolabel>0</sectionAutolabel> | ||
| <sectionLabelIncludesComponentLabel>0</sectionLabelIncludesComponentLabel> | ||
| <postProcess> | ||
| <!-- Copies the figures to the correct location for webhelp --> | ||
| <copy todir="${basedir}/target/docbkx/webhelp/${release.path.name}/basic-install/content/figures"> | ||
| <fileset dir="${basedir}/src/figures"> | ||
| <include name="**/*.*" /> | ||
| </fileset> | ||
| </copy> | ||
| <!-- Copies webhelp (HTML output) to desired URL location on docs.openstack.org --> | ||
| <copy | ||
| todir="${basedir}/target/docbkx/webhelp/${release.path.name}/basic-install/"> | ||
| <fileset | ||
| dir="${basedir}/target/docbkx/webhelp/bk-basic-install/"> | ||
| <include name="**/*" /> | ||
| </fileset> | ||
| </copy> | ||
| <!--Moves PDF to the needed placement --> | ||
| <move failonerror="false" | ||
| file="${basedir}/target/docbkx/pdf/bk-basic-install.pdf" | ||
| tofile="${basedir}/target/docbkx/webhelp/${release.path.name}/basic-install/content/basic-install-${release.path.name}.pdf"/> | ||
| <!--Deletes leftover uneeded directories --> | ||
| <delete dir="${basedir}/target/docbkx/webhelp/bk-basic-install"/> | ||
| </postProcess> | ||
| </configuration> | ||
| </execution> | ||
| </executions> | ||
| <configuration> | ||
| <!-- These parameters apply to pdf and webhelp --> | ||
| <xincludeSupported>true</xincludeSupported> | ||
| <sourceDirectory>src</sourceDirectory> | ||
| <includes> | ||
| bk-basic-install.xml | ||
| </includes> | ||
| <canonicalUrlBase>http://docs.openstack.org/${release.path.name}/basic-install/content/</canonicalUrlBase> | ||
| <profileSecurity>reviewer</profileSecurity> | ||
| <branding>openstack</branding> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
|
|
||
| </project> |
52 changes: 52 additions & 0 deletions
52
doc/src/docbkx/basic-install/src/basic-install_architecture.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <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="basic-install_architecture"> | ||
| <title>Architecture</title> | ||
| <mediaobject> | ||
| <imageobject role="fo"> | ||
| <imagedata scale="60" fileref="figures/Quantum-PhysNet-Diagram.png"/> | ||
| </imageobject> | ||
| <imageobject role="html"> | ||
| <imagedata role="html" fileref="figures/Quantum-PhysNet-Diagram.png"/> | ||
| <!-- Edit link: http://docs.google.com/drawings/d/19qtlB_EeG9TM_jpeX5DprHRd9ShngXgfpt_t5mlrUMo/edit --> | ||
| </imageobject> | ||
| </mediaobject> | ||
| <para>A standard Quantum setup has up to four distinct physical data center networks: </para> | ||
| <itemizedlist> | ||
| <listitem> | ||
| <para><emphasis role="bold">Management | ||
| network</emphasis>. Used for internal | ||
| communication between OpenStack components. The IP | ||
| addresses on this network should be reachable only | ||
| within the data center. </para> | ||
| </listitem> | ||
| <listitem> | ||
| <para><emphasis role="bold">Data | ||
| network</emphasis>. Used for VM data communication | ||
| within the cloud deployment. The IP addressing | ||
| requirements of this network depend on the Quantum | ||
| plugin in use. </para> | ||
| </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> | ||
| </listitem> | ||
| <listitem> | ||
| <para><emphasis role="bold">API | ||
| network</emphasis>. Exposes all OpenStack | ||
| APIs, including the Quantum API, to | ||
| tenants. The IP addresses on this network | ||
| should be reachable by anyone on the | ||
| Internet. This may be the same network as | ||
| the external network, as it is possible to create | ||
| a quantum subnet for the external network that uses | ||
| IP allocation ranges to use only less than the full | ||
| range of IP addresses in an IP block. </para> | ||
| </listitem> | ||
| </itemizedlist> | ||
| </section> |
85 changes: 85 additions & 0 deletions
85
doc/src/docbkx/basic-install/src/basic-install_compute-common.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <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="basic-install_compute-common"> | ||
| <title>Common services</title> | ||
| <orderedlist> | ||
| <listitem> | ||
| <para>Install Ubuntu with this parameters :<itemizedlist> | ||
| <listitem> | ||
| <para>Time zone : <emphasis role="bold">UTC</emphasis></para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Hostname : <emphasis role="bold">folsom-compute</emphasis></para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Packages : <emphasis role="bold">OpenSSH-Server</emphasis></para> | ||
| </listitem> | ||
| </itemizedlist></para> | ||
| <para>After OS Installation, reboot the server .</para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Since Ubuntu 12.04 LTS has OpenStack Essex by default, we are going to use | ||
| Cloud Archives for Folsom :<screen>apt-get install ubuntu-cloud-keyring</screen>Edit | ||
| <emphasis role="bold">/etc/apt/sources.list.d/cloud-archive.list</emphasis> | ||
| :<screen>deb http://ubuntu-cloud.archive.canonical.com/ubuntu precise-updates/folsom main </screen>Upgrade | ||
| the system (and reboot if you need) | ||
| :<screen>apt-get update && apt-get upgrade</screen></para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Configure the network :</para> | ||
| <para><itemizedlist> | ||
| <listitem> | ||
| <para>Edit <emphasis role="bold">/etc/network/interfaces</emphasis> file | ||
| :</para> | ||
| </listitem> | ||
| </itemizedlist><screen><userinput># Management Network | ||
| auto eth0 | ||
| iface eth0 inet static | ||
| address 192.168.0.3 | ||
| netmask 255.255.255.0 | ||
| gateway 192.168.0.254 | ||
| dns-nameservers 8.8.8.8 | ||
|
|
||
| # Data Network | ||
| auto eth1 | ||
| iface eth1 inet static | ||
| address 10.10.10.2 | ||
| netmask 255.255.255.0</userinput></screen>Then, | ||
| restart network service | ||
| :<screen><userinput>service networking restart</userinput></screen></para> | ||
| <para> | ||
| <itemizedlist> | ||
| <listitem> | ||
| <para>Edit <emphasis role="bold">/etc/sysctl.conf | ||
| </emphasis>:</para> | ||
| </listitem> | ||
| </itemizedlist> | ||
| <programlisting>net.ipv4.conf.all.rp_filter = 0 | ||
| net.ipv4.conf.default.rp_filter = 0 </programlisting> | ||
| <itemizedlist> | ||
| <listitem> | ||
| <para>Edit the <emphasis role="bold">/etc/hosts</emphasis> file and | ||
| add <emphasis role="bold">folsom-controller</emphasis>, <emphasis | ||
| role="bold">folsom-network</emphasis> and <emphasis role="bold" | ||
| >folsom-compute</emphasis> hostnames with correct IP.</para> | ||
| </listitem> | ||
| </itemizedlist> | ||
| </para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Install & Configure NTP :<itemizedlist> | ||
| <listitem> | ||
| <para>Install the package :<screen><userinput>apt-get install -y ntp</userinput></screen></para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Configure <emphasis role="bold">/etc/ntp.conf</emphasis> file :<screen><userinput>server 192.168.0.1</userinput></screen></para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Restart the service :<screen><userinput>service ntp restart</userinput></screen></para> | ||
| </listitem> | ||
| </itemizedlist></para> | ||
| </listitem> | ||
| </orderedlist> | ||
| </section> |
45 changes: 45 additions & 0 deletions
45
doc/src/docbkx/basic-install/src/basic-install_compute-hypervisor.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <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="basic-install_compute-hypervisor"> | ||
| <title>Hypervisor</title> | ||
| <para> | ||
| <orderedlist> | ||
| <listitem> | ||
| <para>Install the packages that we need | ||
| :<screen><userinput>apt-get install -y kvm libvirt-bin pm-utils</userinput></screen></para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Configure libvirt :</para> | ||
| <itemizedlist> | ||
| <listitem> | ||
| <para>Edit <emphasis role="bold">/etc/libvirt/qemu.conf</emphasis> | ||
| file and add :<screen><userinput>cgroup_device_acl = [ | ||
| "/dev/null", "/dev/full", "/dev/zero", | ||
| "/dev/random", "/dev/urandom", | ||
| "/dev/ptmx", "/dev/kvm", "/dev/kqemu", | ||
| "/dev/rtc", "/dev/hpet", "/dev/net/tun"]</userinput></screen></para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Disable <emphasis role="bold">KVM default virtual bridge</emphasis> to avoid any confusion :<screen><userinput>virsh net-destroy default | ||
| virsh net-undefine default</userinput></screen></para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Allow <emphasis role="bold">Live Migrations</emphasis> :</para> | ||
| <para>Edit <emphasis role="bold">/etc/libvirt/libvirtd.conf</emphasis> file | ||
| :<programlisting>listen_tls = 0 | ||
| listen_tcp = 1 | ||
| auth_tcp = "none" </programlisting></para> | ||
| <para>Modify libvirtd_opts variable in <emphasis role="bold">/etc/init/libvirt-bin.conf</emphasis> file :<screen><userinput>env libvirtd_opts="-d -l" </userinput></screen></para> | ||
| <para>Edit <emphasis role="bold">/etc/default/libvirt-bin</emphasis> file :<screen><userinput>libvirtd_opts="-d -l" </userinput></screen></para> | ||
| </listitem> | ||
| </itemizedlist> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Restart libvirt :<screen><userinput>service libvirt-bin restart</userinput></screen> | ||
| </para> | ||
| </listitem> | ||
| </orderedlist> | ||
| </para> | ||
| </section> |
19 changes: 19 additions & 0 deletions
19
doc/src/docbkx/basic-install/src/basic-install_compute-intro.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <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="basic-install_compute-intro"> | ||
| <title>Introduction</title> | ||
| <para>The Compute node will provide : | ||
| <itemizedlist> | ||
| <listitem> | ||
| <para>Hypervisor (KVM)</para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>nova-compute</para> | ||
| </listitem> | ||
| <listitem> | ||
| <para>Quantum OVS Agent</para> | ||
| </listitem> | ||
| </itemizedlist></para> | ||
| </section> |
Oops, something went wrong.