etolbakov/excalidocker-rs

Convert your docker-compose into excalidraw

excalidocker-rs's Issues

Implement config validation

The application should validate the values provided in the config file

support docker-compose `network`

At the moment network is ignored, it will be good to add network support. At the moment there are 2 options

• have a single colour for all services in one network and paste the agenda.
• wrap all services in one network in a big rectangle with the text that shows network name

links:
[1]. https://docs.docker.com/compose/networking/

config file support

It will allow users to customize colors, fonts, sloppiness etc

use arrows to connect boxes

This would be useful because connections remain when boxes are moved

Web extension for a browser

Since it's possible to build a Rust program for Web assembly maybe it will be possible to convert excalidocker into
browser add-on.

Resources:
[1] Rust Linz, November 2020 - Karl Grasegger - Building a web extension in Rust
[1.1] https://github.com/grasegger/rust-web-extension-talk
[2] https://www.reddit.com/r/WebAssembly/comments/yobynb/webnava_rust_wasm_and_typescript_chrome_extension/
[3] Serverless Architecture Conf London 2023: Rust + Wasm - A Dream Team for Serverless
[3.1] https://github.com/rstropek/rust-samples/tree/master/wasm-serverless

Wasm and Rust Deep Dive With Advent of Code

release pipeline doesn't release when it should

As per output of the comparison

Run echo "Version: '0.1.6' | latest release: '0.1.5'"
Version: '0.1.6' | latest release: '0.1.5'
Proceeding with building & release steps.

there should be release, while release jobs are skipped
https://github.com/etolbakov/excalidocker-rs/actions/runs/5315546707/jobs/9624039777

Config to support word colour format

Currently excalidocker-config.yaml supports only hex format for colors

...
services: # rectangle
  background_color: "#b2f2bb"
....
ports: # ellipse
  background_color: "#a5d8ff"
....

It would be helpful to let users specify colors like red, blue, green, etc.
Potentially - this crate can be useful
https://docs.rs/hex_color/latest/hex_color/

Support include

Support include

https://www.docker.com/blog/improve-docker-compose-modularity-with-include/

Edge type support

Excalidraw supports 2 edge types: sharp and round. We need to add support in the config.
Scope of change:

• add new field in the config
• in the corresponding struct
• in the main method, similar to the background_colour setting

Improve layout for ports

When a docker image exposes several ports the layout has issues.

  minio:
    image: minio/minio
    container_name: minio
    ports:
      - "9000:9000"
      - "9001:9001"
      - "9044:9044"
      - "9055:9055"

It affects all 3 alignment modes (vertical, horizontal, stepped. Might need to consider a totally different way of drawing ports

#20

Suggestions :)

This is just brilliant, thank you!

I saw your roadmap, FWIW I would put at #1 the Docker artefact - being able to run this without installing/building would make it super useful. It could then also be used in things like github actions for auto documentation as well.

Other ideas:

• Echo the output path used; I was a bit confused when I ran it and nothing seemed to happen - I had to RTFM to find out it went to /tmp by default
• Add ability to specify font used
• Add toggle for displaying dependencies
• Use arrows instead of lines as connectors so that when boxes are moved the connections remain with them

thread 'main' panicked at 'index out of bounds: the len is 1 but the index is 1'

./excalidocker --input-path ~/git/lakeFS/deployments/compose/docker-compose.yml
thread 'main' panicked at 'index out of bounds: the len is 1 but the index is 1', src/main.rs:159:38
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

Input file is this one

(excalidocker worked fine with this one)

group port elements(circle and text)

That would give a better user experience when some manual adjustments in the excalidraw are needed

Inconsistent results between subsequent conversions

Expectation: two subsequent conversions should produce a consistent result.
Actual :

improve the existing solution with multiple `HashMap` structs

It feels that these number of structs is excessive:

excalidocker-rs/src/main.rs

Lines 143 to 147 in 99459d0

	let mut components = Vec::new();
	let mut container_name_rectangle_structs = HashMap::new();
	let mut container_name_to_point = HashMap::new();
	let mut container_name_to_parents: HashMap<&str, DependencyComponent> = HashMap::new();
	let mut container_name_to_container_struct = HashMap::new();

During the development I came up with the most straightforward solution and didn't have much time to reflect on the optimal one, but maybe we can reduce the number of HashMap structs.

Excalidocker needs a logo

https://github.com/excalidraw/excalidraw-logo
excalidraw/excalidraw#109

external file support as INPUT_PATH

In some cases it will be useful to pass the link to the external file ( f.e. in github) and create excalidraw out of it

Add brew formula

Partially this has been done https://github.com/etolbakov/homebrew-taps.
Need to update docs on how to install & uninstall

brew install etolbakov/taps/excalidocker
brew uninstall etolbakov/taps/excalidocker

Fix linter issues

The code is in relatively untidy state. Commands

cargo check --all-features
cargo fmt -- --check
cargo clippy -- -D warnings	

produce a lot of actions (unused code, not optimal methods etc). This needs to be addressed.

• clippy issues
• cargo check
• format issues

Fix rendering order for port and network

When container and host ports do not match the host port text is a bit dimmed. This happens due to the order in which network and that text are placed.

Make configurable alignment setting

It came out as a suggestion from #20
It would be a useful to have a flag to choose the layout format:

• stepped (as currently),
• vertical align,
• horizontal

Reduce docker image size

At the moment etolbakov/excalidocker image is 115.55 Mb. Image size optimizations are required.

In github-action release step replace set-output with GITHUB_OUTPUT

The following line causes warnings

excalidocker-rs/.github/workflows/release.yml

Line 234 in 4e64a2a

run: echo ::set-output name=VERSION::$(grep "^version" Cargo.toml | awk '{print $3}' | tr -d '"')

The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

As per Github recommendation a workflow using save-state or set-output like the following

- name: Save state
run: echo "::save-state name={name}::{value}"

- name: Set output
run: echo "::set-output name={name}::{value}"

should be updated to write to the new GITHUB_STATE and GITHUB_OUTPUT environment files:

- name: Save state
run: echo "{name}={value}" >> $GITHUB_STATE

- name: Set output
run: echo "{name}={value}" >> $GITHUB_OUTPUT

source

Support `extends` fully

For example:

docker run --rm -e INPUT_PATH=https://raw.githubusercontent.com/treeverse/lakeFS-samples/main/standalone/airflow-dag-example/docker-compose.yml etolbakov/excalidocker:latest > tmp.excalidraw

The generated diagram doesn't show the ports exposed by the services that are extended from a parent Docker Compose, only those in the Docker Compose specified

Also odd how they're all rendered at an increasing vertical offset, not sure if this is by design but keeping it level would be useful too