From 2a8991b88b5f168b48b97e630f6ba158c9d747f0 Mon Sep 17 00:00:00 2001 From: Bertrand Souville Date: Mon, 22 Aug 2016 10:49:44 +0200 Subject: Updated Doctor user/config guides using opnfvdocs templates https://gerrit.opnfv.org/gerrit/#/c/18311 https://gerrit.opnfv.org/gerrit/#/c/18967 Change-Id: Ia1a08415f316665dcd8ee5d0e99601ec3f3b753c Signed-off-by: Bertrand Souville --- .../feature.configuration.rst | 47 +++++++++++++++++++++ docs/installationprocedure/index.rst | 12 ++++++ docs/userguide/feature.userguide.rst | 48 ++++++++++++++++++++++ docs/userguide/featureusage.rst | 48 ---------------------- docs/userguide/index.rst | 2 +- 5 files changed, 108 insertions(+), 49 deletions(-) create mode 100644 docs/installationprocedure/feature.configuration.rst create mode 100644 docs/installationprocedure/index.rst create mode 100644 docs/userguide/feature.userguide.rst delete mode 100644 docs/userguide/featureusage.rst 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/feature.userguide.rst b/docs/userguide/feature.userguide.rst new file mode 100644 index 00000000..d24c1acb --- /dev/null +++ b/docs/userguide/feature.userguide.rst @@ -0,0 +1,48 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Doctor capabilities and usage +============================= + +.. + This section will be compiled into OPNFV composite document. + +Immediate Notification +---------------------- + +Immediate notification can be used by creating 'event' type alarm via +OpenStack Alarming (Aodh) API with relevant internal components support. + +See, upstream spec document: +http://specs.openstack.org/openstack/ceilometer-specs/specs/liberty/event-alarm-evaluator.html + +An example of a consumer of this notification can be found in the Doctor +repository. It can be executed as follows: + +.. code-block:: bash + + git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra + cd doctor/tests + CONSUMER_PORT=12346 + python consumer.py "$CONSUMER_PORT" > consumer.log 2>&1 & + +Consistent resource state awareness +----------------------------------- + +Resource state of compute host can be changed/updated according to a trigger +from a monitor running outside of OpenStack Compute (Nova) by using +force-down API. + +See +http://artifacts.opnfv.org/doctor/brahmaputra/docs/manuals/mark-host-down_manual.html +for more detail. + +Valid compute host status given to VM owner +------------------------------------------- + +The resource state of a compute host can be retrieved by a user with the +OpenStack Compute (Nova) servers API. + +See +http://artifacts.opnfv.org/doctor/docs/manuals/get-valid-server-state.html +for more detail. diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst deleted file mode 100644 index d24c1acb..00000000 --- a/docs/userguide/featureusage.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Doctor capabilities and usage -============================= - -.. - This section will be compiled into OPNFV composite document. - -Immediate Notification ----------------------- - -Immediate notification can be used by creating 'event' type alarm via -OpenStack Alarming (Aodh) API with relevant internal components support. - -See, upstream spec document: -http://specs.openstack.org/openstack/ceilometer-specs/specs/liberty/event-alarm-evaluator.html - -An example of a consumer of this notification can be found in the Doctor -repository. It can be executed as follows: - -.. code-block:: bash - - git clone https://gerrit.opnfv.org/gerrit/doctor -b stable/brahmaputra - cd doctor/tests - CONSUMER_PORT=12346 - python consumer.py "$CONSUMER_PORT" > consumer.log 2>&1 & - -Consistent resource state awareness ------------------------------------ - -Resource state of compute host can be changed/updated according to a trigger -from a monitor running outside of OpenStack Compute (Nova) by using -force-down API. - -See -http://artifacts.opnfv.org/doctor/brahmaputra/docs/manuals/mark-host-down_manual.html -for more detail. - -Valid compute host status given to VM owner -------------------------------------------- - -The resource state of a compute host can be retrieved by a user with the -OpenStack Compute (Nova) servers API. - -See -http://artifacts.opnfv.org/doctor/docs/manuals/get-valid-server-state.html -for more detail. 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 -- cgit 1.2.3-korg