https://github.com/kahowell/kube-diagram
Experimental cli tool to generate plantuml diagrams of k8s/openshift resources
https://github.com/kahowell/kube-diagram
k8s kubernetes plantuml
Last synced: 3 months ago
JSON representation
Experimental cli tool to generate plantuml diagrams of k8s/openshift resources
- Host: GitHub
- URL: https://github.com/kahowell/kube-diagram
- Owner: kahowell
- License: apache-2.0
- Created: 2022-01-10T17:41:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-14T14:40:34.000Z (over 3 years ago)
- Last Synced: 2025-01-25T04:47:43.862Z (4 months ago)
- Topics: k8s, kubernetes, plantuml
- Language: Java
- Homepage:
- Size: 65.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-kubernetes-architecture-diagrams - kube-diagram - at/kahowell/kube-diagram)   |  | (Generation Tools / Comparison Table)
- awesome-kubernetes-architecture-diagrams - kube-diagram - at/kahowell/kube-diagram)   |  | (Generation Tools / Comparison Table)
README
# kube-diagram Project
This project uses Quarkus, the Supersonic Subatomic Java Framework.
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
## Running the application in dev mode
You can run your application in dev mode that enables live coding using:
```shell script
./mvnw compile quarkus:dev
```
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
## Packaging and running the application
The application can be packaged using:
```shell script
./mvnw package
```
It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory.
Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory.
The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`.
If you want to build an _über-jar_, execute the following command:
```shell script
./mvnw package -Dquarkus.package.type=uber-jar
```
The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`.
## Creating a native executable
You can create a native executable using:
```shell script
./mvnw package -Pnative
```
Or, if you don't have GraalVM installed, you can run the native executable build in a container using:
```shell script
./mvnw package -Pnative -Dquarkus.native.container-build=true
```
You can then execute your native executable with: `./target/kube-diagram-1.0.0-SNAPSHOT-runner`
If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.
## Related Guides
- Picocli ([guide](https://quarkus.io/guides/picocli)): Develop command line applications with Picocli
## Provided Code
### Picocli Example
Hello and goodbye are civilization fundamentals. Let's not forget it with this example picocli application by changing the command and parameters.
[Related guide section...](https://quarkus.io/guides/picocli#command-line-application-with-multiple-commands)
Also for picocli applications the dev mode is supported. When running dev mode, the picocli application is executed and on press of the Enter key, is restarted.
As picocli applications will often require arguments to be passed on the commandline, this is also possible in dev mode via:
```shell script
./mvnw compile quarkus:dev -Dquarkus.args='Quarky'
```