Add info about Murano-repository to installation chapter into developer's guide
Change-Id: Iba100ff6829051a38c3203356a2de2657b41addd
This commit is contained in:
Ekaterina Fedorova
parent
443ecf41f3
commit
890c9d61cb
|
|
@ -90,22 +90,6 @@
|
|||
</para>
|
||||
</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>
|
||||
<title>Integration with Heat</title>
|
||||
<para>Heat is a cloud resource management engine that allows you to manipulate resources that represent
|
||||
|
|
|
|||
|
|
@ -1,247 +1,281 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<?xml version='1.0' encoding='UTF-8'?>
|
||||
<!--
|
||||
Copyright (c) 2013 Mirantis, Inc.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
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 "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.
|
||||
Copyright (c) 2013 Mirantis, Inc. Licensed under the Apache License,
|
||||
Version 2.0 (the "License"); 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 "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:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
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>
|
||||
<para>Note that all Murano modules can be downloaded from
|
||||
<link xlink:href="https://launchpad.net/murano/">our page</link>
|
||||
on launchpad.
|
||||
</para>
|
||||
<section xml:id="prerequisites">
|
||||
<title>Pre-Requisites</title>
|
||||
<para>Murano supports the following operating systems:</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>Ubuntu 12.04</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>RHEL/CentOS 6.4</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<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>
|
||||
<listitem>
|
||||
<para>libxml2-dev</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>libxslt-dev</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>libffi-dev</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<para>
|
||||
<emphasis>CentOS</emphasis>
|
||||
</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>gcc</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>python-pip</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>python-devel</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>libxml2-devel</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>libxslt-devel</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>libffi-devel</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<note>
|
||||
<para>Before installing any packages make sure that your system is updated and upgraded.</para>
|
||||
</note>
|
||||
</section>
|
||||
<section xml:id="venv">
|
||||
<title>Installing with virtual environment</title>
|
||||
<para>
|
||||
For a local development, all Murano components can be installed in
|
||||
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>
|
||||
<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>Install Murano</title>
|
||||
<para>This chapter describes Murano services installation in virtual
|
||||
environment.</para>
|
||||
<para>Note that all Murano modules can be downloaded from
|
||||
<link xlink:href="https://launchpad.net/murano/">our page</link> on
|
||||
launchpad.</para>
|
||||
<section xml:id="prerequisites">
|
||||
<title>Pre-Requisites</title>
|
||||
<para>Murano supports the following operating systems:</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>Ubuntu 12.04</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>RHEL/CentOS 6.4</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<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>
|
||||
<listitem>
|
||||
<para>libxml2-dev</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>libxslt-dev</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>libffi-dev</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<para><emphasis>CentOS</emphasis></para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>gcc</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>python-pip</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>python-devel</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>libxml2-devel</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>libxslt-devel</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>libffi-devel</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<note>
|
||||
<para>Before installing any packages make sure that your system is
|
||||
updated and upgraded.</para>
|
||||
</note>
|
||||
</section>
|
||||
<section xml:id="venv">
|
||||
<title>Installing with virtual environment</title>
|
||||
<para>
|
||||
For a local development, all Murano components can be installed in 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
|
||||
</programlisting>
|
||||
</para>
|
||||
<para><emphasis role="bold" >Murano Api</emphasis>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Check out git repository with murano component:
|
||||
<programlisting>
|
||||
</para>
|
||||
<para>
|
||||
<emphasis role="bold">Murano Api</emphasis>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Check out git repository with murano component:
|
||||
<programlisting>
|
||||
git clone https://github.com/stackforge/murano-api
|
||||
</programlisting>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Execute a script located at the <filename>murano-api/tools</filename> directory
|
||||
to create virtual environment automatically:
|
||||
<programlisting>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Execute a script located at the
|
||||
<filename>murano-api/tools</filename>
|
||||
directory to create virtual environment automatically:
|
||||
<programlisting>
|
||||
cd murano-api && 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>
|
||||
</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>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
<para>
|
||||
<emphasis role="bold">Murano Conductor</emphasis>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Check out git repository with murano component:
|
||||
<programlisting>
|
||||
git clone https://github.com/stackforge/murano-conductor
|
||||
</programlisting>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Execute a script located at the<filename>
|
||||
murano-conductor/tools</filename> directory
|
||||
to create virtual environment automatically:
|
||||
<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-conductor && python ./tools/install_venv.py
|
||||
</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's data directory located.
|
||||
# "data" must be subdirectory to this.
|
||||
</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's data directory located.
|
||||
# "data" 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.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Run 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.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Run Murano Conductor:
|
||||
<programlisting>
|
||||
./tools/with_venv.sh python muranoconductor/cmd/run.py --config-file=./etc/conductor.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>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
<para>
|
||||
<emphasis role="bold">Murano Repository</emphasis>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Check out git repository with murano component:
|
||||
<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 && 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
|
||||
</programlisting>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Execute a script located at the<filename>
|
||||
murano-dashboard/tools</filename> directory
|
||||
to create virtual environment automatically:
|
||||
<programlisting>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Execute a script located at the
|
||||
<filename>murano-dashboard/tools</filename>
|
||||
directory to create virtual environment automatically:
|
||||
<programlisting>
|
||||
cd murano-dashboard && 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>
|
||||
</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>
|
||||
<emphasis>Ubuntu</emphasis>
|
||||
<programlisting>
|
||||
# apt-get install nodejs
|
||||
</programlisting>
|
||||
<emphasis>CentOS</emphasis>
|
||||
<programlisting>
|
||||
<emphasis>CentOS</emphasis>
|
||||
<programlisting>
|
||||
# yum install nodejs
|
||||
</programlisting>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
To configure Murano Dashboard copy example config file:
|
||||
<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>
|
||||
<para><emphasis>Run Murano Dashboard:</emphasis>
|
||||
To start the Murano development server use the Django
|
||||
manage.py utility with the context of the virtual
|
||||
environment:
|
||||
<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>
|
||||
<emphasis>Run Murano Dashboard:</emphasis>
|
||||
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
|
||||
</programlisting>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</chapter>
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</chapter>
|
||||
|
|
|
|||
|
|
@ -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 &quot;License&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 &quot;AS
|
||||
IS&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>
|
||||
|
|
@ -41,6 +41,7 @@
|
|||
<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/knownissues.xml" xlink:title="Known Issues" />
|
||||
<xi:include href="./content/releases.xml" xlink:title="Release History" />
|
||||
<chapter>
|
||||
<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
|
||||
|
|
|
|||
Loading…
Reference in New Issue