diff options
| author |   Bertrand Souville <souville@docomolab-euro.com> | 2016-08-22 10:49:44 +0200 |
|---|---|---|
| committer | Bertrand Souville <souville@docomolab-euro.com> | 2016-08-22 14:03:59 +0200 |
| commit | 2a8991b88b5f168b48b97e630f6ba158c9d747f0 (patch) | |
| tree | e9c1c30120f8be997d833afba092fd8f20a9cbab /docs | |
| parent | a60aa0abf92a6658b2af446a02617e6832fc8412 (diff) | |
Updated Doctor user/config guides using opnfvdocs templates
https://gerrit.opnfv.org/gerrit/#/c/18311
https://gerrit.opnfv.org/gerrit/#/c/18967
Change-Id: Ia1a08415f316665dcd8ee5d0e99601ec3f3b753c
Signed-off-by: Bertrand Souville <souville@docomolab-euro.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installationprocedure/feature.configuration.rst | 47 | ||||
| -rw-r--r-- | docs/installationprocedure/index.rst | 12 | ||||
| -rw-r--r-- | docs/userguide/feature.userguide.rst (renamed from docs/userguide/featureusage.rst) | 0 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 2 |
4 files changed, 60 insertions, 1 deletions
diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst new file mode 100644 index 00000000..f90b213d --- /dev/null +++ b/docs/installationprocedure/feature.configuration.rst @@ -0,0 +1,47 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Doctor Configuration +==================== + +Doctor Inspector +---------------- + +Doctor Inspector is suggested to be placed in one of the controller nodes, +but it can be put on any host where Doctor Monitor can reach and access +the OpenStack Controller (Nova). + +Make sure OpenStack env parameters are set properly, so that Doctor Inspector +can issue admin actions such as compute host force-down and state update of VM. + +Then, you can configure Doctor Inspector as follows: + +.. code-block:: bash + + git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/colorado + cd doctor/tests + INSPECTOR_PORT=12345 + python inspector.py $INSPECTOR_PORT > inspector.log 2>&1 & + +Doctor Monitor +-------------- + +Doctor Monitors are suggested to be placed in one of the controller nodes, +but those can be put on any host which is reachable to target compute host and +accessible by the Doctor Inspector. +You need to configure Monitors for all compute hosts one by one. + +Make sure OpenStack env parameters are set properly, so that Doctor Inspector +can issue admin actions such as compute host force-down and state update of VM. + +Then, you can configure the Doctor Monitor as follows (Example for Apex deployment): + +.. code-block:: bash + + git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/colorado + cd doctor/tests + INSPECTOR_PORT=12345 + COMPUTE_HOST='overcloud-novacompute-1.localdomain.com' + COMPUTE_IP=192.30.9.5 + sudo python monitor.py "$COMPUTE_HOST" "$COMPUTE_IP" \ + "http://127.0.0.1:$INSPECTOR_PORT/events" > monitor.log 2>&1 & diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst new file mode 100644 index 00000000..b74b91f8 --- /dev/null +++ b/docs/installationprocedure/index.rst @@ -0,0 +1,12 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +************************** +Doctor Configuration Guide +************************** + +.. toctree:: + :maxdepth: 2 + :numbered: + + feature.configuration.rst diff --git a/docs/userguide/featureusage.rst b/docs/userguide/feature.userguide.rst index d24c1acb..d24c1acb 100644 --- a/docs/userguide/featureusage.rst +++ b/docs/userguide/feature.userguide.rst diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 43726ea3..c6830fd1 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -9,4 +9,4 @@ Doctor User Guide :maxdepth: 2 :numbered: -.. include:: featureusage.rst + feature.userguide.rst |