stackforge-attic/murano-docs
Code Issues Proposed changes

Update installation part

Browse Source 
1) remove manual way installation and appendix with vm configuration for developer guide (temprory)
2) Add css for developer guide
3) add link to additional linux repos in installation guide

Change-Id: I2d63d280512ed0e28fe97e6196ec38c73334b6d4
This commit is contained in:
Ekaterina Fedorova
2013-09-17 13:51:49 +04:00
parent 13ec26d06c
commit 19029b1150
7 changed files with 72 additions and 202 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/developers-guide/pom.xml
View File

@@ -38,6 +38,8 @@
</execution>
</executions>
<configuration>
<htmlCustomization>../style/config.xsl</htmlCustomization>
<htmlStylesheet>../style/developers-guide.css</htmlStylesheet>
<xincludeSupported>true</xincludeSupported>
<chunkSectionDepth>100</chunkSectionDepth>
<postProcess>
@@ -46,6 +48,12 @@
<include name="**/*.png"/>
</fileset>
</copy>
<copy todir="target/docbkx/webhelp/developers-guide/style">
<fileset dir="src/docbkx/style">
<include name="**/*.css"/>
<include name="**/*.xsl"/>
</fileset>
</copy>
</postProcess>
</configuration>
</plugin>

8
src/getting-started/src/docbkx/content/appendix.xml → src/developers-guide/src/docbkx/content/appendix.xml
View File

@@ -108,7 +108,7 @@ deb http://archive.gplhost.com/debian grizzly-backports main
<programlisting>
># yum install -y http://rdo.fedorapeople.org/openstack/
openstack-grizzly/rdo-release-grizzly.rpm
># yum install -y http://mirror.yandex.ru/
># yum install -y mirror.us.leaseweb.net/
epel/6/x86_64/epel-release-6-8.noarch.rpm
># yum update
># yum upgrade
@@ -139,11 +139,9 @@ deb http://archive.gplhost.com/debian grizzly-backports main
<programlisting>
># pip --version
</programlisting>
<para>How-to upgrade pip to latest version:
<para>To upgrade pip to latest version use
<programlisting>
># pip install --upgrade pip
># pip install
https://pypi.python.org/packages/source/p/pip/pip-1.4.1.tar.gz
</programlisting>
<note>
<para>
@@ -153,7 +151,7 @@ deb http://archive.gplhost.com/debian grizzly-backports main
</para>
</note>
</para>
<para>How to handle this situation:</para>
<para>To handle this situation:</para>
<programlisting>
># rm /usr/bin/pip
># ln -s /usr/local/bin/pip /usr/bin/pip

60
src/developers-guide/src/docbkx/content/installation-guide.xml
View File

@@ -23,11 +23,19 @@
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
version="5.0">
<title>Installation Guide</title>
<para>This chapter describes installation and configuration of Murano services.</para>
<para>This chapter describes manual installation and configuration of Murano services.</para>
<para>Note that all Murano modules can be downloaded from
<link xlink:href="https://launchpad.net/murano/">our page</link>
on launchpad.
</para>
<para>
<note>
<title>Automatic installation</title> Murano can be installed in automatic way. Script will install all
necessary packages to your system. Find out more about this in
<link xlink:href='http://murano-docs.github.io/0.2/getting-started/content/ch04s02.html'>
Getting Started Guide</link>
</note>
</para>
<section>
<title>Pre-Requisites</title>
<para>Murano supports the following operating systems:</para>
@@ -42,6 +50,12 @@
<para>These system packages are required for Murano:</para>
<para><emphasis>Ubuntu</emphasis></para>
<orderedlist>
<listitem>
<para>gcc</para>
</listitem>
<listitem>
<para>python-pip</para>
</listitem>
<listitem>
<para>python-dev</para>
</listitem>
@@ -59,6 +73,12 @@
<emphasis>CentOS</emphasis>
</para>
<orderedlist>
<listitem>
<para>gcc</para>
</listitem>
<listitem>
<para>python-pip</para>
</listitem>
<listitem>
<para>python-devel</para>
</listitem>
@@ -72,6 +92,10 @@
<para>libffi-devel</para>
</listitem>
</orderedlist>
<para>
All these packages will be installed in murano-installation scripts. In addition to these packages some repositories are required.
Please follow the instructions in <link linkend="Appendix">the appendix</link> to prepare your environment for murano installation.
</para>
</section>
<section>
@@ -89,6 +113,10 @@ sudo su -
]]>
</programlisting>
</listitem>
<listitem>
<para>Make sure that additional linux repositories are installed. See <link linkend="Appendix">the appendix</link> for information about preparing a virtual machine for murano installation.
</para>
</listitem>
<listitem>
<para>Clone Murano API git repository:</para>
<programlisting>
@@ -120,7 +148,6 @@ sh setup.sh install
<programlisting>
<![CDATA[
cd murano-api
yum install -y http://mirror.yandex.ru/epel/6/x86_64/epel-release-6-8.noarch.rpm
sh setup-centos.sh install
]]>
</programlisting>
@@ -309,6 +336,13 @@ sudo su -
]]>
</programlisting>
</listitem>
<listitem>
<para>Make sure that additional repositories are installed.
See
<link linkend="Appendix">the appendix</link>
for information about preparing a virtual machine for murano installation.
</para>
</listitem>
<listitem>
<para>Clone Murano Conductor repository from the github.</para>
<programlisting>
@@ -344,7 +378,6 @@ sh setup.sh install
<![CDATA[
cd murano-conductor
yum install -y
http://mirror.yandex.ru/epel/6/x86_64/epel-release-6-8.noarch.rpm
sh setup-centos.sh install
]]>
</programlisting>
@@ -481,6 +514,27 @@ sudo su -
]]>
</programlisting>
</listitem>
<listitem>
<para>Make sure that additional repositories are installed.
See <link linkend="Appendix">the appendix</link>
for information about preparing a virtual machine for murano installation.
</para>
</listitem>
<listitem>
<para>If there is no openstack dashboard package in your environment install it now with all dependencies:</para>
<para><emphasis>CentOS</emphasis></para>
<programlisting>
yum install -y make gcc memcached python-memcached
mod_wsgi openstack-dashboard python-netaddr.noarch --assumeyes
</programlisting>
<para>
<emphasis>Ubuntu</emphasis>
</para>
<programlisting>
apt-get install -y memcached libapache2-mod-wsgi
openstack-dashboard
</programlisting>
</listitem>
<listitem>
<para>Clone Murano Dashboard repository from the github:</para>
<programlisting>

1
src/developers-guide/src/docbkx/developers-guide.xml
View File

@@ -75,4 +75,5 @@
xlink:href="https://launchpad.net/murano">launchpad page</link>.
</para>
</chapter>
<xi:include href="./content/appendix.xml" xlink:title="Appendix"/>
</book>

2
src/getting-started/src/docbkx/content/before_you_begin.xml
View File

@@ -135,8 +135,6 @@
backup your VM easily.
Any type of hypervisor software which supports linux as guest OS
could be used. KVM, VMWare and VirtualBox were tested with success.
There is a <link linkend="Appendix">Murano VM Appendix</link>
which contains steps to build your own VM.
</para>
<para>
<emphasis role="bold">Supported OS</emphasis>

194
src/getting-started/src/docbkx/content/setup_devbox.xml
View File

@@ -136,16 +136,13 @@ LAB_HOST='***.***.***.***'
</section>
<section xml:id="AutomatedWay">
<title>Automated Way</title>
<para>
Build your VM using instructions from <link linkend="Appendix">Murano VM</link> first.
</para>
<itemizedlist>
<listitem>
<para>Create a folder to hold cloned repositories</para>
<para>Create a folder to hold git repositories</para>
</listitem>
</itemizedlist>
<programlisting>
># mkdir -p /opt/git
># mkdir -p /opt/git cd /opt/git &amp;&amp; cd /opt/git
</programlisting>
<itemizedlist>
<listitem>
@@ -153,7 +150,6 @@ LAB_HOST='***.***.***.***'
</listitem>
</itemizedlist>
<programlisting>
># cd /opt/git
># git clone git://github.com/stackforge/murano-deployment.git
</programlisting>
<itemizedlist>
@@ -169,7 +165,7 @@ LAB_HOST='***.***.***.***'
</programlisting>
<itemizedlist>
<listitem>
<para>Install prerequisites</para>
<para>Install prerequisites. On this step some additional system packages will be installed</para>
</listitem>
</itemizedlist>
<programlisting>
@@ -213,190 +209,6 @@ BRANCH_NAME='release-0.2'
</listitem>
</itemizedlist>
</section>
<section>
<title>Manual Way</title>
<para>Build your VM using instructions from
<link linkend="Appendix">Murano VM</link>
first.
</para>
<para>
Package for Ubuntu and CentOS already in progress and will soon
be accessible for users. While they are not available, we provide
information about how to get and install all murano services from
source code below. We made setup scripts for automated installation
of our products which accepts install and uninstall command line
arguments. Service startup jobs are handled by Upstart.
</para>
<para>At first we need to create a working directory.</para>
<note> <para>All installation steps require the superuser rights.</para></note>
<programlisting>
># mkdir -p /opt/git &amp;&amp; cd /opt/git
</programlisting>
<note>
<para>
Please, track actual projects stable branch, at the time of
writing current stable branch is - release-0.2
</para>
</note>
<para>
<emphasis role="bold">Murano-Api</emphasis></para>
<itemizedlist>
<listitem>
<para>Get source code</para>
</listitem>
</itemizedlist>
<programlisting>
># git clone https://github.com/stackforge/murano-api -b release-0.2
># chmod +x murano-api/setup*.sh
</programlisting>
<itemizedlist>
<listitem>
<para>Install the component</para>
<para>
<emphasis>Ubuntu</emphasis>
</para>
<programlisting>
># ./murano-api/setup.sh install
</programlisting>
<para>
<emphasis>CentOS</emphasis>
</para>
<programlisting>
># ./murano-api/setup-centos.sh install
</programlisting>
</listitem>
</itemizedlist>
<para>Configuration:</para>
<programlisting>
># cd /etc/murano-api &amp;&amp; cp murano-api-paste.ini.sample \
murano-api-paste.ini
># cd /etc/murano-api &amp;&amp; cp murano-api.conf.sample murano-api.conf
</programlisting>
<note>
<para>
Before start service, set proper configuration values in
configuration files mentioned above.
</para>
</note>
<para>
Service control:
</para>
<programlisting>
># start murano-api
># stop murano-api
># restart murano-api
># status murano-api
</programlisting>
<para><emphasis role="bold">Murano-Conductor</emphasis></para>
<itemizedlist>
<listitem>
<para>Get source code</para>
</listitem>
</itemizedlist>
<programlisting>
># git clone https://github.com/stackforge/murano-conductor \
-b release-0.2
># chmod +x murano-conductor/setup*.sh
</programlisting>
<itemizedlist>
<listitem>
<para>Install the component</para>
<para>
<emphasis>Ubuntu</emphasis>
</para>
<programlisting>
># ./murano-conductor/setup.sh install
</programlisting>
<para>
<emphasis>CentOS</emphasis>
</para>
<programlisting>
># ./murano-conductor/setup-centos.sh install
</programlisting>
</listitem>
</itemizedlist>
<para>Configuration</para>
<programlisting>
># cd /etc/murano-conductor &amp;&amp; cp \
conductor-paste.ini.sample conductor-paste.ini
># cd /etc/murano-conductor &amp;&amp; cp \
conductor.conf.sample conductor.conf
</programlisting>
<note>
<para>
Before starting the service, set proper configuration values in
configuration files mentioned above.
</para>
</note>
<para>Service control:</para>
<programlisting>
># start murano-conductor
># stop murano-conductor
># restart murano-conductor
># status murano-conductor
</programlisting>
<para>
<emphasis role="bold">Murano-Dashboard</emphasis></para>
<para>At first, Install OpenStack dashboard(Horizon)  and dependent
packages.
</para>
<para>How-to do this:</para>
<itemizedlist>
<listitem>
<para><emphasis>Ubuntu</emphasis></para>
<programlisting>
># apt-get install -y memcached libapache2-mod-wsgi openstack-dashboard
># dpkg --purge openstack-dashboard-ubuntu-theme # optional step
</programlisting>
<para>After installation is complete, openstack dashboard should be
available at: http://&lt;your VM IP>/horizon
</para>
</listitem>
<listitem>
<para><emphasis>CentOS</emphasis></para>
<programlisting>
># yum install python-netaddr.noarch \
python-keystoneclient.noarch \
python-django-horizon.noarch \
python-django-openstack-auth.noarch \
 httpd.x86_64 mod_wsgi.x86_64 \
openstack-dashboard.noarch --assumeyes
># chkconfig httpd on
</programlisting>
<para>After installation is complete, openstack dashboard should be available
at: http://&lt;your VM IP>/dashboard
</para>
</listitem>
</itemizedlist>
<para>Installation of the murano-dashboard described below.</para>
<itemizedlist>
<listitem>
<para>Get source code</para>
<programlisting>
># git clone https://github.com/stackforge/murano-dashboard
-b release-0.2
># chmod +x murano-dashboard/setup*.sh
</programlisting>
</listitem>
<listitem>
<para>Install the component</para>
<para><emphasis>Ubuntu</emphasis>
<programlisting>
># ./murano-dashboard/setup.sh install
</programlisting>
</para>
<para>
<emphasis>CentOS</emphasis>
<programlisting>
># ./murano-dashboard/setup-centos.sh install
</programlisting>
</para>
</listitem>
</itemizedlist>
</section>
<section>
<title>Murano Services Configuration</title>
<para>This chapter descrides how to configure Murano services

1
src/getting-started/src/docbkx/getting-started.xml
View File

@@ -57,5 +57,4 @@
<xi:include href="./content/setup_lab_environment.xml" xlink:title="Setup Lab Environment"/>
<xi:include href="./content/setup_devbox.xml" xlink:title="Setup Devbox"/>
<xi:include href="./content/troubleshooting.xml" xlink:title="Troubleshooting"/>
<xi:include href="./content/appendix.xml" xlink:title="Appendix"/>
</book>