openstack-attic/akanda
Code Issues Proposed changes

add state machine bits

Browse Source 
updating existing rug state machine doc
with additional states and diagram

Partially Implements: blueprint liberty-doc-updates

Change-Id: Ie328bb421b16235d08e3fdaabe4f7a20d3e798b9
This commit is contained in:
Sean Roberts 2015-06-10 12:33:18 -07:00
parent faea392eb6
commit d50ffe70db
2 changed files with 99 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/source/rug.rst
View File

@ -93,6 +93,47 @@ The supported states in the state machine are:
are resolved and signal to :py:mod:`akanda-rug` that it should attempt are resolved and signal to :py:mod:`akanda-rug` that it should attempt
to manage them again. to manage them again.
:STATS: Reads traffic data from the router.
:CONFIG: Configures the VM and its services.
:EXIT: Processing stops.
ACT(ion) Variables are:
:Create: Create router was requested.
:Read: Read router traffic stats.
:Update: Update router configuration.
:Delete: Delete router.
:Poll: Poll router alive status.
:rEbuild: Recreate a router from scratch.
VM Variables are:
:Down: VM is known to be down.
:Booting: VM is booting.
:Up: VM is known to be up (pingable).
:Configured: VM is known to be configured.
:Restart Needed: VM needs to be rebooted.
:Hotplug Needed: VM needs to be replugged.
:Gone: The router definition has been removed from neutron.
:Error: The router has been rebooted too many times, or has had some
other error.
.. graphviz:: state_machine.dot
.. _health: .. _health:

57
docs/source/state_machine.dot Normal file
View File

@ -0,0 +1,57 @@
digraph rug {
// rankdir=LR;
node [shape = rectangle];
START;
// These nodes enter and exit the state machine.
node [shape = doublecircle];
EXIT;
CALC_ACTION;
node [shape = circle];
START -> CALC_ACTION;
CALC_ACTION -> ALIVE [ label = "ACT>[CRUP],vm:[UC]" ];
CALC_ACTION -> CREATE_VM [ label = "ACT>[CRUP],vm:D" ];
CALC_ACTION -> CHECK_BOOT [ label = "ACT>[CRUP],vm:B" ];
CALC_ACTION -> REBUILD_VM [ label = "ACT:E" ];
CALC_ACTION -> STOP_VM [ label = "ACT>D or vm:G" ];
CALC_ACTION -> CLEAR_ERROR [ label = "vm:E" ];
ALIVE -> CREATE_VM [ label = "vm>D" ];
ALIVE -> CONFIG [ label = "ACT:[CU],vm:[UC]" ];
ALIVE -> STATS [ label = "ACT:R,vm:C" ];
ALIVE -> CALC_ACTION [ label = "ACT:P,vm>[UC]" ];
ALIVE -> STOP_VM [ label = "vm:G" ];
CREATE_VM -> CHECK_BOOT [ label = "ACT:[CRUDP],vm:[DBUCR]" ];
CREATE_VM -> STOP_VM [ label = "vm:G" ];
CREATE_VM -> CALC_ACTION [ label = "vm:E" ];
CREATE_VM -> CREATE_VM [ label = "vm:D" ];
CHECK_BOOT -> CONFIG [ label = "vm>U" ];
CHECK_BOOT -> CALC_ACTION [ label = "vm:[BCR]" ];
CHECK_BOOT -> STOP_VM [ label = "vm:[DG]" ];
CONFIG -> STATS [ label = "ACT:R,vm>C" ];
CONFIG -> CALC_ACTION [ label = "ACT>P,vm>C" ];
CONFIG -> REPLUG_VM [ label = "vm>[H]" ];
CONFIG -> STOP_VM [ label = "vm>[RDG]" ];
REPLUG_VM -> CONFIG [ label = "vm>[H]" ];
REPLUG_VM -> STOP_VM [ label = "vm>[R]" ];
STATS -> CALC_ACTION [ label = "ACT>P" ];
CLEAR_ERROR -> CALC_ACTION [ label = "no pause before next action" ];
REBUILD_VM -> REBUILD_VM [ label = "vm!=[DG]" ];
REBUILD_VM -> CREATE_VM [ label = "ACT:E,vm:D" ];
STOP_VM -> CREATE_VM [ label = "ACT:E or vm>D" ];
STOP_VM -> EXIT [ label = "ACT:D,vm>D or vm:G" ];
}