Connector v1alpha1 — tailscale.com

apiVersion string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata object

spec object required

ConnectorSpec describes the desired Tailscale component. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

appConnector object

AppConnector defines whether the Connector device should act as a Tailscale app connector. A Connector that is configured as an app connector cannot be a subnet router or an exit node. If this field is unset, the Connector does not act as an app connector. Note that you will need to manually configure the permissions and the domains for the app connector via the Admin panel. Note also that the main tested and supported use case of this config option is to deploy an app connector on Kubernetes to access SaaS applications available on the public internet. Using the app connector to expose cluster workloads or other internal workloads to tailnet might work, but this is not a use case that we have tested or optimised for. If you are using the app connector to access SaaS applications because you need a predictable egress IP that can be whitelisted, it is also your responsibility to ensure that cluster traffic from the connector flows via that predictable IP, for example by enforcing that cluster egress traffic is routed via an egress NAT device with a static IP address. https://tailscale.com/kb/1281/app-connectors

routes []string

Routes are optional preconfigured routes for the domains routed via the app connector. If not set, routes for the domains will be discovered dynamically. If set, the app connector will immediately be able to route traffic using the preconfigured routes, but may also dynamically discover other routes. https://tailscale.com/kb/1332/apps-best-practices#preconfiguration

minItems: 1

exitNode boolean

ExitNode defines whether the Connector device should act as a Tailscale exit node. Defaults to false. This field is mutually exclusive with the appConnector field. https://tailscale.com/kb/1103/exit-nodes

hostname string

Hostname is the tailnet hostname that should be assigned to the Connector node. If unset, hostname defaults to <connector name>-connector. Hostname can contain lower case letters, numbers and dashes, it must not start or end with a dash and must be between 2 and 63 characters long. This field should only be used when creating a connector with an unspecified number of replicas, or a single replica.

pattern: ^[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$

hostnamePrefix string

HostnamePrefix specifies the hostname prefix for each replica. Each device will have the integer number from its StatefulSet pod appended to this prefix to form the full hostname. HostnamePrefix can contain lower case letters, numbers and dashes, it must not start with a dash and must be between 1 and 62 characters long.

pattern: ^[a-z0-9][a-z0-9-]{0,61}$

proxyClass string

ProxyClass is the name of the ProxyClass custom resource that contains configuration options that should be applied to the resources created for this Connector. If unset, the operator will create resources with the default configuration.

replicas integer

Replicas specifies how many devices to create. Set this to enable high availability for app connectors, subnet routers, or exit nodes. https://tailscale.com/kb/1115/high-availability. Defaults to 1.

format: int32

minimum: 0

subnetRouter object

SubnetRouter defines subnet routes that the Connector device should expose to tailnet as a Tailscale subnet router. https://tailscale.com/kb/1019/subnets/ If this field is unset, the device does not get configured as a Tailscale subnet router. This field is mutually exclusive with the appConnector field.

advertiseRoutes []string required

AdvertiseRoutes refer to CIDRs that the subnet router should make available. Route values must be strings that represent a valid IPv4 or IPv6 CIDR range. Values can be Tailscale 4via6 subnet routes. https://tailscale.com/kb/1201/4via6-subnets/

minItems: 1

tags []string

Tags that the Tailscale node will be tagged with. Defaults to [tag:k8s]. To autoapprove the subnet routes or exit node defined by a Connector, you can configure Tailscale ACLs to give these tags the necessary permissions. See https://tailscale.com/kb/1337/acl-syntax#autoapprovers. If you specify custom tags here, you must also make the operator an owner of these tags. See https://tailscale.com/kb/1236/kubernetes-operator/#setting-up-the-kubernetes-operator. Tags cannot be changed once a Connector node has been created. Tag values must be in form ^tag:[a-zA-Z][a-zA-Z0-9-]*$.

tailnet string

Tailnet specifies the tailnet this Connector should join. If blank, the default tailnet is used. When set, this name must match that of a valid Tailnet resource. This field is immutable and cannot be changed once set.

status object

ConnectorStatus describes the status of the Connector. This is set and managed by the Tailscale operator.

conditions []object

List of status conditions to indicate the status of the Connector. Known condition types are `ConnectorReady`.

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

format: date-time

message string required

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

format: int64

minimum: 0

reason string required

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

type of condition in CamelCase or in foo.example.com/CamelCase.

pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

maxLength: 316

devices []object

Devices contains information on each device managed by the Connector resource.

hostname string

Hostname is the fully qualified domain name of the Connector replica. If MagicDNS is enabled in your tailnet, it is the MagicDNS name of the node.

tailnetIPs []string

TailnetIPs is the set of tailnet IP addresses (both IPv4 and IPv6) assigned to the Connector replica.

hostname string

Hostname is the fully qualified domain name of the Connector node. If MagicDNS is enabled in your tailnet, it is the MagicDNS name of the node. When using multiple replicas, this field will be populated with the first replica's hostname. Use the Hostnames field for the full list of hostnames.

isAppConnector boolean

IsAppConnector is set to true if the Connector acts as an app connector.

isExitNode boolean

IsExitNode is set to true if the Connector acts as an exit node.

subnetRoutes string

SubnetRoutes are the routes currently exposed to tailnet via this Connector instance.

tailnetIPs []string

TailnetIPs is the set of tailnet IP addresses (both IPv4 and IPv6) assigned to the Connector node.