deb-murano/doc/source/draft/admin-guide/deploy_murano/install_manually.rst

Install murano manually

Before you install Murano, verify that you completed the following tasks:

1. Install software prerequisites depending on the operating system you use as described in the System prerequisites section.

2. Install tox:

   sudo pip install tox

3. Install and configure a database.

   Murano can use various database types on back end. For development purposes, use SQLite. For production installations, consider using MySQL database.

   Warning

   Murano supports PostgreSQL as well. Though, use it with caution as it has not been thoroughly tested yet.

   Before you can use MySQL database, proceed with the following:

   1. Install MySQL:

      apt-get install mysql-server

   2. Create an empty database:

      Replace %MURANO_DB_PASSWORD% with the actual password. For example, 'admin'.

      mysql -u root -p
      
      mysql> CREATE DATABASE murano;
      mysql> GRANT ALL PRIVILEGES ON murano.* TO 'murano'@'localhost' \
      IDENTIFIED BY %MURANO_DB_PASSWORD%;
      mysql> exit;

Install the API service and engine

1. Create a folder to which all murano components will be stored:

   mkdir ~/murano

2. Clone the murano git repository to the management server:

   cd ~/murano
   git clone git://git.openstack.org/openstack/murano

3. Create the configuration file. Murano has a common configuration file for API and engine services.

   1. Generate a sample configuration file using tox:

      cd ~/murano/murano
      tox -e genconfig

   2. Create a copy of murano.conf for further modifications:

      cd ~/murano/murano/etc/murano
      cp murano.conf.sample murano.conf

4. Edit the murano.conf file. An example below contains the basic configuration.

   Note

   The example uses MySQL database. If you want to use another database type, edit the [database] section correspondingly.

   Replace items in "%" with the actual values. For example, replace %RABBITMQ_SERVER_IP% with 127.0.0.1. So, the complete row with the replaced value will be rabbit_host = 127.0.0.1

   [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%
   
   ...
   
   [database]
   connection = mysql+pymysql://murano:%MURANO_DB_PASSWORD%@127.0.0.1/murano
   
   ...
   
   [keystone]
   auth_url = 'http://%OPENSTACK_HOST_IP%:5000'
   
   ...
   
   [keystone_authtoken]
   auth_uri = 'http://%OPENSTACK_HOST_IP%:5000'
   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%
   
   [networking]
   default_dns = 8.8.8.8 # In case openstack neutron has no default
                         # DNS configured
   
   [oslo_messaging_notifications]
   driver = messagingv2

5. Create a virtual environment and install murano prerequisites using tox. The virtual environment will be created under the tox directory.

   1. Install MySQL driver since it is not a part of the murano requirements:

      tox -e venv -- pip install PyMYSQL

   2. Create database tables for murano:

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

   3. Launch the murano API in a separate terminal:

      cd ~/murano/murano
      tox -e venv -- murano-api --config-file ./etc/murano/murano.conf

      Note

      Run the command in a new terminal as the process will be running in the terminal until you terminate it, therefore, blocking the current terminal.

   4. Leaving the API process running, return to the previous console and import murano core library:

      cd ~/murano/murano
      pushd ./meta/io.murano
      zip -r ../../io.murano.zip *
      popd
      tox -e venv -- murano --murano-url http://localhost:8082 \
      package-import --is-public io.murano.zip

   5. Launch the murano engine in a separate terminal:

      cd ~/murano/murano
      tox -e venv -- murano-engine --config-file ./etc/murano/murano.conf

      Note

      Run the command in a new terminal as the process will be running in the terminal until you terminate it, therefore, blocking the current terminal.

Register in keystone

To make the murano API available to all OpenStack users, you need to register the Application Catalog service within the Identity service.

1. Add the application-catalog service to keystone:

   openstack service create --name murano --description \
   "Application Catalog for OpenStack" application-catalog

2. Provide an endpoint for this service:

   openstack endpoint create --region RegionOne --publicurl 'http://MURANO_IP:8082/' \
   --adminurl 'http://MURANO_IP:8082/' --internalurl 'http://http://MURANO_IP:8082/' \
   MURANO_SERVICE_ID

   where MURANO-SERVICE-ID is the unique service number that can be found in the openstack service create output.

Note

URLs (--publicurl, --internalurl, and --adminurl values) may differ depending on your environment.

Install the murano dashboard

This section describes how to install and run the murano dashboard.

1. Clone the repository with the murano dashboard:

   cd ~/murano
   git clone git://git.openstack.org/openstack/murano-dashboard

2. Clone the horizon repository:

   git clone git://git.openstack.org/openstack/horizon

3. Create a virtual environment and install muranodashboard as an editable module:

   cd horizon
   tox -e venv -- pip install -e ../murano-dashboard

4. Prepare local settings.

   cp openstack_dashboard/local/local_settings.py.example \
   openstack_dashboard/local/local_settings.py
   
   For more information, check out the official
   `horizon documentation <http://docs.openstack.org/developer/horizon/topics/settings.html#openstack-settings-partial>`_.

5. Enable and configure Murano dashboard in the OpenStack Dashboard:

   • For the Newton (and later) OpenStack installations, copy plug-in file local settings files, and policy files:

     cp ../murano-dashboard/muranodashboard/local/enabled/*.py \
     openstack_dashboard/local/enabled/
     
     cp ../murano-dashboard/muranodashboard/local/local_settings.d/*.py \
     openstack_dashboard/local/local_settings.d/
     
     cp ../murano-dashboard/muranodashboard/conf/* openstack_dashboard/conf/

   • For the OpenStack installations prior to the Newton release, run:

     cp ../murano-dashboard/muranodashboard/local/_50_murano.py \
     openstack_dashboard/local/enabled/

     Customize local settings of your horizon installation, by editing the openstack_dashboard/local/local_settings.py file:

     ...
     ALLOWED_HOSTS = '*'
     
     # Provide your OpenStack Lab credentials
     OPENSTACK_HOST = '%OPENSTACK_HOST_IP%'
     
     ...
     
     DEBUG_PROPAGATE_EXCEPTIONS = DEBUG

     Change the default session back end from browser cookies to database to avoid issues with forms during the applications creation:

     DATABASES = {
       'default': {
       'ENGINE': 'django.db.backends.sqlite3',
       'NAME': 'murano-dashboard.sqlite',
       }
     }
     
     SESSION_ENGINE = 'django.contrib.sessions.backends.db'

6. (Optional) If you do not plan to get the murano service from the keystone application catalog, specify where the murano-api service is running:

   MURANO_API_URL = 'http://localhost:8082'

7. (Optional) If you have set up the database as a session back end (this is done by default with murano local_settings file starting with Newton), perform database migration:

   tox -e venv -- python manage.py migrate --noinput

   Since a separate user is not required for development purpose, you can reply no.

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

   tox -e venv -- python manage.py runserver <IP:PORT>

   Note

   The development server restarts automatically on every code change.

Result: The murano dashboard is available at http://IP:PORT.

Import murano applications

To fill the application catalog, you need to import applications to your OpenStack environment. You can import applications using the murano dashboard, as well as the command-line client.

To import applications using CLI, complete the following tasks:

1. Clone the murano apps repository:

   cd ~/murano
   git clone git://git.openstack.org/openstack/murano-apps

2. Import every package you need from this repository by running the following command:

   cd ~/murano/murano
   pushd ../murano-apps/Docker/Applications/%APP-NAME%/package
   zip -r ~/murano/murano/app.zip *
   popd
   tox -e venv -- murano --murano-url http://localhost:8082 package-import app.zip

Result: The applications are imported and available from the application catalog.