agent

Documentation

Overview

Copyright 2024 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func NewLeaseInformerWithMetrics(client kubernetes.Interface, namespace string, resyncPeriod time.Duration) cache.SharedIndexInformer
• type Client
  • func (a *Client) Close()
  • func (a *Client) Connect() (int, error)
  • func (a *Client) Recv() (*client.Packet, error)
  • func (a *Client) Send(pkt *client.Packet) error
  • func (a *Client) Serve()
• type ClientSet
  • func (cs *ClientSet) AddClient(serverID string, c *Client) error
  • func (cs *ClientSet) ClientsCount() int
  • func (cs *ClientSet) HasID(serverID string) bool
  • func (cs *ClientSet) HealthyClientsCount() int
  • func (cs *ClientSet) Ready() bool
  • func (cs *ClientSet) RemoveClient(serverID string)
  • func (cs *ClientSet) Serve()
  • func (cs *ClientSet) ServerCount() int
• type ClientSetConfig
  • func (cc *ClientSetConfig) NewAgentClientSet(drainCh, stopCh <-chan struct{}) *ClientSet
• type DuplicateServerError
  • func (dse *DuplicateServerError) Error() string
• type HealthChecker
  • func NewServerConnected(cs ReadinessManager) HealthChecker
• type ReadinessManager
• type ServerCounter
• type ServerLeaseCounter
  • func NewServerLeaseCounter(pc clock.PassiveClock, leaseLister coordinationv1lister.LeaseLister, ...) *ServerLeaseCounter
  • func (lc *ServerLeaseCounter) Count() int

Functions

func NewLeaseInformerWithMetrics

func NewLeaseInformerWithMetrics(client kubernetes.Interface, namespace string, resyncPeriod time.Duration) cache.SharedIndexInformer

Types

type Client

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

Client runs on the node network side. It connects to proxy server and establishes a stream connection from which it sends and receives network traffic.

func (*Client) Close

func (a *Client) Close()

Close closes the Connect gRPC connection.

func (*Client) Connect

func (a *Client) Connect() (int, error)

Connect makes the grpc dial to the proxy server. It returns the serverID it connects to.

func (*Client) Recv

func (a *Client) Recv() (*client.Packet, error)

func (*Client) Send

func (a *Client) Send(pkt *client.Packet) error

func (*Client) Serve

func (a *Client) Serve()

Serve starts to serve proxied requests from proxy server over the gRPC stream. Successful Connect is required before Serve. The The requests include things like opening a connection to a server, streaming data and close the connection.

type ClientSet

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

ClientSet consists of clients connected to each instance of an HA proxy server.

func (*ClientSet) AddClient

func (cs *ClientSet) AddClient(serverID string, c *Client) error

func (*ClientSet) ClientsCount

func (cs *ClientSet) ClientsCount() int

func (*ClientSet) HasID

func (cs *ClientSet) HasID(serverID string) bool

func (*ClientSet) HealthyClientsCount

func (cs *ClientSet) HealthyClientsCount() int

func (*ClientSet) Ready

func (cs *ClientSet) Ready() bool

func (*ClientSet) RemoveClient

func (cs *ClientSet) RemoveClient(serverID string)

func (*ClientSet) Serve

func (cs *ClientSet) Serve()

func (*ClientSet) ServerCount

func (cs *ClientSet) ServerCount() int

type ClientSetConfig

type ClientSetConfig struct {
	Address                 string
	AgentID                 string
	AgentIdentifiers        string
	SyncInterval            time.Duration
	ProbeInterval           time.Duration
	SyncIntervalCap         time.Duration
	DialOptions             []grpc.DialOption
	ServiceAccountTokenPath string
	WarnOnChannelLimit      bool
	SyncForever             bool
	XfrChannelSize          int
	ServerLeaseCounter      ServerCounter
	ServerCountSource       string
}

func (*ClientSetConfig) NewAgentClientSet

func (cc *ClientSetConfig) NewAgentClientSet(drainCh, stopCh <-chan struct{}) *ClientSet

type DuplicateServerError

type DuplicateServerError struct {
	ServerID string
}

func (*DuplicateServerError) Error

func (dse *DuplicateServerError) Error() string

type HealthChecker

type HealthChecker interface {
	Name() string
	Check(req *http.Request) error
}

HealthChecker represents an entity capable of performing health checks.

var Ping HealthChecker = &ping{}

var ServerConnected HealthChecker = &serverConnected{}

func NewServerConnected

func NewServerConnected(cs ReadinessManager) HealthChecker

type ReadinessManager

type ReadinessManager interface {
	// Ready returns true the proxy server is ready.
	Ready() bool
}

ReadinessManager supports checking if the agent is ready.

type ServerCounter

type ServerCounter interface {
	Count() int
}

type ServerLeaseCounter

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

A ServerLeaseCounter counts leases in the k8s apiserver to determine the current proxy server count.

func NewServerLeaseCounter

func NewServerLeaseCounter(pc clock.PassiveClock, leaseLister coordinationv1lister.LeaseLister, labelSelector labels.Selector) *ServerLeaseCounter

NewServerLeaseCounter creates a server counter that counts valid leases that match the label selector and provides the fallback count (initially 0) if this fails.

func (*ServerLeaseCounter) Count

func (lc *ServerLeaseCounter) Count() int

Count counts the number of leases in the apiserver matching the provided label selector.

In the event that no valid leases are found or lease listing fails, the fallback count is returned. This fallback count is updated upon successful discovery of valid leases.