Write a documentation describing how the supervisor and orchestrator

LiquidAI-project / wasmiot-supervisor

Device supervisor to manage deployment of WebAssembly modules. Works together with wasmiot-orchestrator.

MIT License

0 stars 1 forks source link

Write a documentation describing how the supervisor and orchestrator #27

Closed isoteemu closed 6 months ago

isoteemu commented 1 year ago

Write a documentation describing for supervisor and orchestrator. It should describe; How to deploy them; how they operate internally and how they communicate.

Deadline: 2023-12-31

### Documentation
- [x] Deployment / installation documentation
- [ ] Supervisor technical documentation
- [x] Orhestrator technical documentation
- [ ] Overview documentation

trkks commented 1 year ago

[x] Add links to related code (simple main-branch sufficient)

Orchestrator technical documentation

Per module:

[x] Discovery and devices
[x] WebAssembly, modules and description
[x] Deployment manifest and orchestration
[x] Execution

Supervisor technical documentation

[x] Device description
[x] Deployment self-setup
[x] WebAssembly, execution, control and data-flow

trkks commented 1 year ago

I was planning to do the supervisor OpenAPI document like the orchestrator has but it seems like a lot of work for little benefit. The orchestrator document was at least immediately beneficial in creating a CLI client, but as supervisor is not meant to be used in such a way it seems pointless having to write and maintain an API description of it.

So unless it is needed, I would consider "supervisor technical documentation" done.