Skip to content

Commit

Permalink
Improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bastianeicher committed Jul 22, 2021
1 parent c5b2397 commit a8bbbac
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
4 changes: 2 additions & 2 deletions charts/generic-service/Chart.yaml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 4 additions & 2 deletions charts/generic-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down Expand Up @@ -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`.
Expand Down

0 comments on commit a8bbbac

Please sign in to comment.