kubernetes

Documentation

Index

• type Client
  • func NewClient(clientGetter genericclioptions.RESTClientGetter) (*Client, error)
  • func (k *Client) CopyFromPod(podName, podFilePath, localFilePath string) error
  • func (k *Client) CopyToPod(localFilePath, podName, podFilePath string) error
  • func (k *Client) DeleteJob(name string) error
  • func (k *Client) GetPodInfo(name string) (*PodInfo, error)
  • func (k *Client) ReadPodLogs(podName, containerName string) (io.ReadCloser, error)
  • func (k *Client) RunJob(spec *JobRunSpec) error
  • func (k *Client) WaitPod(labelSelector map[string]string) (*PodInfo, error)
• type ContainerConfigInfo
  • func NewContainerConfigInfo(runtime, id string) (*ContainerConfigInfo, error)
  • func (c *ContainerConfigInfo) GetTmpSource() string
• type ContainerInfo
  • func NewContainerInfo(cs *core.ContainerStatus) *ContainerInfo
  • func (c *ContainerInfo) GetContainerFSVolume() JobVolume
  • func (c *ContainerInfo) GetContainerSharedVolumes() JobVolume
• type ContainerMount
• type JobRunSpec
  • func NewJobRunSpec(args []string, image string, pod *PodInfo) *JobRunSpec
  • func (j *JobRunSpec) Build(namespace string) *batch.Job
  • func (j *JobRunSpec) WithContainerFSVolume(container *ContainerInfo) *JobRunSpec
  • func (j *JobRunSpec) WithContainerMountsVolume(container *ContainerInfo) *JobRunSpec
  • func (j *JobRunSpec) WithHostProcVolume() *JobRunSpec
  • func (j *JobRunSpec) WithHostTmpVolume(path string) *JobRunSpec
  • func (j *JobRunSpec) WithPrivilegedOptions() *JobRunSpec
• type JobVolume
• type PodInfo
  • func NewPodInfo(pod *core.Pod) *PodInfo
  • func (p *PodInfo) ContainsMountedTmp(container string) bool
  • func (p *PodInfo) FindContainerInfo(container string) (*ContainerInfo, error)
  • func (p *PodInfo) GetContainerNames() []string

Types

type Client

type Client struct {
	Namespace string
	*kubernetes.Clientset
	*rest.Config
}

Client is kubernetes client set wrapper

func NewClient

func NewClient(clientGetter genericclioptions.RESTClientGetter) (*Client, error)

NewClient return new kubernetes client

func (*Client) CopyFromPod

func (k *Client) CopyFromPod(podName, podFilePath, localFilePath string) error

CopyFromPod - copy file from pod to local file

func (*Client) CopyToPod

func (k *Client) CopyToPod(localFilePath, podName, podFilePath string) error

CopyToPod - copy local file to pod

func (*Client) DeleteJob

func (k *Client) DeleteJob(name string) error

DeleteJob deleting job

func (*Client) GetPodInfo

func (k *Client) GetPodInfo(name string) (*PodInfo, error)

GetPodInfo get info about pod by name

func (*Client) ReadPodLogs

func (k *Client) ReadPodLogs(podName, containerName string) (io.ReadCloser, error)

ReadPodLogs stream logs from pod

func (*Client) RunJob

func (k *Client) RunJob(spec *JobRunSpec) error

RunJob will run job with specified parameters

func (*Client) WaitPod

func (k *Client) WaitPod(labelSelector map[string]string) (*PodInfo, error)

WaitPod will wait until pod to start or failed

type ContainerConfigInfo

type ContainerConfigInfo struct {
	ID            string
	HostProcessID int
	Mounts        []ContainerMount
	RootFS        string
	Runtime       string
}

ContainerConfigInfo is an information about container state located at node

func NewContainerConfigInfo

func NewContainerConfigInfo(runtime, id string) (*ContainerConfigInfo, error)

NewContainerConfigInfo returns container configuration state

func (*ContainerConfigInfo) GetTmpSource

func (c *ContainerConfigInfo) GetTmpSource() string

GetTmpSource returns mount point for /tmp folder, depending upon container runtime and existing mounts If container contains mounts to /tmp folder, this mount source path will be used, otherwise – container rootfs

type ContainerInfo

type ContainerInfo struct {
	ID      string
	Name    string
	Runtime string
}

ContainerInfo is an information about container struct

func NewContainerInfo

func NewContainerInfo(cs *core.ContainerStatus) *ContainerInfo

NewContainerInfo returns container info mapped from core.ContainerStatus

func (*ContainerInfo) GetContainerFSVolume

func (c *ContainerInfo) GetContainerFSVolume() JobVolume

GetContainerFSVolume returns JobVolume (mounted from host) that contains container definitions, depending upon container runtime

func (*ContainerInfo) GetContainerSharedVolumes

func (c *ContainerInfo) GetContainerSharedVolumes() JobVolume

GetContainerSharedVolumes returns JobVolume (mounted from host) that contains container additional mounts, depending upon container runtime

type ContainerMount

type ContainerMount struct {
	Source      string
	Destination string
}

ContainerMount is an information about available container mounts

type JobRunSpec

type JobRunSpec struct {
	Args       []string
	Image      string
	Name       string
	Node       string
	Privileged bool
	Selectors  map[string]string
	Volumes    []JobVolume
}

JobRunSpec is helper struct to describe job spec customization

func NewJobRunSpec

func NewJobRunSpec(args []string, image string, pod *PodInfo) *JobRunSpec

NewJobRunSpec returns JobRunSpec constructed from specified args, image, pod and container

func (*JobRunSpec) Build

func (j *JobRunSpec) Build(namespace string) *batch.Job

Build returns resulted batch.Job spec from JobRunSpec options

func (*JobRunSpec) WithContainerFSVolume

func (j *JobRunSpec) WithContainerFSVolume(container *ContainerInfo) *JobRunSpec

WithContainerFSVolume add host volume that used to store container file system volumes

func (*JobRunSpec) WithContainerMountsVolume

func (j *JobRunSpec) WithContainerMountsVolume(container *ContainerInfo) *JobRunSpec

WithContainerMountsVolume add host volume that used to store container additional volumes

func (*JobRunSpec) WithHostProcVolume

func (j *JobRunSpec) WithHostProcVolume() *JobRunSpec

WithHostProcVolume adds host volume that used to locate target process memory sections

func (*JobRunSpec) WithHostTmpVolume

func (j *JobRunSpec) WithHostTmpVolume(path string) *JobRunSpec

WithHostTmpVolume add host /tmp volume that used to store output

func (*JobRunSpec) WithPrivilegedOptions

func (j *JobRunSpec) WithPrivilegedOptions() *JobRunSpec

WithPrivilegedOptions adds core.SecurityContext to with SYS_PTRACE capability to core.JobSpec

type JobVolume

type JobVolume struct {
	Name      string
	HostPath  string
	MountPath string
}

JobVolume is helper struct to describe job volume customization

type PodInfo

type PodInfo struct {
	Annotations map[string]string
	Name        string
	Namespace   string
	Node        string
	// contains filtered or unexported fields
}

func NewPodInfo

func NewPodInfo(pod *core.Pod) *PodInfo

NewPodInfo returns PodInfo generated from core.Pod spec

func (*PodInfo) ContainsMountedTmp

func (p *PodInfo) ContainsMountedTmp(container string) bool

ContainsMountedTmp returns true if container has /tmp folder mounted from host or shared with other container

func (*PodInfo) FindContainerInfo

func (p *PodInfo) FindContainerInfo(container string) (*ContainerInfo, error)

FindContainerInfo returns container info with specified name or error

func (*PodInfo) GetContainerNames

func (p *PodInfo) GetContainerNames() []string

GetContainerNames returns container names associated with pod