Merge pull request #79 from librenms/main

Merge pull request #78 from librenms/develop

.github/workflows/chart-testing.yml

@@ -12,7 +12,7 @@ jobs:
           fetch-depth: 0
 
       - name: Set up Helm
-        uses: azure/setup-helm@v4.2.0
+        uses: azure/setup-helm@v4.3.0
         with:
           version: v3.14.4
 
@@ -22,7 +22,7 @@ jobs:
           check-latest: true
 
       - name: Set up chart-testing
-        uses: helm/chart-testing-action@v2.6.1
+        uses: helm/chart-testing-action@v2.7.0
 
       - name: Add repositories
         run: |
@@ -48,7 +48,7 @@ jobs:
 
       - name: Create kind cluster
         if: steps.list-changed.outputs.changed == 'true' || github.event.pull_request.base.ref == 'main' 
-        uses: helm/kind-action@v1.10.0
+        uses: helm/kind-action@v1.12.0
 
       - name: Run chart-testing (install)
         if: steps.list-changed.outputs.changed == 'true' && github.ref != 'refs/heads/develop'

.github/workflows/release.yml

@@ -7,6 +7,8 @@ jobs:
     if: github.ref == 'refs/heads/main'
     permissions:
       contents: write
+      packages: write
+
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -29,6 +31,24 @@ jobs:
           done
           
       - name: Run chart-releaser
-        uses: helm/chart-releaser-action@v1.6.0
+        uses: helm/chart-releaser-action@v1.7.0
         env:
-          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+
+      # see https://github.com/helm/chart-releaser/issues/183
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Push charts to GHCR
+        run: |
+          shopt -s nullglob
+          for pkg in .cr-release-packages/*; do
+            if [ -z "${pkg:-}" ]; then
+              break
+            fi
+            helm push "${pkg}" "oci://ghcr.io/${GITHUB_REPOSITORY_OWNER}/charts"
+          done

charts/librenms/Chart.lock

@@ -1,9 +1,9 @@
 dependencies:
 - name: redis
   repository: https://charts.bitnami.com/bitnami
-  version: 19.6.1
+  version: 21.1.3
 - name: mysql
   repository: https://charts.bitnami.com/bitnami
-  version: 11.1.8
+  version: 13.0.0
-digest: sha256:4b82fafdf2c4c72a003d1dc6df9343a089eb5d2f686927d134821854f9633c83
+digest: sha256:ab48525b17834c3b7e491483bb35fad9d11ddbf74368a352cafd59dbbe34d940
-generated: "2024-07-09T10:22:10.255911997Z"
+generated: "2025-05-19T07:25:23.570909791Z"

charts/librenms/Chart.yaml

@@ -2,17 +2,17 @@ apiVersion: v2
 name: librenms
 description: LibreNMS is an autodiscovering PHP/MySQL-based network monitoring system.
 type: application
-version: 3.11.1
+version: 5.0.2
-appVersion: "24.5.0"
+appVersion: "25.5.0"
 maintainers:
-  - name: TheChef23
+  - name: jacobw
-    url: https://github.com/TheChef23
+    url: https://github.com/jacobw
 dependencies:
   - name: redis
-    version: "~19.6.0"
+    version: "~21.1.0"
     repository: "https://charts.bitnami.com/bitnami"
     condition: redis.enabled
   - name: mysql
-    version: "~11.1.0"
+    version: "~13.0.0"
     repository: "https://charts.bitnami.com/bitnami"
     condition: mysql.enabled

charts/librenms/README.md

@@ -1,5 +1,5 @@
 # LibreNMS
-![Version: 3.11.0](https://img.shields.io/badge/Version-3.11.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 24.5.0](https://img.shields.io/badge/AppVersion-24.5.0-informational?style=flat-square)
+![Version: 3.12.0](https://img.shields.io/badge/Version-3.12.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 24.5.0](https://img.shields.io/badge/AppVersion-24.5.0-informational?style=flat-square)
 
 ## TL;DR
 
@@ -47,12 +47,17 @@ librenms:
 
 ### Available values
 
-The following table lists the main configurable parameters of the librenms chart v3.11.0 and their default values. Please, refer to [values.yaml](./values.yaml) for the full list of configurable parameters.
+The following table lists the main configurable parameters of the librenms chart v3.12.0 and their default values. Please, refer to [values.yaml](./values.yaml) for the full list of configurable parameters.
 
 ## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
+| ingress | object | `{"annotations":{},"className":"","enabled":false,"hosts":[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}],"tls":[]}` | LibreNMS ingress configuration |
+| ingress.annotations | object | `{}` | Ingress annotations |
+| ingress.className | string | `""` | Ingress class name |
+| ingress.enabled | bool | `false` | Enable or disable ingress |
+| ingress.hosts | list | `[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}]` | Ingress ingress rules |
 | librenms.appkey | string | `nil` | Laravel appkey used by LibreNMS, this should be generated by you and is a required setting. See the README for more information |
 | librenms.configuration | string | `"$config['distributed_poller_group']          = '0';\n$config['distributed_poller']                = true;\n"` | Custom configuration options for LibreNMS. Fore more infomation on options in this file check the following link: https://docs.librenms.org/Support/Configuration/ |
 | librenms.extraEnvs | object | `{}` | LibreNMS frontend extra envs |

charts/librenms/ci/test-values.yaml

@@ -1,2 +1,4 @@
 librenms:
   appkey: base64:RTMmh+i10E2RMcDxookMu47BTzJQy87hOU+k/zcuPnA=
+ingress:
+  enabled: true

charts/librenms/files/env

@@ -1 +0,0 @@
-APP_KEY={{.Values.librenms.appkey}}

charts/librenms/files/init.sh

@@ -1,7 +1,7 @@
 #!/bin/sh
 TARGET="/data/env-volume/env"
 echo "Target: $TARGET"
-cp /data/files/env $TARGET
+echo "APP_KEY=$(cat /data/key/appkey)" > $TARGET
-echo -e "\nNODE_ID=`hostname`" >> $TARGET
+echo "NODE_ID=$(hostname)" >> $TARGET
 
 cat $TARGET

charts/librenms/templates/_helpers.tpl

@@ -1,3 +1,77 @@
 {{- define "librenms.configChecksum" -}}
 {{- include (print $.Template.BasePath "/librenms-configmap.yml") . | sha256sum -}}
+{{- end -}}
+
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "librenms.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "librenms.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "librenms.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "librenms.labels" -}}
+helm.sh/chart: {{ include "librenms.chart" . }}
+{{ include "librenms.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "librenms.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "librenms.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "librenms.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "librenms.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create the name of the secret to use
+*/}}
+{{- define "librenms.secretName" -}}
+{{- if .Values.librenms.existingSecret -}}
+{{- .Values.librenms.existingSecret -}}
+{{- else -}}
+{{- .Release.Name -}}
+{{- end -}}
 {{- end -}}

charts/librenms/templates/ingress.yml

@@ -0,0 +1,62 @@
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := .Release.Name  -}}
+{{- $svcPort := 8000 -}}
+{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }}
+  {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }}
+  {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}}
+  {{- end }}
+{{- end }}
+{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1
+{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1beta1
+{{- else -}}
+apiVersion: extensions/v1beta1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ .Release.Name }}
+  labels:
+    app.kubernetes.io/name: {{ .Release.Name }}
+    app.kubernetes.io/instance: frontend
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }}
+  ingressClassName: {{ .Values.ingress.className }}
+  {{- end }}
+  {{- if .Values.ingress.tls }}
+  tls:
+    {{- range .Values.ingress.tls }}
+    - hosts:
+        {{- range .hosts }}
+        - {{ . | quote }}
+        {{- end }}
+      secretName: {{ .secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    {{- range .Values.ingress.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+          {{- range .paths }}
+          - path: {{ .path }}
+            {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
+            pathType: {{ .pathType }}
+            {{- end }}
+            backend:
+              {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+              service:
+                name: {{ $fullName }}
+                port:
+                  number: {{ $svcPort }}
+              {{- else }}
+              serviceName: {{ $fullName }}
+              servicePort: {{ $svcPort }}
+              {{- end }}
+          {{- end }}
+    {{- end }}
+{{- end }}

charts/librenms/templates/librenms-configmap.yml

@@ -23,7 +23,5 @@ metadata:
 data:
   custom.php: |-
 {{ tpl (.Files.Get "files/custom.php") . | indent 4 }}
-  env: |-
-{{ tpl (.Files.Get "files/env") . | indent 4 }}
   init.sh: |-
-{{ tpl (.Files.Get "files/init.sh") . | indent 4 }}
+{{ .Files.Get "files/init.sh" | indent 4 }}

charts/librenms/templates/librenms-deployment.yml

@@ -19,6 +19,9 @@ spec:
       volumes:
       - name: env-volume
         emptyDir: {}
+      - name: key
+        secret:
+          secretName: {{ include "librenms.secretName" . }}
       - name: files
         configMap:
           name: {{ .Release.Name }}-files
@@ -33,6 +36,8 @@ spec:
           volumeMounts:
           - name: env-volume
             mountPath: /data/env-volume
+          - name: key
+            mountPath: /data/key
           - name: files
             mountPath: /data/files
       containers:
@@ -55,7 +60,7 @@ spec:
         - name: files
           mountPath: /data/files
         - name: files
-          mountPath: /opt/librenms/custom.php
+          mountPath: /data/config/custom.php
           subPath: custom.php
           readOnly: true
         - name: mysql

charts/librenms/templates/librenms-poller-ss.yml

@@ -20,6 +20,9 @@ spec:
       volumes:
       - name: env-volume
         emptyDir: {}
+      - name: key
+        secret:
+          secretName: {{ include "librenms.secretName" . }}
       - name: files
         configMap:
           name: {{ .Release.Name }}-files
@@ -33,6 +36,8 @@ spec:
           volumeMounts:
           - name: env-volume
             mountPath: /data/env-volume
+          - name: key
+            mountPath: /data/key
           - name: files
             mountPath: /data/files
       containers:

charts/librenms/templates/librenms-secret.yml

@@ -0,0 +1,10 @@
+{{- if not .Values.librenms.existingSecret }}
+---
+apiVersion: v1
+kind: Secret
+metadata:
+  name: {{ .Release.Name }}
+type: Opaque
+data:
+  appkey: {{ .Values.librenms.appkey | b64enc | quote }}
+{{- end }}

charts/librenms/values.yaml

@@ -6,12 +6,16 @@ librenms:
     # -- repository is the image repository to pull from.
     repository: librenms/librenms
     # -- tag is image tag to pull.
-    tag: 24.5.0
+    tag: 25.5.0
 
   # -- Laravel appkey used by LibreNMS, this should be generated by you and is a
   # required setting. See the README for more information
   appkey:
 
+  # -- Existing secret name to use for appkey
+  # Must have the key 'appkey' as above
+  existingSecret: false
+
   # -- Timezone used by librenms for communication with RRD cached
   timezone: UTC
 
@@ -123,6 +127,27 @@ librenms:
     # -- Extra environment variable for RRDCACHED container
     extraEnvs: {}
 
+# -- LibreNMS ingress configuration
+ingress:
+  # -- Enable or disable ingress
+  enabled: false
+  # -- Ingress class name
+  className: ""
+  # -- Ingress annotations
+  annotations: {}
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+  # -- Ingress ingress rules
+  hosts:
+    - host: chart-example.local
+      paths:
+        - path: /
+          pathType: ImplementationSpecific
+  tls: []
+  #  - secretName: chart-example-tls
+  #    hosts:
+  #      - chart-example.local
+
 # -- Configuration for MySQL dependency chart by Bitnami. See their chart for
 # more information: https://github.com/bitnami/charts/tree/master/bitnami/mysql
 mysql: