k8s

Documentation

Overview

Package k8s provides a k8s client.

Index

• func ConnectToServer(socket string) (*grpc.ClientConn, error)
• func CreateHTTPStreams(w http.ResponseWriter, req *http.Request, opts *remotecommand.StreamOptions) (*streamContext, error)
• func CreateListener(addr string) (net.Listener, error)
• type Client
  • func New(kubeconfigPath string, kubeletSocket string, logger *slog.Logger) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) ConfigMap(ctx context.Context, ns string, name string) (map[string]string, error)
  • func (c *Client) Exec(ctx context.Context, ns string, pod string, container string, cmd []string) ([]byte, []byte, error)
  • func (c *Client) ListPods(ctx context.Context, ns string, opts metav1.ListOptions) ([]Pod, error)
  • func (c *Client) ListPodsWithDevs(ctx context.Context) ([]Pod, error)
  • func (c *Client) ListUsers(ctx context.Context, ns string) (map[string][]string, error)
  • func (c *Client) NewPodInformer(resyncPeriod time.Duration) error
  • func (c *Client) Pods() []*v1.Pod
  • func (c *Client) StartInformer() error
• type Container
• type Device
• type FakeResourceServer
  • func FakeKubeletServer(socketDir string, listResp *podresourcesapi.ListPodResourcesResponse, ...) (*FakeResourceServer, error)
  • func (m *FakeResourceServer) Get(_ context.Context, _ *podresourcesapi.GetPodResourcesRequest) (*podresourcesapi.GetPodResourcesResponse, error)
  • func (m *FakeResourceServer) GetAllocatableResources(_ context.Context, _ *podresourcesapi.AllocatableResourcesRequest) (*podresourcesapi.AllocatableResourcesResponse, error)
  • func (m *FakeResourceServer) List(_ context.Context, _ *podresourcesapi.ListPodResourcesRequest) (*podresourcesapi.ListPodResourcesResponse, error)
• type Pod

Functions

func ConnectToServer

func ConnectToServer(socket string) (*grpc.ClientConn, error)

func CreateHTTPStreams

func CreateHTTPStreams(w http.ResponseWriter, req *http.Request, opts *remotecommand.StreamOptions) (*streamContext, error)

CreateHTTPStreams only support StreamProtocolV4Name Nicked from https://github.com/kubernetes/client-go/blob/c106b23895edc59ff05c65770a17e6a6d3caee66/tools/remotecommand/spdy_test.go#L227-L288

func CreateListener

func CreateListener(addr string) (net.Listener, error)

CreateListener creates a listener on the specified endpoint. based from k8s.io/kubernetes/pkg/kubelet/util Nicked from https://github.com/k8snetworkplumbingwg/multus-cni/blob/v4.2.0/pkg/kubeletclient/kubeletclient_test.go

Types

type Client

type Client struct {
	Logger            *slog.Logger
	Hostname          string
	Config            *rest.Config
	Clientset         kubernetes.Interface
	PodResourceClient podresourcesapi.PodResourcesListerClient
	PodInformer       coreinformers.PodInformer
	// contains filtered or unexported fields
}

func New

func New(kubeconfigPath string, kubeletSocket string, logger *slog.Logger) (*Client, error)

New returns an instance of Client struct.

func (*Client) Close

func (c *Client) Close() error

Close stops clients and release resources.

func (*Client) ConfigMap

func (c *Client) ConfigMap(ctx context.Context, ns string, name string) (map[string]string, error)

ConfigMap returns contents of a configMap.

func (*Client) Exec

func (c *Client) Exec(ctx context.Context, ns string, pod string, container string, cmd []string) ([]byte, []byte, error)

Exec executes a given command in the pod and returns output.

func (*Client) ListPods

func (c *Client) ListPods(ctx context.Context, ns string, opts metav1.ListOptions) ([]Pod, error)

ListPods returns lists all current pods in the cluster.

func (*Client) ListPodsWithDevs

func (c *Client) ListPodsWithDevs(ctx context.Context) ([]Pod, error)

ListPodsWithDevs returns a slice of pods with devices associated with each pod.

func (*Client) ListUsers

func (c *Client) ListUsers(ctx context.Context, ns string) (map[string][]string, error)

ListUsers returns a slice of map of namespaces to users fetched from rolebindings.

func (*Client) NewPodInformer

func (c *Client) NewPodInformer(resyncPeriod time.Duration) error

NewInformer creates new pod informer using current client.

func (*Client) Pods

func (c *Client) Pods() []*v1.Pod

Pods returns a slice of pods provided by shared informer.

func (*Client) StartInformer

func (c *Client) StartInformer() error

StartInformer starts shared informers and waits for the shared informer cache to synchronize.

type Container

type Container struct {
	Name    string
	UID     string
	Devices []Device
}

Container is a representation of K8s container resource.

type Device

type Device struct {
	Name string
	IDs  []string
}

Device is a representation of a allocatable device for k8s containers.

type FakeResourceServer

type FakeResourceServer struct {
	podresourcesapi.UnimplementedPodResourcesListerServer

	Server                      *grpc.Server
	ListResp                    *podresourcesapi.ListPodResourcesResponse
	GetAllocatableResourcesResp *podresourcesapi.AllocatableResourcesResponse
}

func FakeKubeletServer

func FakeKubeletServer(socketDir string, listResp *podresourcesapi.ListPodResourcesResponse, getAllocatableResourcesResp *podresourcesapi.AllocatableResourcesResponse) (*FakeResourceServer, error)

FakeKubeletServer returns a mock API resource server.

func (*FakeResourceServer) Get

func (m *FakeResourceServer) Get(_ context.Context, _ *podresourcesapi.GetPodResourcesRequest) (*podresourcesapi.GetPodResourcesResponse, error)

func (*FakeResourceServer) GetAllocatableResources

func (m *FakeResourceServer) GetAllocatableResources(_ context.Context, _ *podresourcesapi.AllocatableResourcesRequest) (*podresourcesapi.AllocatableResourcesResponse, error)

func (*FakeResourceServer) List

func (m *FakeResourceServer) List(_ context.Context, _ *podresourcesapi.ListPodResourcesRequest) (*podresourcesapi.ListPodResourcesResponse, error)

type Pod

type Pod struct {
	Namespace  string
	Name       string
	UID        string
	CreatedAt  time.Time
	StartedAt  time.Time
	DeletedAt  time.Time
	Status     string
	QoS        string
	Containers []Container
}

Pod is a representation of K8s pod resource.