kube

Documentation

Overview

Package kube implements the shared and reusable library for Kubernetes

Index

• Constants
• func ConvertProtocol(name string, proto v1.Protocol) model.Protocol
• func CreateInterface(kubeconfig string) (*rest.Config, kubernetes.Interface, error)
• func KeyFunc(name, namespace string) string
• func RegisterEndpoint(client kubernetes.Interface, namespace string, svcName string, ip string, ...) error
• func ResolveConfig(kubeconfig string) (string, error)
• type ChainHandler
  • func (ch *ChainHandler) Append(h Handler)
  • func (ch *ChainHandler) Apply(obj interface{}, event model.Event) error
• type Controller
  • func NewController(client kubernetes.Interface, options ControllerOptions) *Controller
  • func (c *Controller) AppendInstanceHandler(f func(*model.ServiceInstance, model.Event)) error
  • func (c *Controller) AppendServiceHandler(f func(*model.Service, model.Event)) error
  • func (c *Controller) GetIstioServiceAccounts(hostname string, ports []string) []string
  • func (c *Controller) GetPodAZ(pod *v1.Pod) (string, bool)
  • func (c *Controller) GetService(hostname string) (*model.Service, bool)
  • func (c *Controller) HasSynced() bool
  • func (c *Controller) HostInstances(addrs map[string]bool) []*model.ServiceInstance
  • func (c *Controller) Instances(hostname string, ports []string, labelsList model.LabelsCollection) []*model.ServiceInstance
  • func (c *Controller) ManagementPorts(addr string) model.PortList
  • func (c *Controller) Run(stop <-chan struct{})
  • func (c *Controller) Services() []*model.Service
• type ControllerOptions
• type Handler
• type NamedPort
  • func Str2NamedPort(str string) (NamedPort, error)
• type PodCache
• type Queue
  • func NewQueue(errorDelay time.Duration) Queue
• type Task
  • func NewTask(handler Handler, obj interface{}, event model.Event) Task

Constants

const (
	// NodeRegionLabel is the well-known label for kubernetes node region
	NodeRegionLabel = "failure-domain.beta.kubernetes.io/region"
	// NodeZoneLabel is the well-known label for kubernetes node zone
	NodeZoneLabel = "failure-domain.beta.kubernetes.io/zone"
	// IstioNamespace used by default for Istio cluster-wide installation
	IstioNamespace = "istio-system"
)

const (
	// IngressClassAnnotation is the annotation on ingress resources for the class of controllers
	// responsible for it
	IngressClassAnnotation = "kubernetes.io/ingress.class"

	// KubeServiceAccountsOnVMAnnotation is to specify the K8s service accounts that are allowed to run
	// this service on the VMs
	KubeServiceAccountsOnVMAnnotation = "alpha.istio.io/kubernetes-serviceaccounts"

	// CanonicalServiceAccountsOnVMAnnotation is to specify the non-Kubernetes service accounts that
	// are allowed to run this service on the VMs
	CanonicalServiceAccountsOnVMAnnotation = "alpha.istio.io/canonical-serviceaccounts"

	// IstioURIPrefix is the URI prefix in the Istio service account scheme
	IstioURIPrefix = "spiffe"
)

Functions

func ConvertProtocol

func ConvertProtocol(name string, proto v1.Protocol) model.Protocol

ConvertProtocol from k8s protocol and port name

func CreateInterface

func CreateInterface(kubeconfig string) (*rest.Config, kubernetes.Interface, error)

CreateInterface is a helper function to create Kubernetes interface

func KeyFunc

func KeyFunc(name, namespace string) string

KeyFunc is the internal API key function that returns "namespace"/"name" or "name" if "namespace" is empty

func RegisterEndpoint

func RegisterEndpoint(client kubernetes.Interface, namespace string, svcName string,
	ip string, portsList []NamedPort, labels []string, annotations []string) error

RegisterEndpoint registers the endpoint (and the service if it doesn't already exists). It creates or updates as needed. When creating it adds the optional labels.

func ResolveConfig

func ResolveConfig(kubeconfig string) (string, error)

ResolveConfig checks whether to use the in-cluster or out-of-cluster config

Types

type ChainHandler

type ChainHandler struct {
	// contains filtered or unexported fields
}

ChainHandler applies handlers in a sequence

func (*ChainHandler) Append

func (ch *ChainHandler) Append(h Handler)

Append a handler as the last handler in the chain

func (*ChainHandler) Apply

func (ch *ChainHandler) Apply(obj interface{}, event model.Event) error

Apply is the handler function

type Controller

type Controller struct {
	// contains filtered or unexported fields
}

Controller is a collection of synchronized resource watchers Caches are thread-safe

func NewController

func NewController(client kubernetes.Interface, options ControllerOptions) *Controller

NewController creates a new Kubernetes controller

func (*Controller) AppendInstanceHandler

func (c *Controller) AppendInstanceHandler(f func(*model.ServiceInstance, model.Event)) error

AppendInstanceHandler implements a service catalog operation

func (*Controller) AppendServiceHandler

func (c *Controller) AppendServiceHandler(f func(*model.Service, model.Event)) error

AppendServiceHandler implements a service catalog operation

func (*Controller) GetIstioServiceAccounts

func (c *Controller) GetIstioServiceAccounts(hostname string, ports []string) []string

GetIstioServiceAccounts returns the Istio service accounts running a serivce hostname. Each service account is encoded according to the SPIFFE VSID spec. For example, a service account named "bar" in namespace "foo" is encoded as "spiffe://cluster.local/ns/foo/sa/bar".

func (*Controller) GetPodAZ

func (c *Controller) GetPodAZ(pod *v1.Pod) (string, bool)

GetPodAZ retrieves the AZ for a pod.

func (*Controller) GetService

func (c *Controller) GetService(hostname string) (*model.Service, bool)

GetService implements a service catalog operation

func (*Controller) HasSynced

func (c *Controller) HasSynced() bool

HasSynced returns true after the initial state synchronization

func (*Controller) HostInstances

func (c *Controller) HostInstances(addrs map[string]bool) []*model.ServiceInstance

HostInstances implements a service catalog operation

func (*Controller) Instances

func (c *Controller) Instances(hostname string, ports []string,
	labelsList model.LabelsCollection) []*model.ServiceInstance

Instances implements a service catalog operation

func (*Controller) ManagementPorts

func (c *Controller) ManagementPorts(addr string) model.PortList

ManagementPorts implements a service catalog operation

func (*Controller) Run

func (c *Controller) Run(stop <-chan struct{})

Run all controllers until a signal is received

func (*Controller) Services

func (c *Controller) Services() []*model.Service

Services implements a service catalog operation

type ControllerOptions

type ControllerOptions struct {
	// Namespace the controller watches. If set to meta_v1.NamespaceAll (""), controller watches all namespaces
	WatchedNamespace string
	ResyncPeriod     time.Duration
	DomainSuffix     string
}

ControllerOptions stores the configurable attributes of a Controller.

type Handler

type Handler func(obj interface{}, event model.Event) error

Handler specifies a function to apply on an object for a given event type

type NamedPort

type NamedPort struct {
	Port int32
	Name string
}

NamedPort defines the Port and Name tuple needed for services and endpoints.

func Str2NamedPort

func Str2NamedPort(str string) (NamedPort, error)

Str2NamedPort parses a proto:port string into a namePort struct.

type PodCache

type PodCache struct {
	// contains filtered or unexported fields
}

PodCache is an eventually consistent pod cache

type Queue

type Queue interface {
	// Push a ticket
	Push(Task)
	// Run the loop until a signal on the channel
	Run(<-chan struct{})
}

Queue of work tickets processed using a rate-limiting loop

func NewQueue

func NewQueue(errorDelay time.Duration) Queue

NewQueue instantiates a queue with a processing function

type Task

type Task struct {
	// contains filtered or unexported fields
}

Task object for the event watchers; processes until handler succeeds

func NewTask

func NewTask(handler Handler, obj interface{}, event model.Event) Task

NewTask creates a task from a work item