k8s

Documentation

Overview

Copyright 2023 Operant AI

Copyright 2023 Operant AI

Copyright 2023 Operant AI

Index

• Variables
• type Client
  • func NewClient() (*Client, error)
  • func NewClientInContainer() (*Client, error)
  • func (c *Client) ExecuteRemoteCommand(ctx context.Context, namespace, podName, container string, commands []string) (string, string, error)
  • func (c *Client) FindContainerByName(containers []corev1.Container, containerName string) (corev1.Container, error)
  • func (c *Client) GetDeploymentsPods(ctx context.Context, namespace string, deployment *appsv1.Deployment) ([]corev1.Pod, error)
  • func (c *Client) GetK8sVersion() (*k8sVersion.Info, error)
  • func (c *Client) NewPortForwarder(ctx context.Context) *portForwarder

Variables

var ErrContainerNotFound = errors.New("container not found")

ErrContainerNotFound is returned when a container is not found

Types

type Client

type Client struct {
	Clientset  *kubernetes.Clientset
	RestConfig *rest.Config
}

func NewClient

func NewClient() (*Client, error)

func NewClientInContainer

func NewClientInContainer() (*Client, error)

func (*Client) ExecuteRemoteCommand

func (c *Client) ExecuteRemoteCommand(ctx context.Context, namespace, podName, container string, commands []string) (string, string, error)

func (*Client) FindContainerByName

func (c *Client) FindContainerByName(containers []corev1.Container, containerName string) (corev1.Container, error)

FindContainerByName returns a container by name from a list of containers

func (*Client) GetDeploymentsPods

func (c *Client) GetDeploymentsPods(ctx context.Context, namespace string, deployment *appsv1.Deployment) ([]corev1.Pod, error)

GetDeploymentsPods gets the pods belonging to the provided deployment

func (*Client) GetK8sVersion

func (c *Client) GetK8sVersion() (*k8sVersion.Info, error)

func (*Client) NewPortForwarder

func (c *Client) NewPortForwarder(ctx context.Context) *portForwarder