charts/charts/stable/ser2sock
2021-03-29 19:56:40 -04:00
..
templates [ser2sock] migrate to common library (#719) 2021-03-26 08:12:08 +01:00
.helmignore [ser2sock] migrate to common library (#719) 2021-03-26 08:12:08 +01:00
Chart.yaml fix: update releases (#736) 2021-03-29 19:56:40 -04:00
README_CHANGELOG.md.gotmpl [ser2sock] migrate to common library (#719) 2021-03-26 08:12:08 +01:00
README_CONFIG.md.gotmpl [ser2sock] migrate to common library (#719) 2021-03-26 08:12:08 +01:00
README.md [ser2sock] migrate to common library (#719) 2021-03-26 08:12:08 +01:00
README.md.gotmpl chore(docs): update helm-docs [ci-skip] (#694) 2021-03-19 08:30:40 +01:00
values.yaml [ser2sock] migrate to common library (#719) 2021-03-26 08:12:08 +01:00

ser2sock

Version: 3.0.0 AppVersion: 1.0.0

Serial to Socket Redirector

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 2.0.1

TL;DR

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

Installing the Chart

To install the chart with the release name ser2sock

helm install ser2sock k8s-at-home/ser2sock

Uninstalling the Chart

To uninstall the ser2sock deployment

helm uninstall ser2sock

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 ser2sock \
  --set env.TZ="America/New York" \
    k8s-at-home/ser2sock

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

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

Custom configuration

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

First, you will need to mount your ser2sock device into the pod, you can do so by adding the following to your values:

additionalVolumeMounts:
  - name: usb
    mountPath: /path/to/device

additionalVolumes:
  - name: usb
    hostPath:
      path: /path/to/device

Second you will need to set a nodeAffinity rule, for example:

affinity:
  nodeAffinity:
    requiredDuringSchedulingIgnoredDuringExecution:
      nodeSelectorTerms:
      - matchExpressions:
        - key: app
          operator: In
          values:
          - ser2sock-controller

... where a node with an attached ser2sock controller USB device is labeled with app: ser2sock-controller

Values

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

Key Type Default Description
additionalVolumeMounts list []
additionalVolumes list []
env.BAUD_RATE int 115200
env.LISTENER_PORT int 10000
env.SERIAL_DEVICE string "/dev/ttyUSB0"
image.pullPolicy string "IfNotPresent"
image.repository string "tenstartups/ser2sock"
image.tag string "latest"
ingress.enabled bool false
service.port.port int 10000
strategy.type string "Recreate"

Changelog

All notable changes to this application Helm chart will be documented in this file but does not include changes from our common library. To read those click here.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

3.0.0

Added

  • N/A

Changed

  • BREAKING Migrate ser2sock to the common library, Helm configuration values have changed.

Removed

  • N/A

1.0.0

Added

  • N/A

Changed

  • N/A

Removed

  • N/A

Support


Autogenerated from chart metadata using helm-docs v1.5.0