From ad0d1b7bc78cc078d623d6f68ff76841a93292dc Mon Sep 17 00:00:00 2001 From: Philippe MERLE Date: Thu, 2 Jul 2026 13:35:27 +0200 Subject: [PATCH] Improve README.md --- webapp/README.md | 30 ++++++++++++++---------------- 1 file changed, 14 insertions(+), 16 deletions(-) diff --git a/webapp/README.md b/webapp/README.md index 9d321c0..c66ba03 100644 --- a/webapp/README.md +++ b/webapp/README.md @@ -1,13 +1,11 @@ -## Project Structure -Web Interface for generating Kubernetes diagrams from manifests, Helm charts, or Helmfile files using Kubediagrams. # KubeDiagrams Web App -A modern web application for generating Kubernetes architecture diagrams from manifests, Helm charts, or Helmfile configurations using [KubeDiagrams](https://github.com/philippemerle/KubeDiagrams). +A modern web application for generating Kubernetes architecture diagrams from manifests, Helm charts, Helmfile configurations, and live cluster state using [KubeDiagrams](https://github.com/philippemerle/KubeDiagrams). ## Features -- **Multiple Input Types**: Support for Kubernetes manifests, Helm charts, Helmfile configurations, and live cluster diagrams -- **Flexible Output Formats**: Generate diagrams in PNG, SVG, PDF, DOT, and interactive HTML +- **Multiple Input Types**: Support for Kubernetes manifests, Helm charts, Helmfile configurations, and live cluster state +- **Flexible Output Formats**: Generate diagrams in PNG, JPEG, SVG, PDF, DOT, interactive HTML, and draw.io - **Interactive Viewer**: Explore diagrams with an interactive web viewer - **Built-in Examples**: Pre-loaded examples for quick testing - **History Management**: Keep track of your diagram generations @@ -30,7 +28,7 @@ cd KubeDiagrams/webapp #### 2. **Start the application** ```bash -docker-compose up -d +docker compose up -d ``` #### 3. **Access the application** @@ -42,7 +40,7 @@ That's it! The application is now running with both frontend and backend service #### Stopping the application ```bash -docker-compose down +docker compose down ``` --- @@ -58,7 +56,7 @@ The following command-line tools must be installed and available in your PATH: ### Docker Deployment - Docker Engine 20.10+ -- Docker Compose +- Docker Compose ### Manual Deployment - **Backend**: Python 3.8+, pip, venv @@ -219,25 +217,25 @@ The Docker Compose setup consists of two services: #### **Build and start services** ```bash -docker-compose up --build +docker compose up --build ``` #### **Start in detached mode** ```bash -docker-compose up -d +docker compose up -d ``` #### **View logs** ```bash -docker-compose logs -f +docker compose logs -f ``` #### **Stop services** ```bash -docker-compose down +docker compose down ``` ### Health Checks @@ -314,7 +312,7 @@ Generate diagrams from Helmfile configurations. 4. Click "Generate Diagram" **Requirement**: `helmfile` must be installed on the server. -5. + ### 4. Cluster Tab Generate diagrams from a live Kubernetes cluster. **Steps**: @@ -323,12 +321,12 @@ Generate diagrams from a live Kubernetes cluster. 3. Optionally specify a namespace (leave empty to diagram all namespaces) 4. Configure diagram options 5. Click "Generate Cluster Diagram" -**Requirements**: +**Requirements**: - `kubectl-diagrams` must be installed on the server - Server must have access to a Kubernetes cluster via kubeconfig - Proper RBAC permissions to read cluster resources **Note**: This uses the server's kubectl configuration, not the client's. -6. + ### 5. Interactive Viewer View diagrams in an interactive HTML viewer with zoom, pan, and search capabilities. @@ -344,7 +342,7 @@ View diagrams in an interactive HTML viewer with zoom, pan, and search capabilit ### Diagram Options -- **Format**: PNG, SVG, PDF, DOT, Interactive HTML +- **Format**: PNG, JPEG, SVG, PDF, DOT, Interactive HTML, draw.io - **CLI Arguments**: Optional custom parameters passed to the underlying KubeDiagrams tools - **Without Namespace**: Option to generate diagrams without namespace grouping - **Feedback System**: Rate diagrams (1-5 stars) and provide comments for improvement