Headscale¶

An open source, self-hosted implementation of the Tailscale control server.

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

Source Code¶

• https://github.com/juanfont/headscale

Requirements¶

Kubernetes: >=1.22.0-0

Dependencies¶

Installing the Chart¶

To install the chart with the release name headscale

OCI (Recommended)¶

helm install headscale oci://ghcr.io/gabe565/charts/headscale

Traditional¶

helm repo add gabe565 https://charts.gabe565.com
helm repo update
helm install headscale gabe565/headscale

Uninstalling the Chart¶

To uninstall the headscale deployment

helm uninstall headscale

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 bjw-s common library.

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

helm install headscale \
  --set env.TZ="America/New York" \
    gabe565/headscale

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

helm install headscale gabe565/headscale -f values.yaml

Custom configuration¶

Headscale runs in a distroless Docker container, which does not have any of the expected command line utilities. This keeps the container small and minimizes the possibility of CVEs, but it makes working with a config file in Kubernetes more difficult.

To keep config simple, this Helm chart suggests using environment variables. All of the Headscale config variables are supported as envs, but official documentation is lacking.

To configure Headscale:

1. See the Headscale example config for available variables.

2. For any that you want to set: flatten object keys using _, then prefix with HEADSCALE_.

   • For example, the following config:

     disable_check_updates: true
     log:
       level: warn
     

     would be set with the following Helm values:

     env:
       HEADSCALE_DISABLE_CHECK_UPDATES: "true"
       HEADSCALE_LOG_LEVEL: "warn"
     

Also, note that this chart sets some defaults based on your values. See templates/common.yaml for a list.

Headscale UI¶

You can deploy gurucomputing/headscale-ui as a sidecar container by adding the following values:

sidecars:
  ui:
    image: ghcr.io/gurucomputing/headscale-ui:latest
    ports:
      - name: http
        containerPort: 80

service:
  main:
    ports:
      ui:
        port: 80

ingress:
  ui:
    enabled: true
    hosts:
      - host: example.com
        paths:
          - path: /web
            service:
              port: 80
    tls:
      - ...

Once deployed, the UI will be available at /web.

Values¶

Important: When deploying an application Helm chart you can add more values from the bjw-s common library chart here

Autogenerated from chart metadata using helm-docs