kompose VS C4-PlantUML

Install Kompose - a conversion tool that allows you to convert your Docker Compose code to Kubernetes configuration files Run kompose convert in the same directory as your docker-compose.yml to generate the config files for your Kubernetes cluster

Kubernetes (via kompose)

As stated on their homepage, with Kompose, you can now push the same file to a production container orchestrator!. The tool definitely covers a wide range of Kubernetes features, among which these are meaningless locally but crucial for kubernetes :

K3s is a small, open source, no nonsense, distribution of Kubernetes. I think you'll find it just as easy to setup as Swarm. The challenge will be that Kubernetes has an entirely different API compared to Docker/Docker Compose. This can be mitigated by a tool called kompose, but using this will limit what you can do on Kubernetes.

Although I recently moved my own services from docker compose to kubernetes using https://kompose.io/ and now the only thing I run with docker compose, currently, is my private docker registry but everything including in kube, are always in their own folders.

I haven't run into the need to do that, but there is the Kompose project that exists to help with the conversion (https://kompose.io/)!

Compose claims to do that. https://kompose.io and https://kubernetes.io/docs/tasks/configure-pod-container/translate-compose-kubernetes/

C4-PlantUML: Export your model as C4-PlantUML diagrams.

PlantUML + C4 plugin;

Yes. I use this all the time for software diagramming. With c4 model (https://github.com/plantuml-stdlib/C4-PlantUML) and AWS icons (https://github.com/awslabs/aws-icons-for-plantuml)

The C4 model (https://c4model.com/) is great for architecture diagrams. You can use different tools to generate them. Here are the ones I've been using:

- https://github.com/plantuml-stdlib/C4-PlantUML

3️⃣ Text-based diagramming- C4-PlantUML

> onboarding docs

yes, they're don't changing frequently

> system design docs

yes - see C4-PlantUML[1]

> meeting notes

no, unless they're directly code related like ADRs [2,3].

Although one can abuse Github Issues + comments for this, in my opinion it's better to use modern SaaS tools for this, i.e. Loom, Descript, Linear.app, etc. - you can automate this process, e.g. transcribe the meeting's recording and add the issue/repo using Github Actions.

--

[1] https://github.com/plantuml-stdlib/C4-PlantUML

[2] https://adr.github.io/

[3] https://docs.aws.amazon.com/prescriptive-guidance/latest/arc...

I use a combination of: * Markdown (for notes and code blocks) * Mermaid markdown (for architectural diagrams in markdown documents) * PlantUML markdown (again for arch. docs in markdown, but mainly for C4 diagrams) * a Docker container to render PlantUML markdown to images * Joplin, installed on every device I regularly use * NextCloud, to store, secure, encrypt, and make available everywhere, the markdown notes managed by Joplin