pod

package
v0.12.4 Latest Latest
Warning

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

 Go to latest Published: Oct 11, 2022 License: Apache-2.0 Imports: 45 Imported by: 5

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidToolsType  = errors.New("type must be string, *corev1.Pod, corev1.Pod, metav1.Object or runtime.Object")
	ErrInvalidCreateType = errors.New("type must be string, []byte, *corev1.Pod, corev1.Pod, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}")
	ErrInvalidUpdateType = ErrInvalidCreateType
	ErrInvalidApplyType  = ErrInvalidCreateType
	ErrInvalidDeleteType = ErrInvalidCreateType
	ErrInvalidGetType    = ErrInvalidCreateType
	ErrInvalidLogType    = ErrInvalidCreateType
	ErrInvalidPatchType  = errors.New("patch data type must be string, []byte, *corev1.Pod, corev1.Pod, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}")
)
View Source 
var DefaultLogOptions = &LogOptions{
	PodLogOptions: corev1.PodLogOptions{},
	Writer:        os.Stdout,
	NewLine:       true,
}
View Source 
var GVK = schema.GroupVersionKind{
	Group:   corev1.SchemeGroupVersion.Group,
	Version: corev1.SchemeGroupVersion.Version,
	Kind:    types.KindPod,
}

GVK contains the Group, Version, Kind name of pod.

View Source 
var GVR = schema.GroupVersionResource{
	Group:    corev1.SchemeGroupVersion.Group,
	Version:  corev1.SchemeGroupVersion.Version,
	Resource: types.ResourcePod,
}

GVR contains the Group, Version and Resource name of pod.

View Source 
var Group = GVK.Group

Group is the pod Group name.

View Source 
var Kind = GVK.Kind

Kind is the pod Kind name.

View Source 
var Resource = GVR.Resource

Resource is the pod Resource name.

View Source 
var Version = GVK.Version

Version is the pod Version name.

Functions

This section is empty.

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, error)

New returns a pod handler from kubeconfig or in-cluster config. The kubeconfig precedence is: * kubeconfig variable passed. * KUBECONFIG environment variable pointing at a file. * $HOME/.kube/config if exists. * In-cluster config if running in cluster.

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, metav1.Object, 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 data.

func (*Handler) ApplyFromFile 

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

ApplyFromFile applies pod from yaml or json 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 interface{}) (*corev1.Pod, error)

ApplyFromObject applies deployment from metav1.Object or 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, metav1.Object, 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 data.

func (*Handler) CreateFromFile 

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

CreateFromFile creates pod from yaml or json 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 interface{}) (*corev1.Pod, error)

CreateFromObject creates pod from metav1.Object or 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

Delete deletes pod from type string, []byte, *corev1.Pod, corev1.Pod, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.

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 data.

func (*Handler) DeleteFromFile 

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

DeleteFromFile deletes pod from yaml or json 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 interface{}) error

DeleteFromObject deletes pod from metav1.Object or 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) 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.

The remote processes default stdin, stdout, stderr are os.Stdin, os.Stdout, os.Stderr.

func (*Handler) ExecuteWithPty added in v0.9.1 

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

ExecuteWithPty 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.

You should provide a PtyHandler interface. What is pty, please refer to https://man7.org/linux/man-pages/man7/pty.7.html

func (*Handler) ExecuteWithStream added in v0.9.1 

func (h *Handler) ExecuteWithStream(podName, containerName string, command []string, stdin io.Reader, stdout, stderr io.Writer) error

ExecuteWithStream 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.

You should manually specify that the stdin, stdout and stderr of the remote shell process.

func (*Handler) Get 

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

Get gets pod from type string, []byte, *corev1.Pod, corev1.Pod, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.

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 data.

func (*Handler) GetFromFile 

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

GetFromFile gets pod from yaml or json 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 interface{}) (*corev1.Pod, error)

GetFromObject gets pod from metav1.Object or 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() ([]*corev1.Pod, error)

List list all pods in k8s cluster where the pod is running, it simply call `ListAll`.

func (*Handler) ListAll 

func (h *Handler) ListAll() ([]*corev1.Pod, error)

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

func (*Handler) ListByField added in v0.7.0 

func (h *Handler) ListByField(field string) ([]*corev1.Pod, error)

ListByField list pods by field, work like `kubectl get xxx --field-selector=xxx`.

func (*Handler) ListByLabel 

func (h *Handler) ListByLabel(labels string) ([]*corev1.Pod, error)

ListByLabel list pods by labels.

Multiple labels separated by comma(",") eg: "name=myapp,role=devops", and there is an "And" relationship between multiple labels.

func (*Handler) ListByNamespace 

func (h *Handler) ListByNamespace(namespace string) ([]*corev1.Pod, error)

ListByNamespace list all pods in the specified namespace.

func (*Handler) ListByNode 

func (h *Handler) ListByNode(name string) ([]*corev1.Pod, error)

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

func (*Handler) ListFailed added in v0.7.0 

func (h *Handler) ListFailed() ([]*corev1.Pod, error)

ListFailed list all pods whose .status.phase is "Failed" in the k8s cluster.

"Failed" means that all containers in the pod have terminated, and at least one container has terminated in a failure (exited with a non-zero exit code or was stopped by the system).

func (*Handler) ListPending added in v0.7.0 

func (h *Handler) ListPending() ([]*corev1.Pod, error)

ListPending list all pods whose .status.phase is "Pending" in the k8s cluster.

"Pending" means the pod has been accepted by the system, but one or more of the containers has not been started. This includes time before being bound to a node, as well as time spent pulling images onto the host.

func (*Handler) ListRunning added in v0.7.0 

func (h *Handler) ListRunning() ([]*corev1.Pod, error)

ListRunning list all pods whose .status.phase is "Running" in the k8s cluster.

"Running" means the pod has been bound to a node and all of the containers have been started. At least one container is still running or is in the process of being restarted.

func (*Handler) ListSucceeded added in v0.7.0 

func (h *Handler) ListSucceeded() ([]*corev1.Pod, error)

ListSucceeded list all pods whose .status.phase is "Succeeded" in the k8s cluster.

"Succeeded" means that all containers in the pod have voluntarily terminated with a container exit code of 0, and the system is not going to restart any of these containers.

func (*Handler) ListUnknow added in v0.7.0 

func (h *Handler) ListUnknow() ([]*corev1.Pod, error)

ListUnknow list all pods whose .status.phase is "Unknow" in the k8s cluster.

"Unknown" means that 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. Deprecated: It isn't being set since 2015 (74da3b14b0c0f658b3bb8d2def5094686d0e9095)

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

Log get pod logs from type string, []byte, *corev1.pod, corev1.pod, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.

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 data.

func (*Handler) LogFromFile added in v0.4.1 

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

LogFromFile get pod logs from yaml or json 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 interface{}, logOptions *LogOptions) error

LogFromObject get logs from metav1.Object or 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) Patch added in v0.11.1 

func (h *Handler) Patch(original *corev1.Pod, patch interface{}, patchOptions ...types.PatchType) (*corev1.Pod, error)

Patch use the default patch type(Strategic Merge Patch) to patch pod. Supported patch types are: "StrategicMergePatchType", "MergePatchType", "JSONPatchType".

For further more Strategic Merge patch, see: 

https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/#before-you-begin

For a comparison of JSON patch and JSON merge patch, see: 

https://erosb.github.io/post/json-patch-vs-merge-patch/

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) PortForward added in v0.10.0 

func (h *Handler) PortForward(podName string, localPort, remotePort uint32, stopChan ...<-chan struct{}) error

PortForward forward a local port to the pod.

func (*Handler) PortForwardWithStream added in v0.10.3 

func (h *Handler) PortForwardWithStream(podName string, localPort, remotePort uint32, stdout, stderr io.Writer, stopChan ...<-chan struct{}) error

PortForwardWithStreama forward a local port to the pod, and you should provide the stdout, stderr.

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) ResetNamespace added in v0.11.4 

func (h *Handler) ResetNamespace(namespace string)

func (*Handler) RunInformer 

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

RunInformer start and run the shared informer, returning after it stops. The informer will be stopped when stopCh is closed.

AddFunc, updateFunc, and deleteFunc are used to handle add, update, and delete event of k8s pod resource, respectively.

func (*Handler) SetForceDelete 

func (h *Handler) SetForceDelete(force bool)

func (*Handler) SetInformerFactoryNamespace added in v0.10.4 

func (h *Handler) SetInformerFactoryNamespace(namespace string)

SetInformerFactoryNamespace limit the scope of informer list-and-watch k8s resource. informer list-and-watch all namespace k8s resource by default.

func (*Handler) SetInformerFactoryResyncPeriod added in v0.10.4 

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

SetInformerFactoryResyncPeriod will set informer resync period.

func (*Handler) SetInformerFactoryTweakListOptions added in v0.10.4 

func (h *Handler) SetInformerFactoryTweakListOptions(tweakListOptions internalinterfaces.TweakListOptionsFunc)

SetInformerFactoryTweakListOptions sets a custom filter on all listers of the configured SharedInformerFactory.

func (*Handler) SetLimit 

func (h *Handler) SetLimit(limit int64)

func (*Handler) SetTimeout 

func (h *Handler) SetTimeout(timeout int64)

func (*Handler) StartInformer added in v0.10.1 

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

StartInformer simply call RunInformer.

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, metav1.Object, 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 data.

func (*Handler) UpdateFromFile 

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

UpdateFromFile updates pod from yaml or json 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 interface{}) (*corev1.Pod, error)

UpdateFromObject updates pod from metav1.Object or 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(addFunc, modifyFunc, deleteFunc func(obj interface{})) error

Watch watch all pod resources.

Object as the parameter of addFunc, modifyFunc, deleteFunc:

  • If Event.Type is Added or Modified: the new state of the object.
  • If Event.Type is Deleted: the state of the object immediately before deletion.
  • If Event.Type is Bookmark: the object (instance of a type being watched) where only ResourceVersion field is set. On successful restart of watch from a bookmark resourceVersion, client is guaranteed to not get repeat event nor miss any events.
  • If Event.Type is Error: *api.Status is recommended; other types may make sense depending on context.

func (*Handler) WatchByField added in v0.11.1 

func (h *Handler) WatchByField(field string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error

WatchByField watch a single or multiple Pod resources selected by the field.

Object as the parameter of addFunc, modifyFunc, deleteFunc:

  • If Event.Type is Added or Modified: the new state of the object.
  • If Event.Type is Deleted: the state of the object immediately before deletion.
  • If Event.Type is Bookmark: the object (instance of a type being watched) where only ResourceVersion field is set. On successful restart of watch from a bookmark resourceVersion, client is guaranteed to not get repeat event nor miss any events.
  • If Event.Type is Error: *api.Status is recommended; other types may make sense depending on context.

func (*Handler) WatchByLabel 

func (h *Handler) WatchByLabel(labels string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error

WatchByLabel watch a single or multiple Pod resources selected by the label. Multiple labels are separated by ",", label key and value conjunctaed by "=".

Object as the parameter of addFunc, modifyFunc, deleteFunc:

  • If Event.Type is Added or Modified: the new state of the object.
  • If Event.Type is Deleted: the state of the object immediately before deletion.
  • If Event.Type is Bookmark: the object (instance of a type being watched) where only ResourceVersion field is set. On successful restart of watch from a bookmark resourceVersion, client is guaranteed to not get repeat event nor miss any events.
  • If Event.Type is Error: *api.Status is recommended; other types may make sense depending on context.

func (*Handler) WatchByName 

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

WatchByName watch a single pod reseource.

Object as the parameter of addFunc, modifyFunc, deleteFunc:

  • If Event.Type is Added or Modified: the new state of the object.
  • If Event.Type is Deleted: the state of the object immediately before deletion.
  • If Event.Type is Bookmark: the object (instance of a type being watched) where only ResourceVersion field is set. On successful restart of watch from a bookmark resourceVersion, client is guaranteed to not get repeat event nor miss any events.
  • If Event.Type is Error: *api.Status is recommended; other types may make sense depending on context.

func (*Handler) WatchByNamespace added in v0.11.1 

func (h *Handler) WatchByNamespace(namespace string, addFunc, modifyFunc, deleteFunc func(obj interface{})) error

WatchByNamespace watch all pod resources in the specified namespace.

Object as the parameter of addFunc, modifyFunc, deleteFunc:

  • If Event.Type is Added or Modified: the new state of the object.
  • If Event.Type is Deleted: the state of the object immediately before deletion.
  • If Event.Type is Bookmark: the object (instance of a type being watched) where only ResourceVersion field is set. On successful restart of watch from a bookmark resourceVersion, client is guaranteed to not get repeat event nor miss any events.
  • If Event.Type is Error: *api.Status is recommended; other types may make sense depending on context.

func (*Handler) WithDryRun 

func (h *Handler) WithDryRun() *Handler

WithDryRun deep copies a new handler and prints the create/update/apply/delete operations, without sending it to apiserver.

func (*Handler) WithNamespace 

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

WithNamespace deep copies a new handler, but set the handler.namespace to the provided namespace.

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.