Skip to content

Commit

Permalink
Edits to install/deploy guide.
Browse files Browse the repository at this point in the history
Fix bug 1060536 - removes unofficial .yaml script, rearranges scripted section,
updates curl example in case user used keystone script to populate users/tenants
roles etc.
Fix bug 1060805 - ensuring we use YOUR_GLANCEDB_PASSWORD consistently
Fix bug 1052967 - adds list of dependencies on Ubuntu 12.04
Partial fix for bug 1041703 - updates nova.conf for folsom, not sure if there
are many changes though since our sample install is quite simple

Rebase against master removing curl verification steps for keystone install.

Change-Id: I4e367eb6d2f4787ac01b60bdde2cf68545298093
  • Loading branch information
annegentle committed Oct 4, 2012
1 parent 9a6f017 commit 763618e
Show file tree
Hide file tree
Showing 6 changed files with 296 additions and 56 deletions.
53 changes: 25 additions & 28 deletions doc/src/docbkx/openstack-compute-admin/computeinstall.xml
Expand Up @@ -157,8 +157,8 @@
<varlistentry>
<term><link
xlink:href="http://docs.openstack.org/trunk/openstack-compute/install/yum/content/"
>OpenStack Install and Deploy Manual - Red
Hat</link></term>
>OpenStack Install and Deploy Manual - Red Hat</link>
(Folsom)</term>
<listitem>
<para>This guide walks through an installation using
packages available through Fedora 17 as well as on RHEL
Expand Down Expand Up @@ -193,9 +193,7 @@
<listitem>
<para>This page was originally written as instructions for
getting started with OpenStack on Fedora 16, which
includes the Diablo release. At the time of writing, while
EPEL 6 still includes Diablo, these instructions should be
used if installing on RHEL 6.</para>
includes the Diablo release.</para>
</listitem>
</varlistentry>
</variablelist>
Expand All @@ -209,18 +207,24 @@
installation.</para>

<section xml:id="iso-ubuntu-installation">
<title>ISO Distribution Installation</title>
<title>ISO Installation</title>

<para>You can download and use an ISO image that is based on a Ubuntu
Linux Server 10.04 LTS distribution containing only the components
needed to run OpenStack Compute. See <link
xlink:href="http://sourceforge.net/projects/stackops/files/">http://sourceforge.net/projects/stackops/files/</link>
for download files and information, license information, and a
<filename>README</filename> file. For documentation on the StackOps
distro, see <link
xlink:href="http://docs.stackops.org">http://docs.stackops.org</link>.
For free support, go to <link
xlink:href="http://getsatisfaction.com/stackops">http://getsatisfaction.com/stackops</link>.</para>
<para>Two ISO distributions are available for Essex: </para>
<para>See <link
xlink:href="http://sourceforge.net/projects/stackops/files/"
>http://sourceforge.net/projects/stackops/files/</link> for
download files and information, license information, and a
<filename>README</filename> file. For documentation on the
StackOps ISO, see <link xlink:href="http://docs.stackops.org"
>http://docs.stackops.org</link>. For free support, go to
<link xlink:href="http://getsatisfaction.com/stackops"
>http://getsatisfaction.com/stackops</link>.</para>
<para>See <link
xlink:href="http://www.rackspace.com/knowledge_center/article/installing-rackspace-private-cloud-on-physical-hardware"
>Installing Rackspace Private Cloud on Physical
Hardware</link> for download links and instructions for the
Rackspace Private Cloud ISO. For documentation on the
Rackspace, see <link xlink:href="http://www.rackspace.com/cloud/private">http://www.rackspace.com/cloud/private</link>. </para>
</section>

<section xml:id="scripted-ubuntu-installation">
Expand All @@ -233,13 +237,10 @@

<orderedlist>
<listitem>
<para>Install Ubuntu 11.04 (Natty):</para>
<para>Install Ubuntu 12.10 or RHEL/CentOS/Fedora 16:</para>

<para>In order to correctly install all the dependencies, we assume
a specific version of Ubuntu to make it as easy as possible.
OpenStack works on other flavors of Linux (and some folks even run
it on Windows!) We recommend using a minimal install of Ubuntu
server in a VM if this is your first time.</para>
a specific version of the OS to make it as easy as possible.</para>
</listitem>

<listitem>
Expand All @@ -248,7 +249,7 @@
<screen><prompt>$</prompt> <userinput>git clone git://github.com/openstack-dev/devstack.git</userinput></screen>

<para>The devstack repo contains a script that installs OpenStack
Compute, the Image Service and the Identity Service and offers
Compute, Object Storage, the Image Service, Volumes, the Dashboard and the Identity Service and offers
templates for configuration files plus data scripts.</para>
</listitem>

Expand All @@ -271,12 +272,8 @@
<para>The manual installation involves installing from packages
shipped on Ubuntu 12.04 as a user with root (or sudo)
permission. The <link
xlink:href="http://docs.openstack.org/diablo/openstack-compute/starter/content/"
>Oneiric OpenStack Starter Guide</link> provides
instructions for a manual installation using the packages
shipped with Ubuntu 11.10. The <link
xlink:href="http://docs.openstack.org/essex/openstack-compute/install/content/"
>OpenStack Install and Deploy Manual</link> provides
xlink:href="http://docs.openstack.org/install/"
>OpenStack Install and Deploy Manuals</link> provide
instructions for installing using Ubuntu 12.04 packages. Refer
to those manuals for detailed instructions by going to <link
xlink:href="http://docs.openstack.org"
Expand Down
13 changes: 13 additions & 0 deletions doc/src/docbkx/openstack-install/ap_dependencies.xml
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix xml:id="dependencies"
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">
<title>Appendix: Dependencies</title>

<para>Included for your reference is a list of dependencies.</para>
<section xml:id="ubuntu-dependencies"><title>Ubuntu 12.04 dependencies</title><para></para>

<literallayout class="monospaced"><xi:include parse="text"
href="samples/ubuntu_dependencies.txt"/></literallayout></section>
</appendix>
48 changes: 21 additions & 27 deletions doc/src/docbkx/openstack-install/identity-install-keystone.xml
Expand Up @@ -61,10 +61,10 @@
<title>Note</title>
<para>Choose a secure password for the keystone user and replace
all references to
<replaceable>[YOUR_KEYSTONE_PASSWORD]</replaceable> with this
password.</para>
<replaceable>[YOUR_KEYSTONEDB_PASSWORD]</replaceable> with
this password.</para>
</note>
<screen><prompt>mysql&gt;</prompt> <userinput>GRANT ALL ON keystone.* TO 'keystone'@'%' IDENTIFIED BY '<replaceable>[YOUR_KEYSTONE_PASSWORD]</replaceable>';</userinput></screen>
<screen><prompt>mysql&gt;</prompt> <userinput>GRANT ALL ON keystone.* TO 'keystone'@'%' IDENTIFIED BY '<replaceable>[YOUR_KEYSTONEDB_PASSWORD]</replaceable>';</userinput></screen>
<para>Enter quit at the <literal>mysql></literal> prompt to exit
MySQL.</para>
<screen><prompt>mysql&gt;</prompt> <userinput>quit</userinput></screen>
Expand All @@ -80,7 +80,7 @@
default, Keystone's data store is sqlite. To change the data store
to mysql, change the line defining "connection" in
<filename>/etc/keystone/keystone.conf</filename> like so:</para>
<programlisting>connection = mysql://keystone:<replaceable>[YOUR_KEYSTONE_PASSWORD]</replaceable>@192.168.206.130/keystone</programlisting>
<programlisting>connection = mysql://keystone:<replaceable>[YOUR_KEYSTONEDB_PASSWORD]</replaceable>@192.168.206.130/keystone</programlisting>
<para>Also, ensure that the proper service token is used in the
<filename>keystone.conf</filename> file. An example is provided in the Appendix or you can generate a random string. The sample token is:</para>
<programlisting>admin_token = 012345SECRET99TOKEN012345</programlisting>
Expand All @@ -96,33 +96,16 @@
<title>Configuring Services to work with Keystone</title>
<para> Once Keystone is installed and running, you set up users
and tenants and services to be configured to work with it. </para>
<section xml:id="setting-up-tenants-users-and-roles">
<title>Setting up tenants, users, and roles</title>
<section xml:id="setting-up-tenants-users-and-roles-manually">
<title>Setting up tenants, users, and roles - manually</title>
<para>You need to minimally define a tenant, user, and role to
link the tenant and user as the most basic set of details to
get other services authenticating and authorizing with the
Identity service. </para>
<para>Scripted configuration:</para>
<para>The Keystone project offers a bash script for populating
tenants, users, and roles at
<link xlink:href="https://github.com/openstack/keystone/blob/master/tools/sample_data.sh">https://github.com/openstack/keystone/blob/master/tools/sample_data.sh</link>
with sample data </para>
<para>On any distribution with python tools, you can run this keystone-init script that automates the steps below that use the keystone client API.</para>
<screen><prompt>$</prompt> <userinput>git clone https://github.com/nimbis/keystone-init.git</userinput></screen>
<para>You'll need <link xlink:href="http://pyyaml.org/wiki/PyYAML">PyYAML</link> installed to use this script. Look at
the script that does the work: <link
xlink:href="https://github.com/nimbis/keystone-init/blob/master/keystone-init.py"
>https://github.com/nimbis/keystone-init/blob/master/keystone-init.py</link>. </para>
<para>Edit the accompanying configuration file the script uses:
<link
xlink:href="https://github.com/nimbis/keystone-init/blob/master/config.yaml"
>https://github.com/nimbis/keystone-init/blob/master/config.yaml</link> with the IP address
of your servers. You can substitute quickly using this command in the directory where config.yaml is stored:</para>
<screen><prompt>$</prompt> <userinput>sed -i.bak s/192.168.206.130/172.16.150.12/g config.yaml</userinput></screen>
<para>Then run the modified script as
root:<screen><prompt>#</prompt> <userinput>./keystone-init.py config.yaml</userinput></screen></para>
<para>Manual configuration:</para>
<para>Here are the manual, unscripted steps. First, create a default tenant, we'll name it
<para>Here are the manual, unscripted steps using the keystone
client. At the end of this section a scripted method is
available. </para>
<para>First, create a default tenant, we'll name it
<literal>openstackDemo</literal> in this example.</para>
<screen><prompt>$ </prompt><userinput>keystone --token 012345SECRET99TOKEN012345 --endpoint http://192.168.206.130:35357/v2.0 tenant-create --name openstackDemo --description "Default Tenant" --enabled true</userinput></screen>
<programlisting> +-------------+----------------------------------+
Expand Down Expand Up @@ -250,6 +233,7 @@
<screen><prompt>$</prompt><userinput>keystone --token 012345SECRET99TOKEN012345 --endpoint http://192.168.206.130:35357/v2.0 user-role-add --user-id 4346677b8909823e389f0b4037b1246e --tenant_id eb7e0c10a99446cfa14c244374549e9d --role-id e3d9d157cc95410ea45d23bbbc2e5c10</userinput></screen>
<para>There is no output to this command.</para>
<para>Next you create definitions for the services.</para>

</section>
</section>
<section xml:id="defining-services">
Expand Down Expand Up @@ -641,5 +625,15 @@ service-create \
</computeroutput>
</screen>
</section>
<section xml:id="scripted-keystone-setup">
<title>Setting up Tenants, Users, Roles, and Services -
Scripted</title>
<para>The Keystone project offers a bash script for populating
tenants, users, roles and services at <link
xlink:href="https://github.com/openstack/keystone/blob/master/tools/sample_data.sh"
>https://github.com/openstack/keystone/blob/master/tools/sample_data.sh</link>
with sample data. This script uses 127.0.0.1 for all endpoint
IP addresses. This script also defines services for you. </para>
</section>
</section>
</section>
2 changes: 1 addition & 1 deletion doc/src/docbkx/openstack-install/install-config-glance.xml
Expand Up @@ -59,7 +59,7 @@ admin_password = glance</screen>
pipeline = authtoken auth-context context registryapp</screen>
<para>Ensure that <filename>/etc/glance/glance-registry.conf</filename>
points to the MySQL database rather than
sqlite.<programlisting>sql_connection = mysql://glance:yourpassword@192.168.206.130/glance</programlisting></para>
sqlite.<programlisting>sql_connection = mysql://glance:<replaceable>[YOUR_GLANCEDB_PASSWORD]</replaceable>@192.168.206.130/glance</programlisting></para>
<note><para>Any time you change the .conf files, restart the
corresponding service.</para></note>
<para os="ubuntu">On Ubuntu 12.04, the database tables are under version control and you must do these
Expand Down
1 change: 1 addition & 0 deletions doc/src/docbkx/openstack-install/samples/nova.conf
Expand Up @@ -13,6 +13,7 @@ auth_strategy=keystone
compute_scheduler_driver=nova.scheduler.filter_scheduler.FilterScheduler

# VOLUMES
volume_driver=nova.volume.driver.ISCSIDriver
volume_group=nova-volumes
volume_name_template=volume-%08x
iscsi_helper=tgtadm
Expand Down

0 comments on commit 763618e

Please sign in to comment.