mistral-documentation: dashboard documentation regarding debug
* added debug instructions for mistral dashboard * added screenshots for the described instructions Partially implements blueprint:mistral-documentation Change-Id: I08fd360c67953f168beca76479b1581ecacfd913
This commit is contained in:
parent
0420bbd86f
commit
3608c88215
@ -1,4 +1,47 @@
|
|||||||
Troubleshooting And Debugging
|
Troubleshooting And Debugging
|
||||||
=============================
|
=============================
|
||||||
|
|
||||||
TBD
|
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:
|
||||||
|
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
|
||||||
|
|
||||||
|
.. 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.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
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)
|
@ -52,16 +52,4 @@ The following should get you started:
|
|||||||
|
|
||||||
Debug Instructions
|
Debug Instructions
|
||||||
------------------
|
------------------
|
||||||
|
Please refer to :doc:`Mistral Troubleshooting <../developer/troubleshooting>`
|
||||||
**Pycharm**
|
|
||||||
|
|
||||||
Set PyCharm debug settings:
|
|
||||||
|
|
||||||
1. Enter debug configurations menu
|
|
||||||
2. Create a new Django Server configuration
|
|
||||||
3. Enter some port so it won't run on the default (for example - port: 4000)
|
|
||||||
4. On the same window click on Environment variables
|
|
||||||
a. Make sure you have PYTHONUNBUFFERED set as 1
|
|
||||||
b. Create a new pair - DJANGO_SETTINGS_MODULE : openstack_dashboard.settings
|
|
||||||
|
|
||||||
You should now be able to debug and run the project using PyCharm.
|
|
BIN
doc/source/img/Mistral_dashboard_debug_config.png
Normal file
BIN
doc/source/img/Mistral_dashboard_debug_config.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 47 KiB |
BIN
doc/source/img/Mistral_dashboard_django_settings.png
Normal file
BIN
doc/source/img/Mistral_dashboard_django_settings.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 46 KiB |
BIN
doc/source/img/Mistral_dashboard_environment_variables.png
Normal file
BIN
doc/source/img/Mistral_dashboard_environment_variables.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 14 KiB |
BIN
doc/source/img/Pycharm_run_config_menu.png
Normal file
BIN
doc/source/img/Pycharm_run_config_menu.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 30 KiB |
Loading…
Reference in New Issue
Block a user