diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst index 7905c4a30..6a9c66140 100644 --- a/doc/source/architecture.rst +++ b/doc/source/architecture.rst @@ -127,7 +127,19 @@ Watcher CLI The watcher command-line interface (CLI) can be used to interact with the Watcher system in order to control it or to know its current status. -Please, read `the detailed documentation about Watcher CLI `_ +Please, read `the detailed documentation about Watcher CLI +`_. + +.. _archi_watcher_dashboard_definition: + +Watcher Dashboard +----------------- + +The Watcher Dashboard can be used to interact with the Watcher system through +Horizon in order to control it or to know its current status. + +Please, read `the detailed documentation about Watcher Dashboard +`_. .. _archi_watcher_database_definition: diff --git a/doc/source/deploy/configuration.rst b/doc/source/deploy/configuration.rst index 8e24adfce..37a30f731 100644 --- a/doc/source/deploy/configuration.rst +++ b/doc/source/deploy/configuration.rst @@ -34,6 +34,8 @@ The Watcher service includes the following components: - ``watcher-applier``: applies the action plan. - `python-watcherclient`_: A command-line interface (CLI) for interacting with the Watcher service. +- `watcher-dashboard`_: An Horizon plugin for interacting with the Watcher + service. Additionally, the Bare Metal service has certain external dependencies, which are very similar to other OpenStack services: @@ -52,6 +54,7 @@ additional functionality: .. _`ceilometer`: https://github.com/openstack/ceilometer .. _`nova`: https://github.com/openstack/nova .. _`python-watcherclient`: https://github.com/openstack/python-watcherclient +.. _`watcher-dashboard`: https://github.com/openstack/watcher-dashboard .. _`watcher metering`: https://github.com/b-com/watcher-metering .. _`RabbitMQ`: https://www.rabbitmq.com/ diff --git a/doc/source/deploy/user-guide.rst b/doc/source/deploy/user-guide.rst index e3161dab5..fcd2c6006 100644 --- a/doc/source/deploy/user-guide.rst +++ b/doc/source/deploy/user-guide.rst @@ -38,7 +38,11 @@ If you need help on a specific command, you can use: $ watcher help COMMAND +If you want to deploy Watcher in Horizon, please refer to the `Watcher Horizon +plugin installation guide`_. + .. _`installation guide`: https://factory.b-com.com/www/watcher/doc/python-watcherclient +.. _`Watcher Horizon plugin installation guide`: https://factory.b-com.com/www/watcher/doc/watcher-dashboard/deploy/installation.html Seeing what the Watcher CLI can do ? ------------------------------------ diff --git a/doc/source/dev/environment.rst b/doc/source/dev/environment.rst index 4343733bd..162f03391 100644 --- a/doc/source/dev/environment.rst +++ b/doc/source/dev/environment.rst @@ -269,6 +269,11 @@ interface. .. _`python-watcherclient`: https://github.com/openstack/python-watcherclient +There is also an Horizon plugin for Watcher `watcher-dashboard`_ which +allows to interact with Watcher through a web-based interface. + +.. _`watcher-dashboard`: https://github.com/openstack/watcher-dashboard + Exercising the Watcher Services locally ======================================= diff --git a/doc/source/index.rst b/doc/source/index.rst index 13e3f173f..6f78b6b4f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -22,6 +22,7 @@ Watcher project consists of several source code repositories: * `watcher`_ - is the main repository. It contains code for Watcher API server, Watcher Decision Engine and Watcher Applier. * `python-watcherclient`_ - Client library and CLI client for Watcher. +* `watcher-dashboard`_ - Watcher Horizon plugin. The documentation provided here is continually kept up-to-date based on the latest code, and may not represent the state of the project at any @@ -29,6 +30,7 @@ specific prior release. .. _watcher: https://git.openstack.org/cgit/openstack/watcher/ .. _python-watcherclient: https://git.openstack.org/cgit/openstack/python-watcherclient/ +.. _watcher-dashboard: https://git.openstack.org/cgit/openstack/watcher-dashboard/ Developer Guide ===============