mirror of https://github.com/k8s-at-home/charts.git synced 2025-01-23 23:49:12 +00:00

History

k8s-at-home[bot] 2f55aac1a8 chore: Auto-update chart README [skip ci]		2022-08-02 12:19:34 +00:00
..
templates	fix: Emergency fix for resources missing common setup	2022-05-01 19:30:42 +02:00
.helmignore	[wireguard] add standalone chart (#1121 )	2021-08-16 19:06:56 -04:00
Chart.yaml	chore(deps): update helm chart common to v4.5.1 (#1728 )	2022-08-02 14:18:55 +02:00
README_CONFIG.md.gotmpl	[wireguard] add standalone chart (#1121 )	2021-08-16 19:06:56 -04:00
README.md	chore: Auto-update chart README [skip ci]	2022-08-02 12:19:34 +00:00
values.yaml	[wireguard] add standalone chart (#1121 )	2021-08-16 19:06:56 -04:00

README.md

wireguard

Fast, modern, secure VPN tunnel

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.5.1

TL;DR

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

Installing the Chart

To install the chart with the release name wireguard

helm install wireguard k8s-at-home/wireguard

Uninstalling the Chart

To uninstall the wireguard deployment

helm uninstall wireguard

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

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

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

Custom configuration

The container in this chart requires the wg0.conf to be in /etc/wireguard for it to run. Either add it under configSecret or under persistence.

Values

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

Key	Type	Default	Description
configSecret	object	base64 encoded wg0.conf by running `base64 wg0.conf`	If set to 'true', the configuration will be read from these values. -- Otherwise you have to mount a volume to /etc/wireguard containing the wg0.conf.
configSecret.enabled	bool	`false`	Store Wireguard config as a secret
env.IPTABLES_BACKEND	string	`"nft"`	Override the backend used by iptables. Valid values are nft and legacy
env.KILLSWITCH	bool	false	Enable a killswitch that kills all trafic when the VPN is not connected
env.TZ	string	`"UTC"`	Set the container timezone
image.pullPolicy	string	`"IfNotPresent"`	image pull policy
image.repository	string	`"ghcr.io/k8s-at-home/wireguard"`	image repository
image.tag	string	`"v1.0.20210424"`	image tag
ingress.main	object	See values.yaml	Enable and configure ingress settings for the chart under this key.
persistence	object	See values.yaml	Configure persistence settings for the chart under this key.
probes	object	See values.yaml	Configures the probes for the main Pod.
securityContext	object	see values.yaml	Security contexts required for container.
service	object	See values.yaml	Configures service settings for the chart.

Changelog

Version 1.4.1

Added

N/A

Changed

Upgraded common chart dependency to version 4.5.1

Fixed

N/A

Older versions

A historical overview of changes can be found on ArtifactHUB

Support

See the Docs
Open an issue
Ask a question
Join our Discord community

Autogenerated from chart metadata using helm-docs v0.1.1