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
- 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) - Twingate API token with
Read/Write/Provision
permissions - this can be generated in the Twingate Admin Console
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:
- Create a custom
values.yaml
(You can start by copying the default values .yaml file): - Edit the settings in the file and specifically
twingateOperator
. - 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
-
Clone this repository to your local machine.
-
Use the
helm
chart in./deploy/twingate-operator
:- Create a custom
values.yaml
:
cp ./deploy/twingate-operator/values.yaml ./deploy/twingate-operator/values.local.yaml
- Edit the settings (
twingateOperator
specifically) in./deploy/twingate-operator/values.local.yaml
- 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
- Create a custom
With Helm v3, CRDs created by this chart are not updated by default and should be manually updated. Consult also the Helm Documentation on CRDs.
See helm upgrade for command documentation.
See CHANGELOG
- 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
See developer guide