diff --git a/doc/source/devref/testing.rst b/doc/source/devref/testing.rst index cefeae49..0c94f87a 100644 --- a/doc/source/devref/testing.rst +++ b/doc/source/devref/testing.rst @@ -33,8 +33,9 @@ testing Sahara. Here is a list of currently implemented tests: Selenium Integration tests ++++++++++++++++++++++++++ -We have a bunch of Selenium-based UI tests for sahara-dashboard in -`saharadashboard/tests`. The following UI parts are covered: +We have a bunch of Selenium-based UI tests for Sahara UI in +https://git.openstack.org/cgit/openstack/sahara-dashboard repository. +The following UI parts are covered: * Clusters * Cluster templates diff --git a/doc/source/horizon/dashboard.user.guide.rst b/doc/source/horizon/dashboard.user.guide.rst index 5ec7e8f3..3ca0f94a 100644 --- a/doc/source/horizon/dashboard.user.guide.rst +++ b/doc/source/horizon/dashboard.user.guide.rst @@ -2,10 +2,11 @@ Sahara (Data Processing) UI User Guide ====================================== This guide assumes that you already have Sahara service and the Horizon dashboard up and running. -If you require assistance with that, please see the installation guides. +Don't forget to make sure that Sahara is registered in Keystone. +If you require assistance with that, please see the `installation guide <../installation.guide.html>`_. -Launching a cluster via the Sahara Dashboard --------------------------------------------- +Launching a cluster via the Sahara UI +------------------------------------- Registering an Image -------------------- @@ -271,4 +272,4 @@ An example of this would be trying to delete a Job that has an existing Job Exec 2) In the examples above, we mention adding your username/password for the Swift Data Sources. It should be noted that it is possible to configure Sahara such that the username/password credentials are *not* required. -For more information on that, please refer to: :doc:`Sahara Advanced Configuration Guide <../userdoc/advanced.configuration.guide>` \ No newline at end of file +For more information on that, please refer to: :doc:`Sahara Advanced Configuration Guide <../userdoc/advanced.configuration.guide>` diff --git a/doc/source/horizon/dev.environment.guide.rst b/doc/source/horizon/dev.environment.guide.rst index 97bbb773..f1550ae1 100644 --- a/doc/source/horizon/dev.environment.guide.rst +++ b/doc/source/horizon/dev.environment.guide.rst @@ -1,24 +1,18 @@ Sahara UI Dev Environment Setup =============================== -This page describes how to setup the Sahara dashboard UI component by either -installing it as part of DevStack or installing it in an isolated environment +This page describes how to setup Horizon for developing Sahara by either +installing it as part of DevStack with Sahara or installing it in an isolated environment and running from the command line. Install as a part of DevStack ----------------------------- -Sahara-Dashboard will be installed as a component of Horizon in DevStack. -See the `DevStack documentation `_ for more information -on installing and configuring DevStack. - -If you are developing Sahara from an OSX environment you will need to run -DevStack on a virtual machine. See -`Setup VM for DevStack on OSX <../devref/devstack.html>`_ for more -information. +See the `DevStack guide <../devref/devstack.html>`_ for more information +on installing and configuring DevStack with Sahara. After Horizon installation, it will contain a Data Processing tab under Projects tab. -Sahara-Dashboard source code will be located at +Sahara UI source code will be located at ``$DEST/horizon/openstack_dashboard/dashboards/project/data_processing`` where ``$DEST/`` is usually ``/opt/stack/``. diff --git a/doc/source/horizon/installation.guide.rst b/doc/source/horizon/installation.guide.rst deleted file mode 100644 index 1a47ef18..00000000 --- a/doc/source/horizon/installation.guide.rst +++ /dev/null @@ -1,145 +0,0 @@ -Sahara UI Installation Guide -============================ - -Sahara UI is a plugin for OpenStack Dashboard. There are two ways to install -it. One is to plug it into existing Dashboard installation and another is -to setup another Dashboard and plug Sahara UI there. The first approach -advantage is that you will have Sahara UI in the very same Dashboard with -which you work with OpenStack. The disadvantage is that you have to tweak -your Dashboard configuration in order to enable the plugin. The second -approach does not have this disadvantage. - -Further steps describe installation for the first approach. For the second -approach see :doc:`/horizon/dev.environment.guide` - -1. Prerequisites ----------------- - -1) OpenStack IceHouse installed. - -2) Sahara installed, configured and running, see :doc:`/userdoc/installation.guide`. - -2. Sahara Dashboard Installation --------------------------------- - -1) Go to the machine where Dashboard resides and install Sahara UI there: - - For RDO: - -.. sourcecode:: console - - $ sudo yum install python-django-sahara -.. - - Otherwise: - -.. sourcecode:: console - - $ sudo pip install sahara-dashboard -.. - - This will install the latest stable release of Sahara UI. If you - want to install the development version of Sahara UI do the - following instead: - -.. sourcecode:: console - - $ sudo pip install http://tarballs.openstack.org/sahara-dashboard/sahara-dashboard-master.tar.gz -.. - - Note that dev version might be broken at any time and also it - might lose backward compatibility with Icehouse release at some point. - -2) Configure OpenStack Dashboard. In ``settings.py`` add sahara to - -.. sourcecode:: python - - HORIZON_CONFIG = { - 'dashboards': ('nova', 'syspanel', 'settings', ..., 'sahara'), -.. - - and also add saharadashboard to - -.. sourcecode:: python - - INSTALLED_APPS = ( - 'saharadashboard', - .... -.. - - Note: ``settings.py`` file is located in - ``/usr/share/openstack-dashboard/openstack_dashboard/`` by default. - -3) Now let's switch to another file - ``local_settings.py``. - If you are using Neutron instead of Nova-Network add the following - parameter there: - -.. sourcecode:: python - - SAHARA_USE_NEUTRON = True -.. - - If you are using Nova-Network with ``auto_assign_floating_ip=False`` or Neutron add - the following parameter: - -.. sourcecode:: python - - AUTO_ASSIGNMENT_ENABLED = False -.. - - Note: For RDO, the ``local_settings.py`` file is named - ``local_settings`` and its absolute path is - ``/etc/openstack-dashboard/local_settings``, otherwise the file's - absolute path is - ``/usr/share/openstack-dashboard/openstack_dashboard/local/local_settings.py``. - -4) You also need to tell Sahara UI where it can find Sahara service. - There are two ways to do that. First is to define Sahara endpoint in - Keystone. The endpoint type must be ``data_processing``: - -.. sourcecode:: console - - keystone service-create --name sahara --type data_processing \ - --description "Sahara Data Processing" - - keystone endpoint-create --service sahara --region RegionOne \ - --publicurl "http://10.0.0.2:8386/v1.1/%(tenant_id)s" \ - --adminurl "http://10.0.0.2:8386/v1.1/%(tenant_id)s" \ - --internalurl "http://10.0.0.2:8386/v1.1/%(tenant_id)s" -.. - - While executing the commands above, don't forget to change IP - addresses and ports to the ones actual for your setup. - - This approach might not work for you if your Keystone already has Sahara - endpoint registered. This could be in DevStack and Fuel environments - as both are capable to install Sahara and Sahara UI on their own. In - that case use the second approach described below. - - The second way to tell Sahara UI where Sahara service is deployed - is to specify ``SAHARA_URL`` parameter in ``local_settings.py``. - For example: - -.. sourcecode:: python - - SAHARA_URL = 'http://localhost:8386/v1.1' -.. - -5) The installation is complete. You need to restart the apache - web server for the changes to take effect. - - For Ubuntu: - -.. sourcecode:: console - - $ sudo service apache2 restart -.. - - For Centos: - -.. sourcecode:: console - - $ sudo service httpd reload -.. - - Now if you log into Horizon you should see the Sahara menu available there. diff --git a/doc/source/index.rst b/doc/source/index.rst index 2d61e20c..02d7afcb 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -27,7 +27,6 @@ User guide userdoc/installation.guide userdoc/configuration.guide userdoc/advanced.configuration.guide - horizon/installation.guide userdoc/upgrade.guide **How To** diff --git a/doc/source/userdoc/installation.guide.rst b/doc/source/userdoc/installation.guide.rst index 3302ef8e..4e5beb21 100644 --- a/doc/source/userdoc/installation.guide.rst +++ b/doc/source/userdoc/installation.guide.rst @@ -48,7 +48,10 @@ To install with RDO $ sahara-db-manage --config-file /etc/sahara/sahara.conf upgrade head .. -5. Start the sahara-api service: +5. Go through :ref:`common_installation_steps` and make the + necessary changes. + +6. Start the sahara-api service: .. sourcecode:: console @@ -125,7 +128,15 @@ To install into a virtual environment Make the necessary changes in ``sahara-venv/etc/sahara.conf``. For details see :doc:`Sahara Configuration Guide ` -5. If you use Sahara with MySQL database, then for storing big Job Binaries +.. _common_installation_steps: + +Common installation steps +------------------------- + +The steps below are common for both installing Sahara as part of RDO and +installing it in virtual environment. + +1. If you use Sahara with MySQL database, then for storing big Job Binaries in Sahara Internal Database you must configure size of max allowed packet. Edit ``my.cnf`` and change parameter: @@ -139,20 +150,36 @@ To install into a virtual environment and restart mysql server. -6. Create database schema: +2. Create database schema: .. sourcecode:: console $ sahara-venv/bin/sahara-db-manage --config-file sahara-venv/etc/sahara.conf upgrade head .. -7. To start Sahara call: +3. To start Sahara call: .. sourcecode:: console $ sahara-venv/bin/sahara-all --config-file sahara-venv/etc/sahara.conf .. +.. _register-sahara-label: +4. In order for Sahara to be accessible in OpenStack Dashboard and for + python-saharaclient to work properly you need to register Sahara in + Keystone. For example: + +.. sourcecode:: console + + keystone service-create --name sahara --type data_processing \ + --description "Sahara Data Processing" + + keystone endpoint-create --service sahara --region RegionOne \ + --publicurl "http://10.0.0.2:8386/v1.1/%(tenant_id)s" \ + --adminurl "http://10.0.0.2:8386/v1.1/%(tenant_id)s" \ + --internalurl "http://10.0.0.2:8386/v1.1/%(tenant_id)s" +.. + Notes: ------ diff --git a/doc/source/userdoc/upgrade.guide.rst b/doc/source/userdoc/upgrade.guide.rst index d5cca6d6..22558b46 100644 --- a/doc/source/userdoc/upgrade.guide.rst +++ b/doc/source/userdoc/upgrade.guide.rst @@ -38,6 +38,21 @@ COLUMN and DROP COLUMN commands required for DB migrations between versions. You can find more info about config file options in Sahara repository in file ``etc/sahara/sahara.conf.sample``. +Sahara Dashboard was merged into OpenStack Dashboard +++++++++++++++++++++++++++++++++++++++++++++++++++++ + +The Sahara Dashboard is not available in Juno release. Instead it's +functionality is provided by OpenStack Dashboard out of the box. +The Sahara UI is available in OpenStack Dashboard in +"Project" -> "Data Processing" tab. + +Note that you have to properly register Sahara in Keystone in +order for Sahara UI in the Dashboard to work. For details see +``:ref:`registering Sahara in installation guide ```. + +The `sahara-dashboard `_ +project is now used solely to host Sahara UI integration tests. + VM user name changed for HEAT infrastructure engine +++++++++++++++++++++++++++++++++++++++++++++++++++