Plans for command line interface

[phil-opp]

We are planning a dora command line tool with the following subcommands:

For v0.1:

• help: Help about any command (generated by clap)
• check
  • Pre-check the dora installation/environment for potential problems (e.g., YAML syntax)
  • Check that the dora-coordinator is running
  • Check that the iox-roudi deamon is running
• build: Build the dora nodes/operators (similar to run.rs in current examples)
• graph: Generate dataflow graph per YAML spec
  • visualize as mermaid code
  • open image automatically, e.g. in OS or browser window
• templates: Dora node/operator template
  • Rust
  • C
  • Python
  • C++
  • dataflow YAML
• start: Run dora dataflow
• stop: Stop dora dataflow
• destroy: Cleanup and destroy all dora related processes
• list: List running dora entities (resources)
• up: Install all dora dependencies and start dora coordinator, iceoryx daemon and/or zenoh router etc
  • Unfortunately there does not seem a good way to detect whether the iceoryx daemon is already running (see Fallible version of Runtime::init function eclipse-iceoryx/iceoryx-rs#62).
• upgrade: Upgrade dora

Later:

• dashboard: Open the dora dashboard in a web browser (future)
• logs: Tail logs from customer node/operators
• metrics: Fetch metrics from customer node/operators
• stats: Display dora/traffic statistics
• get: Get info about the dora entity (future may need CRUD on dora entity)
• graph: visualize as image directly (e.g. as svg)

Other Ideas:

• package: Create an archive file containing all compiled nodes for easier distribution
  • similar to cargo package

See the discussion in #81 for more context.

Implementation PRs:

• Start creating command line interface with check, build, graph and templates commands #84
• Implement CLI start and destroy and make coordinator a daemon #97
• Add support for replies in CLI and implement stop command #105
• Implement cli list command to list running dataflows #107
• CLI check wether dora-runtime and iceoryx daemons are running #114
• Create dataflow html file in current directory #115
• Implement dataflow templates in dora new #116
• Implement dora up command to start coordinator and iceoryx RouDi #117
• Implement Python template #123
• Implement C++ template in dora CLI #126

[elBoberido]

@phil-opp creating an API to check whether the iceoryx daemon is running is on our todo list. We are at the moment just busy with other stuff.

[phil-opp]

Great to hear that, thanks! For now we just check the running processes, so we have a workaround.

[haixuanTao]

Just want to comment that, I think that the upgrade of dora should be done at a package manager level.

At present time, dora is packaged in cargo, and can be upgraded as such: cargo install dora-cli --force or with https://crates.io/crates/cargo-update as any other Rust application.

Therefore I marked it as done.

We can later plan to release dora into more package manager.