drydock/doc/diagrams/basic_task_sequence.uml
Roman Gorshunov 161326fe06 Fix: Drydock Exceptions docs rendering on RTD
Readthedocs failed to render Drydock exceptions with error:
> WARNING: autodoc: failed to import exception xxx from module
> 'drydock_provisioner'; the following exception was raised: No module
> named 'drydock_provisioner'

Trying to add Drydock requirements to the installed requirements list,
so that Readthedocs has all modules, including those needed for the
Drydock itself.

Unify docs building by utilizing Zuul docs-on-readthedocs template job.

Cosmetic readability changes:
1. combined all Makefile .PHONY targets into one
2. merged multiple LABEL instructions in Dockerfile into one

Change-Id: I6a9b47cffc66d739968fa886c51e25b1e09ef124
2019-08-27 22:56:32 +02:00

44 lines
1.2 KiB
Plaintext

' PlantUML file describing the basic task execution
' sequence diagram
@startuml
actor User
== Task Creation ==
User -> TasksAPI : POST task body
TasksAPI -> oslo_policy : Enforce RBAC
oslo_policy -> TasksAPI : Approved
TasksAPI -> Statemgr : Insert Task as Queued
Statemgr -> TasksAPI : Result
TasksAPI -> User : Serialized Task
== Task Execution ==
Orchestrator -> Statemgr : Poll for Queued Tasks
Statemgr -> Orchestrator : Task ID of Queued Task
Orchestrator -> Statemgr : Update Task to Running
Statemgr -> Orchestrator : Result
Orchestrator -> Orchestrator : Execute task
Orchestrator -> Ingester : Ingest Site Design
Ingester -> Statemgr : Resolve Design Reference
Statemgr -> Ingester : Raw Site Design
Ingester -> Orchestrator : Parsed Site Design
Orchestrator -> Orchestrator : Create Subtask
Orchestrator ->> Driver : Execute Subtask
par Threaded Task Execution
Driver -> Driver : Execute 1 or More Actions
Driver -> Statemgr : Update Subtask to Complete
Statemgr -> Driver : Result
loop Until Subtask Complete or Timeout
Orchestrator -> Statemgr : Poll Subtask Status
Statemgr -> Orchestrator : Subtask Status
end
end
Orchestrator -> Statemgr : Update Task to Complete
== Task Query ==
User -> TasksAPI : GET task
@enduml