Jump to: navigation, search

Difference between revisions of "StructuredStateManagement"

(→‎What problems does this solve in general)
 
(96 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
== Summary ==
+
Drafter:  [[Harlowja]]
  
−
Move away from ad-hoc states and state transitions to a more concrete organized structured state management in the various openstack projects (initial interests are in nova/heat).
+
Revised on: {{REVISIONMONTH1}}/{{REVISIONDAY}}/{{REVISIONYEAR}} by {{REVISIONUSER}}
  
−
=== What problems does this solve in general ===
+
=== Rationale ===
  
−
* Increases the [stability, extendability, reliability] of the various openstack projects.
+
Move away from ad-hoc states and state transitions for resource acquisition and modification to a more well-defined organized state management system. This new state management system will have advanced new & shiny features such as greater stability, automatic recovery mechanisms and greater scalability than what currently exists  (and more!).
−
* Makes it easier to [debug, test, understand, verify, review] the projects which have a workflow-like concept.
 
−
* Removes hard to discover state-transition dependencies and interactions with clearly defined state-transition dependencies and interactions.
 
−
* Ensures state transitions are done reliably and correctly by isolating those transitions to a single place/entity.
 
−
* Fixes a variety of problems that previously had piecemeal like patches applied to attempt to solve them (avoiding fixing the larger problem).
 
−
* Eliminates the inherent  fragility of the current ad-hoc workflows that exist in the openstack projects.
 
−
** They are by there ad-hoc nature hard to debug, hard to verify, hard to adjust, hard to understand (just hard in general)...
 
−
* Makes it possible to audit & track the state transitions performed on a given resource.
 
−
** This kind of functionality has started to appear in nova, but the ad-hoc nature was preserved (https://github.com/openstack/nova/blob/stable/grizzly/nova/compute/utils.py#L305)
 
−
* Addresses the underlying key point of http://www.slideshare.net/harlowja/nova-states-summit/9 where states will now be fully recovered from on ''cutting''.
 
  
 +
=== Definitions ===
  
−
==== What problems does this solve in nova ====
+
;State
 +
: The particular condition that someone or something is in at a specific time: "the state of the instance request".
 +
;State transition
 +
: Altering a state by applying a function on-top of that state (of which said function may take inputs and provide outputs) resulting in a new state.
 +
;Task
 +
: The application of a state transition on a given state.
 +
;Workflow
 +
: The sequence of administrative/other processes through which a piece of work passes from initiation to completion.
 +
;State management engine
 +
: An individual or entity that arranges or control the elements of, as to achieve a desired overall effect.
  
−
* Removes the need for periodic tasks to cleanup ''garbage'' (orphaned instances, orphaned resources...) left by nova's ad-hoc states.
+
=== What problems is this attempting to solve ===
−
* Creates the path for ''smart'' resource scheduling.
 
−
* Makes it possible to do [resizing, live migration] in a more secure and manageable manner.
 
−
** Discussion about how this can be done correctly require a intermediary to orchestrate this ownership transfer.
 
−
* Makes it possible for nova to have multi-stage booting where an instances and its dependent resources are first reserved, the resources configured, the instance configured, and then finally the instance is ''powered-on'' (thus completing the instance provisioning process).
 
  
−
==== Issues that would likely not have happened with a better state management system ====
+
* Increasing the ['extendability', 'recoverability', 'reliability', 'stability'] of states and state transitions.
 +
* Making it easier to [ 'add', 'debug', 'review', 'test', 'understand', 'verify'] existing & new states and state transitions.
 +
* Removing hard to discover state & transition dependencies and interactions.
 +
* Ensuring state transitions are done ['correctly', 'reliably'] by isolating those transitions to a entity whose exclusive responsibility is to ['correctly', 'reliably'] perform said transitions.
 +
* Fixing a variety of problems that previously had piecemeal like patches applied to solve them.
 +
* Eliminating the inherent ''fragility'' of the current ad-hoc workflows.
 +
* Allows for upgrading a cloud/software with inflight actions without needing later manual cleanup of said  actions.
 +
* Makes it possible to audit & track the state transitions performed on a given resource in a unified manner.
 +
** '''Note:''' that there currently exists notifications, logging, event reporting as different mechanisms (which are not used in a uniform manner).
 +
* Removes the need for certain types of periodic tasks which start to consume more and more resources as  you grow your cluster larger.
 +
* Moves toward the path where actions will automatically recover on ''cutting'' events (node failure, resource failure, network failure..).
 +
* Removes the need for periodic tasks to cleanup ''garbage'' (orphaned instances/resources/tasks...) left behind.
 +
* Creates the foundation for a more reliable and automatic recovery process when errors do occur.
 +
* Encourages the ['altering', 'extension'] of default workflows with a more ['complex', 'custom', 'experimental'] workflows.
  
−
* In nova
+
==== Fixing a known need ====
−
** https://blueprints.launchpad.net/nova/+spec/compute-instance-cleanup-service
 
−
** https://bugs.launchpad.net/nova/+bug/1050979
 
−
** https://bugs.launchpad.net/nova/+bug/1061024
 
−
** https://bugs.launchpad.net/nova/+bug/1082414
 
−
** ...
 
  
−
=== Connected blueprints ===
+
* https://blueprints.launchpad.net/nova/+spec/compute-instance-cleanup-service
 +
* https://blueprints.launchpad.net/cinder/+spec/cinder-state-machine
 +
* https://bugs.launchpad.net/nova/+bug/1173408
 +
* https://bugs.launchpad.net/nova/+bug/1173413
 +
* https://bugs.launchpad.net/nova/+bug/1173417
 +
* https://bugs.launchpad.net/nova/+bug/1173420
 +
* https://bugs.launchpad.net/nova/+bug/1050979
 +
* https://bugs.launchpad.net/nova/+bug/1061024
 +
* https://bugs.launchpad.net/nova/+bug/1082414
 +
* https://bugs.launchpad.net/nova/+bug/1173429
 +
* https://bugs.launchpad.net/nova/+bug/1173430
 +
* (and more)
 +
 
 +
=== Blueprints ===
  
 
* https://blueprints.launchpad.net/nova/+spec/structured-state-management
 
* https://blueprints.launchpad.net/nova/+spec/structured-state-management
−
** https://blueprints.launchpad.net/nova/+spec/structured-state-management-core-library
+
* https://blueprints.launchpad.net/cinder/+spec/cinder-state-machine
−
** https://blueprints.launchpad.net/nova/+spec/structured-state-management-run-instance-path
+
 
 +
=== Related papers ===
 +
 
 +
* http://www.netdb.cis.upenn.edu/papers/tropic_tr.pdf
 +
* http://research.microsoft.com/pubs/64604/osr2007.pdf
  
−
=== Connected wikis ===
+
=== Related wikis ===
  
 
* https://wiki.openstack.org/wiki/Convection
 
* https://wiki.openstack.org/wiki/Convection
 +
* https://wiki.openstack.org/wiki/NovaOrchestration/WorkflowEngines ('''old''')
  
−
=== Requirements ===
+
=== Potential Requirements ===
  
 
https://etherpad.openstack.org/task-system
 
https://etherpad.openstack.org/task-system
  
−
=== Discussions ===
+
=== Summit Discussions ===
  
−
https://etherpad.openstack.org/the-future-of-orch
+
'''Havana summit:'''
 +
* https://etherpad.openstack.org/the-future-of-orch
 +
* https://etherpad.openstack.org/Summit-Havana-Cinder-Safe-Shutdown
  
 
=== Plan of record ===
 
=== Plan of record ===
 
   
 
   
−
# Create prototype
+
==== Step 1 ====
−
## Create library and use said library in nova for run_instance api in nova.
 
−
# Get feedback others
 
−
## Get feedback  from summit session on said discussion and prototype.
 
−
## Get more feedback from email list & heat folks about common library.
 
−
# Adjust prototype as needed from feedback.
 
−
# Split prototype+library into small chunks.
 
−
# Adjust tests for each small chunks.
 
−
# Start to submit chunks into http://review.openstack.org (disabling whole/pieces component until ready to turn on?).
 
  
−
=== Prototype ===
+
'''Create prototype'''
  
−
https://github.com/Yahoo/NovaOrc
+
# Create core workflow/task library and prototype using said library in nova for ''run_instance'' action.
 +
# Split this action (refactored) into small atomic task chunks (don't aim for perfection just yet, since its a prototype).
 +
# Organize chunks into a workflow and test workflow.
 +
# Show working prototype at summit session (with associated docs...)
  
−
== Design ==
+
==== Step 2 ====
−
[[File:New-arch.png|thumbnail|center]]
 
  
 +
# Get feedback on prototype from people involved in making it + other interested parties.
 +
# Get feedback from summit session.
 +
# Get more feedback from email list + other interested parties.
 +
# Form group of interested folks that would like to help move forward the prototypes design principles & usage in other core projects.
  
 +
==== Step 3 ====
  
 +
# Select single first target project to use new ''taskflow'' library.
 +
# Incubate ''taskflow'' library using parts from prototype inside said project.
 +
## Keep other active projects involved from the start (so that said library can be easily used there).
 +
# Prove library in said single first target project by using it to do a key workflow.
 +
## Adjust workflow in chunks in said target project to use said library.
 +
# Adjust tests for each small chunks (depending on what it changes) and add new ones for new functionality.
 +
# Submit chunks into http://review.openstack.org (disabling whole/pieces component until ready to turn on?).
  
−
=== Design details ===
+
==== Step 4 ====
  
−
In order to implement of this new orchestration layer the following key concepts must be built into the design from the start.
+
# Move ''taskflow'' library (and associated tests) into oslo.
  
−
# A set of '''atomic''' tasks that can be organized into a workflow.
+
==== Step 5 ====
−
# Task resumption.
 
−
# Task rollback.
 
−
# Task tracking.
 
−
# Resource locking.
 
−
# Workflow sharding/ownership.
 
−
# Simplicity (allowing for extension and verifiability).
 
−
# Tolerant to upgrades.
 
  
−
==== Atomic tasks ====
+
# Pick another flow and refactor it in said first project ''and/or'' pick another interested project for said flow.
 +
# Split this other flow into small chunks using said library.
 +
# Adjust unit tests for each small chunks (depending on what it changes) and add new ones for new functionality.
 +
# Submit chunks into http://review.openstack.org (disabling whole/pieces component until ready to turn on?).
 +
# Rinse & repeat.
  
−
===== Why it matters =====
+
== Prototype ==
  
−
===== How it will be addressed =====
+
https://github.com/Yahoo/NovaOrc
  
−
==== Task resumption ====
+
=== Design ===
  
−
===== Why it matters =====
+
[[File:New-arch.png|thumbnail|center]]
−
 
 
−
===== How it will be addressed =====
 
−
 
 
−
==== Task rollback ====
 
−
 
 
−
===== Why it matters =====
 
−
 
 
−
===== How it will be addressed =====
 
−
 
 
−
==== Task tracking ====
 
−
 
 
−
===== Why it matters =====
 
−
 
 
−
===== How it will be addressed =====
 
−
 
 
−
==== Resource locking ====
 
−
 
 
−
===== Why it matters =====
 
−
 
 
−
===== How it will be addressed =====
 
−
 
 
−
==== Workflow sharding/ownership ====
 
−
 
 
−
===== Why it matters =====
 
−
 
 
−
===== How it will be addressed =====
 
−
 
 
−
==== Simplicity ====
 
  
−
===== Why it matters =====
+
=== Workflow ===
 +
[[File:Run_workflow.png|thumbnail|center]]
  
−
===== How it will be addressed =====
+
== More  Details! ==
  
−
==== Tolerant to upgrades ====
+
See: [[StructuredStateManagementDetails]]
  
−
===== Why it matters =====
+
See: [[StructuredWorkflowPrimitives]]
  
−
===== How it will be addressed =====
+
Get involved: [[StructuredWorkflows]]

Latest revision as of 20:16, 25 May 2013

Drafter: Harlowja

Revised on: 5/25/2013 by Harlowja

Rationale

Move away from ad-hoc states and state transitions for resource acquisition and modification to a more well-defined organized state management system. This new state management system will have advanced new & shiny features such as greater stability, automatic recovery mechanisms and greater scalability than what currently exists (and more!).

Definitions

State
The particular condition that someone or something is in at a specific time: "the state of the instance request".
State transition
Altering a state by applying a function on-top of that state (of which said function may take inputs and provide outputs) resulting in a new state.
Task
The application of a state transition on a given state.
Workflow
The sequence of administrative/other processes through which a piece of work passes from initiation to completion.
State management engine
An individual or entity that arranges or control the elements of, as to achieve a desired overall effect.

What problems is this attempting to solve

  • Increasing the ['extendability', 'recoverability', 'reliability', 'stability'] of states and state transitions.
  • Making it easier to [ 'add', 'debug', 'review', 'test', 'understand', 'verify'] existing & new states and state transitions.
  • Removing hard to discover state & transition dependencies and interactions.
  • Ensuring state transitions are done ['correctly', 'reliably'] by isolating those transitions to a entity whose exclusive responsibility is to ['correctly', 'reliably'] perform said transitions.
  • Fixing a variety of problems that previously had piecemeal like patches applied to solve them.
  • Eliminating the inherent fragility of the current ad-hoc workflows.
  • Allows for upgrading a cloud/software with inflight actions without needing later manual cleanup of said actions.
  • Makes it possible to audit & track the state transitions performed on a given resource in a unified manner.
    • Note: that there currently exists notifications, logging, event reporting as different mechanisms (which are not used in a uniform manner).
  • Removes the need for certain types of periodic tasks which start to consume more and more resources as you grow your cluster larger.
  • Moves toward the path where actions will automatically recover on cutting events (node failure, resource failure, network failure..).
  • Removes the need for periodic tasks to cleanup garbage (orphaned instances/resources/tasks...) left behind.
  • Creates the foundation for a more reliable and automatic recovery process when errors do occur.
  • Encourages the ['altering', 'extension'] of default workflows with a more ['complex', 'custom', 'experimental'] workflows.

Fixing a known need

Blueprints

Related papers

Related wikis

Potential Requirements

https://etherpad.openstack.org/task-system

Summit Discussions

Havana summit:

Plan of record

Step 1

Create prototype

  1. Create core workflow/task library and prototype using said library in nova for run_instance action.
  2. Split this action (refactored) into small atomic task chunks (don't aim for perfection just yet, since its a prototype).
  3. Organize chunks into a workflow and test workflow.
  4. Show working prototype at summit session (with associated docs...)

Step 2

  1. Get feedback on prototype from people involved in making it + other interested parties.
  2. Get feedback from summit session.
  3. Get more feedback from email list + other interested parties.
  4. Form group of interested folks that would like to help move forward the prototypes design principles & usage in other core projects.

Step 3

  1. Select single first target project to use new taskflow library.
  2. Incubate taskflow library using parts from prototype inside said project.
    1. Keep other active projects involved from the start (so that said library can be easily used there).
  3. Prove library in said single first target project by using it to do a key workflow.
    1. Adjust workflow in chunks in said target project to use said library.
  4. Adjust tests for each small chunks (depending on what it changes) and add new ones for new functionality.
  5. Submit chunks into http://review.openstack.org (disabling whole/pieces component until ready to turn on?).

Step 4

  1. Move taskflow library (and associated tests) into oslo.

Step 5

  1. Pick another flow and refactor it in said first project and/or pick another interested project for said flow.
  2. Split this other flow into small chunks using said library.
  3. Adjust unit tests for each small chunks (depending on what it changes) and add new ones for new functionality.
  4. Submit chunks into http://review.openstack.org (disabling whole/pieces component until ready to turn on?).
  5. Rinse & repeat.

Prototype

https://github.com/Yahoo/NovaOrc

Design

New-arch.png

Workflow

Run workflow.png

More Details!

See: StructuredStateManagementDetails

See: StructuredWorkflowPrimitives

Get involved: StructuredWorkflows

Retrieved from "https://wiki.openstack.org/w/index.php?title=StructuredStateManagement&oldid=23471"