From b209f93f3a19ff6c0184b496182c8d34c30f3e38 Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Mon, 8 Feb 2016 22:41:40 +0900 Subject: docs: fix filename and test4composite Change-Id: I78366611efd26987a71c3ecf25d2406e6f489cca Signed-off-by: Ryota MIBU --- docs/configguide/configguide.rst | 49 -------------------------------- docs/configguide/featureconfig.rst | 49 ++++++++++++++++++++++++++++++++ docs/test4composite/configguide.rst | 4 +++ docs/test4composite/images | 1 + docs/test4composite/index.rst | 8 ++++-- docs/test4composite/platformoverview.rst | 4 +++ docs/test4composite/userguide.rst | 4 +++ 7 files changed, 67 insertions(+), 52 deletions(-) delete mode 100644 docs/configguide/configguide.rst create mode 100644 docs/configguide/featureconfig.rst create mode 100644 docs/test4composite/configguide.rst create mode 120000 docs/test4composite/images create mode 100644 docs/test4composite/platformoverview.rst create mode 100644 docs/test4composite/userguide.rst (limited to 'docs') diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst deleted file mode 100644 index 9190fe45..00000000 --- a/docs/configguide/configguide.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -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 & 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 & diff --git a/docs/test4composite/configguide.rst b/docs/test4composite/configguide.rst new file mode 100644 index 00000000..d1f89634 --- /dev/null +++ b/docs/test4composite/configguide.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../configguide/featureconfig.rst diff --git a/docs/test4composite/images b/docs/test4composite/images new file mode 120000 index 00000000..70631720 --- /dev/null +++ b/docs/test4composite/images @@ -0,0 +1 @@ +../platformoverview/images \ No newline at end of file diff --git a/docs/test4composite/index.rst b/docs/test4composite/index.rst index 1feee739..5b176773 100644 --- a/docs/test4composite/index.rst +++ b/docs/test4composite/index.rst @@ -13,6 +13,8 @@ Doctor contents in composite docs :maxdepth: 2 :numbered: - ../platformoverview/platformoverview.rst - ../configguide/configguide.rst - ../userguide/userguide.rst + * + +.. include:: ../platformoverview/platformoverview.rst +.. include:: ../configguide/featureconfig.rst +.. include:: ../userguide/userguide.rst diff --git a/docs/test4composite/platformoverview.rst b/docs/test4composite/platformoverview.rst new file mode 100644 index 00000000..2473f673 --- /dev/null +++ b/docs/test4composite/platformoverview.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../platformoverview/platformoverview.rst diff --git a/docs/test4composite/userguide.rst b/docs/test4composite/userguide.rst new file mode 100644 index 00000000..e05aec11 --- /dev/null +++ b/docs/test4composite/userguide.rst @@ -0,0 +1,4 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +.. include:: ../userguide/userguide.rst -- cgit 1.2.3-korg