From 914382438b80d1d6168d55fadba1ba7ecaf8846b Mon Sep 17 00:00:00 2001 From: Gal Margalit Date: Wed, 14 Oct 2015 14:02:04 +0000 Subject: [PATCH] mistral-documentation: dashboard documentation regarding debug known issue * added explanation how to resolve an unsuccessful login upon debug/run session using pycharm Implements blueprint:mistral-docs-dashboard-troubleshooting Change-Id: I64ed6f6d934b847962d1c8eb690e635c1d77e2ae --- doc/source/developer/troubleshooting.rst | 42 +++++++++++++++++++----- 1 file changed, 33 insertions(+), 9 deletions(-) diff --git a/doc/source/developer/troubleshooting.rst b/doc/source/developer/troubleshooting.rst index 46f9c65a..0b331bb0 100644 --- a/doc/source/developer/troubleshooting.rst +++ b/doc/source/developer/troubleshooting.rst @@ -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 `_ +**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** - sudo service apache2 restart +- If you need help with PyCharm and general debugging, please refer to: + `JetBrains PyCharm developer guide `_ -(if not under Ubuntu, replace "sudo" with an identical command) \ No newline at end of file +- 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)*