openstack/deb-mistral
Code Issues Proposed changes
5ed1f7e811
deb-mistral/doc/source/developer/troubleshooting.rst
Sharat Sharma c07cf48a60 Changes made to comply with OpenStack writing style 
The writing styles at few places were not in compliance with
the OpenStack writing style as mentioned in
http://docs.openstack.org/contributor-guide/writing-style
/general-writing-guidelines.html. This patch changes the heading
styles and adds a few other minor changes in the documents.

Change-Id: I0d90ba32ddcef0427b1dc4358206210f166e798a
Partial-Implements: blueprint mistral-doc
2016-10-04 20:06:15 +05:30

2.3 KiB
Raw Blame History

Troubleshooting And Debugging

Mistral-Dashboard debug instructions

Pycharm

Debugging OpenStack Mistral-Dashboard is the same as debugging OpenStack Horizon. The following instructions should get you sorted to debug both on the same run.

Set PyCharm debug settings:

  1. Under File > Settings > Languages and Framework > Django - Enter the following:
  1. Check "Enable Django Support"
  2. Django project root: your file system path to Horizon project root
  3. Settings: openstack_dashboard/settings.py (under your Horizon folder)
  4. Manage script: manage.py (also in your horizon folder)
  5. Click OK

image

  1. Enter debug configurations menu, using the tiny arrow pointing down, left to the "play" icon, or under the run menu

image

  1. In the new window, click the green plus icon and then select "Django server" to create a new Django Server configuration.
  2. In the new window appeared:
  1. Name that configuration Horizon
  2. Enter some port so it won't run on the default (for example - port: 4000)

image

  1. Click on Environment variables button, then in the new window:
  1. Make sure you have PYTHONUNBUFFERED set as 1
  2. Create a new pair - DJANGO_SETTINGS_MODULE : openstack_dashboard.settings
  3. When finished click OK.

image

You should now be able to debug and run the project using PyCharm. PyCharm will listen to any changes you make and restart the Horizon server automatically.

Note: When executing the project via PyCharm Run / Debug, you could get an error page after trying to login: "Page not found (404)". To resolve that - remove the port from the browser URL bar, then login. You should be able to login without it. After a successful login bring the port back - it will continue your session.

Further notes

  • If you need help with PyCharm and general debugging, please refer to: JetBrains PyCharm developer guide

  • If you would like to manually restart the apache server, open a terminal and run:

    $ sudo service apache2 restart

    (if not under Ubuntu, replace "sudo" with an identical command)