kube

Documentation

Index

• func BuildPVCManifest(namespace, name, size, storageClass string, labels map[string]string, ...) ([]byte, error)
• func BuildPodManifest(namespace, name string, labels map[string]string, ...) ([]byte, error)
• func InjectPreStopForTarget(spec *corev1.PodSpec, preStop string, targetContainer string)
• func PreparePodSpec(podSpec corev1.PodSpec, volumes []corev1.Volume, ...) (corev1.PodSpec, error)
• func PreparePodSpecForTarget(podSpec corev1.PodSpec, volumes []corev1.Volume, ...) (corev1.PodSpec, error)
• type Client
  • func (c *Client) AnnotatePod(ctx context.Context, namespace, pod, key, value string) error
  • func (c *Client) Apply(ctx context.Context, namespace string, manifest []byte) error
  • func (c *Client) CopyDirFromPod(ctx context.Context, namespace, pod, container, remoteDir, localDir string) error
  • func (c *Client) CopyDirToPod(ctx context.Context, namespace, pod, container, localDir, remoteDir string) error
  • func (c *Client) CopyFromPod(ctx context.Context, namespace, podName, remotePath, localPath string) error
  • func (c *Client) CopyFromPodInContainer(ctx context.Context, ...) error
  • func (c *Client) CopyToPod(ctx context.Context, namespace, localPath, podName, remotePath string) error
  • func (c *Client) CopyToPodInContainer(ctx context.Context, ...) error
  • func (c *Client) Delete(ctx context.Context, namespace string, kind string, name string, ...) error
  • func (c *Client) DeleteByRef(ctx context.Context, namespace string, apiVersion string, kind string, ...) error
  • func (c *Client) DescribePod(ctx context.Context, namespace, pod string) (string, error)
  • func (c *Client) ExecInteractive(ctx context.Context, namespace, pod string, tty bool, command []string, ...) error
  • func (c *Client) ExecInteractiveInContainer(ctx context.Context, namespace, pod, container string, tty bool, ...) error
  • func (c *Client) ExecSh(ctx context.Context, namespace, pod string, script string) ([]byte, error)
  • func (c *Client) ExecShInContainer(ctx context.Context, namespace, pod, container, script string) ([]byte, error)
  • func (c *Client) ExtractTarToPod(ctx context.Context, namespace, podName, remoteDir string, tarStream io.Reader) error
  • func (c *Client) GetContainerRestartInfo(ctx context.Context, namespace, pod, container string) (*ContainerRestartInfo, error)
  • func (c *Client) GetPodAnnotation(ctx context.Context, namespace, pod, key string) (string, error)
  • func (c *Client) GetPodSummary(ctx context.Context, namespace, name string) (*PodSummary, error)
  • func (c *Client) GetResourceAnnotation(ctx context.Context, namespace, apiVersion, kind, name, key string) (string, bool, error)
  • func (c *Client) IsRemoteDir(ctx context.Context, namespace, pod, container, remotePath string) (bool, error)
  • func (c *Client) ListPods(ctx context.Context, namespace string, allNamespaces bool, ...) ([]PodSummary, error)
  • func (c *Client) PersistentVolumeClaimExists(ctx context.Context, namespace, name string) (bool, error)
  • func (c *Client) PodContainerNames(ctx context.Context, namespace, pod string) ([]string, error)
  • func (c *Client) PortForward(ctx context.Context, namespace, pod string, forwards []string, ...) error
  • func (c *Client) ResourceExists(ctx context.Context, namespace string, apiVersion string, kind string, ...) (bool, error)
  • func (c *Client) StreamFromPod(ctx context.Context, namespace, podName, script string, stdout io.Writer) error
  • func (c *Client) StreamPodLogs(ctx context.Context, namespace, pod string, opts LogStreamOptions, ...) error
  • func (c *Client) StreamShInContainer(ctx context.Context, namespace, pod, container, script string, ...) error
  • func (c *Client) TouchPodActivity(ctx context.Context, namespace, pod string) error
  • func (c *Client) WaitReady(ctx context.Context, namespace, pod string, timeout time.Duration) error
  • func (c *Client) WaitReadyWithProgress(ctx context.Context, namespace, pod string, timeout time.Duration, ...) error
  • func (c *Client) WatchPodEvents(ctx context.Context, namespace, pod string, ...)
• type ContainerRestartInfo
• type LogStreamOptions
• type PodReadinessProgress
• type PodSummary

Functions

func BuildPVCManifest

func BuildPVCManifest(namespace, name, size, storageClass string, labels map[string]string, annotations map[string]string) ([]byte, error)

func BuildPodManifest

func BuildPodManifest(namespace, name string, labels map[string]string, annotations map[string]string, podSpec corev1.PodSpec) ([]byte, error)

func InjectPreStopForTarget

func InjectPreStopForTarget(spec *corev1.PodSpec, preStop string, targetContainer string)

func PreparePodSpec

func PreparePodSpec(podSpec corev1.PodSpec, volumes []corev1.Volume, workspaceMountPath, sidecarImage string, sidecarResources corev1.ResourceRequirements, tmux bool, preStop string) (corev1.PodSpec, error)

func PreparePodSpecForTarget

func PreparePodSpecForTarget(podSpec corev1.PodSpec, volumes []corev1.Volume, workspaceMountPath, sidecarImage string, sidecarResources corev1.ResourceRequirements, tmux bool, preStop string, targetContainer string) (corev1.PodSpec, error)

Types

type Client

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

func (*Client) AnnotatePod

func (c *Client) AnnotatePod(ctx context.Context, namespace, pod, key, value string) error

func (*Client) Apply

func (c *Client) Apply(ctx context.Context, namespace string, manifest []byte) error

func (*Client) CopyDirFromPod

func (c *Client) CopyDirFromPod(ctx context.Context, namespace, pod, container, remoteDir, localDir string) error

CopyDirFromPod streams a remote directory as a tar archive and extracts it locally.

func (*Client) CopyDirToPod

func (c *Client) CopyDirToPod(ctx context.Context, namespace, pod, container, localDir, remoteDir string) error

CopyDirToPod archives a local directory and extracts it into remoteDir on the pod.

func (*Client) CopyFromPod

func (c *Client) CopyFromPod(ctx context.Context, namespace, podName, remotePath, localPath string) error

func (*Client) CopyFromPodInContainer

func (c *Client) CopyFromPodInContainer(ctx context.Context, namespace, podName, container, remotePath, localPath string) error

func (*Client) CopyToPod

func (c *Client) CopyToPod(ctx context.Context, namespace, localPath, podName, remotePath string) error

func (*Client) CopyToPodInContainer

func (c *Client) CopyToPodInContainer(ctx context.Context, namespace, localPath, podName, container, remotePath string) error

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, namespace string, kind string, name string, ignoreNotFound bool) error

func (*Client) DeleteByRef

func (c *Client) DeleteByRef(ctx context.Context, namespace string, apiVersion string, kind string, name string, ignoreNotFound bool) error

func (*Client) DescribePod

func (c *Client) DescribePod(ctx context.Context, namespace, pod string) (string, error)

func (*Client) ExecInteractive

func (c *Client) ExecInteractive(ctx context.Context, namespace, pod string, tty bool, command []string, stdin io.Reader, stdout io.Writer, stderr io.Writer) error

func (*Client) ExecInteractiveInContainer

func (c *Client) ExecInteractiveInContainer(ctx context.Context, namespace, pod, container string, tty bool, command []string, stdin io.Reader, stdout io.Writer, stderr io.Writer) error

func (*Client) ExecSh

func (c *Client) ExecSh(ctx context.Context, namespace, pod string, script string) ([]byte, error)

func (*Client) ExecShInContainer

func (c *Client) ExecShInContainer(ctx context.Context, namespace, pod, container, script string) ([]byte, error)

func (*Client) ExtractTarToPod

func (c *Client) ExtractTarToPod(ctx context.Context, namespace, podName, remoteDir string, tarStream io.Reader) error

func (*Client) GetContainerRestartInfo

func (c *Client) GetContainerRestartInfo(ctx context.Context, namespace, pod, container string) (*ContainerRestartInfo, error)

GetContainerRestartInfo returns restart information for a specific container in a pod. Returns nil if the container is not found.

func (*Client) GetPodAnnotation

func (c *Client) GetPodAnnotation(ctx context.Context, namespace, pod, key string) (string, error)

func (*Client) GetPodSummary

func (c *Client) GetPodSummary(ctx context.Context, namespace, name string) (*PodSummary, error)

func (*Client) GetResourceAnnotation

func (c *Client) GetResourceAnnotation(ctx context.Context, namespace, apiVersion, kind, name, key string) (string, bool, error)

func (*Client) IsRemoteDir

func (c *Client) IsRemoteDir(ctx context.Context, namespace, pod, container, remotePath string) (bool, error)

IsRemoteDir probes whether remotePath is a directory on the pod.

func (*Client) ListPods

func (c *Client) ListPods(ctx context.Context, namespace string, allNamespaces bool, labelSelector string) ([]PodSummary, error)

func (*Client) PersistentVolumeClaimExists

func (c *Client) PersistentVolumeClaimExists(ctx context.Context, namespace, name string) (bool, error)

func (*Client) PodContainerNames

func (c *Client) PodContainerNames(ctx context.Context, namespace, pod string) ([]string, error)

func (*Client) PortForward

func (c *Client) PortForward(ctx context.Context, namespace, pod string, forwards []string, stdout io.Writer, stderr io.Writer) error

func (*Client) ResourceExists

func (c *Client) ResourceExists(ctx context.Context, namespace string, apiVersion string, kind string, name string) (bool, error)

func (*Client) StreamFromPod

func (c *Client) StreamFromPod(ctx context.Context, namespace, podName, script string, stdout io.Writer) error

func (*Client) StreamPodLogs

func (c *Client) StreamPodLogs(ctx context.Context, namespace, pod string, opts LogStreamOptions, stdout io.Writer) error

func (*Client) StreamShInContainer

func (c *Client) StreamShInContainer(ctx context.Context, namespace, pod, container, script string, stdout, stderr io.Writer) error

func (*Client) TouchPodActivity

func (c *Client) TouchPodActivity(ctx context.Context, namespace, pod string) error

func (*Client) WaitReady

func (c *Client) WaitReady(ctx context.Context, namespace, pod string, timeout time.Duration) error

func (*Client) WaitReadyWithProgress

func (c *Client) WaitReadyWithProgress(ctx context.Context, namespace, pod string, timeout time.Duration, onProgress func(PodReadinessProgress)) error

func (*Client) WatchPodEvents

func (c *Client) WatchPodEvents(ctx context.Context, namespace, pod string, onEvent func(reason, message string))

WatchPodEvents watches Kubernetes events for the given pod and calls onEvent for each relevant event. It blocks until the context is cancelled. Only events with reasons in the allowlist are forwarded.

type ContainerRestartInfo

type ContainerRestartInfo struct {
	RestartCount   int32
	LastExitCode   int32
	LastReason     string // e.g. "OOMKilled", "Error"
	LastMessage    string
	CurrentWaiting string // e.g. "CrashLoopBackOff"
}

ContainerRestartInfo holds restart details for a single container.

type LogStreamOptions

type LogStreamOptions struct {
	Container string
	Follow    bool
	Previous  bool
	TailLines *int64
	Since     time.Duration
}

type PodReadinessProgress

type PodReadinessProgress struct {
	Phase           corev1.PodPhase
	ReadyContainers int
	TotalContainers int
	Reason          string
}

type PodSummary

type PodSummary struct {
	Namespace   string
	Name        string
	Phase       string
	Deleting    bool
	CreatedAt   time.Time
	Labels      map[string]string
	Annotations map[string]string
	Ready       string
	Restarts    int32
	Reason      string
	PodIP       string
}