infra-bootstrap-tools
c4-notation
Our great sponsors
infra-bootstrap-tools | c4-notation | |
---|---|---|
5 | 125 | |
30 | 25 | |
- | - | |
6.8 | 10.0 | |
23 days ago | almost 5 years ago | |
HCL | ||
- | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
infra-bootstrap-tools
- How can I document an AWS project?
-
Ansible Usage
I have started to documents my infra for small projects here if you are interested: https://github.com/xNok/infra-bootstrap-tools
-
What is Terraform Cloud and why you might need it?
In this article, I will give you a tour of Terraform Cloud and the necessary explanations to get started. This piece is part of a series I created on How to create infrastructure for a small self-hosted project. You can find all the code here: https://github.com/xNok/infra-bootstrap-tools, but this article does not how much prior requirements if it is not being a little bit familiar with Terraform.
-
Docker Swarm is still Relevant for Small Self-hosted Projects -Experiment with Vagrant and Ansible
I want to remind you that the goal of this tutorial series is to document what I consider the bare minimum for a small self-hosted side project. I invite you to visit my repository for more information: https://github.com/xNok/infra-bootstrap-tools. At this point, we are doing the groundwork of setting up a server to host the application we will deploy later as docker containers.
-
A Disposable Local Test Environment is Essential for DevOps / SysAdmin
With a small project spread across several articles, I want to show you what I consider the minimum requirement for a small self-hosted project. I invite you to check my Github repository for other articles and more details about the whole project.
c4-notation
-
Show HN: Flyde – an open-source visual programming language
What you are describing sounds a lot like C4: https://c4model.com/
-
Ask HN: How do you document complex software systems?
The C4 model [0] provides a mostly sensible structure and techniques for representing pure software systems across different abstraction levels.
For systems involving software and hardware, or other complex interfacing (both technology and bureaucracy) this starts to delve into the universe of systems engineering. There's a decent assembly of knowledge on that in the SEBoK [1].
As another commenter has already called out too, one of the most valuable sources of information is also _why_ a system is in its current form and _how_ that's changed over time. ADR's [2] really do a good job at nailing this for just about any scale.
[0]: https://c4model.com
[1]: https://sebokwiki.org
[2]: https://adr.github.io
-
A View on Functional Software Architecture
There a various standards for documenting software architecture, like arc42 or C4. While useful and somewhat well-known (there is certainly a correlation here), here architecture documentation can be further simplified, particularly due to the self-similarity of project and component. Following is a small template, that can also serve as a project's and component's README:
- The C4 model for visualising software architecture
-
Inkscape Cloud Architect
I would suggest that if your architecture diagrams are a bunch of icons provided by AWS/Azure/GCP with lines pointing at each other... you are doing it wrong.
The 'what does this box do for my system' is vastly more important than the 'which in vogue offering from my cloud provider implements it'.
I highly suggest folks take a look at the C4 Model: https://c4model.com/
- What do you wish business folks knew about UML?
-
How to create interactive zoomable software architecture diagrams
We often use abstractions in software engineering to communicate complex architectures and software systems. In this article, we’ll discuss how abstractions are inherently hierarchical and how the C4 model provides a nested structure for defining your software architecture. We’ll then cover how IcePanel allows you to create interactive and zoomable diagrams for your audience to zoom in and out of different levels of technical detail.
-
Architecture diagrams enable better conversations
You probably want https://c4model.com/ which explains what a C4 architecture diagram is. (See the first footnote in the article.)
-
Do modern diagramming techniques play a crucial role in software development?
I looked at the book OP is talking about and it seems to be advocating 'C4' (https://c4model.com/). IMO this is the same kind of block diagrams we end up creating organically. I dunno that I'd call this 'modern' or anything special, it's just what everyone already does. I've done hundreds of these and not once has anyone ever mentioned 'C4' or anything being 'modern'. Shrug
What are some alternatives?
modules.tf-lambda - Infrastructure as code generator - from visual diagrams created with Cloudcraft.co to Terraform
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
ansible-dockerswarm - Docker Engine clustering using "Swarm Mode" and Ansible
backstage - Backstage is an open platform for building developer portals
ansible-docker-swarm - Initialize Docker Swarm with Ansible
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
ansible.traefik - Setup Traefik Proxy (https://docs.traefik.io/v2.0) using Docker
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
consul-template - Template rendering, notifier, and supervisor for @HashiCorp Consul and Vault data.
pumla - pumla - systematic re-use of model elements described with PlantUML
100_Days_Of_Go - 100 days of Go learning
plantuml - Generate diagrams from textual description