Workflow¶
A workflow defines a series of stages that a machine should go through.
Workflows have the following fields:
| Field | Definition |
|---|---|
| Description | Description is a string for providing a simple description |
| Documentation | Documentation is a string for providing additional in depth information. |
| Meta | Meta contains the meta data of the object. The type of this field is a key / value map/dictionary. The key type is string. The value type is also string. The general content of the field is undefined and can be an arbritary store. There are some common known keys: color - The color the UX uses when displaying icon - The icon the UX uses when displaying * title - The UX uses this for additional display information. Often the source of the object. Specific Object types use additional meta data fields. These are described at: https://docs.rackn.io/stable/redirect/?ref=rs_object_metadata |
| Name | Name defines the name of the workflow |
| Stages | Stages contains the list of stages that make up the workflow. Additionally, tasks can be directly specified by prepending task: to the task name.Additionally, actions can be directly specified by prepending action: to the action name.Additionally, context changes can be directly specified by prepending context: to the context name. |
When the workflow field on a machine is set, the current task list on the machine is replaced with the results of expanding each stage in the workflow using the following items:
- stage:stageName
- bootenv:bootEnvName (if the stage has a non-empty bootenv field)
- task0...taskN (the content of the stage's
Tasksfield)
Additionally, the Stage and BootEnv fields of the machine become read-only, as stage and bootenv transitions will occur as dictated by the machine task list, and when the stage changes it does not affect the task list.