Metadata-Version: 1.1
Name: searchlight-ui
Version: 1.0.0.0b2
Summary: Horizon panels and libraries for Searchlight
Home-page: http://www.openstack.org/
Author: OpenStack
Author-email: openstack-dev@lists.openstack.org
License: UNKNOWN
Description: ==============
        searchlight-ui
        ==============
        
        Horizon panels and libraries for searchlight
        
        * Free software: Apache license
        * Documentation: http://docs.openstack.org/developer/searchlight
        * Source: http://git.openstack.org/cgit/openstack/searchlight-ui
        * Bugs: http://bugs.launchpad.net/searchlight
        
        The Searchlight project provides indexing and search capabilities across
        OpenStack resources. Its goal is to achieve high performance and flexible
        querying combined with near real-time indexing.
        
        Use the following resources to learn more:
        
        * `Official Searchlight documentation * <http://docs.openstack.org/developer/searchlight/>`_
        
        Features
        --------
        
        * Please see the searchlight-ui repository
        
        Horizon Version Compatibility
        -----------------------------
        
        This project provides a Horizon plugin. The plugin relies on features developed in the Horizon
        framework, so the version of the plugin must be deployed with a compatible Horizon verion. The
        below table provides an overview of the Horizon version compatibility matrix.
        
        | Searchlight UI Version | Horizon Version(s) Compatibilty |
        | ---------------------: | -------------------------------:|
        | master (Newton)        | master 10.x (Newton)            |
        | 0.1.0 (Mitaka)         | 9.x (Mitaka)                    |
        
        Devstack Install
        ----------------
        
        * See https://github.com/openstack/searchlight-ui/tree/master/devstack
        
        Setup Local Dev Environment
        ---------------------------
        
        Assumptions:
        
         * horizon is installed or cloned into <basedir>/horizon/
         * searchlight-ui is installed or cloned into <basedir>/searchlight-ui/
         * current working directory is <basedir>/horizon/
        
        1. Install environment.::
        
            #Locally cloned Horizon environment
            ./tools/with_venv.sh pip install -e ../searchlight-ui
        
            #Devstack environment
            pip install -e ../searchlight-ui
        
        2. Copy <searchlight-ui>/``searchlight_ui/enabled/_1001_project_search_panel.py``
           to <horizon_dir>/``openstack_dashboard/local/enabled/``::
        
            cp -rv ../searchlight-ui/searchlight_ui/enabled/_1001_project_search_panel.py openstack_dashboard/local/enabled/
        
        3. Set up the policy files. First copy the policy file
           <searchlight-ui>/``searchlight_ui/conf/searchlight_policy.json`` into
           horizon's policy files <horizon_dir>/``openstack_dashboard/conf/`` folder.
           Then copy
           <searchlight-ui>/``local_settings.d/_1001_search_settings.py``
           to <horizon_dir>/``local/local_settings.d/``::
        
            cp ../searchlight-ui/searchlight_ui/conf/searchlight_policy.json openstack_dashboard/conf/
        
            cp ../searchlight-ui/searchlight_ui/local_settings.d/_1001_search_settings.py openstack_dashboard/local/local_settings.d/
        
        4. (If offline compression is enabled - typical in production and devstack).
           Django has a compressor feature that performs many enhancements for the
           delivery of static files. It can be enable or disabled
           (``COMPRESS_ENABLED``). In addition, offline compression may be enabled or
           disabled (``COMPRESS_OFFLINE = True``). If offline compression is enabled
           in your environment, you must run the following commands the first time
           you install searchlight-ui and anytime you make changes to it.::
        
            ./manage.py collectstatic
            ./manage.py compress
        
        5. Restart your horizon services.::
        
            #Locally cloned Horizon environment (not under apache)
            ./run_tests.sh --runserver 0.0.0.0:8005 (use desired IP and port)
        
            #Devstack
            sudo service apache2 restart
        
        Create and Install Local Package
        --------------------------------
        
        Change working directory to <basedir>/searchlight-ui/
        
        1. Package the searchlight_ui by running::
        
            python setup.py sdist
        
        2. This will create a python egg in the dist folder, which can be used to
           install on the horizon machine or within horizon's python virtual
           environment (prepend wih ``./tools/with_venv.sh``)::
        
            pip install dist/searchlight-ui-0.0.0.tar.gz (use appropriate version)
        
        
Platform: UNKNOWN
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
