HiveBrain v1.2.0
Get Started
← Back to all entries
patternMinor

Is there an established scheme for creating diagrams about Containers, Services etc.?

Submitted by: @import:stackexchange-devops··
0
Viewed 0 times
schemecreatingservicesforaboutestablishedcontainerstherediagramsetc

Problem

We have UML to describe classes, components, workflows. We have BPMN to describe business processes. We have more old-fashioned forms used in times past for structural diagrams.

Is there anything established or semi-established in the DevOps world? The information contained in a simple diagram should be something like:

  • Which containers are there in a containerized app, including their associations (i.e. which statically depends on which for building) and the (micro)services they provide?



  • How do they interact dynamically (networking etc.)?



  • What responsibility does each of the containers fulfill?



  • What requirements does each container have on the host, if relevant?



  • ... and so on.



I'm neither asking for a list of any private schemes somebody may fancy, nor about opinions on which is the most beautiful.

I'm strictly asking about whether there exist any that either by purpose are industry standards or have turned out to just be used in many places by chance/convention.

The purpose of using such a scheme would be to have something that would instantly be recognized by fellow DevOps people; or which could easily be shown in contexts where it is not appropriate to look into Dockerfiles or other Infrastructure-as-code sources (e.g., when scribbling on a board, or holding a more abstract presentation).

Solution

The established method is infrastructure as code.

Want to find out what processes run in a container? Check the Dockerfile. Infrastructure dependencies? Check the Cloudformation template/Terraform blueprint. Interactions between containers? Check the docker-compose.yml or Kubernetes yaml file.

Context

StackExchange DevOps Q#2094, answer score: 2

Revisions (0)

No revisions yet.