X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Fconfigguide%2Fconfigguide.rst;fp=docs%2Fconfigguide%2Fconfigguide.rst;h=c35729015df3c790c32674cb9521e7522b08d366;hb=e036d0f69b14dcbe0711c1e46448f380912d794f;hp=0000000000000000000000000000000000000000;hpb=67a45e55d8cd3fbef20864034527f0f56a9464b1;p=doctor.git

diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst
new file mode 100644
index 00000000..c3572901
--- /dev/null
+++ b/docs/configguide/configguide.rst
@@ -0,0 +1,46 @@
+Configuring Doctor features
+===========================
+
+..
+    This section will be compiled into OPNFV composite document.
+
+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 accessible
+to 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/brahmaputra
+    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 to 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 Doctor Monitor as follows:
+
+.. code-block:: bash
+
+    git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra
+    cd doctor/tests
+    INSPECTOR_PORT=12345
+    COMPUTE_HOST='overcloud-novacompute-0'
+    sudo python monitor.py "$COMPUTE_HOST" \
+        "http://127.0.0.1:$INSPECTOR_PORT/events" > monitor.log 2>&1 &