Fixed link and tabs. refactor install venv chapter

Change-Id: I9d9e5a958872e176a1470e8655f78f692482ec8b
This commit is contained in:
Ekaterina Fedorova 2013-09-25 17:23:28 +04:00
parent eeef9bd06e
commit f78198e993
3 changed files with 147 additions and 148 deletions

View File

@ -90,10 +90,8 @@ deb http://archive.gplhost.com/debian grizzly-backports main
<listitem> <listitem>
<para>Update system and add repositories and update OS <para>Update system and add repositories and update OS
<programlisting> <programlisting>
># yum install -y http://rdo.fedorapeople.org/openstack/\ ># yum install -y http://rdo.fedorapeople.org/openstack/openstack-grizzly/rdo-release-grizzly.rpm
openstack-grizzly/rdo-release-grizzly.rpm ># yum install -y http://mirror.us.leaseweb.net/epel/6/x86_64/epel-release-6-8.noarch.rpm
># yum install -y http://mirror.us.leaseweb.net/\
epel/6/x86_64/epel-release-6-8.noarch.rpm
># yum install -y mc unzip git make gcc python-setuptools python-pip upstart ># yum install -y mc unzip git make gcc python-setuptools python-pip upstart
># yum update ># yum update
># yum upgrade ># yum upgrade

View File

@ -335,9 +335,7 @@ git clone https://github.com/stackforge/murano-api
</programlisting> </programlisting>
<para>Stable version one of our <link xlink:href="http://murano-docs.github.io/latest/developers-guide/content/ch03s02.html"> releases</link> can be checked by tag:</para> <para>Stable version one of our <link xlink:href="http://murano-docs.github.io/latest/developers-guide/content/ch03s02.html"> releases</link> can be checked by tag:</para>
<programlisting> <programlisting>
<![CDATA[ cd murano-api &amp;&amp; git checkout 0.2
git checkout 0.2
]]>
</programlisting> </programlisting>
</listitem> </listitem>
<listitem> <listitem>
@ -347,7 +345,7 @@ git checkout 0.2
</para> </para>
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
sh murano-api/setup.sh install sh setup.sh install
]]> ]]>
</programlisting> </programlisting>
<para> <para>
@ -355,7 +353,7 @@ sh murano-api/setup.sh install
</para> </para>
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
sh murano-api/setup-centos.sh install sh setup-centos.sh install
]]> ]]>
</programlisting> </programlisting>
</listitem> </listitem>
@ -383,13 +381,11 @@ LOG:> Please, make proper configuration,located at "/etc/murano-api", before sta
cd /etc/murano-api cd /etc/murano-api
cp murano-api.conf.sample murano-api.conf cp murano-api.conf.sample murano-api.conf
cp murano-api-paste.ini.sample murano-api-paste.ini cp murano-api-paste.ini.sample murano-api-paste.ini
vi murano-api.conf
]]> ]]>
</programlisting> </programlisting>
</listitem> </listitem>
<listitem> <listitem>
<para>Configure it according to your environment: <para>Configure <file>murano-api.conf</file> it according to your environment:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis>[DEFAULT]</emphasis> section sets up logging. <para><emphasis>[DEFAULT]</emphasis> section sets up logging.
@ -402,13 +398,10 @@ vi murano-api.conf
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>In <para>In <emphasis>[rabbitmq]</emphasis>
<emphasis>[rabbitmq]</emphasis>
section you can set up host configuration where rabbitMQ section you can set up host configuration where rabbitMQ
with just created user and vhost is running. with just created user and vhost is running. If you consider to use Murano in production it's better to use separate vhosts in RabbitMQ.
If you consider to use Murano in production it;sbetter to use seperate vhosts in RabbitMQ. To add new vhost and user with administrator rights perform:
To add new vhost and user with
administrator rights preform:
</para> </para>
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
@ -538,9 +531,7 @@ git clone https://github.com/stackforge/murano-conductor
can be checked out by tag: can be checked out by tag:
</para> </para>
<programlisting> <programlisting>
<![CDATA[ cd murano-conductor &amp;&amp; git checkout 0.2
git checkout 0.2
]]>
</programlisting> </programlisting>
</listitem> </listitem>
<listitem> <listitem>
@ -550,7 +541,7 @@ git checkout 0.2
</para> </para>
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
sh murano-conductor/setup.sh install sh setup.sh install
]]> ]]>
</programlisting> </programlisting>
<para> <para>
@ -558,7 +549,7 @@ sh murano-conductor/setup.sh install
</para> </para>
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
sh murano-conductor/setup-centos.sh install sh setup-centos.sh install
]]> ]]>
</programlisting> </programlisting>
</listitem> </listitem>
@ -699,7 +690,7 @@ sudo su -
</listitem> </listitem>
<listitem> <listitem>
<para>Make sure that additional repositories are installed and your system is updated and upgraded. <para>Make sure that additional repositories are installed and your system is updated and upgraded.
Please check from with steps in the <link linked="Appendix">appendix</link>. Please check from with steps in the <link linkend="Appendix">appendix</link>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -710,11 +701,6 @@ sudo su -
Horizon installed by devstack is not capable for a murano installation. Horizon installed by devstack is not capable for a murano installation.
</para> </para>
</note> </note>
<para><emphasis>CentOS</emphasis></para>
<programlisting>
yum install make gcc memcached python-memcached \
mod_wsgi openstack-dashboard python-netaddr.noarch
</programlisting>
<para> <para>
<emphasis>Ubuntu</emphasis> <emphasis>Ubuntu</emphasis>
</para> </para>
@ -722,6 +708,13 @@ yum install make gcc memcached python-memcached \
apt-get install memcached libapache2-mod-wsgi openstack-dashboard apt-get install memcached libapache2-mod-wsgi openstack-dashboard
dpkg --purge openstack-dashboard-ubuntu-theme dpkg --purge openstack-dashboard-ubuntu-theme
</programlisting> </programlisting>
<para>
<emphasis>CentOS</emphasis>
</para>
<programlisting>
yum install make gcc memcached python-memcached \
mod_wsgi openstack-dashboard python-netaddr.noarch
</programlisting>
</listitem> </listitem>
<listitem> <listitem>
<para>Clone Murano Dashboard repository from the github:</para> <para>Clone Murano Dashboard repository from the github:</para>
@ -737,7 +730,7 @@ git clone https://github.com/stackforge/murano-dashboard
can be checked out by tag: can be checked out by tag:
</para> </para>
<programlisting> <programlisting>
git checkout 0.2 cd murano-dashboard &amp;&amp; git checkout 0.2
</programlisting> </programlisting>
</listitem> </listitem>
<listitem> <listitem>
@ -747,7 +740,7 @@ git checkout 0.2
</para> </para>
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
sh murano-dashboard/setup.sh install sh setup.sh install
]]> ]]>
</programlisting> </programlisting>
<para> <para>
@ -755,7 +748,7 @@ sh murano-dashboard/setup.sh install
</para> </para>
<programlisting> <programlisting>
<![CDATA[ <![CDATA[
sh murano-dashboard/setup-centos.sh install sh setup-centos.sh install
]]> ]]>
</programlisting> </programlisting>
</listitem> </listitem>
@ -784,17 +777,17 @@ sh murano-dashboard/setup-centos.sh install
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<emphasis>CentOS</emphasis> <emphasis>Ubuntu</emphasis>
<programlisting> <programlisting>
# service httpd restart # service apache2 restart
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<emphasis>Ubuntu</emphasis> <emphasis>CentOS</emphasis>
<programlisting> <programlisting>
# service apache2 restart # service httpd restart
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>

View File

@ -93,134 +93,80 @@ http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
<para> <para>
For a local development, all Murano components can be installed in For a local development, all Murano components can be installed in
a virtual environment. a virtual environment.
</para> First thing you need to do is to install check that
<itemizedlist> <link linkend="prerequisites"> prerequisites</link> are installed, system is updated and upgraded.
<listitem> Next, install virtualenv package if you don't have one:
<para>
Install virtualenv package if you don't have one:
<programlisting> <programlisting>
sudo pip install virtualenv sudo pip install virtualenv
</programlisting> </programlisting>
</para>
</listitem>
<listitem>
<para>Check out git repository with murano component:
</para> </para>
<para><emphasis role="bold" >Murano Api</emphasis>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>
Check out git repository with murano component:
<programlisting> <programlisting>
git clone https://github.com/stackforge/murano-api git clone https://github.com/stackforge/murano-api
</programlisting> </programlisting>
</para>
</listitem> </listitem>
<listitem> <listitem>
<para>
Execute a script located at the <filename>murano-api/tools</filename>directory
to create virtual environment automatically:
<programlisting>
cd murano-api &amp;&amp; python ./tools/install_venv.py
</programlisting>
</para>
</listitem>
<listitem>
<para>
Config files are <filename>etc/murano-api.conf</filename>
where you just need to point out IP address where your RabbitMQ is
running, and <filename>etc/murano-api-paste.ini</filename>, which doesn't require any changes.
</para>
</listitem>
<listitem>
<para>And finally run Murano API:
<programlisting>
./tools/with_venv.sh python muranoapi/cmd/api.py --config-file=./etc/murano-api.conf
</programlisting>
</para>
</listitem>
</itemizedlist>
</para>
<para>
<emphasis role="bold">Murano Conductor</emphasis>
<itemizedlist>
<listitem>
<para>
Check out git repository with murano component:
<programlisting> <programlisting>
git clone https://github.com/stackforge/murano-conductor git clone https://github.com/stackforge/murano-conductor
</programlisting> </programlisting>
</listitem>
<listitem>
<programlisting>
git clone https://github.com/stackforge/murano-dashboard
</programlisting>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
Make sure that required system packages are installed.
Check list from <link linkend="prerequisites"> prerequisites page</link>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Execute a script in the <filename>tools</filename> directory Execute a script located at the<filename>
murano-conductor/tools</filename>directory
to create virtual environment automatically: to create virtual environment automatically:
<programlisting> <programlisting>
$ python murano-api/tools/install_venv.py cd murano-conductor &amp;&amp; python ./tools/install_venv.py
$ python murano-conductor/tools/install_venv.py
$ python murano-dashboard/tools/install_venv.py
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>Murano Conductor config file located at <filename> etc/conductor.conf</filename>
For <emphasis role="bold"> Murano Dashboard </emphasis>additional installation need to be done: For a local development comment data_dir parameter in this file:
<itemizedlist>
<listitem>
<para>
Openstack dashboard (horizon).:
<programlisting>
./tools/with_venv.sh pip install https://github.com/openstack/horizon/archive/grizzly-2.tar.gz
</programlisting>
</para>
</listitem>
<listitem>
<para>
Install openstack-dashboard dependency:
<itemizedlist>
<listitem>
<para>
<emphasis>Ubuntu</emphasis>
<programlisting>
# apt-get install nodejs
</programlisting>
</para>
</listitem>
<listitem>
<para>
<emphasis>CentOS</emphasis>
<programlisting>
# yum install nodejs
</programlisting>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
Customized Djblets package to support datagrid element (installation by pip is not supported):
<programlisting>
./tools/with_venv.sh easy_install https://github.com/tsufiev/djblets/archive/master.zip
</programlisting>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
Config files for the development infrastructure of murano-api and murano-conductor can be found at <filename>etc</filename>
under folder with component repository. In murano-api and murano-conductor config file (located under ./etc directory)
just point out IP address where your RabbitMQ is running.
For a murano-conductor local development comment data_dir parameter in <filename>./etc/config.conf</filename>:
<programlisting> <programlisting>
# Directory where conductor's data directory located. # Directory where conductor's data directory located.
# "data" must be subdirectory to this. # "data" must be subdirectory to this.
# data_dir = /etc/murano-conductor # data_dir = /etc/murano-conductor
</programlisting> </programlisting>
After that local <filename>data</filename> directory, which contain all necessary files will be used. After that local <filename>data</filename>
All other possible configuration described in the Murano Admin Guide. directory, which contain all necessary files will be
</para> used. All other possible configuration described in the Murano Admin Guide.
</listitem>
<listitem>
<para>
To configure Murano Dashboard copy
<programlisting>
# cp muranodashboard/local/local_settings.py.example muranodashboard/local/local_settings.py
</programlisting>
and set in just copied file the the actual IP address of the OpenStack end-point.
If you haven't register murano-api service in the keystone catalog you can set MURANO_API_URL in the same settings file.
Note that local murano-api service will be using by default.
</para>
</listitem>
<listitem>
<para>Run Murano API:
<programlisting>
./tools/with_venv.sh python muranoapi/cmd/api.py --config-file=./etc/murano-api.conf
</programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -230,6 +176,68 @@ $ python murano-dashboard/tools/install_venv.py
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
</itemizedlist>
</para>
<para>
<emphasis role="bold">Murano Dashboard</emphasis>
</para>
<itemizedlist>
<listitem>
<para>Check out git repository with murano component:
<programlisting>
git clone https://github.com/stackforge/murano-dashboard
</programlisting>
</para>
</listitem>
<listitem>
<para>
Execute a script located at the<filename>
murano-conductor/tools</filename>directory
to create virtual environment automatically:
<programlisting>
cd murano-dashboard &amp;&amp; python ./tools/install_venv.py
</programlisting>
</para>
</listitem>
<listitem>
<para>
Murano is a plugin for a Openstack dashboard. So need to install it and it's dependency:
<itemizedlist>
<listitem>
<para>
<programlisting>
# ./tools/with_venv.sh pip install https://github.com/openstack/horizon/archive/grizzly-2.tar.gz
</programlisting>
<emphasis>Ubuntu</emphasis>
<programlisting>
# apt-get install nodejs
</programlisting>
<emphasis>CentOS</emphasis>
<programlisting>
# yum install nodejs
</programlisting>
</para>
<para>
Customized Djblets package to support datagrid element (installation by pip is not supported):
<programlisting>
# ./tools/with_venv.sh easy_install https://github.com/tsufiev/djblets/archive/master.zip
</programlisting>
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>
To configure Murano Dashboard copy example config file:
<programlisting>
# cp muranodashboard/local/local_settings.py.example muranodashboard/local/local_settings.py
</programlisting>
and set in just copied file the the actual IP address of the OpenStack end-point.
If you haven't register murano-api service in the keystone catalog you can set MURANO_API_URL in the same settings file.
Note that local murano-api service will be using by default.
</para>
</listitem>
<listitem> <listitem>
<para><emphasis>Run Murano Dashboard:</emphasis> <para><emphasis>Run Murano Dashboard:</emphasis>
To start the Murano development server use the Django To start the Murano development server use the Django