kube

Documentation

Overview

Package kube contains types and utilities for the Tailscale Kubernetes Operator.

Index

• Constants
• func CapVerFromFileName(name string) (tailcfg.CapabilityVersion, error)
• func DNSCfgIsReady(cfg *tsapi.DNSConfig) bool
• func EgressServiceIsValidAndConfigured(svc *corev1.Service) bool
• func GetServiceCondition(svc *corev1.Service, conditionType tsapi.ConditionType) *metav1.Condition
• func ProxyClassIsReady(pc *tsapi.ProxyClass) bool
• func ProxyGroupIsReady(pg *tsapi.ProxyGroup) bool
• func RemoveConnectorCondition(conn *tsapi.Connector, conditionType tsapi.ConditionType)
• func RemoveServiceCondition(svc *corev1.Service, conditionType tsapi.ConditionType)
• func SetConnectorCondition(cn *tsapi.Connector, conditionType tsapi.ConditionType, ...)
• func SetDNSConfigCondition(dnsCfg *tsapi.DNSConfig, conditionType tsapi.ConditionType, ...)
• func SetProxyClassCondition(pc *tsapi.ProxyClass, conditionType tsapi.ConditionType, ...)
• func SetProxyGroupCondition(pg *tsapi.ProxyGroup, conditionType tsapi.ConditionType, ...)
• func SetRecorderCondition(tsr *tsapi.Recorder, conditionType tsapi.ConditionType, ...)
• func SetServiceCondition(svc *corev1.Service, conditionType tsapi.ConditionType, ...)
• func TailscaledConfigFileName(cap tailcfg.CapabilityVersion) string
• type Records

Constants

const (
	Alpha1Version = "v1alpha1"

	DNSRecordsCMName = "dnsrecords"
	DNSRecordsCMKey  = "records.json"
)

Functions

func CapVerFromFileName

func CapVerFromFileName(name string) (tailcfg.CapabilityVersion, error)

CapVerFromFileName parses the capability version from a tailscaled config file name previously generated by TailscaledConfigFileNameForCap.

func DNSCfgIsReady

func DNSCfgIsReady(cfg *tsapi.DNSConfig) bool

func EgressServiceIsValidAndConfigured

func EgressServiceIsValidAndConfigured(svc *corev1.Service) bool

func GetServiceCondition

func GetServiceCondition(svc *corev1.Service, conditionType tsapi.ConditionType) *metav1.Condition

GetServiceCondition returns Service condition with the specified type, if it exists on the Service.

func ProxyClassIsReady

func ProxyClassIsReady(pc *tsapi.ProxyClass) bool

func ProxyGroupIsReady

func ProxyGroupIsReady(pg *tsapi.ProxyGroup) bool

func RemoveConnectorCondition

func RemoveConnectorCondition(conn *tsapi.Connector, conditionType tsapi.ConditionType)

RemoveConnectorCondition will remove condition of the given type if it exists.

func RemoveServiceCondition

func RemoveServiceCondition(svc *corev1.Service, conditionType tsapi.ConditionType)

RemoveServiceCondition will remove condition of the given type if it exists.

func SetConnectorCondition

func SetConnectorCondition(cn *tsapi.Connector, conditionType tsapi.ConditionType, status metav1.ConditionStatus, reason, message string, gen int64, clock tstime.Clock, logger *zap.SugaredLogger)

SetConnectorCondition ensures that Connector status has a condition with the given attributes. LastTransitionTime gets set every time condition's status changes.

func SetDNSConfigCondition

func SetDNSConfigCondition(dnsCfg *tsapi.DNSConfig, conditionType tsapi.ConditionType, status metav1.ConditionStatus, reason, message string, gen int64, clock tstime.Clock, logger *zap.SugaredLogger)

SetDNSConfigCondition ensures that DNSConfig status has a condition with the given attributes. LastTransitionTime gets set every time condition's status changes

func SetProxyClassCondition

func SetProxyClassCondition(pc *tsapi.ProxyClass, conditionType tsapi.ConditionType, status metav1.ConditionStatus, reason, message string, gen int64, clock tstime.Clock, logger *zap.SugaredLogger)

SetProxyClassCondition ensures that ProxyClass status has a condition with the given attributes. LastTransitionTime gets set every time condition's status changes.

func SetProxyGroupCondition

func SetProxyGroupCondition(pg *tsapi.ProxyGroup, conditionType tsapi.ConditionType, status metav1.ConditionStatus, reason, message string, gen int64, clock tstime.Clock, logger *zap.SugaredLogger)

SetProxyGroupCondition ensures that ProxyGroup status has a condition with the given attributes. LastTransitionTime gets set every time condition's status changes.

func SetRecorderCondition

func SetRecorderCondition(tsr *tsapi.Recorder, conditionType tsapi.ConditionType, status metav1.ConditionStatus, reason, message string, gen int64, clock tstime.Clock, logger *zap.SugaredLogger)

SetRecorderCondition ensures that Recorder status has a condition with the given attributes. LastTransitionTime gets set every time condition's status changes.

func SetServiceCondition

func SetServiceCondition(svc *corev1.Service, conditionType tsapi.ConditionType, status metav1.ConditionStatus, reason, message string, clock tstime.Clock, logger *zap.SugaredLogger)

SetServiceCondition ensures that Service status has a condition with the given attributes. LastTransitionTime gets set every time condition's status changes.

func TailscaledConfigFileName

func TailscaledConfigFileName(cap tailcfg.CapabilityVersion) string

TailscaledConfigFileName returns a tailscaled config file name in format expected by containerboot for the given CapVer.

Types

type Records

type Records struct {
	// Version is the version of this Records configuration. Version is
	// written by the operator, i.e when it first populates the Records.
	// k8s-nameserver must verify that it knows how to parse a given
	// version.
	Version string `json:"version"`
	// IP4 contains a mapping of DNS names to IPv4 address(es).
	IP4 map[string][]string `json:"ip4"`
}