deb-murano/doc/source/install/manual.rst
Ruslan Kamaldinov 3b1cec10be Added developer documentation
* Updated README file
* Updated contrib/devstack/README
* Added documentation for Devstack installation
* Added documentation for manual installation of the API and Engine services
* Added basic contributing guide
* Added extended contributing guide
* Added HACKING.rst to the root of the project
* Added development guidelines
* Sets simple Sphinx theme

Partially implements blueprint: murano-dev-doc-05

Change-Id: Ib7d7b416ccc61667ed96297555db2ef5dca9ae67
2014-04-21 16:32:28 +04:00

105 lines
2.7 KiB
ReStructuredText

..
Copyright 2014 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.
.. _installing_manually:
================================
Installing and Running Manually
================================
Installing prerequisites
========================
First you need to install a number of packages with your OS package manager.
The list of packages depends on the OS you use.
* For Ubuntu run:
::
$ sudo apt-get install python-setuptools python-dev
* For Fedora:
::
$ sudo yum install gcc python-setuptools python-devel
.. note::
Fedora support wasn't thoroughly tested. We do not guarantee that Murano
will work on Fedora.
* For CentOS:
::
$ sudo yum install gcc python-setuptools python-devel
$ sudo easy_install pip
Installing the API service and Engine
=====================================
1. Clone the Murano git repository to the management server:
::
$ cd /opt/stack
$ git clone https://git.openstack.org/stackforge/murano-api.git
2. Configure the database. Murano can run with MySQL and SQLite. MySQL is
required for produciton installation, SQLite can be used for developemnt
purposes only. Let's setup MySQL database for Murano:
::
$ apt-get install python-mysqldb mysql-server
$ mysql -u root -p
mysql> CREATE DATABASE murano;
mysql> GRANT ALL PRIVILEGES ON murano.* TO 'murano'@'localhost' \
IDENTIFIED BY 'MURANO_DBPASS';
mysql> exit;
3. Copy the sample configuration from the source tree to their final location:
::
$ mkdir -p /etc/murano
$ cp etc/murano/murano-api.conf.sample /etc/murano/murano-api.conf
$ cp etc/murano/murano-api-paste.ini /etc/murano/
4. Edit ``/etc/murano/murano-api.conf``
TODO(ruhe): document configuration options
5. Create database tables for Murano:
::
$ tox -e venv -- murano-manage --config-file /etc/murano/murano-api.conf db-sync
6. Launch Murano API service:
::
$ tox -e venv -- murano-api --config-file /etc/murano/murano-api.conf
7. Launch Murano Engine service:
::
$ tox -e venv -- murano-engine --config-file /etc/murano/murano-api.conf