From 23fce9b8dc1d1f8f16222b3a9cb41039ff01a84d Mon Sep 17 00:00:00 2001 From: Paraschiv-Catalin Paius Date: Tue, 13 Dec 2022 07:52:49 +0100 Subject: [PATCH] updated docs and storage (#202) --- charts/grafana/Chart.yaml | 2 +- charts/grafana/README.md | 16 +++++++++------- charts/grafana/README.md.gotmpl | 12 ++++++------ charts/grafana/values.yaml | 3 +++ 4 files changed, 19 insertions(+), 14 deletions(-) diff --git a/charts/grafana/Chart.yaml b/charts/grafana/Chart.yaml index 494da74..5b4b0ca 100644 --- a/charts/grafana/Chart.yaml +++ b/charts/grafana/Chart.yaml @@ -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 diff --git a/charts/grafana/README.md b/charts/grafana/README.md index 9879ec2..9dc1c25 100644 --- a/charts/grafana/README.md +++ b/charts/grafana/README.md @@ -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 @@ -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 \ ``` @@ -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 \ @@ -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 \ @@ -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"` | | ---------------------------------------------- diff --git a/charts/grafana/README.md.gotmpl b/charts/grafana/README.md.gotmpl index 3e1ede2..2f1a186 100644 --- a/charts/grafana/README.md.gotmpl +++ b/charts/grafana/README.md.gotmpl @@ -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 \ ``` @@ -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 \ @@ -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 \ diff --git a/charts/grafana/values.yaml b/charts/grafana/values.yaml index 20c8ff1..c498683 100644 --- a/charts/grafana/values.yaml +++ b/charts/grafana/values.yaml @@ -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