summaryrefslogtreecommitdiffstats
path: root/docs/configguide/featureconfig.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configguide/featureconfig.rst')
-rw-r--r--docs/configguide/featureconfig.rst49
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
new file mode 100644
index 00000000..5ca17b9b
--- /dev/null
+++ b/docs/configguide/featureconfig.rst
@@ -0,0 +1,49 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Doctor Configuration
+====================
+
+..
+ 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 &