Merge pull request #39 from Ortec-Finance/demo-overlay

Adding Demo Overlay
# Conflicts:
#	k8s/sailfish/overlays/demo/kustomization.yaml

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v0.15.0
+Adding Overlays for Demo
+
 ## v0.14.0
 Added a new component that allows you to set the Sailfish Broker in High Availability
 This will make your Queue Messages Zone redundant, which means if one zone goes down, the messages will be migrated to another.

docs/features/observability.md

@@ -0,0 +1,39 @@
+# Observability
+
+In the `k8s/observability` folder is a Grafana Dashboard included.
+If you want to integrate these Grafana dashboards you have to patch `/metadata/labels/app` with the name of your `dashboardLabelSelector` of your Grafana's configuration.
+
+You can use inline patching in your ArgoCD Application, like such:
+
+```
+apiVersion: argoproj.io/v1alpha1
+kind: Application
+metadata:
+  name: sailfish-observability
+spec:
+  destination:
+    server: 'https://kubernetes.default.svc'
+  project: sailfish
+  source:
+    path: k8s/observability
+    repoURL: 'https://github.com/Ortec-Finance/sailfish-hpc.git'
+    targetRevision: 'main'
+    kustomize:
+      patches:
+        - target:
+            version: v1alpha1
+            group: integreatly.org
+            kind: GrafanaDashboard
+            name: sailfish-monitoring-dashboard
+          patch: |-
+            - op: replace
+              path: /metadata/labels/app
+              value: my_dashboard_label_selector
+  syncPolicy:
+    automated:
+      prune: true
+      selfHeal: true
+```
+You can find more about this feature [here](https://argo-cd.readthedocs.io/en/stable/user-guide/kustomize/)
+
+If you make any improvements to this dashboard please contribute them back to this repo!

k8s/sailfish/overlay/kustomization.yaml → k8s/sailfish/overlays/demo/kustomization.yaml

@@ -1,10 +1,10 @@
 resources:
- - ../base/prometheus-trigger
+ - ../../base/prometheus-trigger
 
 components:
- - ../components/sailfish-gateway
- - ../components/broker-scale-to-zero
- - ../components/high-availability
+ - ../../components/sailfish-gateway
+ - ../../components/broker-scale-to-zero
+ - ../../components/high-availability
 
 
 

sailfish-example/argocd/apps/sailfish.yaml

@@ -33,7 +33,7 @@ spec:
       - /spec/triggers/4/metadata/namespace
       - /spec/triggers/5/metadata/namespace
   source:
-    path: k8s/sailfish/overlay
+    path: k8s/sailfish/overlays/demo
     repoURL: 'https://github.com/Ortec-Finance/sailfish-hpc.git'
     targetRevision: 'main'
   syncPolicy: