Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Big feature: generate C4 from docker-compose.yml and ansible #120

Closed
micheelengronne opened this issue Feb 10, 2021 · 6 comments
Closed
Labels
stale Issue has not been active for 60 days

Comments

@micheelengronne
Copy link

Hello,

I searched on the web some tools to extract a C4 diagram from docker-compose.yml and ansible collections.

Nothing convincing. Projects are not maintained and generate diagrams without standards.

Do you know any way to do that ?

Can this project do that ?

The idea would be to generate C4 diagrams automatically for doc purpose and to compare them to reference diagrams and discuss potential divergences between the plan and the implementation.

@Potherca
Copy link
Member

Hi! It would be an awesome idea to create with the C4 code-base, but not in the C4 code-base, I think.

I can't speak for any of the other maintainers, but I would consider this feature to be rather far out of scope for this project.

A quick search turned up these libraries as most mentioned:

There also seem to be a lot of single-use scripts, like https://github.com/krogebry/awsmap/blob/master/lib/awsmap/mappers/docker_compose.py lying around. (And many more in Gists).

So it seems to be possible to build something yourself, the limit obviously being the amount of time and knowledge you have to spend, which is also the main reason I think it would be a poor fit for this project. docker-compose and PlantUML (and C4) have more-or-less nothing in common 😞

However, if you are inclined to spend time on this, I am more than willing to offer advise or support.

@micheelengronne
Copy link
Author

Yes, time is something I don't currently have, sadly. No worries, I will put it back in my backlog and try to make some progress on my epics for that.

@Potherca
Copy link
Member

time is something I don't currently have, sadly

Very recognizable 😀

Let's see what happens!

@kirchsth
Copy link
Contributor

Hi @micheelengronne,
I added properties to the standard (I plane something similar), maybe they are useful for you.
Can you check the current implementation?
Or if you need some extensions please inform me, maybe I have a simple solution that I can add it too?
BR
Helmut

PS.: I wrote a structurz based generator (which uses an older/my C4-Plantuml version). I want to update/extend it that it supports the new features too (properties, tags, ...) but you can easily extend the current version with your requirements too in the meantime too.
The only remaining part would be that you have to write the required docker compose and ansible parser and create a C4 model.

@micheelengronne
Copy link
Author

That's cool and from my POV a good step towards automation. For your DOTNET implementation I can not be of any help, I am on Linux and have never touched a Microsoft language.

@stale
Copy link

stale bot commented Apr 23, 2021

This issue has been automatically marked as stale because it has not had activity in the past 60 days. It will be closed in seven days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Issue has not been active for 60 days label Apr 23, 2021
@stale stale bot closed this as completed Apr 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale Issue has not been active for 60 days
Projects
Status: Done
Development

No branches or pull requests

3 participants