summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/installationprocedure/feature.configuration.rst47
-rw-r--r--docs/installationprocedure/index.rst12
-rw-r--r--docs/userguide/feature.userguide.rst (renamed from docs/userguide/featureusage.rst)0
-rw-r--r--docs/userguide/index.rst2
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