Skip to content

Commit

Permalink
Merge pull request #1 from japerezjr/kustomize_helm_grafana
Browse files Browse the repository at this point in the history
Added example files and updated grafana docs
  • Loading branch information
cblument authored Mar 20, 2024
2 parents 2397292 + 90ff8ec commit 6b55c7e
Show file tree
Hide file tree
Showing 7 changed files with 130 additions and 40 deletions.
87 changes: 50 additions & 37 deletions docs/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@

In order to avoid putting sensative information on the cli, it is recommended to create and use a secret file instead.

You can base64 encode your `client_id` and `client_secret` by using the echo and base64 command:

``` shell
echo -n "YOUR CLIENT ID OR SECRET" | base64
```

This example file is located at `/opt/genestack/kustomize/grafana/base`
example secret file:

``` yaml
Expand All @@ -31,40 +38,17 @@ type: opaque
---
## Create a datasources yaml
If you have specific datasources that should be populated when grafana deploys, create a seperate datasource.yaml. The example below shows one way to configure prometheus and loki datasources.
example datasources yaml file:
``` yaml
datasources:
datasources.yaml:
apiversion: 1
datasources:
- name: prometheus
type: prometheus
access: proxy
url: http://kube-prometheus-stack-prometheus.prometheus.svc.cluster.local:9090
isdefault: true
- name: loki
type: loki
access: proxy
url: http://loki-gateway.{{ .release.namespace }}.svc.cluster.local:80
editable: false
```
---
## Create your ssl files
If you are configuring grafana to use tls/ssl, you should create a file for your certificate and a file for your key. After the deployment, these files can be deleted if desired since the cert and key will now be in a Kubernetes secret.
Your cert and key files should look something like the following (cert and key example taken from [VMware Docs](https://docs.vmware.com/en/VMware-NSX-Data-Center-for-vSphere/6.4/com.vmware.nsx.admin.doc/GUID-BBC4804F-AC54-4DD2-BF6B-ECD2F60083F6.html "VMware Docs")).
These example files are located in `/opt/genestack/kustomize/grafana/base`

??? example

=== "Cert file"
=== "Cert file (example-cert.pem)"
```
-----BEGIN CERTIFICATE-----
MIID0DCCARIGAWIBAGIBATANBGKQHKIG9W0BAQUFADB/MQSWCQYDVQQGEWJGUJET
Expand All @@ -91,7 +75,7 @@ Your cert and key files should look something like the following (cert and key e
-----END CERTIFICATE-----
```

=== "Key file"
=== "Key file (example-key.pem)"
```
-----BEGIN RSA PRIVATE KEY-----
MIIEOWIBAAKCAQEAVPNAPKLIKDVX98KW68LZ8PGARRCYERSNGQPJPIFMVJJE8LUC
Expand Down Expand Up @@ -124,17 +108,46 @@ Your cert and key files should look something like the following (cert and key e

---

## Add repo and install
## Update datasources.yaml

``` shell
helm repo add grafana https://grafana.github.io/helm-charts
helm repo update
kubectl create ns grafana
kubectl -n grafana create secret tls grafana-tls-public --cert=your_cert_file --key=your_key_file
The datasource.yaml file is located at `/opt/genestack/kustomize/grafana/base`

kubectl -n grafana create secret generic azure-client --type opaque --from-literal=client_id="your_client_id" --from-literal=client_secret="your_client_secret"
or
kubectl -n grafana apply -f azure-secrets.yaml
If you have specific datasources that should be populated when grafana deploys, update the datasource.yaml to use your values. The example below shows one way to configure prometheus and loki datasources.

example datasources.yaml file:

``` yaml
datasources:
datasources.yaml:
apiversion: 1
datasources:
- name: prometheus
type: prometheus
access: proxy
url: http://kube-prometheus-stack-prometheus.prometheus.svc.cluster.local:9090
isdefault: true
- name: loki
type: loki
access: proxy
url: http://loki-gateway.{{ $.Release.Namespace }}.svc.cluster.local:80
editable: false
```

---

## Update grafana-values.yaml

The grafana-values.yaml file is located at `/opt/genestack/kustomize/grafana/base`

You must edit this file to include your specific url and azure tenant id

---

## Create the tls secret and install

``` shell
kubectl -n grafana create secret tls grafana-tls-public --cert=/opt/genestack/kustomize/grafana/base/cert.pem --key=/opt/genestack/kustomize/grafana/base/key.pem
helm upgrade --install grafana grafana/grafana --namespace grafana --values overrides.yaml -f datasources.yaml --set tenant_id=your_tenant_id --set custom_host=your_url_for_ingress
kubectl kustomize --enable-helm /opt/genestack/kustomize/grafana/base | \
kubectl -n grafana -f -
```
9 changes: 9 additions & 0 deletions kustomize/grafana/base/azure-client-secret.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
apiversion: v1
data:
client_id: base64_encoded_client_id
client_secret: base64_encoded_client_secret
kind: secret
metadata:
name: azure-client
namespace: grafana
type: opaque
14 changes: 14 additions & 0 deletions kustomize/grafana/base/datasources.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
datasources:
datasources.yaml:
apiversion: 1
datasources:
- name: prometheus
type: prometheus
access: proxy
url: http://kube-prometheus-stack-prometheus.prometheus.svc.cluster.local:9090
isdefault: true
- name: loki
type: loki
access: proxy
url: http://loki-gateway.{{ $.Release.Namespace }}.svc.cluster.local:80
editable: false
23 changes: 23 additions & 0 deletions kustomize/grafana/base/example-cert.pem
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
-----BEGIN CERTIFICATE-----
MIID0DCCARIGAWIBAGIBATANBGKQHKIG9W0BAQUFADB/MQSWCQYDVQQGEWJGUJET
MBEGA1UECAWKU29TZS1TDGF0ZTEOMAWGA1UEBWWFUGFYAXMXDTALBGNVBAOMBERP
BWKXDTALBGNVBASMBE5TQLUXEDAOBGNVBAMMB0RPBWKGQ0EXGZAZBGKQHKIG9W0B
CQEWDGRPBWLAZGLTAS5MCJAEFW0XNDAXMJGYMDM2NTVAFW0YNDAXMJYYMDM2NTVA
MFSXCZAJBGNVBAYTAKZSMRMWEQYDVQQIDAPTB21LLVN0YXRLMSEWHWYDVQQKDBHJ
BNRLCM5LDCBXAWRNAXRZIFB0ESBMDGQXFDASBGNVBAMMC3D3DY5KAW1PLMZYMIIB
IJANBGKQHKIG9W0BAQEFAAOCAQ8AMIIBCGKCAQEAVPNAPKLIKDVX98KW68LZ8PGA
RRCYERSNGQPJPIFMVJJE8LUCOXGPU0HEPNNTUJPSHBNYNKCVRTWHN+HAKBSP+QWX
SXITRW99HBFAL1MDQYWCUKOEB9CW6INCTVUN4IRVKN9T8E6Q174RBCNWA/7YTC7P
1NCVW+6B/AAN9L1G2PQXGRDYC/+G6O1IZEHTWHQZE97NY5QKNUUVD0V09DC5CDYB
AKJQETWWV6DFK/GRDOSED/6BW+20Z0QSHPA3YNW6QSP+X5PYYMDRZRIR03OS6DAU
ZKCHSRYC/WHVURX6O85D6QPZYWO8XWNALZHXTQPGCIA5SU9ZIYTV9LH2E+LSWWID
AQABO3SWETAJBGNVHRMEAJAAMCWGCWCGSAGG+EIBDQQFFH1PCGVUU1NMIEDLBMVY
YXRLZCBDZXJ0AWZPY2F0ZTADBGNVHQ4EFGQU+TUGFTYN+CXE1WXUQEA7X+YS3BGW
HWYDVR0JBBGWFOAUHMWQKBBRGP87HXFVWGPNLGGVR64WDQYJKOZIHVCNAQEFBQAD
GGEBAIEEMQQHEZEXZ4CKHE5UM9VCKZKJ5IV9TFS/A9CCQUEPZPLT7YVMEVBFNOC0
+1ZYR4TXGI4+5MHGZHYCIVVHO4HKQYM+J+O5MWQINF1QOAHUO7CLD3WNA1SKCVUV
VEPIXC/1AHZRG+DPEEHT0MDFFOW13YDUC2FH6AQEDCEL4AV5PXQ2EYR8HR4ZKBC1
FBTUQUSVA8NWSIYZQ16FYGVE+ANF6VXVUIZYVWDRPRV/KFVLNA3ZPNLMMXU98MVH
PXY3PKB8++6U4Y3VDK2NI2WYYLILS8YQBM4327IKMKDC2TIMS8U60CT47MKU7ADY
CBTV5RDKRLAYWM5YQLTIGLVCV7O=
-----END CERTIFICATE-----
27 changes: 27 additions & 0 deletions kustomize/grafana/base/example-key.pem
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
-----BEGIN RSA PRIVATE KEY-----
MIIEOWIBAAKCAQEAVPNAPKLIKDVX98KW68LZ8PGARRCYERSNGQPJPIFMVJJE8LUC
OXGPU0HEPNNTUJPSHBNYNKCVRTWHN+HAKBSP+QWXSXITRW99HBFAL1MDQYWCUKOE
B9CW6INCTVUN4IRVKN9T8E6Q174RBCNWA/7YTC7P1NCVW+6B/AAN9L1G2PQXGRDY
C/+G6O1IZEHTWHQZE97NY5QKNUUVD0V09DC5CDYBAKJQETWWV6DFK/GRDOSED/6B
W+20Z0QSHPA3YNW6QSP+X5PYYMDRZRIR03OS6DAUZKCHSRYC/WHVURX6O85D6QPZ
YWO8XWNALZHXTQPGCIA5SU9ZIYTV9LH2E+LSWWIDAQABAOIBAFML8CD9A5PMQLW3
F9BTTQZ1SRL4FVP7CMHSXHVJSJEHWHHCKEE0OBKWTRSGKTSM1XLU5W8IITNHN0+1
INR+78EB+RRGNGDAXH8DIODKEY+8/CEE8TFI3JYUTKDRLXMBWIKSOUVVIUMOQ3FX
OGQYWQ0Z2L/PVCWY/Y82FFQ3YSC5GAJSBBYSCRG14BQO44ULRELE4SDWS5HCJKYB
EI2B8COMUCQZSOTXG9NILN/JE2BO/I2HGSAWIBGCODBMS8K6TVSSRZMR3KJ5O6J+
77LGWKH37BRVGBVYVBQ6NWPL0XLG7DUV+7LWEO5QQAPY6AXB/ZBCKQLQU6/EJOVE
YDG5JQECGYEA9KKFTZD/WEVAREA0DZFEJRU8VLNWOAGL7CJAODXQXOS4MCR5MPDT
KBWGFKLFFH/AYUNPBLK6BCJP1XK67B13ETUA3I9Q5T1WUZEOBIKKBLFM9DDQJT43
UKZWJXBKFGSVFRYPTGZST719MZVCPCT2CZPJEGN3HLPT6FYW3EORNOECGYEAXIOU
JWXCOMUGAB7+OW2TR0PGEZBVVLEGDKAJ6TC/HOKM1A8R2U4HLTEJJCRLLTFW++4I
DDHE2DLER4Q7O58SFLPHWGPMLDEZN7WRLGR7VYFUV7VMAHJGUC3GV9AGNHWDLA2Q
GBG9/R9OVFL0DC7CGJGLEUTITCYC31BGT3YHV0MCGYEA4K3DG4L+RN4PXDPHVK9I
PA1JXAJHEIFEHNAW1D3VWKBSKVJMGVF+9U5VEV+OWRHN1QZPZV4SURI6M/8LK8RA
GR4UNM4AQK4K/QKY4G05LKRIK9EV2CGQSLQDRA7CJQ+JN3NB50QG6HFNFPAFN+J7
7JUWLN08WFYV4ATPDD+9XQECGYBXIZKZFL+9IQKFOCONVWAZGO+DQ1N0L3J4ITIK
W56CKWXYJ88D4QB4EUU3YJ4UB4S9MIAW/ELEWKZIBWPUPFAN0DB7I6H3ZMP5ZL8Q
QS3NQCB9DULMU2/TU641ERUKAMIOKA1G9SNDKAZUWO+O6FDKIB1RGOBK9XNN8R4R
PSV+AQKBGB+CICEXR30VYCV5BNZN9EFLIXNKAEMJURYCXCRQNVRNUIUBVAO8+JAE
CDLYGS5RTGOLZIB0IVERQWSP3EI1ACGULTS0VQ9GFLQGAN1SAMS40C9KVNS1MLDU
LHIHYPJ8USCVT5SNWO2N+M+6ANH5TPWDQNEK6ZILH4TRBUZAIHGB
-----END RSA PRIVATE KEY-----
7 changes: 4 additions & 3 deletions kustomize/grafana/base/grafana-values.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
custom_host: grafana.example.com # TODO: update this value. Can be set in CLI.
tenant_id: 122333 # TODO: update this value. Can be set in CLI.

#### EDIT THESE TWO VARIABLES WITH YOUR VALUES
custom_host: grafana.example.com # TODO: update this value to the FQDN of your grafana site
tenant_id: 122333 # TODO: update this value to use your Azure Tenant ID
####

ingress:
enabled: true
Expand Down
3 changes: 3 additions & 0 deletions kustomize/grafana/base/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
resources:
- ns-grafana.yaml
- azure-client-secret.yaml
- grafana-database.yaml

helmCharts:
Expand All @@ -8,3 +9,5 @@ helmCharts:
releaseName: grafana
namespace: grafana
valuesFile: grafana-values.yaml
additionalValuesFiles:
- datasources.yaml

0 comments on commit 6b55c7e

Please sign in to comment.