ProxyGroup defines a set of Tailscale devices that will act as proxies. Depending on spec.Type, it can be a group of egress, ingress, or kube-apiserver proxies. In addition to running a highly available set of proxies, ingress and egress ProxyGroups also allow for serving many annotated Services from a single set of proxies to minimise resource consumption. For ingress and egress, use the tailscale.com/proxy-group annotation on a Service to specify that the proxy should be implemented by a ProxyGroup instead of a single dedicated proxy. More info: * https://tailscale.com/kb/1438/kubernetes-operator-cluster-egress * https://tailscale.com/kb/1439/kubernetes-operator-cluster-ingress For kube-apiserver, the ProxyGroup is a standalone resource. Use the spec.kubeAPIServer field to configure options specific to the kube-apiserver ProxyGroup type.
Last changed in Tailscale Operator v1.86.0
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 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
Spec describes the desired ProxyGroup instances.
HostnamePrefix is the hostname prefix to use for tailnet devices created by the ProxyGroup. 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.
KubeAPIServer contains configuration specific to the kube-apiserver ProxyGroup type. This field is only used when Type is set to "kube-apiserver".
Hostname is the hostname with which to expose the Kubernetes API server proxies. Must be a valid DNS label no longer than 63 characters. If not specified, the name of the ProxyGroup is used as the hostname. Must be unique across the whole tailnet.
Mode to run the API server proxy in. Supported modes are auth and noauth. In auth mode, requests from the tailnet proxied over to the Kubernetes API server are additionally impersonated using the sender's tailnet identity. If not specified, defaults to auth mode.
ProxyClass is the name of the ProxyClass custom resource that contains configuration options that should be applied to the resources created for this ProxyGroup. If unset, and there is no default ProxyClass configured, the operator will create resources with the default configuration.
Replicas specifies how many replicas to create the StatefulSet with. Defaults to 2.
Tags that the Tailscale devices will be tagged with. Defaults to [tag:k8s]. If you specify custom tags here, make sure you 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 ProxyGroup device has been created. Tag values must be in form ^tag:[a-zA-Z][a-zA-Z0-9-]*$.
Type of the ProxyGroup proxies. Supported types are egress, ingress, and kube-apiserver. Type is immutable once a ProxyGroup is created.
ProxyGroupStatus describes the status of the ProxyGroup resources. This is set and managed by the Tailscale operator.
List of status conditions to indicate the status of the ProxyGroup resources. Known condition types include `ProxyGroupReady` and `ProxyGroupAvailable`. * `ProxyGroupReady` indicates all ProxyGroup resources are reconciled and all expected conditions are true. * `ProxyGroupAvailable` indicates that at least one proxy is ready to serve traffic. For ProxyGroups of type kube-apiserver, there are two additional conditions: * `KubeAPIServerProxyConfigured` indicates that at least one API server proxy is configured and ready to serve traffic. * `KubeAPIServerProxyValid` indicates that spec.kubeAPIServer config is valid.
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.
message is a human readable message indicating details about the transition. This may be an empty string.
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.
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.
status of the condition, one of True, False, Unknown.
type of condition in CamelCase or in foo.example.com/CamelCase.
List of tailnet devices associated with the ProxyGroup StatefulSet.
Hostname is the fully qualified domain name of the device. If MagicDNS is enabled in your tailnet, it is the MagicDNS name of the node.
StaticEndpoints are user configured, 'static' endpoints by which tailnet peers can reach this device.
TailnetIPs is the set of tailnet IP addresses (both IPv4 and IPv6) assigned to the device.
URL of the kube-apiserver proxy advertised by the ProxyGroup devices, if any. Only applies to ProxyGroups of type kube-apiserver.
Source: tailscale.com_proxygroups.yaml
Changes to ProxyGroup (tailscale.com/v1alpha1) in each Tailscale Operator version, compared to the version before it.
3 properties have been added
The description of ProxyGroup has changed
2 properties have changed the description
Released · View ProxyGroup in v1.86.0
1 property has changed the description
Released · View ProxyGroup in v1.84.0
The description of ProxyGroup has changed
1 property has changed the description
Released · View ProxyGroup in v1.80.0
ProxyGroup was first seen on this version of Tailscale Operator
Released · View ProxyGroup in v1.76.0
No examples of ProxyGroup yet. Contribute one on GitHub.
kubespec.dev