Moved README.rst content to installation.rst doc
Changeset https://review.openstack.org/#/c/402973/ will introduce a new badge for this project, including a external svg image. This update will produce a bug because README.rst file is referenced by the deploy/installation.rst file. So I moved README.rst content to deploy/installation.rst to fix it. Change-Id: I4074baba8e1fea67410710b6565374dcb927e7a2
This commit is contained in:
David TARDIVEL
parent
259445070f
commit
8e7eff49b3
144
README.rst
144
README.rst
@ -1,142 +1,10 @@
|
|||||||
OpenStack Dashboard plugin for Watcher project
|
OpenStack Dashboard plugin for Watcher project
|
||||||
==============================================
|
==============================================
|
||||||
|
|
||||||
Installation
|
The Watcher dashboard is a Horizon plugin that will allow users to realize a
|
||||||
------------
|
wide range of cloud optimization goals.
|
||||||
|
|
||||||
|
Free software: Apache license
|
||||||
First off, create a virtual environment and install the Horizon dependencies::
|
Documentation: http://docs.openstack.org/developer/watcher-dashboard
|
||||||
|
Source: http://git.openstack.org/cgit/openstack/watcher-dashboard
|
||||||
$ git clone https://github.com/openstack/horizon
|
Bugs: http://bugs.launchpad.net/watcher-dashboard
|
||||||
$ cd horizon
|
|
||||||
$ python tools/install_venv.py
|
|
||||||
|
|
||||||
We will refer to the folder you are now in as ``<HORIZON_DIR>``.
|
|
||||||
If you want more details on how to install Horizon, you can have a look at the
|
|
||||||
`Horizon documentation`_, especially their `quickstart tutorial`_.
|
|
||||||
|
|
||||||
Then, you need to install Watcher Dashboard on the server running Horizon.
|
|
||||||
To do so, you can issue the following commands::
|
|
||||||
|
|
||||||
$ git clone git://git.openstack.org/openstack/watcher-dashboard
|
|
||||||
$ cd watcher-dashboard
|
|
||||||
$ pip install -e .
|
|
||||||
|
|
||||||
We will refer to the folder you are now in as ``<DASHBOARD_DIR>``.
|
|
||||||
|
|
||||||
The next step is now to register the Watcher Dashboard plugins against your
|
|
||||||
Horizon. To do so, you can execute the ``tools/register_plugin.sh``::
|
|
||||||
|
|
||||||
$ cd <DASHBOARD_DIR>
|
|
||||||
$ ./tools/register_plugin.sh . <HORIZON_DIR>
|
|
||||||
|
|
||||||
This script will then create the needed symlinks within Horizon so that it can
|
|
||||||
load the Watcher plugin when it starts.
|
|
||||||
|
|
||||||
If you wish to have Horizon running being an Apache server, do not forget to
|
|
||||||
start the service via the following command::
|
|
||||||
|
|
||||||
$ sudo service apache2 restart
|
|
||||||
|
|
||||||
For more details on how to configure Horizon for a production environment, you
|
|
||||||
can refer to their online `installation guide`_.
|
|
||||||
|
|
||||||
.. _Horizon documentation: http://docs.openstack.org/developer/horizon
|
|
||||||
.. _quickstart tutorial: http://docs.openstack.org/developer/horizon/quickstart.html
|
|
||||||
.. _installation guide: http://docs.openstack.org/developer/horizon/topics/install.html
|
|
||||||
|
|
||||||
|
|
||||||
DevStack setup
|
|
||||||
--------------
|
|
||||||
|
|
||||||
Add the following to your DevStack ``local.conf`` file
|
|
||||||
|
|
||||||
::
|
|
||||||
|
|
||||||
enable_plugin watcher-dashboard git://git.openstack.org/openstack/watcher-dashboard
|
|
||||||
|
|
||||||
|
|
||||||
Unit testing
|
|
||||||
------------
|
|
||||||
|
|
||||||
First of all, you have to create an environment to run your tests in. This step
|
|
||||||
is actually part of the ``run_tests.sh`` script which creates and maintains a
|
|
||||||
clean virtual environment.
|
|
||||||
|
|
||||||
Here below is the basic command to run Watcher Dashboard tests::
|
|
||||||
|
|
||||||
$ ./run_tests.sh
|
|
||||||
|
|
||||||
The first time you will issue the command above, you will be asked if you want
|
|
||||||
to create a virtual environment. So unless you have installed everything
|
|
||||||
manually (in which case you should use the ``-N`` flag), you need to accept
|
|
||||||
|
|
||||||
|
|
||||||
Integration testing
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
Before being able to run integration tests, you need to have a Horizon server
|
|
||||||
running with Watcher Dashboard plugin configured. To do so, you can run a test
|
|
||||||
server using the following command::
|
|
||||||
|
|
||||||
$ ./run_tests.sh --runserver 0.0.0.0:8000
|
|
||||||
|
|
||||||
By default, integration tests expect to find a running Horizon server at
|
|
||||||
``http://localhost:8000/`` but this can be customized by editing the
|
|
||||||
``watcher_dashboard/test/integration_tests/horizon.conf`` configuration file.
|
|
||||||
Likewise, this Horizon will be looking, by default, for a Keystone backend at
|
|
||||||
``http://localhost:5000/v2.0``. So in order to customize its location, you will
|
|
||||||
have to edit ``watcher_dashboard/test/settings.py`` by updating the
|
|
||||||
``OPENSTACK_KEYSTONE_URL`` variable.
|
|
||||||
|
|
||||||
To run integration tests::
|
|
||||||
|
|
||||||
$ ./run_tests.sh --integration
|
|
||||||
|
|
||||||
You can use PhantomJS as a headless browser to execute your integration tests.
|
|
||||||
On an Ubuntu distribution you can install it via the following command::
|
|
||||||
|
|
||||||
$ sudo apt-get install phantomjs
|
|
||||||
|
|
||||||
Then you can run your integration tests like this::
|
|
||||||
|
|
||||||
$ ./run_tests.sh --integration --selenium-headless
|
|
||||||
|
|
||||||
Please note that these commands are also available via ``tox``.
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
As of the Mitaka release, the dashboard for watcher is now maintained
|
|
||||||
outside of the Horizon codebase, in this repository.
|
|
||||||
|
|
||||||
|
|
||||||
Policies
|
|
||||||
--------
|
|
||||||
You can enable policies on Watcher ``Optimization`` panel, by updating in the
|
|
||||||
``<HORIZON_DIR>/openstack_dashboard/settings.py`` configuration file the
|
|
||||||
following parameters
|
|
||||||
|
|
||||||
POLICY_FILES = {
|
|
||||||
...
|
|
||||||
'infra-optim': 'watcher_policy.json',
|
|
||||||
}
|
|
||||||
|
|
||||||
You can also update the file ``<HORIZON_DIR>/openstack_dashboard/conf/watcher_policy.conf``
|
|
||||||
to customize your policies.
|
|
||||||
|
|
||||||
|
|
||||||
Links
|
|
||||||
-----
|
|
||||||
|
|
||||||
Watcher project: https://git.openstack.org/openstack/watcher
|
|
||||||
|
|
||||||
Watcher at wiki.openstack.org: https://wiki.openstack.org/wiki/Watcher
|
|
||||||
|
|
||||||
Launchpad project: https://launchpad.net/watcher
|
|
||||||
|
|
||||||
Join us on IRC (Internet Relay Chat)::
|
|
||||||
|
|
||||||
Network: Freenode (irc.freenode.net/watcher)
|
|
||||||
Channel: #openstack-watcher
|
|
||||||
|
|
||||||
Or send an email to openstack-dev@lists.openstack.org.
|
|
||||||
|
|||||||
@ -1 +1,139 @@
|
|||||||
.. include:: ../../../README.rst
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
|
||||||
|
First off, create a virtual environment and install the Horizon dependencies::
|
||||||
|
|
||||||
|
$ git clone https://github.com/openstack/horizon
|
||||||
|
$ cd horizon
|
||||||
|
$ python tools/install_venv.py
|
||||||
|
|
||||||
|
We will refer to the folder you are now in as ``<HORIZON_DIR>``.
|
||||||
|
If you want more details on how to install Horizon, you can have a look at the
|
||||||
|
`Horizon documentation`_, especially their `quickstart tutorial`_.
|
||||||
|
|
||||||
|
Then, you need to install Watcher Dashboard on the server running Horizon.
|
||||||
|
To do so, you can issue the following commands::
|
||||||
|
|
||||||
|
$ git clone git://git.openstack.org/openstack/watcher-dashboard
|
||||||
|
$ cd watcher-dashboard
|
||||||
|
$ pip install -e .
|
||||||
|
|
||||||
|
We will refer to the folder you are now in as ``<DASHBOARD_DIR>``.
|
||||||
|
|
||||||
|
The next step is now to register the Watcher Dashboard plugins against your
|
||||||
|
Horizon. To do so, you can execute the ``tools/register_plugin.sh``::
|
||||||
|
|
||||||
|
$ cd <DASHBOARD_DIR>
|
||||||
|
$ ./tools/register_plugin.sh . <HORIZON_DIR>
|
||||||
|
|
||||||
|
This script will then create the needed symlinks within Horizon so that it can
|
||||||
|
load the Watcher plugin when it starts.
|
||||||
|
|
||||||
|
If you wish to have Horizon running being an Apache server, do not forget to
|
||||||
|
start the service via the following command::
|
||||||
|
|
||||||
|
$ sudo service apache2 restart
|
||||||
|
|
||||||
|
For more details on how to configure Horizon for a production environment, you
|
||||||
|
can refer to their online `installation guide`_.
|
||||||
|
|
||||||
|
.. _Horizon documentation: http://docs.openstack.org/developer/horizon
|
||||||
|
.. _quickstart tutorial: http://docs.openstack.org/developer/horizon/quickstart.html
|
||||||
|
.. _installation guide: http://docs.openstack.org/developer/horizon/topics/install.html
|
||||||
|
|
||||||
|
|
||||||
|
DevStack setup
|
||||||
|
--------------
|
||||||
|
|
||||||
|
Add the following to your DevStack ``local.conf`` file
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
enable_plugin watcher-dashboard git://git.openstack.org/openstack/watcher-dashboard
|
||||||
|
|
||||||
|
|
||||||
|
Unit testing
|
||||||
|
------------
|
||||||
|
|
||||||
|
First of all, you have to create an environment to run your tests in. This step
|
||||||
|
is actually part of the ``run_tests.sh`` script which creates and maintains a
|
||||||
|
clean virtual environment.
|
||||||
|
|
||||||
|
Here below is the basic command to run Watcher Dashboard tests::
|
||||||
|
|
||||||
|
$ ./run_tests.sh
|
||||||
|
|
||||||
|
The first time you will issue the command above, you will be asked if you want
|
||||||
|
to create a virtual environment. So unless you have installed everything
|
||||||
|
manually (in which case you should use the ``-N`` flag), you need to accept
|
||||||
|
|
||||||
|
|
||||||
|
Integration testing
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
Before being able to run integration tests, you need to have a Horizon server
|
||||||
|
running with Watcher Dashboard plugin configured. To do so, you can run a test
|
||||||
|
server using the following command::
|
||||||
|
|
||||||
|
$ ./run_tests.sh --runserver 0.0.0.0:8000
|
||||||
|
|
||||||
|
By default, integration tests expect to find a running Horizon server at
|
||||||
|
``http://localhost:8000/`` but this can be customized by editing the
|
||||||
|
``watcher_dashboard/test/integration_tests/horizon.conf`` configuration file.
|
||||||
|
Likewise, this Horizon will be looking, by default, for a Keystone backend at
|
||||||
|
``http://localhost:5000/v2.0``. So in order to customize its location, you will
|
||||||
|
have to edit ``watcher_dashboard/test/settings.py`` by updating the
|
||||||
|
``OPENSTACK_KEYSTONE_URL`` variable.
|
||||||
|
|
||||||
|
To run integration tests::
|
||||||
|
|
||||||
|
$ ./run_tests.sh --integration
|
||||||
|
|
||||||
|
You can use PhantomJS as a headless browser to execute your integration tests.
|
||||||
|
On an Ubuntu distribution you can install it via the following command::
|
||||||
|
|
||||||
|
$ sudo apt-get install phantomjs
|
||||||
|
|
||||||
|
Then you can run your integration tests like this::
|
||||||
|
|
||||||
|
$ ./run_tests.sh --integration --selenium-headless
|
||||||
|
|
||||||
|
Please note that these commands are also available via ``tox``.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
As of the Mitaka release, the dashboard for watcher is now maintained
|
||||||
|
outside of the Horizon codebase, in this repository.
|
||||||
|
|
||||||
|
|
||||||
|
Policies
|
||||||
|
--------
|
||||||
|
You can enable policies on Watcher ``Optimization`` panel, by updating in the
|
||||||
|
``<HORIZON_DIR>/openstack_dashboard/settings.py`` configuration file the
|
||||||
|
following parameters
|
||||||
|
|
||||||
|
POLICY_FILES = {
|
||||||
|
...
|
||||||
|
'infra-optim': 'watcher_policy.json',
|
||||||
|
}
|
||||||
|
|
||||||
|
You can also update the file ``<HORIZON_DIR>/openstack_dashboard/conf/watcher_policy.conf``
|
||||||
|
to customize your policies.
|
||||||
|
|
||||||
|
|
||||||
|
Links
|
||||||
|
-----
|
||||||
|
|
||||||
|
Watcher project: https://git.openstack.org/openstack/watcher
|
||||||
|
|
||||||
|
Watcher at wiki.openstack.org: https://wiki.openstack.org/wiki/Watcher
|
||||||
|
|
||||||
|
Launchpad project: https://launchpad.net/watcher
|
||||||
|
|
||||||
|
Join us on IRC (Internet Relay Chat)::
|
||||||
|
|
||||||
|
Network: Freenode (irc.freenode.net/watcher)
|
||||||
|
Channel: #openstack-watcher
|
||||||
|
|
||||||
|
Or send an email to openstack-dev@lists.openstack.org.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user