openstack/deb-mistral
Code Issues Proposed changes

mistral-documentation: dashboard documentation regarding debug known issue

Browse Source 
* added explanation how to resolve an unsuccessful login
upon debug/run session using pycharm

Implements blueprint:mistral-docs-dashboard-troubleshooting

Change-Id: I64ed6f6d934b847962d1c8eb690e635c1d77e2ae
This commit is contained in:
Gal Margalit 2015-10-14 14:02:04 +00:00
parent ef2054b96b
commit 914382438b
1 changed files with 33 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/source/developer/troubleshooting.rst
View File

@ -6,42 +6,66 @@ Mistral-Dashboard Debug Instructions
**Pycharm**
Debugging OpenStack Mistral-Dashboard is the same as debugging OpenStack Horizon.
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:
a. Check "Enable Django Support"
b. Django project root: your file system path to Horizon project root
c. Settings: openstack_dashboard/settings.py (under your Horizon folder)
d. Manage script: manage.py (also in your horizon folder)
e. Click OK
.. image:: ../img/Mistral_dashboard_django_settings.png
2. Enter debug configurations menu, using the tiny arrow pointing down, left to the "play" icon, or under the run menu
2. Enter debug configurations menu, using the tiny arrow pointing down,
left to the "play" icon, or under the run menu
.. image:: ../img/Pycharm_run_config_menu.png
3. In the new window, click the green plus icon and then select "Django server" to create a new Django Server configuration.
3. In the new window, click the green plus icon and then select "Django server"
to create a new Django Server configuration.
4. In the new window appeared:
a. Name that configuration Horizon
b. Enter some port so it won't run on the default (for example - port: 4000)
.. image:: ../img/Mistral_dashboard_debug_config.png
5. Click on Environment variables button, then in the new window:
a. Make sure you have PYTHONUNBUFFERED set as 1
b. Create a new pair - DJANGO_SETTINGS_MODULE : openstack_dashboard.settings
c. When finished click OK.
.. image:: ../img/Mistral_dashboard_environment_variables.png
You should now be able to debug and run the project using PyCharm.
PyCharm will listen to any changes you made and restart the horizon server automatically.
PyCharm will listen to any changes you make
and restart the Horizon server automatically.
If you need help with PyCharm and general debugging, please refer to:
`JetBrains PyCharm developer guide <http://www.jetbrains.com/pycharm/help/debugging.html.>`_
**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.
If you would like to manually restart the apache server, open a terminal and run::
**Further notes**
- If you need help with PyCharm and general debugging, please refer to:
`JetBrains PyCharm developer guide <http://www.jetbrains.com/pycharm/help/debugging.html.>`_
- 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)
*(if not under Ubuntu, replace "sudo" with an identical command)*