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 * * *"

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

Exposing a cluster workload by annotating an existing Service

Edit the Service and under metadata.annotations add the annotation twingate.com/resource with a "true" value. Note that "true" is quoted because annotation values are strings, and an unquoted true will be incorrectly interpreted as a boolean.

When you do this, the operator will create a TwingateResource object based on your Service properties. You can further customize the generated TwingateResource object by adding more annotations on the Service, each matches the respective TwingateResource spec property:

• twingate.com/resource-name - the resource's name in the Twingate Admin Console.
• twingate.com/resource-alias - the resource's alias.
• twingate.com/resource-isBrowserShortcutEnabled - wether the “Open in Browser” should show for this resource.
• twingate.com/resource-securityPolicyId - assign a Security Policy to this resource.
• twingate.com/resource-isVisible - is the resource visibile in the client dropdown menu.

Example:

apiVersion: v1
kind: Service
metadata:
  name: my-service-local
  annotations:
    twingate.com/resource: "true"
    twingate.com/resource-alias: "myapp.internal"
spec:
  selector:
    app.kubernetes.io/name: MyApp
  ports:
    - protocol: TCP
      port: 80
      targetPort: 9376
      name: first
    - protocol: UDP
      port: 22
      targetPort: 9376
      name: second