diff options
| author |   Ryota Mibu <r-mibu@cq.jp.nec.com> | 2017-02-17 04:36:05 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@opnfv.org> | 2017-02-17 04:36:05 +0000 |
| commit | f3ab498aaddb27f6f598a84e2dbe0203ced6d666 (patch) | |
| tree | fc7b2be2681db87adc1eb935e6fdcc93a8bc1645 /docs/release/userguide | |
| parent | 5d9c24fd28bcc02243306a8c96d0c68809523343 (diff) | |
| parent | d0b22e1d856cf8f78e152dfb6c150e001e03dd52 (diff) | |
Merge "Update docs structure according to new guidelines in https://wiki.opnfv.org/display/DOC"
Diffstat (limited to 'docs/release/userguide')
| -rw-r--r-- | docs/release/userguide/feature.userguide.rst | 44 | ||||
| -rw-r--r-- | docs/release/userguide/index.rst | 12 |
2 files changed, 56 insertions, 0 deletions
diff --git a/docs/release/userguide/feature.userguide.rst b/docs/release/userguide/feature.userguide.rst new file mode 100644 index 00000000..4ae521bd --- /dev/null +++ b/docs/release/userguide/feature.userguide.rst @@ -0,0 +1,44 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Doctor capabilities and usage +============================= +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/danube + 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/danube/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/danube/manuals/get-valid-server-state.html +for more detail. diff --git a/docs/release/userguide/index.rst b/docs/release/userguide/index.rst new file mode 100644 index 00000000..c6830fd1 --- /dev/null +++ b/docs/release/userguide/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 User Guide +***************** + +.. toctree:: + :maxdepth: 2 + :numbered: + + feature.userguide.rst |