Skip to content

Commit

Permalink
Merge pull request #1069 from christianknell/renovate/umami-postgresq…
Browse files Browse the repository at this point in the history 
…l-14.x

chore(deps): update helm release postgresql to v14
  • Loading branch information
@christianhuth
christianhuth authored Feb 19, 2024
2 parents e29c74f + 8cf0a8d commit 04ff0ad
Show file tree
Hide file tree
Showing 10 changed files with 183 additions and 49 deletions.
12 changes: 9 additions & 3 deletions charts/umami/Chart.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ apiVersion: v2
name: umami
description: Umami is a simple, fast, privacy-focused alternative to Google Analytics.
type: application
version: 1.21.0
appVersion: "postgresql-v1.40.0"
version: 2.0.0
appVersion: "postgresql-v2.9.0"
home: https://github.com/christianknell/helm-charts
icon: https://raw.githubusercontent.com/umami-software/umami/master/public/android-chrome-512x512.png
maintainers:
Expand All @@ -25,7 +25,13 @@ annotations:
artifacthub.io/category: monitoring-logging
artifacthub.io/changes: |
- kind: changed
description: bumped chart version of mysql to 9.19.1
description: bumped image version to v2.9.0
- kind: changed
description: environment variable HASH_SALT is now called APP_SECRET. Values have been moved to `umami.appSecret`
- kind: added
description: support for new environment variables of Umami v2
- kind: added
description: database migration job
artifacthub.io/screenshots: |
- title: Umami measures just the important metrics that you care about and everything is displayed on a single, easy to browse page.
url: https://umami.is/images/feature-website-stats.png
Expand Down
26 changes: 21 additions & 5 deletions charts/umami/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The command removes all the Kubernetes components associated with the chart and
| image.pullPolicy | string | `"Always"` | image pull policy |
| image.registry | string | `"ghcr.io"` | image registry |
| image.repository | string | `"umami-software/umami"` | image repository |
| image.tag | string | `"postgresql-v1.40.0"` | Overrides the image tag |
| image.tag | string | `"postgresql-v2.9.0"` | Overrides the image tag |
| imagePullSecrets | list | `[]` | If defined, uses a Secret to pull an image from a private Docker registry or repository. |
| ingress.annotations | object | `{}` | Additional annotations for the Ingress resource |
| ingress.className | string | `""` | IngressClass that will be be used to implement the Ingress |
Expand Down Expand Up @@ -96,16 +96,24 @@ The command removes all the Kubernetes components associated with the chart and
| serviceAccount.create | bool | `true` | Specifies whether a service account should be created |
| serviceAccount.name | string | `""` | The name of the service account to use. If not set and create is true, a name is generated using the fullname template |
| tolerations | list | `[]` | Toleration labels for pod assignment |
| umami.appSecret.existingSecret | string | `""` | Name of an existing secret containing the app secret under the key app-secret. |
| umami.appSecret.secret | string | `""` | A random string used to generate unique values. |
| umami.clientIpHeader | string | `""` | HTTP header to check for the client's IP address. This is useful when you're behind a proxy that uses non-standard headers. |
| umami.collectApiEndpoint | string | `""` | Allows you to send metrics to a location different than the default /api/collect. This is to help you avoid some ad-blockers. |
| umami.cloudMode | string | `"1"` | Disables users, teams, and websites settings page. |
| umami.collectApiEndpoint | string | `""` | Allows you to send metrics to a location different than the default `/api/send`. This is to help you avoid some ad-blockers. |
| umami.corsMaxAge | string | `"86400"` | How many seconds a CORS preflight should last. Default is 24 hours. |
| umami.debug | string | `""` | Console logging for specific areas of the application. Values include `umami:auth`, `umami:clickhouse`, `umami:kafka`, `umami:middleware`, and `umami:prisma`. |
| umami.disableBotCheck | string | `"1"` | By default bots are excluded from statistics. This disables checking for bots. |
| umami.disableLogin | string | `"1"` | Disables the login page for the application |
| umami.disableTelemetry | string | `"1"` | Umami collects completely anonymous telemetry data in order help improve the application. You can choose to disable this if you don't want to participate. |
| umami.disableUpdates | string | `"1"` | Disables the check for new versions of Umami |
| umami.enableTestConsole | string | `"1"` | Enables the internal test page, {host}/console. Admin access is required. Users can manually fire pageviews and events to their websites. |
| umami.forceSSL | string | `"1"` | This will redirect all requests from http to https in the Umami application. Note, this does not apply to the tracking script. |
| umami.hash.existingSecret | string | `""` | Name of an existing secret containing the hash salt under the key hash-salt |
| umami.hash.salt | string | `""` | A random string used to generate unique values. |
| umami.hostname | string | `""` | hostname under which Umami will be reached |
| umami.hostname | string | `"0.0.0.0"` | hostname under which Umami will be reached |
| umami.ignoreHostname | string | `""` | This will do a DNS lookup on a hostname and the resulting IP address will be ignored. This can be a comma delimited list of hostnames. |
| umami.ignoredIpAddresses | string | `""` | You can provide a comma-delimited list of IP address to exclude from data collection. |
| umami.logQuery | string | `"1"` | If you are running in development mode, this will log database queries to the console for debugging. |
| umami.migration.v1v2.enabled | bool | `false` | enable a job that migrates database structure from v1 to v2 |
| umami.removeDisableLoginEnv | bool | `false` | setting this to true removes the environment variable DISABLE_LOGIN defined in `umami.disableLogin` from the deployment as this caused errors in some setups |
| umami.removeTrailingSlash | string | `"1"` | Removes the trailing slash from all incoming urls. |
| umami.trackerScriptName | string | `"umami"` | Allows you to assign a custom name to the tracker script different from the default umami. This is to help you avoid some ad-blockers. |
Expand All @@ -117,3 +125,11 @@ Alternatively, a YAML file that specifies the values for the parameters can be p
```console
helm install my-release -f values.yaml christianknell/umami
```

## Upgrading the Chart

### To 2.0.0

This major updates the Docker Image to its newest major, 2.0.0. [Here](https://github.com/umami-software/umami/releases/tag/v2.0.0) you can find more information about the changes introduced in that version.

To upgrade from a previous version of the Helm Chart make sure to activate the database migration job with `umami.migration.v1v2.enabled`.
8 changes: 8 additions & 0 deletions charts/umami/README.md.gotmpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,11 @@ Alternatively, a YAML file that specifies the values for the parameters can be p
```console
helm install my-release -f values.yaml christianknell/umami
```

## Upgrading the Chart

### To 2.0.0

This major updates the Docker Image to its newest major, 2.0.0. [Here](https://github.com/umami-software/umami/releases/tag/v2.0.0) you can find more information about the changes introduced in that version.

To upgrade from a previous version of the Helm Chart make sure to activate the database migration job with `umami.migration.v1v2.enabled`.
10 changes: 5 additions & 5 deletions charts/umami/templates/_helpers.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -170,12 +170,12 @@ Get the key for the database url
{{- end -}}

{{/*
Get the name of the secret containing the hash salt
Get the name of the secret containing the app secret
*/}}
{{- define "umami.hash.secretName" -}}
{{- if .Values.umami.hash.existingSecret -}}
{{- printf "%s" (tpl .Values.umami.hash.existingSecret $) -}}
{{- define "umami.appSecret.secretName" -}}
{{- if .Values.umami.appSecret.existingSecret -}}
{{- printf "%s" (tpl .Values.umami.appSecret.existingSecret $) -}}
{{- else -}}
{{- printf "%s" (include "umami.fullname" .) -}}-hash
{{- printf "%s" (include "umami.fullname" .) -}}-app-secret
{{- end -}}
{{- end -}}
12 changes: 12 additions & 0 deletions charts/umami/templates/app-secret.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{{- if and (not .Values.umami.appSecret.existingSecret) -}}
apiVersion: v1
kind: Secret
metadata:
name: {{ include "umami.appSecret.secretName" . }}
data:
{{- if .Values.umami.appSecret.secret }}
app-secret: {{ .Values.umami.appSecret.secret | b64enc }}
{{- else }}
app-secret: {{ randAlphaNum 50 | b64enc }}
{{- end }}
{{- end }}
Loading

0 comments on commit 04ff0ad

Please sign in to comment.