Dmytro Dovbii 94fcdd966f Update information about murano sample config file

Change-Id: Iec32be5b640dad7e3826b17b1dd41c6957b123a6

2014-12-02 17:57:42 +02:00

9.7 KiB

Raw Blame History

Installing and Running Manually

Prepare Environment

Install 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.

Ubuntu

$ sudo apt-get install python-pip python-dev \
> libmysqlclient-dev libpq-dev \
> libxml2-dev libxslt1-dev \
> libffi-dev

Fedora

Note

Fedora support wasn't thoroughly tested. We do not guarantee that Murano will work on Fedora.

$ sudo yum install gcc python-setuptools python-devel python-pip

CentOS

$ sudo yum install gcc python-setuptools python-devel
$ sudo easy_install pip

Install tox

$ sudo pip install tox

Install And Configure Database

Murano can use various database types on backend. For development purposes SQLite is enough in most cases. For production installations you should use MySQL or PostgreSQL databases.

Warning

Although Murano could use PostgreSQL database on backend, it wasn't thoroughly tested and should be used with caution.

To use MySQL database you should install it and create an empty database first:

$ 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;

Install the API service and Engine

Create a folder which will hold all Murano components.
```
$ mkdir ~/murano
```

Clone the Murano git repository to the management server.

$ cd ~/murano
$ git clone https://github.com/stackforge/murano

Generate the sample configuration file with tox.
```
$ cd ~/murano/murano
$ tox -egenconfig
```
Copy the sample configuration from the source tree to their final location.
```
$ cd ~/murano/murano/etc/murano
$ cp murano.conf.sample murano.conf
```

Edit murano.conf with your favorite editor. Below is an example which contains basic settings your are likely need to configure.

Note

The example below uses SQLite database. Edit [database] section if you want to use other database type.

[DEFAULT]
debug = true
verbose = true
rabbit_host = %RABBITMQ_SERVER_IP%
rabbit_userid = %RABBITMQ_USER%
rabbit_password = %RABBITMQ_PASSWORD%
rabbit_virtual_host = %RABBITMQ_SERVER_VIRTUAL_HOST%
notification_driver = messagingv2

[database]
backend = sqlalchemy
connection = sqlite:///murano.sqlite

[keystone]
auth_url = 'http://%OPENSTACK_HOST_IP%:5000/v2.0'

[keystone_authtoken]
auth_uri = 'http://%OPENSTACK_HOST_IP%:5000/v2.0'
auth_host = '%OPENSTACK_HOST_IP%'
auth_port = 5000
auth_protocol = http
admin_tenant_name = %OPENSTACK_ADMIN_TENANT%
admin_user = %OPENSTACK_ADMIN_USER%
admin_password = %OPENSTACK_ADMIN_PASSWORD%

[murano]
url = http://%YOUR_HOST_IP%:8082

[rabbitmq]
host = %RABBITMQ_SERVER_IP%
login = %RABBITMQ_USER%
password = %RABBITMQ_PASSWORD%
virtual_host = %RABBITMQ_SERVER_VIRTUAL_HOST%

Create a virtual environment and install Murano prerequisites. We will use tox for that. Virtual environment will be created under .tox directory.
```
$ cd ~/murano/murano
$ tox
```

Create database tables for Murano.

$ cd ~/murano/murano
$ tox -e venv -- murano-db-manage \
> --config-file ./etc/murano/murano.conf upgrade

Open a new console and launch Murano API. A separate terminal is required because the console will be locked by a running process.
```
$ cd ~/murano/murano
$ tox -e venv -- murano-api \
> --config-file ./etc/murano/murano.conf
```

Import Core Murano Library.

$ cd ~/murano/murano
$ tox -e venv -- murano-manage \
> --config-file ./etc/murano/murano.conf \
> import-package ./meta/io.murano

Open a new console and launch Murano Engine. A separate terminal is required because the console will be locked by a running process.
```
$ cd ~/murano/murano
$ tox -e venv -- murano-engine --config-file ./etc/murano/murano.conf
```

Install Murano Dashboard

Murano API & Engine services provide the core of Murano. However, your need a control plane to use it. This section decribes how to install and run Murano Dashboard.

Clone the repository with Murano Dashboard.

$ cd ~/murano
$ git clone https://github.com/stackforge/murano-dashboard

Create a virtual environment and install dashboard prerequisites. Again, we use tox for that.
```
$ cd ~/murano/murano-dashboard
$ tox
```
Install the latest horizon version and all murano-dashboard requirements into the virtual environment:
```
$ tox -e venv pip install horizon
```

It may happen, that the last release of horizon will be not capable with latest murano-dashboard code. In that case, horizon need to be installed from master branch of this repository: https://github.com/openstack/horizon

Copy configuration file for dashboard.

$ cd ~/murano/murano-dashboard/muranodashboard/local
$ cp local_settings.py.sample local_settings.py

Edit configuration file.

$ cd ~/murano/murano-dashboard/muranodashboard/local
$ vim ./local_settings.py

...
ALLOWED_HOSTS = '*'

# Provide OpenStack Lab credentials
OPENSTACK_HOST = '%OPENSTACK_HOST_IP%'

...
# Set secret key to prevent it's generation
SECRET_KEY = 'random_string'

...
DEBUG_PROPAGATE_EXCEPTIONS = DEBUG
...

Update settings file

Running Murano dashboard on developer environment implies the use of murano settings file instead of horizon. However, for the correct setup requires settings file to be synchronized with corresponding horizon release. But murano-dashboard also have parameters, that should be added to that config. So for your convenience, Murano has special script that allows to quickly synchronize Django settings file for a developer installation. update_setting.sh file can be found here.

To display all possible options run:
./update_setting.sh --help
Note

Ether output or input parameter should be specified.

--input={PATH/TO/HORIZON/SETTINGS/FILE} - settings file to which murano settings would be applied. If omitted, settings from horizon master branch are downloaded.
--output={PATH/TO/FILE} - file to store script execution result. Will be overwrite if already exist. If omitted, coincides to the input parameter.
--tag - horizon release tag name, applied, if no input parameter is provided.
--remove - if set, Murano parameters would be removed from the settings file.
--cache-dir={PATH/TO/DIRECTORY} - directory to store intermediate script data. Default is /tmp/muranodashboard-cache.
--log-file={PATH/TO/FILE} - file to store the script execution log to a separate file.

Run Django server at 127.0.0.1:8000 or provide different IP and PORT parameters.

$ cd ~/murano/murano-dashboard
$ tox -e venv -- python manage.py runserver <IP:PORT>
Development server will be restarted automatically on every code change.

Open dashboard using url http://localhost:8000

Import Murano Applications

Murano provides excellent catalog services, but it also requires applications which to provide. This section describes how to import Murano Applications from Murano App Incubator.

Clone Murano App Incubator repository.

$ cd ~/murano
$ git clone https://github.com/murano-project/murano-app-incubator

Import every package you need from Murano App Incubator using the command below.

$ cd ~/murano/murano
$ tox -e venv -- murano-manage \
> --config-file ./etc/murano/murano.conf \
> import-package ../murano-app-incubator/%APPLICATION_DIRECTORY_NAME%

9.7 KiB Raw Blame History