summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/development/overview/OPNFV_HA_Guest_APIs-Overview_HLD.rst8
-rw-r--r--docs/development/overview/OPNFV_HA_Guest_APIs-Overview_HLD.rst.bak24
-rw-r--r--docs/development/overview/index.rst9
3 files changed, 18 insertions, 23 deletions
diff --git a/docs/development/overview/OPNFV_HA_Guest_APIs-Overview_HLD.rst b/docs/development/overview/OPNFV_HA_Guest_APIs-Overview_HLD.rst
index f7d5284..0bc0537 100644
--- a/docs/development/overview/OPNFV_HA_Guest_APIs-Overview_HLD.rst
+++ b/docs/development/overview/OPNFV_HA_Guest_APIs-Overview_HLD.rst
@@ -1,7 +1,3 @@
-*********************************************************************
-PROPOSAL: Reach-thru Guest Monitoring and Services for High Availability
-*********************************************************************
-
Overview
=====================================================================
@@ -169,7 +165,7 @@ VM Heartbeating and Health Checking
- Guest Deliverables:
+ a Heartbeat / Health-Check Message Specification covering
-
+
- Heartbeat / Health-Check Application Layer JSON Protocol,
- Base Host-to-Guest JSON Protocol,
- Details on the use of the underlying 'virtio serial device',
@@ -252,7 +248,7 @@ VM Peer State Notification and Messaging
- Guest Deliverables:
+ a Server Group Messaging Message Specification covering
-
+
- Server Group Messaging Application Layer JSON Protocol,
- [ leveraging Base Host-to-Guest JSON Protocol from previous section ],
- [ leveraging Details on the use of the underlying 'virtio serial device' from previous section ],
diff --git a/docs/development/overview/OPNFV_HA_Guest_APIs-Overview_HLD.rst.bak b/docs/development/overview/OPNFV_HA_Guest_APIs-Overview_HLD.rst.bak
index 0a0a746..f7d5284 100644
--- a/docs/development/overview/OPNFV_HA_Guest_APIs-Overview_HLD.rst.bak
+++ b/docs/development/overview/OPNFV_HA_Guest_APIs-Overview_HLD.rst.bak
@@ -1,9 +1,9 @@
-=========================================================================
+*********************************************************************
PROPOSAL: Reach-thru Guest Monitoring and Services for High Availability
-=========================================================================
---------
+*********************************************************************
+
Overview
---------
+=====================================================================
:author: Greg Waines
:organization: Wind River Systems
@@ -28,7 +28,7 @@ Overview
Introduction
-============
+=====================================================================
This document provides an overview and rationale for a PROPOSAL
of a set of new capabilities where the OpenStack Cloud messages
@@ -61,7 +61,7 @@ Introduction
Messaging Layer
-===============
+========================================================================
The Host-to-Guest messaging APIs used by the services discussed
in this document use a JSON-formatted application messaging layer
@@ -92,7 +92,7 @@ Messaging Layer
VM Heartbeating and Health Checking
-===================================
+============================================================================
Normally OpenStack monitoring of the health of a Guest VM is limited
to a black-box approach of simply monitoring the presence of the
@@ -126,7 +126,7 @@ VM Heartbeating and Health Checking
Part of the Guest VM's registration process is the specification of the
heartbeat interval in msecs. I.e. the registering Guest VM specifies the
heartbeating interval.
-
+
Guest heartbeat works on a challenge response model. The OpenStack
Guest Heartbeat Service on the compute node will challenge the registered
Guest VM daemon with a message each interval. The registered Guest VM daemon
@@ -169,7 +169,7 @@ VM Heartbeating and Health Checking
- Guest Deliverables:
+ a Heartbeat / Health-Check Message Specification covering
-
+
- Heartbeat / Health-Check Application Layer JSON Protocol,
- Base Host-to-Guest JSON Protocol,
- Details on the use of the underlying 'virtio serial device',
@@ -187,7 +187,7 @@ VM Heartbeating and Health Checking
VM Peer State Notification and Messaging
-========================================
+===================================================================================
Server Group State Notification and Messaging is a service to provide
simple low-bandwidth datagram messaging and notifications for servers that
@@ -252,7 +252,7 @@ VM Peer State Notification and Messaging
- Guest Deliverables:
+ a Server Group Messaging Message Specification covering
-
+
- Server Group Messaging Application Layer JSON Protocol,
- [ leveraging Base Host-to-Guest JSON Protocol from previous section ],
- [ leveraging Details on the use of the underlying 'virtio serial device' from previous section ],
@@ -266,7 +266,7 @@ VM Peer State Notification and Messaging
Conclusion
-==========
+======================================================================================
The PROPOSAL of Reach-thru Guest Monitoring and Services described in this document
leverage Host-to-Guest messaging to provide a number of extended capabilities
diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst
index 813ac02..06e0c4f 100644
--- a/docs/development/overview/index.rst
+++ b/docs/development/overview/index.rst
@@ -5,12 +5,11 @@
.. (c) <optionally add copywriters name>
-*********************************
-OPNFV HA Guest APIs -- Overview
-*********************************
+*********************************************************************
+PROPOSAL: Reach-thru Guest Monitoring and Services for High Availability
+*********************************************************************
.. toctree::
- :numbered:
- :maxdepth: 2
+ :maxdepth: 4
OPNFV_HA_Guest_APIs-Overview_HLD.rst