Twingate Kubernetes Operator

[!IMPORTANT] Beta: The Twingate K8S Operator is currently in beta

The Twingate Kubernetes Controller is a custom controller designed to automate and manage Twingate resources within a Kubernetes environment. It provides seamless integration between your Kubernetes clusters and the Twingate Zero Trust Network.

Wiki | Getting Started | API Reference

Prerequisites

• Kubernetes cluster (1.16+)
• Twingate account and resources (Gateways, Networks, Applications, etc.)
• Twingate account setup with a Remote Network for the Kubernetes cluster and connectors deployed (see this Helm chart if required)
• Read/Write API token - this can be generated in the Twingate Admin Console

Installation

Helm via OCI (recommended)

The operator's helm chart is published to the following OCI repository: oci://ghcr.io/twingate/helmcharts/twingate-operator

Follow these steps to install the operator:

1. Create a custom values.yaml (You can start by copying the default values .yaml file):
2. Edit the settings in the file and specifically twingateOperator.
3. Deploy (add -n [namespace] if you want to install to a specific namespace):

helm upgrade twop oci://ghcr.io/twingate/helmcharts/twingate-operator --install --wait -f ./values.yaml

Helm by closing the git repository

1. Clone this repository to your local machine.

2. Use the helm chart in ./deploy/twingate-operator:

   1. Create a custom values.yaml:

   cp ./deploy/twingate-operator/values.yaml ./deploy/twingate-operator/values.local.yaml
   

   1. Edit the settings (twingateOperator specifically) in ./deploy/twingate-operator/values.local.yaml
   2. Deploy (add -n [namespace] if you want to install to a specific namespace):

   helm upgrade twop ./deploy/twingate-operator --install --wait -f ./deploy/twingate-operator/values.local.yaml
   

Changelog

See CHANGELOG

Support

• For general issues using this operator please open a GitHub issue.
• For account specific issues, please visit the Twingate forum or open a support ticket

Developers

See developer guide