stackforge-attic
/
murano-docs
Code Issues Proposed changes

Update documentation for a release-0.4.1 release 

Change-Id: I31ce794bc7b35891b0bc1ec13f9e5818f6a41b2c
Closes-bug: #1268537
This commit is contained in:
Ekaterina Fedorova 2014-02-06 16:16:46 +04:00
parent ac045cb3e1
commit 666cc306cf
7 changed files with 1034 additions and 881 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1669
src/administrators-guide/src/docbkx/content/installation-guide.xml
View File

File diff suppressed because it is too large Load Diff

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

@ -13,8 +13,7 @@
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
version="5.0">
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd" version="5.0">
<title>Install Murano</title>
<para>This chapter describes Murano services installation in virtual
environment.</para>
@ -79,6 +78,9 @@
<para>Before installing any packages make sure that your system is
updated and upgraded.</para>
</note>
<note>
To deploy web farm services Neutron LBaaS (Neutron extension package) should be installed in Openstack
</note>
</section>
<section xml:id="venv">
<title>Installing with virtual environment</title>
@ -91,7 +93,7 @@
virtualenv package if you don&apos;t have one:
<programlisting>
sudo pip install virtualenv
</programlisting>
</programlisting>
</para>
<para>
<emphasis role="bold">Murano Api</emphasis>
@ -101,7 +103,7 @@ sudo pip install virtualenv
Check out git repository with murano component:
<programlisting>
git clone https://github.com/stackforge/murano-api
</programlisting>
</programlisting>
</para>
</listitem>
<listitem>
@ -111,21 +113,22 @@ git clone https://github.com/stackforge/murano-api
directory to create virtual environment automatically:
<programlisting>
cd murano-api &amp;&amp; python ./tools/install_venv.py
</programlisting>
</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&apos;t require any changes.</para>
<para> Copy murano-api sample config file located at
<filename>etc/murano/murano-api.conf.sample</filename> to <filename>etc/murano/murano-api.conf</filename>.
In config file set up keystone endpoint in Openstack installation. Other settings are described in 'Murano Admin Guide'.
Config <filename>etc/murano/murano-api-paste.conf</filename>
doesn't require any modification.</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>
./tools/with_venv.sh python muranoapi/cmd/api.py --config-file=./etc/murano/murano-api.conf
</programlisting>
</para>
</listitem>
</itemizedlist>
@ -138,41 +141,33 @@ cd murano-api &amp;&amp; python ./tools/install_venv.py
Check out git repository with murano component:
<programlisting>
git clone https://github.com/stackforge/murano-conductor
</programlisting>
</programlisting>
</para>
</listitem>
<listitem>
<para>
Execute a script located at the
Execute the following script located at the
<filename>murano-conductor/tools</filename>
directory to create virtual environment automatically:
<programlisting>
cd murano-conductor &amp;&amp; python ./tools/install_venv.py
</programlisting>
</programlisting>
</para>
</listitem>
<listitem>
<para>
Murano Conductor config file located at
<filename>etc/conductor.conf</filename>
For a local development comment data_dir parameter in this file:
<programlisting>
# Directory where conductor&apos;s data directory located.
# &quot;data&quot; must be subdirectory to this.
# data_dir = /etc/murano-conductor
</programlisting>
After that local
<filename>data</filename>
directory, which contain all necessary files will be used. All
other possible configuration described in the Murano Admin Guide.
Copy Murano Conductor sample config file located at
<filename>etc/murano/conductor.conf.sample</filename> to <filename>etc/murano/conductor.conf</filename>.
In config file set up keystone endpoint in Openstack installation.
All other possible configuration described in the Murano Admin Guide.
</para>
</listitem>
<listitem>
<para>
Run Murano Conductor:
<programlisting>
./tools/with_venv.sh python muranoconductor/cmd/run.py --config-file=./etc/conductor.conf
</programlisting>
./tools/with_venv.sh python muranoconductor/cmd/run.py --config-file=./etc/murano/conductor.conf
</programlisting>
</para>
</listitem>
</itemizedlist>
@ -185,7 +180,7 @@ cd murano-conductor &amp;&amp; python ./tools/install_venv.py
Check out git repository with murano component:
<programlisting>
git clone https://github.com/stackforge/murano-repository
</programlisting>
</programlisting>
</para>
</listitem>
<listitem>
@ -195,20 +190,20 @@ git clone https://github.com/stackforge/murano-repository
directory to create virtual environment automatically:
<programlisting>
cd murano-repository &amp;&amp; python ./tools/install_venv.py
</programlisting>
</programlisting>
</para>
</listitem>
<listitem>
<para>Copy a config file <filename>
etc/murano-repository.conf.sample</filename> to <filename>
etc/murano-repository.conf</filename> and point out Keystone parameters.</para>
etc/murano/murano-repository.conf.sample</filename> to <filename>
etc/murano/murano-repository.conf</filename> and point out Keystone parameters.</para>
</listitem>
<listitem>
<para>
And finally run Murano Repository:
<programlisting>
./tools/with_venv.sh python muranorepository/cmd/run.py --config-file=./etc/murano-repository.conf
</programlisting>
./tools/with_venv.sh python muranorepository/cmd/run.py --config-file=./etc/murano/murano-repository.conf
</programlisting>
</para>
</listitem>
</itemizedlist>
@ -220,7 +215,7 @@ cd murano-repository &amp;&amp; python ./tools/install_venv.py
Check out git repository with murano component:
<programlisting>
git clone https://github.com/stackforge/murano-dashboard
</programlisting>
</programlisting>
</para>
</listitem>
<listitem>
@ -230,7 +225,7 @@ git clone https://github.com/stackforge/murano-dashboard
directory to create virtual environment automatically:
<programlisting>
cd murano-dashboard &amp;&amp; python ./tools/install_venv.py
</programlisting>
</programlisting>
</para>
</listitem>
<listitem>
@ -242,15 +237,15 @@ cd murano-dashboard &amp;&amp; python ./tools/install_venv.py
<para>
<programlisting>
# ./tools/with_venv.sh pip install https://github.com/openstack/horizon/archive/grizzly-2.tar.gz
</programlisting>
</programlisting>
<emphasis>Ubuntu</emphasis>
<programlisting>
# apt-get install nodejs
</programlisting>
</programlisting>
<emphasis>CentOS</emphasis>
<programlisting>
# yum install nodejs
</programlisting>
</programlisting>
</para>
</listitem>
</itemizedlist>
@ -261,12 +256,33 @@ cd murano-dashboard &amp;&amp; python ./tools/install_venv.py
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&apos;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.
</programlisting>
and set in just copied file the following parameters:
<itemizedlist>
<listitem>
<para>
<emphasis>MURANO_API_URL</emphasis> Required if murano-api service is not registered in keystone.
Provide valid URL where Murano API is running
</para>
</listitem>
<listitem>
<para>
<emphasis>MURANO_METADATA_URL</emphasis>
Required if murano-repository service is not registered in keystone.
Provide valid URL where Murano Repository service is running
</para>
</listitem>
<listitem>
<para><emphasis>NETWORK_TOPOLOGY</emphasis></para> - network configuration.
Duplicates murano-conductor setting (routed - default, flat, nova).
</listitem>
</itemizedlist>
Since all UI forms are described in Metadata Repository and kept in Django sessions - default Memcached as a session backend is not
suitable for a dynamic UI and we need to use Database backend. (It's already set up in murano settings file).
But this requires to synchronize database with the specified settings:
<programlisting>
./tools/with_venv.sh ./manage.py syncdb
</programlisting>
</para>
</listitem>
<listitem>
@ -276,7 +292,7 @@ cd murano-dashboard &amp;&amp; python ./tools/install_venv.py
utility with the context of the virtual environment:
<programlisting>
./tools/with_venv.sh ./manage.py runserver 0.0.0.0:8080
</programlisting>
</programlisting>
</para>
</listitem>
</itemizedlist>

12
src/developers-guide/src/docbkx/content/overview.xml
View File

@ -86,6 +86,18 @@
</itemizedlist>
</entry>
</row>
<row>
<entry>
February. 5, 2013
</entry>
<entry>
<itemizedlist spacing="compact">
<listitem>
<para>Update for Release-0.4.1</para>
</listitem>
</itemizedlist>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>

10
src/developers-guide/src/docbkx/content/releases.xml
View File

@ -52,6 +52,16 @@
<entry>0.3</entry>
<entry>2013-11-25</entry>
</row>
<row>
<entry>Release-0.4</entry>
<entry>0.3</entry>
<entry>2013-12-20</entry>
</row>
<row>
<entry>Release-0.4.1</entry>
<entry>0.3</entry>
<entry>2014-02-05</entry>
</row>
</tbody>
</tgroup>
</table>

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

@ -117,6 +117,11 @@ some_key2 = some_value2
RabbitMQ
</para>
</listitem>
<listitem>
<para>
<link xlink:href="https://wiki.openstack.org/wiki/Neutron/LBaaS/HowToRun"> Neutron LBaaS (Neutron extension package)</link>
</para>
</listitem>
<listitem>
<para>Windows Server 2012 Standard image imported into Glance.
See <link linkend="Build Windows Image">Build Windows Image</link> chapter.
@ -126,7 +131,7 @@ some_key2 = some_value2
<para>Samba share with prerequisites. See <link linkend="Samba">Install Samba</link></para>
</listitem>
<listitem>
<para>OpenStack metadata service.</para>
<para>OpenStack metadata service</para>
</listitem>
</itemizedlist>
</listitem>

11
src/getting-started/src/docbkx/content/overview.xml
View File

@ -125,6 +125,17 @@
</itemizedlist>
</td>
</tr>
<tr>
<td colspan="1" align="center"> February. 6, 2014 </td>
<td colspan="3" align="center"> Release-0.4.1 </td>
<td colspan="4">
<itemizedlist>
<listitem>
<para>Update with Release-0.4.1 information</para>
</listitem>
</itemizedlist>
</td>
</tr>
</tbody>
</informaltable>
</section>

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

@ -217,5 +217,103 @@ SSL_KEY_FILE=''
</listitem>
</itemizedlist>
</section>
<section>
<title>Custom devstack script</title>
<para>
It's just like regular devstack installation, but included all Murano services!
Follow the steps below:
</para>
<para><emphasis role="bold">System preparation</emphasis></para>
<para>
<itemizedlist>
<listitem>
<para><emphasis>Create user stack</emphasis></para>
<programlisting>
># adduser stack
</programlisting>
</listitem>
<listitem>
<para>Add user stack to sudoers rules</para>
<programlisting>
># echo 'stack ALL=(ALL) NOPASSWD: ALL' > /etc/sudoers.d/stack
># chmod 440 /etc/sudoers.d/stack
</programlisting>
</listitem>
</itemizedlist>
</para>
<para><emphasis role="bold"></emphasis>Installation</para>
<itemizedlist>
<listitem>
<para>Create folders where devstack will install all the files</para>
<programlisting>
># mkdir -p /opt/stack
># chown stack:stack /opt/stack
</programlisting>
</listitem>
<listitem>
<para>Change current user to "stack" and change directory to home</para>
<programlisting>
># su stack
>stack$ cd ~
</programlisting>
</listitem>
<listitem>
<para>Clone devstack repository and checkout havana branch</para>
<programlisting>
>stack$ cd
>stack$ git clone https://github.com/openstack-dev/devstack.git
>stack$ cd devstack
>stack$ git checkout stable/havana
</programlisting>
</listitem>
<listitem>
<para>Clone murano-deployment repository</para>
<programlisting>>stack$ cd
>stack$ git clone https://github.com/stackforge/murano-deployment.git</programlisting>
</listitem>
<listitem>
<para>Copy required files from murano-deployment to devstack, then configure local.conf.
You should set at least one configuration parameter there - HOST_IP address.</para>
<programlisting>
>stack$ cd
>stack$ cp -r murano-deployment/devstack-integration/* devstack/
</programlisting>
</listitem>
<listitem>
<para>Replace (or merge settings with) <filename>local.conf</filename> with another config file, if you need a different type of installation.
Available config files and installation types are:
<itemizedlist>
<listitem>
<para>
<filename>single-node.local.conf</filename> - single-node all-in-one installation. OpenStack + Murano will be installed on your node together.
</para>
</listitem>
<listitem>
<para>
<filename>devbox.local.conf</filename> - install Murano only. OpenStack must be installed on another node, and your node will be configured to use it.
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
<listitem>
<para>Edit devstack's configuration file</para>
<programlisting>
>stack$ vim devstack/local.conf
</programlisting>
</listitem>
<listitem>
<para>From devstack directory, launch stack.sh</para>
<programlisting>
>stack$ ./stack.sh
</programlisting>
</listitem>
</itemizedlist>
<para>
Now you can operate with Openstack and Murano. Murano Dashboard panel should appears in horizon dashboard.
Just open URL http://&lsaquo;your hostname&rsaquo; in web browser and login with your credentials. Open Murano tab and enjoy.
</para>
</section>
</chapter>