pod

package
v0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 1, 2022 License: Apache-2.0 Imports: 36 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ERR_TYPE_TOOLS  = fmt.Errorf("type must be string *corev1.Pod, or corev1.Pod")
	ERR_TYPE_CREATE = fmt.Errorf("type must be string, []byte, *corev1.Pod, corev1.Pod, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}")
	ERR_TYPE_UPDATE = ERR_TYPE_CREATE
	ERR_TYPE_APPLY  = ERR_TYPE_CREATE
	ERR_TYPE_DELETE = ERR_TYPE_CREATE
	ERR_TYPE_GET    = ERR_TYPE_CREATE
)
View Source 
var DefaultLogOptions = &LogOptions{
	PodLogOptions: corev1.PodLogOptions{},
	Writer:        os.Stdout,
	NewLine:       true,
}
View Source 
var ERR_TYPE = fmt.Errorf("type must be *corev1.Pod, corev1.Pod or string")

Functions

func GVR added in v0.5.0 

func GVR() schema.GroupVersionResource

GVR returns the name of Group, Version, Resource of pod resource.

func Group added in v0.5.0 

func Group() string

Group returns the Group name of pod resource.

func Resource added in v0.5.0 

func Resource() string

Resource returns the Resource name of pod resource.

func Version added in v0.5.0 

func Version() string

Version returns the Version name of pod resource.

Types

type Container 

type Container struct {
	Name  string
	Image string
}

type Handler 

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

func New 

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

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

func NewOrDie added in v0.3.0 

func NewOrDie(ctx context.Context, kubeconfig, namespace string) *Handler

NewOrDie simply call New() to get a pod handler. panic if there is any error occurs.

func (*Handler) Apply 

func (h *Handler) Apply(obj interface{}) (*corev1.Pod, error)

Apply applies pod from type string, []byte, *corev1.pod, corev1.pod, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.

func (*Handler) ApplyFromBytes 

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

ApplyFromBytes applies pod from bytes.

func (*Handler) ApplyFromFile 

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

ApplyFromFile applies pod from yaml file.

func (*Handler) ApplyFromMap added in v0.5.0 

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

ApplyFromMap applies pod from map[string]interface{}.

func (*Handler) ApplyFromObject added in v0.3.0 

func (h *Handler) ApplyFromObject(obj runtime.Object) (*corev1.Pod, error)

ApplyFromObject applies deployment from runtime.Object.

func (*Handler) ApplyFromUnstructured added in v0.3.0 

func (h *Handler) ApplyFromUnstructured(u *unstructured.Unstructured) (*corev1.Pod, error)

ApplyFromUnstructured applies pod from *unstructured.Unstructured.

func (*Handler) Clientset added in v0.2.0 

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

Clientset returns underlying clientset.

func (*Handler) Create 

func (h *Handler) Create(obj interface{}) (*corev1.Pod, error)

Create creates pod from type string, []byte, *corev1.pod, corev1.pod, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.

func (*Handler) CreateFromBytes 

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

CreateFromBytes creates pod from bytes.

func (*Handler) CreateFromFile 

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

CreateFromFile creates pod from yaml file.

func (*Handler) CreateFromMap added in v0.5.0 

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

CreateFromMap creates pod from map[string]interface{}.

func (*Handler) CreateFromObject added in v0.3.0 

func (h *Handler) CreateFromObject(obj runtime.Object) (*corev1.Pod, error)

CreateFromObject creates pod from runtime.Object.

func (*Handler) CreateFromUnstructured added in v0.3.0 

func (h *Handler) CreateFromUnstructured(u *unstructured.Unstructured) (*corev1.Pod, error)

CreateFromUnstructured creates pod from *unstructured.Unstructured.

func (*Handler) DeepCopy 

func (in *Handler) DeepCopy() *Handler

func (*Handler) Delete 

func (h *Handler) Delete(obj interface{}) error

If passed parameter type is string, it will simply call DeleteByName instead of DeleteFromFile. You should always explicitly call DeleteFromFile to delete a pod from file path.

func (*Handler) DeleteByName 

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

DeleteByName deletes pod by name.

func (*Handler) DeleteFromBytes 

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

DeleteFromBytes deletes pod from bytes.

func (*Handler) DeleteFromFile 

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

DeleteFromFile deletes pod from yaml file.

func (*Handler) DeleteFromMap added in v0.5.0 

func (h *Handler) DeleteFromMap(u map[string]interface{}) error

DeleteFromMap deletes pod from map[string]interface{}.

func (*Handler) DeleteFromObject added in v0.3.0 

func (h *Handler) DeleteFromObject(obj runtime.Object) error

DeleteFromObject deletes pod from runtime.Object.

func (*Handler) DeleteFromUnstructured added in v0.3.0 

func (h *Handler) DeleteFromUnstructured(u *unstructured.Unstructured) error

DeleteFromUnstructured deletes pod from *unstructured.Unstructured.

func (*Handler) DiscoveryClient added in v0.2.0 

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

DiscoveryClient returns underlying discovery client.

func (*Handler) DynamicClient added in v0.2.0 

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

DynamicClient returns underlying dynamic client.

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(obj interface{}) (*corev1.Pod, error)

If passed parameter type is string, it will simply call GetByName instead of GetFromFile. You should always explicitly call GetFromFile to get a pod from file path.

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 gets 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 gets pod from bytes.

func (*Handler) GetFromFile 

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

GetFromFile gets pod from yaml file.

func (*Handler) GetFromMap added in v0.5.0 

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

GetFromMap gets pod from map[string]interface{}.

func (*Handler) GetFromObject added in v0.3.0 

func (h *Handler) GetFromObject(obj runtime.Object) (*corev1.Pod, error)

GetFromObject gets pod from runtime.Object.

func (*Handler) GetFromUnstructured added in v0.3.0 

func (h *Handler) GetFromUnstructured(u *unstructured.Unstructured) (*corev1.Pod, error)

GetFromUnstructured gets pod from *unstructured.Unstructured.

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 added in v0.2.0 

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

Informer returns underlying SharedIndexInformer which provides add and Indexers ability based on SharedInformer.

func (*Handler) InformerFactory added in v0.4.5 

func (h *Handler) InformerFactory() informers.SharedInformerFactory

InformerFactory returns underlying SharedInformerFactory which provides shared informer for resources in all known API group version.

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 added in v0.2.0 

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

Lister returns underlying PodLister which helps list pods.

func (*Handler) Log added in v0.4.1 

func (h *Handler) Log(obj interface{}, logOptions *LogOptions) error

If passed parameter type is string, it will simply call LogByName instead of LogFromFile. You should always explicitly call LogFromFile to get pod logs from file path.

func (*Handler) LogByName added in v0.4.1 

func (h *Handler) LogByName(name string, logOption *LogOptions) error

LogByName gets pod by name.

func (*Handler) LogFromBytes added in v0.4.1 

func (h *Handler) LogFromBytes(data []byte, logOptions *LogOptions) error

LogFromBytes get pod logs from bytes.

func (*Handler) LogFromFile added in v0.4.1 

func (h *Handler) LogFromFile(filename string, logOptions *LogOptions) error

LogFromFile get pod logs from yaml file.

func (*Handler) LogFromMap added in v0.5.0 

func (h *Handler) LogFromMap(u map[string]interface{}, logOptions *LogOptions) error

LogFromMap get logs from map[string]interface{}.

func (*Handler) LogFromObject added in v0.4.1 

func (h *Handler) LogFromObject(obj runtime.Object, logOptions *LogOptions) error

LogFromObject get logs from runtime.Object.

func (*Handler) LogFromUnstructured added in v0.4.1 

func (h *Handler) LogFromUnstructured(u *unstructured.Unstructured, logOptions *LogOptions) error

LogFromUnstructured get logs from *unstructured.Unstructured.

func (*Handler) PodInformer added in v0.4.5 

func (h *Handler) PodInformer() informerscore.PodInformer

PodInformer returns underlying PodInformer which provides access to a shared informer and lister for pod.

func (*Handler) RESTClient added in v0.2.0 

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

RESTClient returns underlying rest client.

func (*Handler) RESTConfig added in v0.3.0 

func (h *Handler) RESTConfig() *rest.Config

RESTConfig returns underlying rest config.

func (*Handler) RunInformer 

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

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

func (*Handler) SetForceDelete 

func (p *Handler) SetForceDelete(force bool)

func (*Handler) SetInformerResyncPeriod added in v0.4.5 

func (h *Handler) SetInformerResyncPeriod(resyncPeriod time.Duration)

SetInformerResyncPeriod will set informer resync period.

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{})

TestInformer

func (*Handler) Update 

func (h *Handler) Update(obj interface{}) (*corev1.Pod, error)

Update updates pod from type string, []byte, *corev1.pod, corev1.pod, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.

func (*Handler) UpdateFromBytes 

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

UpdateFromBytes updates pod from bytes.

func (*Handler) UpdateFromFile 

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

UpdateFromFile updates pod from yaml file.

func (*Handler) UpdateFromMap added in v0.5.0 

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

UpdateFromMap updates pod from map[string]interface{}.

func (*Handler) UpdateFromObject added in v0.3.0 

func (h *Handler) UpdateFromObject(obj runtime.Object) (*corev1.Pod, error)

UpdateFromObject updates pod from runtime.Object.

func (*Handler) UpdateFromUnstructured added in v0.3.0 

func (h *Handler) UpdateFromUnstructured(u *unstructured.Unstructured) (*corev1.Pod, error)

UpdateFromUnstructured updates pod from *unstructured.Unstructured.

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 LogOptions added in v0.4.1 

type LogOptions struct {
	// add '\n' after the string that will be written to "io.Writer"
	NewLine bool

	corev1.PodLogOptions
	io.Writer
}

type PodController 

type PodController struct {
	metav1.OwnerReference
}

type PtyHandler added in v0.2.1 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.