Create and run a workflow within a namespace

Add release note and improve docs.

Change-Id: I6edc4e22f90c029d7f3b6e149396cd741266c6a9
This commit is contained in:
Michal Gershenzon 2017-07-31 15:11:45 +00:00 committed by Renat Akhmerov
parent f2ed583540
commit 356a1cf274
2 changed files with 27 additions and 10 deletions

View File

@ -217,12 +217,12 @@ class Execution(resource.Resource):
"reference to workflow definition"
workflow_namespace = wtypes.text
("reference to workflow namespace. The workflow namespace is also saved "
"under params and passed to all sub-workflow executions. When looking for"
" the next sub-workflow to run, The correct workflow will be found by "
"name and namespace, where the namespace can be the workflow namespace or"
" the default namespace. Workflows in the same namespace will be given "
"a higher priority.")
"""reference to workflow namespace. The workflow namespace is also saved
under params and passed to all sub-workflow executions. When looking for
the next sub-workflow to run, The correct workflow will be found by
name and namespace, where the namespace can be the workflow namespace or
the default namespace. Workflows in the same namespace as the top workflow
will be given a higher priority."""
workflow_id = wtypes.text
"reference to workflow ID"
@ -231,8 +231,8 @@ class Execution(resource.Resource):
"description of workflow execution."
params = types.jsontype
("params define workflow type specific parameters. For example, reverse "
"workflow takes one parameter 'task_name' that defines a target task.")
"""params define workflow type specific parameters. For example, reverse
workflow takes one parameter 'task_name' that defines a target task."""
task_execution_id = wtypes.text
"reference to the parent task execution"
@ -303,8 +303,8 @@ class Task(resource.Resource):
workflow_execution_id = wtypes.text
state = wtypes.text
("state can take one of the following values: "
"IDLE, RUNNING, SUCCESS, ERROR, DELAYED")
"""state can take one of the following values:
IDLE, RUNNING, SUCCESS, ERROR, DELAYED"""
state_info = wtypes.text
"an optional state information string"

View File

@ -0,0 +1,17 @@
---
features:
- |
Creating and running workflows within a namespace. Workflows with the same
name can be added to the same project as long as they are within a
different namespace. This feature is backwards compatible.
All existing workflows are assumed to be in the default namespace,
represented by an empty string. Also if a workflow is created without a
namespace spcified, it is assumed to be in the defualt namespace.
When a workflow is being executed, the namespace is saved under params and
passed to all its sub workflow executions. When looking for the next
sub-workflow to run, the correct workflow will be found by name and
namespace, where the namespace can be the workflow namespace or the default
namespace. Workflows in the same namespace as the top workflow will be
given a higher priority.