From 3f484e08ff92b6e4574efb11fa6f013d775ef4a1 Mon Sep 17 00:00:00 2001 From: Ryota MIBU Date: Wed, 10 Feb 2016 00:38:05 +0900 Subject: docs: fix filename See https://wiki.opnfv.org/documentation/userguide . Change-Id: I2d03406de585785d13a58a8181efeaa674f97e31 Signed-off-by: Ryota MIBU (cherry picked from commit 12cbbc40ff05812b3d44ff76e9156a84f4c18944) --- docs/userguide/featureusage.rst | 37 +++++++++++++++++++++++++++++++++++++ docs/userguide/userguide.rst | 37 ------------------------------------- 2 files changed, 37 insertions(+), 37 deletions(-) create mode 100644 docs/userguide/featureusage.rst delete mode 100644 docs/userguide/userguide.rst diff --git a/docs/userguide/featureusage.rst b/docs/userguide/featureusage.rst new file mode 100644 index 00000000..59090a77 --- /dev/null +++ b/docs/userguide/featureusage.rst @@ -0,0 +1,37 @@ +.. 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 + +You can find an example of consumer of this notification in 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 (Compute/host-down) +------------------------------------------------------- + +Resource state of compute host can be fixed according to an input from a monitor +sitting out side 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. diff --git a/docs/userguide/userguide.rst b/docs/userguide/userguide.rst deleted file mode 100644 index 59090a77..00000000 --- a/docs/userguide/userguide.rst +++ /dev/null @@ -1,37 +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 - -You can find an example of consumer of this notification in 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 (Compute/host-down) -------------------------------------------------------- - -Resource state of compute host can be fixed according to an input from a monitor -sitting out side 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. -- cgit 1.2.3-korg