openstack/mistral
Code Issues Proposed changes
mistral/doc/source/install/dashboard_guide.rst
junboli a2c1db4b14 Add doc8 rule and check doc/source files 
doc8 is a linter for documents and used in openstack-manuals. It is better to enforce
document linters for simple checking. This change is to add doc8 in tox file and fix
line too long in some files.

The current rules are as bellow:
- invalid rst format - D000
- lines should not be longer than 79 characters - D001
- no trailing whitespace - D002
- no tabulation for indentation - D003
- no carriage returns (use unix newlines) - D004
- no newline at end of file - D005

Change-Id: Ibba3f0e1c3f724563deb27bbf4f13a8040799687
Closes-bug: #1709571
2017-08-09 16:50:33 +08:00

2.1 KiB
Raw Blame History

Mistral Dashboard Installation Guide

Mistral dashboard is the plugin for Horizon where it is easily possible to control mistral objects by interacting with web user interface.

Setup Instructions

This instruction assumes that Horizon is already installed and it's installation folder is <horizon>. Detailed information on how to install Horizon can be found at Horizon Installation

The installation folder of Mistral Dashboard will be referred to as <mistral-dashboard>.

The following should get you started:

  1. Clone the repository into your local OpenStack directory:

    $ git clone https://github.com/openstack/mistral-dashboard.git

  2. Install mistral-dashboard:

    $ sudo pip install -e <mistral-dashboard>

Or if you're planning to run Horizon server in a virtual environment (see below):

$ tox -evenv -- pip install -e ../mistral-dashboard/

and then:

$ cp -b <mistral-dashboard>/mistraldashboard/enabled/_50_mistral.py \
  <horizon>/openstack_dashboard/local/enabled/_50_mistral.py

  1. Since Mistral only supports Identity v3, you must ensure that the dashboard points the proper OPENSTACK_KEYSTONE_URL in <horizon>/openstack_dashboard/local/local_settings.py file:

    OPENSTACK_API_VERSIONS = {
    "identity": 3,
}

OPENSTACK_KEYSTONE_URL = "http://%s:5000/v3" % OPENSTACK_HOST

  2. Also, make sure you have changed OPENSTACK_HOST to point to your Keystone server and check all endpoints are accessible. You may want to change OPENSTACK_ENDPOINT_TYPE to "publicURL" if some of them are not.

  3. When you're ready, you would need to either restart your apache:

    $ sudo service apache2 restart

or run the development server (in case you have decided to use local horizon):

$ cd ../horizon/
$ tox -evenv -- python manage.py runserver

Debug instructions

Please refer to Mistral Troubleshooting <../contributor/troubleshooting>