kube
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
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 GetServiceCondition(svc *corev1.Service, conditionType tsapi.ConditionType) *metav1.Condition
- func KubeAPIServerProxyConfigured(pg *tsapi.ProxyGroup) bool
- func KubeAPIServerProxyValid(pg *tsapi.ProxyGroup) (valid bool, set bool)
- func ProxyClassIsReady(pc *tsapi.ProxyClass) bool
- func ProxyGroupAvailable(pg *tsapi.ProxyGroup) 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 SvcIsReady(svc *corev1.Service) bool
- func TailscaledConfigFileName(cap tailcfg.CapabilityVersion) string
- type Records
Constants¶
const (Alpha1Version = "v1alpha1"DNSRecordsCMName = "dnsrecords"DNSRecordsCMKey = "records.json")
Variables¶
This section is empty.
Functions¶
funcCapVerFromFileName¶added inv1.66.2
func CapVerFromFileName(namestring) (tailcfg.CapabilityVersion,error)
CapVerFromFileName parses the capability version from a tailscaledconfig file name previously generated by TailscaledConfigFileNameForCap.
funcDNSCfgIsReady¶added inv1.66.0
funcGetServiceCondition¶added inv1.76.0
GetServiceCondition returns Service condition with the specified type, if it exists on the Service.
funcKubeAPIServerProxyConfigured¶added inv1.86.0
func KubeAPIServerProxyConfigured(pg *tsapi.ProxyGroup)bool
funcKubeAPIServerProxyValid¶added inv1.86.0
func KubeAPIServerProxyValid(pg *tsapi.ProxyGroup) (validbool, setbool)
funcProxyClassIsReady¶added inv1.60.0
func ProxyClassIsReady(pc *tsapi.ProxyClass)bool
funcProxyGroupAvailable¶added inv1.86.0
func ProxyGroupAvailable(pg *tsapi.ProxyGroup)bool
funcProxyGroupIsReady¶added inv1.76.0
func ProxyGroupIsReady(pg *tsapi.ProxyGroup)bool
funcRemoveConnectorCondition¶
func RemoveConnectorCondition(conn *tsapi.Connector, conditionTypetsapi.ConditionType)
RemoveConnectorCondition will remove condition of the given type if it exists.
funcRemoveServiceCondition¶added inv1.70.0
func RemoveServiceCondition(svc *corev1.Service, conditionTypetsapi.ConditionType)
RemoveServiceCondition will remove condition of the given type if it exists.
funcSetConnectorCondition¶
func SetConnectorCondition(cn *tsapi.Connector, conditionTypetsapi.ConditionType, statusmetav1.ConditionStatus, reason, messagestring, genint64, clocktstime.Clock, logger *zap.SugaredLogger)
SetConnectorCondition ensures that Connector status has a condition with thegiven attributes. LastTransitionTime gets set every time condition's statuschanges.
funcSetDNSConfigCondition¶added inv1.66.0
func SetDNSConfigCondition(dnsCfg *tsapi.DNSConfig, conditionTypetsapi.ConditionType, statusmetav1.ConditionStatus, reason, messagestring, genint64, clocktstime.Clock, logger *zap.SugaredLogger)
SetDNSConfigCondition ensures that DNSConfig status has a condition with thegiven attributes. LastTransitionTime gets set every time condition's statuschanges
funcSetProxyClassCondition¶added inv1.60.0
func SetProxyClassCondition(pc *tsapi.ProxyClass, conditionTypetsapi.ConditionType, statusmetav1.ConditionStatus, reason, messagestring, genint64, clocktstime.Clock, logger *zap.SugaredLogger)
SetProxyClassCondition ensures that ProxyClass status has a condition with thegiven attributes. LastTransitionTime gets set every time condition's statuschanges.
funcSetProxyGroupCondition¶added inv1.76.0
func SetProxyGroupCondition(pg *tsapi.ProxyGroup, conditionTypetsapi.ConditionType, statusmetav1.ConditionStatus, reason, messagestring, genint64, clocktstime.Clock, logger *zap.SugaredLogger)
SetProxyGroupCondition ensures that ProxyGroup status has a condition with thegiven attributes. LastTransitionTime gets set every time condition's statuschanges.
funcSetRecorderCondition¶added inv1.74.0
func SetRecorderCondition(tsr *tsapi.Recorder, conditionTypetsapi.ConditionType, statusmetav1.ConditionStatus, reason, messagestring, genint64, clocktstime.Clock, logger *zap.SugaredLogger)
SetRecorderCondition ensures that Recorder status has a condition with thegiven attributes. LastTransitionTime gets set every time condition's statuschanges.
funcSetServiceCondition¶added inv1.70.0
func SetServiceCondition(svc *corev1.Service, conditionTypetsapi.ConditionType, statusmetav1.ConditionStatus, reason, messagestring, clocktstime.Clock, logger *zap.SugaredLogger)
SetServiceCondition ensures that Service status has a condition with thegiven attributes. LastTransitionTime gets set every time condition's statuschanges.
funcSvcIsReady¶added inv1.80.0
funcTailscaledConfigFileName¶added inv1.76.0
func TailscaledConfigFileName(captailcfg.CapabilityVersion)string
TailscaledConfigFileName returns a tailscaled config file name informat expected by containerboot for the given CapVer.
Types¶
typeRecords¶added inv1.66.0
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.Versionstring `json:"version"`// IP4 contains a mapping of DNS names to IPv4 address(es).IP4 map[string][]string `json:"ip4"`// IP6 contains a mapping of DNS names to IPv6 address(es).// This field is optional and will be omitted from JSON if empty.// It enables dual-stack DNS support in Kubernetes clusters.// +optionalIP6 map[string][]string `json:"ip6,omitempty"`}
Directories¶
| Path | Synopsis |
|---|---|
Package apiproxy contains the Kubernetes API Proxy implementation used by k8s-operator and k8s-proxy. | Package apiproxy contains the Kubernetes API Proxy implementation used by k8s-operator and k8s-proxy. |
Package apis contains a constant to name the Tailscale Kubernetes Operator's schema group. | Package apis contains a constant to name the Tailscale Kubernetes Operator's schema group. |
v1alpha1 +kubebuilder:object:generate=true +groupName=tailscale.com | +kubebuilder:object:generate=true +groupName=tailscale.com |
Package sessionrecording contains functionality for recording Kubernetes API server proxy 'kubectl exec/attach' sessions. | Package sessionrecording contains functionality for recording Kubernetes API server proxy 'kubectl exec/attach' sessions. |
fakes Package fakes contains mocks used for testing 'kubectl exec' session recording functionality. | Package fakes contains mocks used for testing 'kubectl exec' session recording functionality. |
spdy Package spdy contains functionality for parsing SPDY streaming sessions. | Package spdy contains functionality for parsing SPDY streaming sessions. |
tsrecorder Package tsrecorder contains functionality for connecting to a tsrecorder instance. | Package tsrecorder contains functionality for connecting to a tsrecorder instance. |
ws package ws has functionality to parse 'kubectl exec/attach' sessions streamed using WebSocket protocol. | package ws has functionality to parse 'kubectl exec/attach' sessions streamed using WebSocket protocol. |