Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kocierik/k8s-to-diagram
generate a diagram architecture from kubernetes manifests
https://github.com/kocierik/k8s-to-diagram
Last synced: 10 days ago
JSON representation
generate a diagram architecture from kubernetes manifests
- Host: GitHub
- URL: https://github.com/kocierik/k8s-to-diagram
- Owner: kocierik
- License: mit
- Created: 2024-07-20T11:26:20.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-09-01T12:04:50.000Z (5 months ago)
- Last Synced: 2024-09-13T14:08:29.567Z (5 months ago)
- Language: Go
- Homepage:
- Size: 296 KB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kubernetes-architecture-diagrams - K8s Diagram architecture generator
- awesome-kubernetes-architecture-diagrams - K8s Diagram architecture generator
README
# K8s Diagram architecture generator
A tool for visualizing Kubernetes infrastructure manifest using [d2](https://github.com/terrastruct/d2).
## Overview
This program reads Kubernetes YAML manifests and generates a visual diagram of the infrastructure and its connections. By parsing the `communication` annotations from the Kubernetes manifests, it creates a diagram showing how different services and deployments interact with each other.
## Features
- **Parse Kubernetes YAML manifests**: Reads and parses Kubernetes manifests from a directory.
- **Generate diagrams**: Creates a visual representation of the infrastructure based on communication annotations.
- **Output formats**: Generates diagrams in both SVG and PNG formats.
## Installation
1. **Clone the repository:**
```bash
git clone [email protected]:kocierik/k8s-to-diagram.git
cd k8s-to-diagram
```
2. **Build the application:**
```bash
go build -o k8s-diagram
```
## Running with Docker
You can also run the application using Docker, which makes it easier to manage dependencies and run the program in a consistent environment.
1. **Build the Docker image:**
```bash
docker build -t diagram:1.0 .
```
2. **Run the Docker container:**
```bash
docker run -v ./manifests:/manifests -v ./images:/images diagram:1.0
```
## Configuration
Ensure that your Kubernetes YAML manifests include `communication` annotations in the following example format:
```yaml
metadata:
annotations:
communication: |
{
"name": "service-name-0",
"inbound": [
{"service": "service-name-1", "port": 1234}
],
"outbound": [
{"service": "service-name-2", "port": 1234}
]
}
```
## Troubleshooting
- **Ensure valid YAML**: Make sure your YAML files are correctly formatted and valid.
- **Correct directory**: Verify that the manifest directory path is correctly specified.
- **Check annotations**: Ensure that communication annotations are correctly formatted and included in the manifests.
## Contributing
Feel free to contribute by submitting issues or pull requests. Please adhere to the coding standards and ensure your contributions are well-tested.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/kocierik/k8s-to-diagram/blob/main/LICENSE) file for details.