pod

Documentation

Index

• Variables
• type Container
• type Handler
  • func New(ctx context.Context, namespace, kubeconfig string) (handler *Handler, err error)
  • func (h *Handler) Apply(filename string) (*corev1.Pod, error)
  • func (h *Handler) ApplyFromBytes(data []byte) (pod *corev1.Pod, err error)
  • func (h *Handler) ApplyFromFile(filename string) (pod *corev1.Pod, err error)
  • func (h *Handler) ApplyFromRaw(raw map[string]interface{}) (*corev1.Pod, error)
  • func (h *Handler) Clientset() *kubernetes.Clientset
  • func (h *Handler) Create(filename string) (*corev1.Pod, error)
  • func (h *Handler) CreateFromBytes(data []byte) (*corev1.Pod, error)
  • func (h *Handler) CreateFromFile(filename string) (*corev1.Pod, error)
  • func (h *Handler) CreateFromRaw(raw map[string]interface{}) (*corev1.Pod, error)
  • func (in *Handler) DeepCopy() *Handler
  • func (h *Handler) Delete(name string) error
  • func (h *Handler) DeleteByName(name string) error
  • func (h *Handler) DeleteFromBytes(data []byte) error
  • func (h *Handler) DeleteFromFile(filename string) error
  • func (h *Handler) DiscoveryClient() *discovery.DiscoveryClient
  • func (h *Handler) DynamicClient() dynamic.Interface
  • func (h *Handler) Execute(podName, containerName string, command []string, pty PtyHandler) error
  • func (h *Handler) Get(name string) (pod *corev1.Pod, err error)
  • func (h *Handler) GetAge(object interface{}) (time.Duration, error)
  • func (h *Handler) GetByName(name string) (*corev1.Pod, error)
  • func (h *Handler) GetContainers(object interface{}) ([]Container, error)
  • func (h *Handler) GetController(object interface{}) (*PodController, error)
  • func (h *Handler) GetFromBytes(data []byte) (*corev1.Pod, error)
  • func (h *Handler) GetFromFile(filename string) (*corev1.Pod, error)
  • func (h *Handler) GetIP(object interface{}) (string, error)
  • func (h *Handler) GetInitContainers(object interface{}) ([]Container, error)
  • func (h *Handler) GetNodeIP(object interface{}) (string, error)
  • func (h *Handler) GetNodeName(object interface{}) (string, error)
  • func (h *Handler) GetPV(object interface{}) ([]string, error)
  • func (h *Handler) GetPVC(object interface{}) ([]string, error)
  • func (h *Handler) GetQosClass(object interface{}) (string, error)
  • func (h *Handler) GetReadyContainers(object interface{}) ([]Container, error)
  • func (h *Handler) GetStatus(object interface{}) (string, error)
  • func (h *Handler) GetUID(object interface{}) (string, error)
  • func (h *Handler) Informer() cache.SharedIndexInformer
  • func (h *Handler) IsReady(name string) bool
  • func (h *Handler) List(labels string) (*corev1.PodList, error)
  • func (h *Handler) ListAll() (*corev1.PodList, error)
  • func (h *Handler) ListByLabel(labels string) (*corev1.PodList, error)
  • func (h *Handler) ListByNamespace(namespace string) (*corev1.PodList, error)
  • func (h *Handler) ListByNode(name string) (*corev1.PodList, error)
  • func (h *Handler) Lister() listerscorev1.PodLister
  • func (p *Handler) Namespace() string
  • func (h *Handler) RESTClient() *rest.RESTClient
  • func (h *Handler) RunInformer(addFunc func(obj interface{}), updateFunc func(oldObj, newObj interface{}), ...)
  • func (p *Handler) SetForceDelete(force bool)
  • func (p *Handler) SetLimit(limit int64)
  • func (p *Handler) SetTimeout(timeout int64)
  • func (h *Handler) TestInformer(stopCh chan struct{})
  • func (h *Handler) Update(filename string) (*corev1.Pod, error)
  • func (h *Handler) UpdateFromBytes(data []byte) (*corev1.Pod, error)
  • func (h *Handler) UpdateFromFile(filename string) (*corev1.Pod, error)
  • func (h *Handler) UpdateFromRaw(raw map[string]interface{}) (*corev1.Pod, error)
  • func (h *Handler) WaitReady(name string) error
  • func (h *Handler) Watch(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), ...) (err error)
  • func (h *Handler) WatchByLabel(labelSelector string, addFunc, modifyFunc, deleteFunc func(x interface{}), ...) (err error)
  • func (h *Handler) WatchByName(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), ...) (err error)
  • func (p *Handler) WithDryRun() *Handler
  • func (p *Handler) WithNamespace(namespace string) *Handler
• type PodController
• type PtyHandler

Variables

var ERR_TYPE = fmt.Errorf("type must be *corev1.Pod, corev1.Pod or string")

Types

type Container

type Container struct {
	Name  string
	Image string
}

type Handler

type Handler struct {
	Options *typed.HandlerOptions
	// contains filtered or unexported fields
}

func New

func New(ctx context.Context, namespace, kubeconfig string) (handler *Handler, err error)

New returns a pod handler from kubeconfig or in-cluster config.

func (*Handler) Apply

func (h *Handler) Apply(filename string) (*corev1.Pod, error)

Apply apply pod from file, alias to "ApplyFromFile".

func (*Handler) ApplyFromBytes

func (h *Handler) ApplyFromBytes(data []byte) (pod *corev1.Pod, err error)

ApplyFromBytes apply pod from bytes.

func (*Handler) ApplyFromFile

func (h *Handler) ApplyFromFile(filename string) (pod *corev1.Pod, err error)

ApplyFromFile apply pod from yaml file.

func (*Handler) ApplyFromRaw

func (h *Handler) ApplyFromRaw(raw map[string]interface{}) (*corev1.Pod, error)

ApplyFromRaw apply pod from map[string]interface{}.

func (*Handler) Clientset

func (h *Handler) Clientset() *kubernetes.Clientset

func (*Handler) Create

func (h *Handler) Create(filename string) (*corev1.Pod, error)

Create create pod from file, alias to "CreateFromFile".

func (*Handler) CreateFromBytes

func (h *Handler) CreateFromBytes(data []byte) (*corev1.Pod, error)

CreateFromBytes create pod from bytes.

func (*Handler) CreateFromFile

func (h *Handler) CreateFromFile(filename string) (*corev1.Pod, error)

CreateFromFile create pod from yaml file.

func (*Handler) CreateFromRaw

func (h *Handler) CreateFromRaw(raw map[string]interface{}) (*corev1.Pod, error)

CreateFromRaw create pod from map[string]interface{}.

func (*Handler) DeepCopy

func (in *Handler) DeepCopy() *Handler

func (*Handler) Delete

func (h *Handler) Delete(name string) error

Delete delete pod by name, alias to "DeleteByName".

func (*Handler) DeleteByName

func (h *Handler) DeleteByName(name string) error

DeleteByName delete pod by name.

func (*Handler) DeleteFromBytes

func (h *Handler) DeleteFromBytes(data []byte) error

DeleteFromBytes delete pod from bytes.

func (*Handler) DeleteFromFile

func (h *Handler) DeleteFromFile(filename string) error

DeleteFromFile delete pod from yaml file.

func (*Handler) DiscoveryClient

func (h *Handler) DiscoveryClient() *discovery.DiscoveryClient

func (*Handler) DynamicClient

func (h *Handler) DynamicClient() dynamic.Interface

func (*Handler) Execute

func (h *Handler) Execute(podName, containerName string, command []string, pty PtyHandler) error

Execute will executing remote processes in a container of the pod. If no container name is specified, Execute will executing a process in the first container of the pod by default. It will returns error, If the pod not ready. It's your responsibility to ensure the pod Is running and ready.

func (*Handler) Get

func (h *Handler) Get(name string) (pod *corev1.Pod, err error)

Get get pod by name, alias to "GetByName".

func (*Handler) GetAge

func (h *Handler) GetAge(object interface{}) (time.Duration, error)

GetAge get the pod age.

func (*Handler) GetByName

func (h *Handler) GetByName(name string) (*corev1.Pod, error)

GetByName get pod by name.

func (*Handler) GetContainers

func (h *Handler) GetContainers(object interface{}) ([]Container, error)

GetContainers get all containers of the pod.

func (*Handler) GetController

func (h *Handler) GetController(object interface{}) (*PodController, error)

GetController get the owner of the pod. Controller maybe deployment, statefulset, daemonset, job, replicaset, rc.

func (*Handler) GetFromBytes

func (h *Handler) GetFromBytes(data []byte) (*corev1.Pod, error)

GetFromBytes get pod from bytes.

func (*Handler) GetFromFile

func (h *Handler) GetFromFile(filename string) (*corev1.Pod, error)

GetFromFile get pod from yaml file.

func (*Handler) GetIP

func (h *Handler) GetIP(object interface{}) (string, error)

GetIP returns pod ip.

func (*Handler) GetInitContainers

func (h *Handler) GetInitContainers(object interface{}) ([]Container, error)

GetInitContainers get all init containers of the pod.

func (*Handler) GetNodeIP

func (h *Handler) GetNodeIP(object interface{}) (string, error)

GetNodeIP get the ip addr of the node where pod is located.

func (*Handler) GetNodeName

func (h *Handler) GetNodeName(object interface{}) (string, error)

GetNodeName get the name of the node where pod is located.

func (*Handler) GetPV

func (h *Handler) GetPV(object interface{}) ([]string, error)

GetPV get all persistentvolume mounted by this pod.

func (*Handler) GetPVC

func (h *Handler) GetPVC(object interface{}) ([]string, error)

GetPVC get all persistentvolumeclaim mounted by this pod.

func (*Handler) GetQosClass

func (h *Handler) GetQosClass(object interface{}) (string, error)

GetQosClass get the "Quality of Service" of the pod. PodQOSGuaranteed is the Guaranteed qos class. PodQOSBurstable is the Burstable qos class. PodQOSBestEffort is the BestEffort qos class.

func (*Handler) GetReadyContainers

func (h *Handler) GetReadyContainers(object interface{}) ([]Container, error)

GetReadyContainers get all ready containers of the pod.

func (*Handler) GetStatus

func (h *Handler) GetStatus(object interface{}) (string, error)

GetStatus get the status of the pod. There are the valid statuses of the pod Pending: pod has been accepted by the system, but one or more of the

containers has not been started.

Running: pod is running and all of the containers have been started. Succeeded: all containers in the pod have voluntarily terminated. Failed: all containers in the pod have terminated, and at least one

container hasterminated in a failure (exited with a non-zero
exit code or was stopped by the system).

Unknown: for some reason the state of the pod could not be obtained,

typically due to an error in communicating with the host of the pod.

func (*Handler) GetUID

func (h *Handler) GetUID(object interface{}) (string, error)

GetUID returns pod uuid

func (*Handler) Informer

func (h *Handler) Informer() cache.SharedIndexInformer

func (*Handler) IsReady

func (h *Handler) IsReady(name string) bool

IsReady check whether the pod is ready.

func (*Handler) List

func (h *Handler) List(labels string) (*corev1.PodList, error)

List list pods by labels, alias to "ListByLabel"

func (*Handler) ListAll

func (h *Handler) ListAll() (*corev1.PodList, error)

ListAll list all pods in k8s cluster where the pod is running.

func (*Handler) ListByLabel

func (h *Handler) ListByLabel(labels string) (*corev1.PodList, error)

ListByLabel list pods by labels.

func (*Handler) ListByNamespace

func (h *Handler) ListByNamespace(namespace string) (*corev1.PodList, error)

ListByNamespace list all pods in the specified namespace

func (*Handler) ListByNode

func (h *Handler) ListByNode(name string) (*corev1.PodList, error)

ListByNode list all pods in k8s node where the pod is running.

func (*Handler) Lister

func (h *Handler) Lister() listerscorev1.PodLister

func (*Handler) Namespace

func (p *Handler) Namespace() string

func (*Handler) RESTClient

func (h *Handler) RESTClient() *rest.RESTClient

func (*Handler) RunInformer

func (h *Handler) RunInformer(
	addFunc func(obj interface{}),
	updateFunc func(oldObj, newObj interface{}),
	deleteFunc func(obj interface{}),
	stopCh chan struct{})

addFunc, updateFunc, stopChan informer 的三个回调函数 addFunc, updateFunc, deleteFunc 这个管道用来存放回调函数处理的 k8s 资源对象 RunInformer

func (*Handler) SetForceDelete

func (p *Handler) SetForceDelete(force bool)

func (*Handler) SetLimit

func (p *Handler) SetLimit(limit int64)

func (*Handler) SetTimeout

func (p *Handler) SetTimeout(timeout int64)

func (*Handler) TestInformer

func (h *Handler) TestInformer(stopCh chan struct{})

func (*Handler) Update

func (h *Handler) Update(filename string) (*corev1.Pod, error)

Update update pod from file, alias to "UpdateFromFile".

func (*Handler) UpdateFromBytes

func (h *Handler) UpdateFromBytes(data []byte) (*corev1.Pod, error)

UpdateFromBytes update pod from bytes.

func (*Handler) UpdateFromFile

func (h *Handler) UpdateFromFile(filename string) (*corev1.Pod, error)

UpdateFromFile update pod from yaml file.

func (*Handler) UpdateFromRaw

func (h *Handler) UpdateFromRaw(raw map[string]interface{}) (*corev1.Pod, error)

UpdateFromRaw update pod from map[string]interface{}.

func (*Handler) WaitReady

func (h *Handler) WaitReady(name string) error

WaitReady waiting for the pod to be in the ready status.

func (*Handler) Watch

func (h *Handler) Watch(name string,
	addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)

Watch watch pods by name, alias to "WatchByName".

func (*Handler) WatchByLabel

func (h *Handler) WatchByLabel(labelSelector string,
	addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)

WatchByLabel watch pods by label.

func (*Handler) WatchByName

func (h *Handler) WatchByName(name string,
	addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)

WatchByName watch pods by name.

func (*Handler) WithDryRun

func (p *Handler) WithDryRun() *Handler

func (*Handler) WithNamespace

func (p *Handler) WithNamespace(namespace string) *Handler

type PodController

type PodController struct {
	metav1.OwnerReference
}

type PtyHandler

type PtyHandler interface {
	io.Reader
	io.Writer
	remotecommand.TerminalSizeQueue
}