kube

Documentation

Index

• Constants
• func CreateKubeClient(kubeConfig string, applyFuncs ...func(c *rest.Config)) (kubernetes.Interface, error)
• func GetKmeshNodeInfoClient() (nodeinfo.Interface, error)
• func NewInformerFactory(client kubernetes.Interface) informers.SharedInformerFactory
• type CLIClient
  • func NewCLIClient(opts ...ClientOption) (CLIClient, error)
• type Client
• type ClientOption
• type PortForwarder

Constants

const (
	DefaultLocalAddress      = "localhost"
	DefaultPodRunningTimeout = 30 * time.Second
	KmeshNamespace           = "kmesh-system"
)

Functions

func CreateKubeClient

func CreateKubeClient(kubeConfig string, applyFuncs ...func(c *rest.Config)) (kubernetes.Interface, error)

CreateKubeClient creates a kube client with the given kubeconfig file, if no kubeconfig specified, in cluster kubeconfig will be used. applyFuncs is optional, which can be used to tune client rest.Config

func GetKmeshNodeInfoClient

func GetKmeshNodeInfoClient() (nodeinfo.Interface, error)

func NewInformerFactory

func NewInformerFactory(client kubernetes.Interface) informers.SharedInformerFactory

Types

type CLIClient

type CLIClient interface {
	Client

	// PodsForSelector finds pods matching selector.
	PodsForSelector(ctx context.Context, namespace string, labelSelectors ...string) (*v1.PodList, error)

	// NewPortForwarder creates a new PortForwarder configured for the given pod. If localPort=0, a port will be
	// dynamically selected. If localAddress is empty, "localhost" is used.
	NewPortForwarder(podName string, ns string, localAddress string, localPort int, podPort int) (PortForwarder, error)
}

CLIClient extends the Client interface with additional functionality for CLI operations.

func NewCLIClient

func NewCLIClient(opts ...ClientOption) (CLIClient, error)

type Client

type Client interface {
	// Kube returns the core kube client
	Kube() kubernetes.Interface

	// GatewayAPI returns the gateway-api kube client.
	GatewayAPI() gatewayapiclient.Interface
}

Client defines the interface for accessing Kubernetes clients and resources.

type ClientOption

type ClientOption func(CLIClient) CLIClient

type PortForwarder

type PortForwarder interface {
	// Start runs this forwarder.
	Start() error

	// Address returns the local forwarded address. Only valid while the forwarder is running.
	Address() string

	// Close this forwarder and release an resources.
	Close()
}

PortForwarder manages the forwarding of a single port.