murano-docs/src/getting-started/src/docbkx/content/before_you_begin.xml

236 lines
9.3 KiB
XML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?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.
-->
<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>Before you begin</title>
<para><emphasis role="bold">Naming Conventions</emphasis>
</para>
<para>To clearly separate commands and parts of configuration files we use boxes, like shown below:</para>
<programlisting>
[Some config]
...
some_key1 = some_value1
some_key2 = some_value2
...
</programlisting>
<programlisting>
&gt;$ echo Execute this command as regular user
&gt;# echo Execute this command as root
</programlisting>
<para>
All commands start either with &gt;$ mark or with &gt;# mark.
The difference is that first should be executed as regular user, while second - as superuser (root).
</para>
<para><emphasis role="bold"> Use Appropriate Branch</emphasis></para>
<para>Master is a brunch for a development purposes. For stable releases appropriate branch names are using:
release-0.1, release-0.2 and so on.</para>
<para><emphasis role="bold">Use Separate vHost in <link linkend="Rabbit">RabbitMQ</link></emphasis></para>
<para>
In general it is OK to configure Murano services to use the root (/) vHost in RabbitMQ and use the same user credentials as OpenStack services use.
However, we recommend to create a separate vHost with separate user for each Murano devbox. There are a few reasons for that:
<itemizedlist>
<listitem>
<para>this prevents queue name collisions</para>
</listitem>
<listitem>
<para>this prevents message stealing from queues</para>
</listitem>
<listitem>
<para>this simplify debugging</para>
</listitem>
</itemizedlist>
</para>
<para>
If you are planning to use only one devbox then you may stay vHost with /.
Required steps to configure your own vHost are described in <link
linkend="Rabbit">RabbitMQ Configuration Notes</link>.
</para>
<section>
<title>System requirements</title>
<itemizedlist>
<listitem>
<para><emphasis role="bold">OpenStack Lab</emphasis> - a single node Openstack environment. See <link linkend="Setup Lab Environment">setup lab environment</link></para>
<para>
<emphasis>Supported OS:</emphasis>
</para>
<itemizedlist>
<listitem>
<para>Ubuntu Server 12.04 x64</para>
</listitem>
</itemizedlist>
<para>
<emphasis><anchor xml:id="LabHardware"></anchor>Hardware requirements:</emphasis>
</para>
<itemizedlist>
<listitem>
<para>CPU: 8+ cores</para>
</listitem>
<listitem>
<para>RAM: 12+ GB</para>
</listitem>
<listitem>
<para>HDD:</para>
<itemizedlist>
<listitem>
<para>1x SSD 500+ GB</para>
</listitem>
<listitem>
<para>1x HDD (7200 rpm) 500+ GB and 1x SSD 250+ GB (system onto the HDD and SSD drive for VM images)</para>
</listitem>
<listitem>
<para> 1x HDD (15000 rpm) 500+ GB </para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>NIC: 1x Ethernet 100Мbps (recommended 1Gbps)</para>
</listitem>
</itemizedlist>
<para>
<emphasis>Software requirements:</emphasis>
</para>
<itemizedlist>
<listitem>
<para>Heat</para>
</listitem>
<listitem>
<para>
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.
</para>
</listitem>
<listitem>
<para>Samba share with prerequisites. See <link linkend="Samba">Install Samba</link></para>
</listitem>
<listitem>
<para>OpenStack metadata service</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
<para>
<emphasis role="bold">Devbox</emphasis> - a machine where all murano services will be running.
This machine should have access to the Openstack Lab. See <link linkend="Setup Devbox">Setup Devbox</link> chapter.
</para>
<para>
We suggest to use virtual machine for Murano, as it allows you to
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.
</para>
<para>
<emphasis>Supported OS:</emphasis>
</para>
<itemizedlist>
<listitem>
<para>Ubuntu Server 12.04 LTS x86_64</para>
</listitem>
<listitem>
<para>CentOS 6.4 x86_64</para>
</listitem>
</itemizedlist>
<para>
<emphasis>"Hardware" requirements:</emphasis>
</para>
<itemizedlist>
<listitem>
<para>RAM: 512 MB</para>
</listitem>
<listitem>
<para>CPU: 1 core</para>
</listitem>
<listitem>
<para>HDD: 20 GB</para>
</listitem>
<listitem>
<para>NIC: 1x Ethernet 100Мbps</para>
</listitem>
</itemizedlist>
<para>
<emphasis>Software Requirements:</emphasis>
</para>
<itemizedlist>
<listitem>
<para>Packages:</para>
<para><emphasis>Ubuntu:</emphasis></para>
<itemizedlist>
<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>
</itemizedlist>
<para>
<emphasis>CentOS</emphasis>
</para>
<itemizedlist>
<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>
</itemizedlist>
</listitem>
<listitem>
<para>X Server is NOT required and system runlevel 3 is preferred.</para>
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</section>
</chapter>