Connector User Guide

Deploying a Connector

Define a TwingateConnector object.

Example:

apiVersion: twingate.com/v1beta
kind: TwingateConnector
metadata:
  name: my-connector-auto-updating-image
spec:
  imagePolicy:
    schedule: "0 0 * * *"

Important

For production, run multiple connectors for high availability. Ensure they don’t fail simultaneously:

• If using imagePolicy, stagger update times to avoid simultaneous restarts.
• Schedule pods on different nodes using affinity (via podExtra and podLabels).

An example for a production deployment:

apiVersion: twingate.com/v1beta
kind: TwingateConnector
metadata:
  name: my-production-connector-1
spec:
  imagePolicy:
    schedule: "0 0 * * *" # TODO: make this unique per connector
  podLabels:
    component: twingate-connector
  podExtra:
    affinity:
      podAntiAffinity:
        requiredDuringSchedulingIgnoredDuringExecution:
          - labelSelector:
              matchExpressions:
              - key: component
                operator: In
                values:
                - twingate-connector
            topologyKey: kubernetes.io/hostname

Adding a sidecar to connector

Use the TwingateConnector.spec.sidecarContainers property.

Example:

apiVersion: twingate.com/v1beta
kind: TwingateConnector
metadata:
  name: my-connector-auto-updating-image
spec:
  imagePolicy:
    schedule: "0 0 * * *"
  sidecarContainers:
    - name: filebeat-sidecar
      image: docker.elastic.co/beats/filebeat:7.5.0
      args: ["-c", "/etc/filebeat.yml", "-e"]