stackforge-attic
/
murano-docs
Code Issues Proposed changes

Add info about Murano-repository to installation chapter into developer's guide 

Change-Id: Iba100ff6829051a38c3203356a2de2657b41addd
This commit is contained in:
Ekaterina Fedorova 2013-12-06 15:31:26 +04:00
parent 443ecf41f3
commit 890c9d61cb
4 changed files with 308 additions and 231 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/developers-guide/src/docbkx/content/architecture.xml
View File

@ -90,22 +90,6 @@
</para> </para>
</section> </section>
</section> </section>
<section xml:id="releases">
<title>Releases</title>
<itemizedlist>
<listitem>
<para> <emphasis>Release-0.1</emphasis>
has 0.1 tag in all Murano repositories. Released 2013-05-30.
</para>
</listitem>
<listitem>
<para>
<emphasis>Release-0.2</emphasis>
has 0.2 tag in all Murano repositories. Released 2013-09-05.
</para>
</listitem>
</itemizedlist>
</section>
<section> <section>
<title>Integration with Heat</title> <title>Integration with Heat</title>
<para>Heat is a cloud resource management engine that allows you to manipulate resources that represent <para>Heat is a cloud resource management engine that allows you to manipulate resources that represent

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

@ -1,247 +1,281 @@
<?xml version="1.0" encoding="UTF-8"?> <?xml version='1.0' encoding='UTF-8'?>
<!-- <!--
Copyright (c) 2013 Mirantis, Inc. Copyright (c) 2013 Mirantis, Inc. Licensed under the Apache License,
Version 2.0 (the &quot;License&quot;); you may not use this file
Licensed under the Apache License, Version 2.0 (the "License"); except in compliance with the License. You may obtain a copy of the
you may not use this file except in compliance with the License. License at http://www.apache.org/licenses/LICENSE-2.0 Unless required
You may obtain a copy of the License at by applicable law or agreed to in writing, software distributed under
the License is distributed on an &quot;AS IS&quot; BASIS, WITHOUT
http://www.apache.org/licenses/LICENSE-2.0 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See
the License for the specific language governing permissions and
Unless required by applicable law or agreed to in writing, software limitations under the License.
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
See the License for the specific language governing permissions and
limitations under the License.
--> -->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
<chapter xmlns="http://docbook.org/ns/docbook" 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">
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" <title>Install Murano</title>
xmlns:xlink="http://www.w3.org/1999/xlink" <para>This chapter describes Murano services installation in virtual
xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd environment.</para>
http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd" <para>Note that all Murano modules can be downloaded from
version="5.0"> <link xlink:href="https://launchpad.net/murano/">our page</link> on
<title>Install Murano</title> launchpad.</para>
<para>This chapter describes Murano services installation in virtual environment.</para> <section xml:id="prerequisites">
<para>Note that all Murano modules can be downloaded from <title>Pre-Requisites</title>
<link xlink:href="https://launchpad.net/murano/">our page</link> <para>Murano supports the following operating systems:</para>
on launchpad. <orderedlist>
</para> <listitem>
<section xml:id="prerequisites"> <para>Ubuntu 12.04</para>
<title>Pre-Requisites</title> </listitem>
<para>Murano supports the following operating systems:</para> <listitem>
<orderedlist> <para>RHEL/CentOS 6.4</para>
<listitem> </listitem>
<para>Ubuntu 12.04</para> </orderedlist>
</listitem> <para>These system packages are required for Murano:</para>
<listitem> <para><emphasis>Ubuntu</emphasis></para>
<para>RHEL/CentOS 6.4</para> <orderedlist>
</listitem> <listitem>
</orderedlist> <para>gcc</para>
<para>These system packages are required for Murano:</para> </listitem>
<para><emphasis>Ubuntu</emphasis></para> <listitem>
<orderedlist> <para>python-pip</para>
<listitem> </listitem>
<para>gcc</para> <listitem>
</listitem> <para>python-dev</para>
<listitem> </listitem>
<para>python-pip</para> <listitem>
</listitem> <para>libxml2-dev</para>
<listitem> </listitem>
<para>python-dev</para> <listitem>
</listitem> <para>libxslt-dev</para>
<listitem> </listitem>
<para>libxml2-dev</para> <listitem>
</listitem> <para>libffi-dev</para>
<listitem> </listitem>
<para>libxslt-dev</para> </orderedlist>
</listitem> <para><emphasis>CentOS</emphasis></para>
<listitem> <orderedlist>
<para>libffi-dev</para> <listitem>
</listitem> <para>gcc</para>
</orderedlist> </listitem>
<para> <listitem>
<emphasis>CentOS</emphasis> <para>python-pip</para>
</para> </listitem>
<orderedlist> <listitem>
<listitem> <para>python-devel</para>
<para>gcc</para> </listitem>
</listitem> <listitem>
<listitem> <para>libxml2-devel</para>
<para>python-pip</para> </listitem>
</listitem> <listitem>
<listitem> <para>libxslt-devel</para>
<para>python-devel</para> </listitem>
</listitem> <listitem>
<listitem> <para>libffi-devel</para>
<para>libxml2-devel</para> </listitem>
</listitem> </orderedlist>
<listitem> <note>
<para>libxslt-devel</para> <para>Before installing any packages make sure that your system is
</listitem> updated and upgraded.</para>
<listitem> </note>
<para>libffi-devel</para> </section>
</listitem> <section xml:id="venv">
</orderedlist> <title>Installing with virtual environment</title>
<note> <para>
<para>Before installing any packages make sure that your system is updated and upgraded.</para> For a local development, all Murano components can be installed in a
</note> virtual environment. First thing you need to do is to install check
</section> that
<section xml:id="venv"> <link linkend="prerequisites">prerequisites</link>
<title>Installing with virtual environment</title> are installed, system is updated and upgraded. Next, install
<para> virtualenv package if you don&apos;t have one:
For a local development, all Murano components can be installed in <programlisting>
a virtual environment.
First thing you need to do is to install check that
<link linkend="prerequisites"> prerequisites</link> are installed, system is updated and upgraded.
Next, install virtualenv package if you don't have one:
<programlisting>
sudo pip install virtualenv sudo pip install virtualenv
</programlisting> </programlisting>
</para> </para>
<para><emphasis role="bold" >Murano Api</emphasis> <para>
<itemizedlist> <emphasis role="bold">Murano Api</emphasis>
<listitem> <itemizedlist>
<para> <listitem>
Check out git repository with murano component: <para>
<programlisting> Check out git repository with murano component:
<programlisting>
git clone https://github.com/stackforge/murano-api git clone https://github.com/stackforge/murano-api
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Execute a script located at the <filename>murano-api/tools</filename> directory Execute a script located at the
to create virtual environment automatically: <filename>murano-api/tools</filename>
<programlisting> directory to create virtual environment automatically:
<programlisting>
cd murano-api &amp;&amp; python ./tools/install_venv.py cd murano-api &amp;&amp; python ./tools/install_venv.py
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>Config files are <filename>etc/murano-api.conf</filename>
Config files are <filename>etc/murano-api.conf</filename> where you just need to point out IP address where your RabbitMQ is
where you just need to point out IP address where your RabbitMQ is running, and <filename>etc/murano-api-paste.ini</filename>, which
running, and <filename>etc/murano-api-paste.ini</filename>, which doesn't require any changes. doesn&apos;t require any changes.</para>
</para> </listitem>
</listitem> <listitem>
<listitem> <para>
<para>And finally run Murano API: And finally run Murano API:
<programlisting> <programlisting>
./tools/with_venv.sh python muranoapi/cmd/api.py --config-file=./etc/murano-api.conf ./tools/with_venv.sh python muranoapi/cmd/api.py --config-file=./etc/murano-api.conf
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
<emphasis role="bold">Murano Conductor</emphasis> <emphasis role="bold">Murano Conductor</emphasis>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
Check out git repository with murano component: 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>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Execute a script located at the<filename> Execute a script located at the
murano-conductor/tools</filename> directory <filename>murano-conductor/tools</filename>
to create virtual environment automatically: directory to create virtual environment automatically:
<programlisting> <programlisting>
cd murano-conductor &amp;&amp; python ./tools/install_venv.py cd murano-conductor &amp;&amp; python ./tools/install_venv.py
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para>Murano Conductor config file located at <filename> etc/conductor.conf</filename> <para>
For a local development comment data_dir parameter in this file: Murano Conductor config file located at
<programlisting> <filename>etc/conductor.conf</filename>
# Directory where conductor's data directory located. For a local development comment data_dir parameter in this file:
# "data" must be subdirectory to this. <programlisting>
# Directory where conductor&apos;s data directory located.
# &quot;data&quot; must be subdirectory to this.
# data_dir = /etc/murano-conductor # data_dir = /etc/murano-conductor
</programlisting> </programlisting>
After that local <filename>data</filename> After that local
directory, which contain all necessary files will be <filename>data</filename>
used. All other possible configuration described in the Murano Admin Guide. directory, which contain all necessary files will be used. All
</para> other possible configuration described in the Murano Admin Guide.
</listitem> </para>
<listitem> </listitem>
<para>Run Murano Conductor: <listitem>
<programlisting> <para>
Run Murano Conductor:
<programlisting>
./tools/with_venv.sh python muranoconductor/cmd/run.py --config-file=./etc/conductor.conf ./tools/with_venv.sh python muranoconductor/cmd/run.py --config-file=./etc/conductor.conf
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
<emphasis role="bold">Murano Dashboard</emphasis> <emphasis role="bold">Murano Repository</emphasis>
</para> <itemizedlist>
<itemizedlist> <listitem>
<listitem> <para>
<para>Check out git repository with murano component: Check out git repository with murano component:
<programlisting> <programlisting>
git clone https://github.com/stackforge/murano-repository
</programlisting>
</para>
</listitem>
<listitem>
<para>
Execute a script located at the
<filename>murano-repository/tools</filename>
directory to create virtual environment automatically:
<programlisting>
cd murano-repository &amp;&amp; python ./tools/install_venv.py
</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>
</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>
</para>
</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 git clone https://github.com/stackforge/murano-dashboard
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Execute a script located at the<filename> Execute a script located at the
murano-dashboard/tools</filename> directory <filename>murano-dashboard/tools</filename>
to create virtual environment automatically: directory to create virtual environment automatically:
<programlisting> <programlisting>
cd murano-dashboard &amp;&amp; python ./tools/install_venv.py cd murano-dashboard &amp;&amp; python ./tools/install_venv.py
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Murano is a plugin for a Openstack dashboard. So need to install it and it's dependency: Murano is a plugin for a Openstack dashboard. So need to install
<itemizedlist> it and it&apos;s dependency:
<listitem> <itemizedlist>
<para> <listitem>
<programlisting> <para>
<programlisting>
# ./tools/with_venv.sh pip install https://github.com/openstack/horizon/archive/grizzly-2.tar.gz # ./tools/with_venv.sh pip install https://github.com/openstack/horizon/archive/grizzly-2.tar.gz
</programlisting> </programlisting>
<emphasis>Ubuntu</emphasis> <emphasis>Ubuntu</emphasis>
<programlisting> <programlisting>
# apt-get install nodejs # apt-get install nodejs
</programlisting> </programlisting>
<emphasis>CentOS</emphasis> <emphasis>CentOS</emphasis>
<programlisting> <programlisting>
# yum install nodejs # yum install nodejs
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
To configure Murano Dashboard copy example config file: To configure Murano Dashboard copy example config file:
<programlisting> <programlisting>
# cp muranodashboard/local/local_settings.py.example muranodashboard/local/local_settings.py # cp muranodashboard/local/local_settings.py.example muranodashboard/local/local_settings.py
</programlisting> </programlisting>
and set in just copied file the the actual IP address of the OpenStack end-point. and set in just copied file the the actual IP address of the
If you haven't register murano-api service in the keystone catalog you can set MURANO_API_URL in the same settings file. OpenStack end-point. If you haven&apos;t register murano-api
Note that local murano-api service will be using by default. service in the keystone catalog you can set MURANO_API_URL in the
</para> same settings file. Note that local murano-api service will be
</listitem> using by default.
<listitem> </para>
<para><emphasis>Run Murano Dashboard:</emphasis> </listitem>
To start the Murano development server use the Django <listitem>
manage.py utility with the context of the virtual <para>
environment: <emphasis>Run Murano Dashboard:</emphasis>
<programlisting> To start the Murano development server use the Django manage.py
utility with the context of the virtual environment:
<programlisting>
./tools/with_venv.sh ./manage.py runserver 0.0.0.0:8080 ./tools/with_venv.sh ./manage.py runserver 0.0.0.0:8080
</programlisting> </programlisting>
</para> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
</chapter> </chapter>

58
src/developers-guide/src/docbkx/content/releases.xml Normal file
View File

@ -0,0 +1,58 @@
<?xml version='1.0' encoding='UTF-8'?>
<!--
Copyright (c) 2013 Mirantis, Inc. Licensed under the Apache License,
Version 2.0 (the &amp;quot;License&amp;quot;); you may not use this
file except in compliance with the License. You may obtain a copy of
the License at http://www.apache.org/licenses/LICENSE-2.0 Unless
required by applicable law or agreed to in writing, software
distributed under the License is distributed on an &amp;quot;AS
IS&amp;quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the License for the specific language
governing permissions and limitations under the License.
-->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
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">
<title>Release History</title>
<table xml:id="releases" frame="all">
<title>Murano Releases</title>
<tgroup align="left" cols="3" colsep="1" rowsep="1">
<colspec colname="col1" colnum="1" colwidth="2*"/>
<colspec colname="col2" colnum="2" colwidth="3*"/>
<colspec colname="col3" colnum="3" colwidth="4*"/>
<thead>
<row>
<entry>Release</entry>
<entry>Tag</entry>
<entry>Date</entry>
</row>
</thead>
<tbody>
<row>
<entry>Release-0.1</entry>
<entry>0.1</entry>
<entry>2013-05-30</entry>
</row>
<row>
<entry>Release-0.2</entry>
<entry>0.2</entry>
<entry>2013-09-05</entry>
</row>
<row>
<entry>Release-0.2.11</entry>
<entry>0.2.11</entry>
<entry>2013-10-01</entry>
</row>
<row>
<entry>Release-0.2.12</entry>
<entry>0.2.12</entry>
<entry>2013-11-18</entry>
</row>
<row>
<entry>Release-0.3</entry>
<entry>0.3</entry>
<entry>2013-11-25</entry>
</row>
</tbody>
</tgroup>
</table>
</chapter>

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

@ -41,6 +41,7 @@
<xi:include href="./content/repository-specification.xml" xlink:title="Metadata API Specification" /> <xi:include href="./content/repository-specification.xml" xlink:title="Metadata API Specification" />
<xi:include href="./content/workflows.xml" xlink:title="Workflows XML DSL" /> <xi:include href="./content/workflows.xml" xlink:title="Workflows XML DSL" />
<xi:include href="./content/knownissues.xml" xlink:title="Known Issues" /> <xi:include href="./content/knownissues.xml" xlink:title="Known Issues" />
<xi:include href="./content/releases.xml" xlink:title="Release History" />
<chapter> <chapter>
<title>How To Participate</title> <title>How To Participate</title>
<para>If you would like to ask some questions or make proposals, feel free to reach us on #murano irc channel at <para>If you would like to ask some questions or make proposals, feel free to reach us on #murano irc channel at