From 43eefec47ba23162610cf0cc28eaa8ea652b685d Mon Sep 17 00:00:00 2001 From: Philippe Merle Date: Sun, 29 Dec 2024 07:20:00 +0100 Subject: [PATCH] Document where the mapping between supported Kubernetes resources and architecture diagrams is defined --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 56b9e8d..3f7f6e2 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,8 @@ Supported `kind`/`apiVersion` resource types are 26 ones: * StorageClass/storage.k8s.io/v1 * User/rbac.authorization.k8s.io/v1 +**Note**: The mapping between these supported Kubernetes resources and architecture diagrams is defined into [bin/kube-diagrams.yml](bin/kube-diagrams.yaml#L24). + Currently, unsupported `kind`/`apiGroup` resource types are 33 ones: * Binding/ * ComponentStatus/ @@ -137,7 +139,7 @@ With **KubeDiagrams**, Kubernetes resources can be clustered within the architec | `app.kubernetes.io/component` | K8s Component | | `tier` | Tier | -New mappings can be easily defined in custom configuration files (see [examples/minikube/KubeDiagrams.yml](examples/minikube/KubeDiagrams.yml#L2) and [examples/k0s/KubeDiagrams.yml](examples/k0s/KubeDiagrams.yml#L5) and provided to **KubeDiagrams** via the `--config` command-line option. +New mappings can be easily defined in custom configuration files (see [examples/minikube/KubeDiagrams.yml](examples/minikube/KubeDiagrams.yml#L2) and [examples/k0s/KubeDiagrams.yml](examples/k0s/KubeDiagrams.yml#L5)) and provided to **KubeDiagrams** via the `--config` command-line option. ## License