c35729015df3c790c32674cb9521e7522b08d366
[doctor.git] / docs / configguide / configguide.rst
1 Configuring Doctor features
2 ===========================
3
4 ..
5     This section will be compiled into OPNFV composite document.
6
7 Doctor Inspector
8 ----------------
9
10 Doctor Inspector is suggested to be placed in one of the controller nodes,
11 but it can be put on any host where Doctor Monitor can reach and accessible
12 to the OpenStack Controller (Nova).
13
14 Make sure OpenStack env parameters are set properly, so that Doctor Inspector
15 can issue admin actions such as compute host force-down and state update of VM.
16
17 Then, you can configure Doctor Inspector as follows:
18
19 .. code-block:: bash
20
21     git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra
22     cd doctor/tests
23     INSPECTOR_PORT=12345
24     python inspector.py $INSPECTOR_PORT > inspector.log 2>&1 &
25
26 Doctor Monitor
27 --------------
28
29 Doctor Monitors are suggested to be placed in one of the controller nodes,
30 but those can be put on any host which is reachable to target compute host and
31 accessible to the Doctor Inspector.
32 You need to configure Monitors for all compute hosts one by one.
33
34 Make sure OpenStack env parameters are set properly, so that Doctor Inspector
35 can issue admin actions such as compute host force-down and state update of VM.
36
37 Then, you can configure Doctor Monitor as follows:
38
39 .. code-block:: bash
40
41     git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra
42     cd doctor/tests
43     INSPECTOR_PORT=12345
44     COMPUTE_HOST='overcloud-novacompute-0'
45     sudo python monitor.py "$COMPUTE_HOST" \
46         "http://127.0.0.1:$INSPECTOR_PORT/events" > monitor.log 2>&1 &