Skip to content

Commit

Permalink
updated docs and storage (#202)
Browse files Browse the repository at this point in the history
  • Loading branch information
paiusCatalin authored Dec 13, 2022
1 parent 1b1cbc4 commit 23fce9b
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 14 deletions.
2 changes: 1 addition & 1 deletion charts/grafana/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.0.1
version: 0.0.2

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
Expand Down
16 changes: 9 additions & 7 deletions charts/grafana/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# grafana

![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.1](https://img.shields.io/badge/AppVersion-0.0.1-informational?style=flat-square)
![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.1](https://img.shields.io/badge/AppVersion-0.0.1-informational?style=flat-square)

A Helm chart for Grafana

Expand All @@ -20,21 +20,21 @@ A Helm chart for Grafana

### Quick install with internal service of type NodePort

By default, this helm chart installs the Prometheus as NodePort.
By default, this helm chart installs the Grafana as NodePort.
This is to prevent exposing the service to the internet by accident!

It is recommended to put non-sensitive configuration values in a configuration file and pass sensitive/secret values via commandline.

1. Download the values from helm chart `prometheus` and update them accordingly
1. Download the values from helm chart `grafana` and update them accordingly

```shell
helm show values pharmaledger-imi/prometheus > my-values.yaml
helm show values pharmaledger-imi/grafana > my-values.yaml
```

2. Install via helm to namespace `default`

```bash
helm upgrade my-release-name pharmaledger-imi/prometheus --version=0.0.1 \
helm upgrade my-release-name pharmaledger-imi/grafana --version=0.0.2 \
--install \
--values my-values.yaml \
```
Expand All @@ -48,7 +48,7 @@ Run `helm upgrade --helm` for full list of options.
You can install into other namespace than `default` by setting the `--namespace` parameter, e.g.

```bash
helm upgrade my-release-name pharmaledger-imi/prometheus --version=0.0.1 \
helm upgrade my-release-name pharmaledger-imi/grafana --version=0.0.2 \
--install \
--namespace=my-namespace \
--values my-values.yaml \
Expand All @@ -59,7 +59,7 @@ Run `helm upgrade --helm` for full list of options.
Provide the `--wait` argument and time to wait (default is 5 minutes) via `--timeout`

```bash
helm upgrade my-release-name pharmaledger-imi/prometheus --version=0.0.1 \
helm upgrade my-release-name pharmaledger-imi/grafana --version=0.0.2 \
--install \
--wait --timeout=600s \
--values my-values.yaml \
Expand Down Expand Up @@ -94,6 +94,8 @@ Run `helm upgrade --helm` for full list of options.
| prometheus.serviceName | string | `"prometheus"` | |
| prometheus.servicePort | int | `9090` | |
| storageVolume.mountPath | string | `"/var/lib/grafana"` | |
| storageVolume.storageClassName | string | `""` | |
| storageVolume.storageSize | string | `"5Gi"` | |
| storageVolume.volumeName | string | `"grafana-storage-volume"` | |

----------------------------------------------
Expand Down
12 changes: 6 additions & 6 deletions charts/grafana/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@

### Quick install with internal service of type NodePort

By default, this helm chart installs the Prometheus as NodePort.
By default, this helm chart installs the Grafana as NodePort.
This is to prevent exposing the service to the internet by accident!

It is recommended to put non-sensitive configuration values in a configuration file and pass sensitive/secret values via commandline.

1. Download the values from helm chart `prometheus` and update them accordingly
1. Download the values from helm chart `grafana` and update them accordingly

```shell
helm show values pharmaledger-imi/prometheus > my-values.yaml
helm show values pharmaledger-imi/grafana > my-values.yaml
```

2. Install via helm to namespace `default`

```bash
helm upgrade my-release-name pharmaledger-imi/prometheus --version={{ template "chart.version" . }} \
helm upgrade my-release-name pharmaledger-imi/grafana --version={{ template "chart.version" . }} \
--install \
--values my-values.yaml \
```
Expand All @@ -48,7 +48,7 @@ Run `helm upgrade --helm` for full list of options.
You can install into other namespace than `default` by setting the `--namespace` parameter, e.g.

```bash
helm upgrade my-release-name pharmaledger-imi/prometheus --version={{ template "chart.version" . }} \
helm upgrade my-release-name pharmaledger-imi/grafana --version={{ template "chart.version" . }} \
--install \
--namespace=my-namespace \
--values my-values.yaml \
Expand All @@ -59,7 +59,7 @@ Run `helm upgrade --helm` for full list of options.
Provide the `--wait` argument and time to wait (default is 5 minutes) via `--timeout`

```bash
helm upgrade my-release-name pharmaledger-imi/prometheus --version={{ template "chart.version" . }} \
helm upgrade my-release-name pharmaledger-imi/grafana --version={{ template "chart.version" . }} \
--install \
--wait --timeout=600s \
--values my-values.yaml \
Expand Down
3 changes: 3 additions & 0 deletions charts/grafana/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ configMap:
storageVolume:
volumeName: grafana-storage-volume
mountPath: /var/lib/grafana
# If empty or not set then storage class will not be set - which means that the default storage class will be used.
storageClassName: ""
storageSize: 5Gi

prometheus:
serviceName: prometheus
Expand Down

0 comments on commit 23fce9b

Please sign in to comment.