Helm Chart Release 7.0.2186

oneuptime-7.0.2186.tgz.prov

@@ -0,0 +1,47 @@
+-----BEGIN PGP SIGNED MESSAGE-----
+Hash: SHA512
+
+annotations:
+  artifacthub.io/category: monitoring-logging
+  artifacthub.io/license: MIT
+  artifacthub.io/prerelease: "false"
+  artifacthub.io/signKey: |
+    fingerprint: 83F2C1DDF58A052464C4A1729D87E494AC016697
+    url: https://keybase.io/oneuptime/pgp_keys.asc
+apiVersion: v2
+appVersion: 7.0.2186
+dependencies:
+- - name: postgresql
+  repository: https://charts.bitnami.com/bitnami
+  version: 14.0.0
+- - name: redis
+  repository: https://charts.bitnami.com/bitnami
+  version: 18.19.1
+- - name: clickhouse
+  repository: https://charts.bitnami.com/bitnami
+  version: 5.1.0
+description: The Complete Open-Source Observability Platform
+icon: https://raw.githubusercontent.com/OneUptime/oneuptime/master/App/FeatureSet/Home/Static/img/OneUptimePNG/1.png
+name: oneuptime
+type: application
+version: 7.0.2186
+
+...
+files:
+  oneuptime-7.0.2186.tgz: sha256:3c0b4476f6068e9f597b841f64cda691c703988c056735fe4d27fad4ddb6cba6
+-----BEGIN PGP SIGNATURE-----
+
+wsFcBAEBCgAQBQJmMh/9CRCdh+SUrAFmlwAAR30QAKwetlC1PLTSzrM5VSd+RCfR
+MJVOqtecByWWQaGVtCzxLMbsVp1nvo0/p6kw5WsVb7hgypfXz44yQMN6DEO+sfwv
+FPzanFk/9b9OLDBsBopTx1IgGL+YKCcrVZhdvzxbWdM4rvFk4r7mVvQAFcjXYDQp
+0+QIz3bdHEzbYl/Ai6++OToIHfbgYFcSTwRVepBgntNEco0v6MUT0flytjCM1Ao4
+sCRi9e3KHyNpi79kmfhayZIftFqxv1JSP+xoGzCYlRciC6xIf0c8jjio5OmR/ach
+o3cs4edvojXgiLbw4Tqp82WfTfj45GPFASGi1P7tjwTewnOe1fSUO7C9RmYyoAt5
+QNaKsea0y5NMbitYmR2XFFrI8CPsbu4Dji5dUoCbup+POt7h/cuxvpEJfGvFfkhU
+LwPKJleyHGIlJY9gDaRbbzIVnWgYHq74hD5epS/ZbR8t5VBtISYXEg1lU2otUSbs
+DPmxaWBEzXwwvpXaEMgexvOlMahMrS4FXG8HujhRmfT/OpSheczB/ZyQ+Udct+N+
+846rI8d3WZ6F0AVSBTlxNDrqYRZo80o80eMT6CvuBI+H9fsM884MG+TcEeO69a/v
+ONM7fVnx0MBcwUOUJ8Yq+of32k5TDgZ+4OWMvSTrAFhqjm+LhucMBe44OLoeY2P7
+dms0Yk0GBJuLlgSQVSSO
+=lw/Q
+-----END PGP SIGNATURE-----

oneuptime/README.md

@@ -1,5 +1,5 @@
 <!-- markdownlint-disable MD033 -->
-<h1 align="center"><img alt="oneuptime logo" width=50% src="https://raw.githubusercontent.com/OneUptime/oneuptime/master/Home/public/img/OneUptimePNG/7.png"/></h1>
+<h1 align="center"><img alt="oneuptime logo" width=50% src="https://raw.githubusercontent.com/OneUptime/oneuptime/master/App/FeatureSet/Home/Static/img/OneUptimePNG/7.png"/></h1>
 <!-- markdownlint-enable MD033 -->
 
 # OneUptime Helm Chart
@@ -48,7 +48,7 @@ helm install my-oneuptime oneuptime/oneuptime -f values.yaml
 ## Uninstall Helm Chart
 
 ```console
-helm uninstall my-release
+helm uninstall my-oneuptime
 ```
 
 ## Configuration
@@ -72,8 +72,8 @@ The following table lists the configurable parameters of the OneUptime chart and
 | `autoScaling.targetCPUUtilizationPercentage` | Target CPU utilization percentage | `80` | |
 | `autoScaling.targetMemoryUtilizationPercentage` | Target memory utilization percentage | `80` | |
 | `nodeEnvironment` | Node environment (please dont change this unless you're doing local development) | `production` | |
-| `ingress.service.type` | Ingress service type | `LoadBalancer` | |
-| `ingress.service.loadBalancerIP` | Ingress service load balancer IP | `nil` | |
+| `nginx.service.type` | nginx service type | `LoadBalancer` | |
+| `nginx.service.loadBalancerIP` | nginx service load balancer IP | `nil` | |
 | `deployment.replicaCount` | Number of replicas | `1` | |
 | `probe.<key>.name` | Probe name | `<key>` | |
 | `probe.<key>.description` | Probe description | `nil` | |
@@ -92,6 +92,12 @@ The following table lists the configurable parameters of the OneUptime chart and
 | `nodeSelector` | Node Selector. Please refer to Kubernetes documentation on how to use them. | `{}` |  |
 | `tolerations` | Tolerations. Please refer to Kubernetes documentation on how to use them. | `[]` |  |
 | `affinity` | Affinity. Please refer to Kubernetes documentation on how to use them. | `{}` |  |
+| `extraTemplates` | Extra templates to be added to the deployment | `[]` |  |
+| `ingress.enabled` | Enable ingress | `true` |  |
+| `ingress.annotations` | Ingress annotations | `{}` |  |
+| `ingress.hosts` | Ingress hosts | `[]` |  |
+| `ingress.tls` | Ingress TLS. Please refer to values.yaml to set these | `[]` |  |
+| `ingress.className` | Ingress class name. Change this to your cloud providers ingress class | `nginx` |  |
 
 
 ## Adding a Custom Domain to your Status Page
@@ -119,6 +125,51 @@ Please go to your status page settings and add the custom domain to your status
 
 Once you have added the custom domain, you can access your status page using the custom domain.
 
+## Production Readiness Checklist
+
+Please go through the following checklist to make sure your OneUptime installation is production ready.
+
+- [ ] Please pin OneUptime version to a specific version. This will prevent any breaking changes from affecting your installation.
+
+When you install, you can check the latest version from the github releases page https://github.com/OneUptime/oneuptime/releases. You can pin the version in your values.yaml file.
+
+```
+image:
+  tag: <specific-version>
+```
+
+- [ ] Please pin Postgresql, Redis and Clickhouse versions to a specific version. This will prevent any breaking changes from affecting your installation.
+
+When you install, you can check the version installed by describing the pods. 
+
+```
+kubectl describe pod <pod-name>
+```
+
+For example: 
+
+```
+kubectl describe pod my-oneuptime-postgresql-0
+```
+
+Once you have the version, you can pin the version in your values.yaml file.
+
+```
+postgresql:
+  image:
+    tag: <specific-version>
+```
+
+Please do the same for Redis and Clickhouse.
+
+- [ ] Please make sure you have a backups enabled for your PVCs. This is outside the scope of this chart. Please refer to your cloud provider's documentation on how to enable backups for PVCs.
+- [ ] Please make sure you have static passwords for your database passswords (for redis, clickhouse and postgres). You can refer to Bitnami documentation on how to set static passwords for these databases. 
+
+
+## Releases 
+
+We release frequently, sometimes multiple times a day. It's usually safe to upgrade to the latest version. Any breaking changes will be documented in the release notes. Please make sure you read the release notes before upgrading.
+
 ## Chart Dependencies
 
 We use these charts as dependencies. You dont need to install them separately. Please read the readme for these individual charts to understand the configuration options.

oneuptime/templates/_helpers.tpl

@@ -1,3 +1,16 @@
+{{/*
+Renders a value that contains a template.
+Usage:
+{{ include "oneuptime.renderTemplate" ( dict "value" .Values.path.to.the.Value "context" $) }}
+*/}}
+{{- define "oneuptime.renderTemplate" -}}
+    {{- if typeIs "string" .value }}
+        {{- tpl .value .context }}
+    {{- else }}
+        {{- tpl (.value | toYaml) .context }}
+    {{- end }}
+{{- end -}}
+
 {{- define "oneuptime.env.common" }}
 - name: HOST
   value: {{ $.Values.host }}

oneuptime/templates/extra-templates.yaml

@@ -0,0 +1,5 @@
+{{- range $.Values.extraTemplates }}
+---
+{{ include "oneuptime.renderTemplate" (dict "value" . "context" $) }}
+---
+{{- end }}

oneuptime/templates/ingress.yaml

@@ -0,0 +1,37 @@
+{{- if $.Values.ingress.enabled }}
+
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+  name: {{ printf "%s-%s" $.Release.Name "ingress"  }}
+  namespace: {{ $.Release.Namespace }}
+  labels:
+    app: {{ printf "%s-%s" $.Release.Name "ingress"  }}
+    app.kubernetes.io/part-of: oneuptime
+    app.kubernetes.io/managed-by: Helm
+    appname: oneuptime
+  annotations: {{- $.Values.ingress.annotations | toYaml | nindent 4 }}
+spec:
+  ingressClassName: {{ $.Values.ingress.className }}
+  {{- if $.Values.ingress.tls.enabled }}
+  tls:
+    {{- range $key, $val := $.Values.ingress.tls.hosts }}
+    - hosts:
+        - {{ $val.host }}
+      secretName: {{ $val.secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    {{- range $key, $val := $.Values.ingress.hosts }}
+    - host: {{ $val }}
+      http:
+        paths:
+          - path: /
+            pathType: Prefix
+            backend:
+              service:
+                name: {{ printf "%s-%s" $.Release.Name "nginx"  }}
+                port:
+                  name: "http"
+    {{- end }}
+{{- end }}

oneuptime/templates/nginx.yaml

@@ -85,7 +85,7 @@ spec:
             {{- include "oneuptime.env.commonServer" . | nindent 12 }}
             {{- include "oneuptime.env.oneuptimeSecret" . | nindent 12 }}
             - name: OPENTELEMETRY_EXPORTER_OTLP_HEADERS
-              value: {{ $.Values.openTelemetryExporter.headers.ingress }}
+              value: {{ $.Values.openTelemetryExporter.headers.nginx }}
             - name: PORT
               value: "7851" # Port for the nodejs server for live and ready status
           ports:
@@ -114,12 +114,12 @@ metadata:
     metallb.universe.tf/address-pool: {{ printf "%s-%s" $.Release.Name "metallb-address-pool"  }}
   {{- end }}
 spec:
-  {{- if $.Values.ingress.service.loadBalancerIP }}
-  loadBalancerIP: {{ $.Values.ingress.service.loadBalancerIP }}
+  {{- if $.Values.nginx.service.loadBalancerIP }}
+  loadBalancerIP: {{ $.Values.nginx.service.loadBalancerIP }}
   {{- end }}
-  {{- if $.Values.ingress.service.externalIPs }}
+  {{- if $.Values.nginx.service.externalIPs }}
   externalIPs:
-    {{- range $key, $val := $.Values.ingress.service.externalIPs }}
+    {{- range $key, $val := $.Values.nginx.service.externalIPs }}
     - {{ $val }}
     {{- end }}
   {{- end }}
@@ -132,8 +132,8 @@ spec:
       name: https
   selector:
       app: {{ printf "%s-%s" $.Release.Name "nginx"  }}
-  {{- if $.Values.ingress.service.type }}
-  type: {{ $.Values.ingress.service.type }}
+  {{- if and ($.Values.nginx.service.type) (eq $.Values.ingress.enabled false) }}
+  type: {{ $.Values.nginx.service.type }}
   {{- else }}
   type: ClusterIP
   {{- end}}

oneuptime/values.yaml

@@ -25,7 +25,7 @@ metalLb:
     addresses: 
       # - 51.158.55.153/32 # List of IP addresses of all the servers in the cluster.
 
-ingress:
+nginx:
   service: 
     loadBalancerIP: 
     type: LoadBalancer
@@ -183,7 +183,7 @@ openTelemetryExporter:
     statusPage:
     adminDashboard:
     ingestor:
-    ingress:
+    nginx:
 
 containerSecurityContext:
 podSecurityContext:
@@ -210,4 +210,32 @@ cronJobs:
 
 
 notifications: 
-  letsEncryptEmail:
+  letsEncryptEmail:
+
+ingress: 
+  enabled: false
+  annotations: 
+  # Please change this to the ingress class name for your cluster. If you use a cloud provider, this is usually the default ingress class name.
+  # If you dont have nginx ingress controller installed, please install it by going to https://kubernetes.github.io/ingress-nginx/deploy/
+  className: nginx # Required. Please change this to the ingress class name for your cluster. If you use a cloud provider, this is usually the default ingress class name.
+  hosts:  # List of hosts for the ingress. Please change this to your hosts
+    # - "oneuptime.com" # Host 1
+    # - "www.oneuptime.com" # Host 2
+  tls:
+    enabled: false
+    hosts: 
+      # - host: "oneuptime.com" # Host 1
+      #   secretName: "oneuptime-tls
+
+
+# extraTemplates -- Array of extra objects to deploy with the release. Strings
+# are evaluated as a template and can use template expansions and functions. All
+# other objects are used as yaml.
+extraTemplates:
+  #- |
+  #    apiVersion: v1
+  #    kind: ConfigMap
+  #    metadata:
+  #      name: my-configmap
+  #    data:
+  #      key: {{ .Values.myCustomValue | quote }}