charts/charts/stable/wmbusmeters
renovate[bot] a7da4dbb38
chore(deps): update helm chart common to v4.3.0 (#1350)
* chore(deps): update helm chart common to v4.3.0
* Remove CHANGELOG templates

Co-authored-by: Renovate Bot <bot@renovateapp.com>
Co-authored-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev>
2022-01-06 11:41:00 +01:00
..
templates [wmbusmeters] Adding wmbusmeters chart (#1143) 2021-09-01 20:32:06 +02:00
.helmignore [wmbusmeters] Adding wmbusmeters chart (#1143) 2021-09-01 20:32:06 +02:00
Chart.yaml chore(deps): update helm chart common to v4.3.0 (#1350) 2022-01-06 11:41:00 +01:00
README_CONFIG.md.gotmpl [wmbusmeters] Adding wmbusmeters chart (#1143) 2021-09-01 20:32:06 +02:00
README.md chore(deps): update helm chart common to v4.3.0 (#1350) 2022-01-06 11:41:00 +01:00
README.md.gotmpl chore(deps): update helm chart common to v4.3.0 (#1350) 2022-01-06 11:41:00 +01:00
values.yaml [wmbusmeters] Adding wmbusmeters chart (#1143) 2021-09-01 20:32:06 +02:00

wmbusmeters

Version: 1.2.0 AppVersion: 1.4.1

Wmbusmeters receives and decodes C1,T1 or S1 telegrams (using the wireless mbus protocol) to acquire utility meter readings.

This chart is not maintained by the upstream project and any issues with the chart should be raised here

Source Code

Requirements

Kubernetes: >=1.16.0-0

Dependencies

Repository Name Version
https://library-charts.k8s-at-home.com common 4.3.0

TL;DR

helm repo add k8s-at-home https://k8s-at-home.com/charts/
helm repo update
helm install wmbusmeters k8s-at-home/wmbusmeters

Installing the Chart

To install the chart with the release name wmbusmeters

helm install wmbusmeters k8s-at-home/wmbusmeters

Uninstalling the Chart

To uninstall the wmbusmeters deployment

helm uninstall wmbusmeters

The command removes all the Kubernetes components associated with the chart including persistent volumes and deletes the release.

Configuration

Read through the values.yaml file. It has several commented out suggested values. Other values may be used from the values.yaml from the common library.

Specify each parameter using the --set key=value[,key=value] argument to helm install.

helm install wmbusmeters \
  --set env.TZ="America/New York" \
    k8s-at-home/wmbusmeters

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.

helm install wmbusmeters k8s-at-home/wmbusmeters -f values.yaml

Custom configuration

IMPORTANT NOTE: a rtlsdr device must be accessible on the node where this pod runs, in order for this chart to function properly.

Wmbusmeters can auto-discover this dongle, but first you need to give the pod extended privileges:

securityContext:
  privileged: true

Alternatively you could mount the device directly, if you know what you are doing and can manually configure wmbusmetersto use it:

host-dev:
  enabled: true
  type: hostPath
  hostPath: /dev/device1
  mountPath: /dev/device1

Second you will need to set a nodeAffinity rule, for example if you are using node-feature-discovery:

  nodeSelector:
    feature.node.kubernetes.io/custom-rtl: "true"

or by simply labeling the node which has the usb dongle:

affinity:
  nodeAffinity:
    requiredDuringSchedulingIgnoredDuringExecution:
      nodeSelectorTerms:
      - matchExpressions:
        - key: app
          operator: In
          values:
          - rtlsdr-dongle

Values

Important: When deploying an application Helm chart you can add more values from our common library chart here

Key Type Default Description
config string "loglevel=normal\ndevice=rtlwmbus\nlistento=t1\nlogtelegrams=false\nformat=json\nmeterfiles=/wmbusmeters_data/logs/meter_readings\nmeterfilesaction=overwrite\nlogfile=/wmbusmeters_data/logs/wmbusmeters.log\n" Set the default config for wmbusmeters, see: https://github.com/weetmuts/wmbusmeters/blob/master/README.md
env object See below environment variables.
env.TZ string "UTC" Set the container timezone
image.pullPolicy string "IfNotPresent" image pull policy
image.repository string "weetmuts/wmbusmeters" image repository
image.tag string "release-1.4.1-amd64" image tag
persistence object See values.yaml Configure persistence settings for the chart under this key.
securityContext.privileged bool true (bool) Privileged securityContext may be required if USB controller is accessed directly through the host machine
wmbusmeters list [{"config":"name=watermeter\ntype=multical21\nid=1234567\nkey=000000000000000000000000\n","name":"watermeter"}] Set the config for individual meters to read, see: https://github.com/weetmuts/wmbusmeters/blob/master/README.md

Changelog

Version 1.2.0

Added

N/A

Changed

  • Upgraded common chart dependency to version 4.3.0.

Fixed

N/A

Older versions

A historical overview of changes can be found on ArtifactHUB

Support


Autogenerated from chart metadata using helm-docs v0.1.1