From a8bbbacacd7c8dd06efc6bdcbef913605fdaf28b Mon Sep 17 00:00:00 2001 From: Bastian Eicher Date: Thu, 22 Jul 2021 17:39:22 +0200 Subject: [PATCH] Improved readme --- charts/generic-service/Chart.yaml | 4 ++-- charts/generic-service/README.md | 6 ++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/charts/generic-service/Chart.yaml b/charts/generic-service/Chart.yaml index e493092..bf9782c 100644 --- a/charts/generic-service/Chart.yaml +++ b/charts/generic-service/Chart.yaml @@ -1,5 +1,5 @@ apiVersion: v1 name: generic-service -version: 1.1.8 +version: 1.1.9 description: runs a service (with monitoring, ingress, etc.) -home: https://helm.nano-byte.net +home: https://github.com/nano-byte/helm-charts/tree/master/charts/generic-service diff --git a/charts/generic-service/README.md b/charts/generic-service/README.md index ca39259..10e9507 100644 --- a/charts/generic-service/README.md +++ b/charts/generic-service/README.md @@ -7,6 +7,8 @@ This Helm chart simplifies deploying a typical "80% case" service on Kubernetes. - [Jaeger Operator](https://www.jaegertracing.io/docs/latest/operator/) for tracing - [Flagger](https://flagger.app/) for canary deployments +The [Generic Service Grafana Dashboard](https://grafana.com/grafana/dashboards/14759) is a useful companion to this chart. + ## Getting started This chart is most commonly used as a dependency instead of installing it directly. You can reference it in your chart by adding this to your `Chart.yaml`: @@ -120,10 +122,10 @@ In addition to the environment variables specified via the `env` value, the foll This Helm chart generates a number of Resources based on the specified [Values](#values). These resources reference each other: -![Resources](docs/resources.svg) +![Resources](https://raw.githubusercontent.com/nano-byte/helm-charts/master/charts/generic-service/docs/resources.svg) Legend: -![Legend](docs/legend.svg) +![Legend](https://raw.githubusercontent.com/nano-byte/helm-charts/master/charts/generic-service/docs/legend.svg) **Deployment** Instructs Kubernetes to create a certain number of `Pod`s (`replicas`) running a specific `image`.