persistentvolumeclaim

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: 33 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidToolsType  = errors.New("type must be string, *corev1.PersistentVolumeClaim, corev1.PersistentVolumeClaim, metav1.Object or runtime.Object")
	ErrInvalidCreateType = errors.New("type must be string, []byte, *corev1.PersistentVolumeClaim, corev1.PersistentVolumeClaim, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}")
	ErrInvalidUpdateType = ErrInvalidCreateType
	ErrInvalidApplyType  = ErrInvalidCreateType
	ErrInvalidDeleteType = ErrInvalidCreateType
	ErrInvalidGetType    = ErrInvalidCreateType
	ErrInvalidPatchType  = errors.New("patch data type must be string, []byte, *corev1.PersistentVolumeClaim, corev1.PersistentVolumeClaim, metav1.Object, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}")
)
View Source 
var GVK = schema.GroupVersionKind{
	Group:   corev1.SchemeGroupVersion.Group,
	Version: corev1.SchemeGroupVersion.Version,
	Kind:    types.KindPersistentVolumeClaim,
}

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

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

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

View Source 
var Group = GVK.Group

Group is the persistentvolumeclaim Group name.

View Source 
var Kind = GVK.Kind

Kind is the persistentvolumeclaim Kind name.

View Source 
var Resource = GVR.Resource

Resource is the persistentvolumeclaim Resource name.

View Source 
var Version = GVK.Version

Version is the persistentvolumeclaim Version name.

Functions

This section is empty.

Types

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 Handler 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 persistentvolumeclaim handler. panic if there is any error occurs.

func (*Handler) Apply 

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

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

func (*Handler) ApplyFromBytes 

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

ApplyFromBytes pply persistentvolumeclaim from bytes data.

func (*Handler) ApplyFromFile 

func (h *Handler) ApplyFromFile(filename string) (pvc *corev1.PersistentVolumeClaim, err error)

ApplyFromFile applies persistentvolumeclaim from yaml or json file.

func (*Handler) ApplyFromMap added in v0.5.0 

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

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

func (*Handler) ApplyFromObject added in v0.3.0 

func (h *Handler) ApplyFromObject(obj interface{}) (*corev1.PersistentVolumeClaim, error)

ApplyFromObject applies persistentvolumeclaim from metav1.Object or runtime.Object.

func (*Handler) ApplyFromUnstructured added in v0.3.0 

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

ApplyFromUnstructured applies persistentvolumeclaim 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.PersistentVolumeClaim, error)

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

func (*Handler) CreateFromBytes 

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

CreateFromBytes creates persistentvolumeclaim from bytes data.

func (*Handler) CreateFromFile 

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

CreateFromFile creates persistentvolumeclaim from yaml or json file.

func (*Handler) CreateFromMap added in v0.5.0 

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

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

func (*Handler) CreateFromObject added in v0.3.0 

func (h *Handler) CreateFromObject(obj interface{}) (*corev1.PersistentVolumeClaim, error)

CreateFromObject creates persistentvolumeclaim from metav1.Object or runtime.Object.

func (*Handler) CreateFromUnstructured added in v0.3.0 

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

CreateFromUnstructured creates persistentvolumeclaim from *unstructured.Unstructured.

func (*Handler) DeepCopy 

func (in *Handler) DeepCopy() *Handler

func (*Handler) Delete 

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

Delete deletes persistentvolumeclaim from type string, []byte, *corev1.PersistentVolumeClaim, corev1.PersistentVolumeClaim, 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 persistentvolumeclaim from file path.

func (*Handler) DeleteByName 

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

DeleteByName deletes persistentvolumeclaim by name.

func (*Handler) DeleteFromBytes 

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

DeleteFromBytes deletes persistentvolumeclaim from bytes data.

func (*Handler) DeleteFromFile 

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

DeleteFromFile deletes persistentvolumeclaim from yaml or json file.

func (*Handler) DeleteFromMap added in v0.5.0 

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

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

func (*Handler) DeleteFromObject added in v0.3.0 

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

DeleteFromObject deletes persistentvolumeclaim from metav1.Object or runtime.Object.

func (*Handler) DeleteFromUnstructured added in v0.3.0 

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

DeleteFromUnstructured deletes persistentvolumeclaim 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) Get 

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

Get gets persistentvolumeclaim from type string, []byte, *corev1.PersistentVolumeClaim, corev1.PersistentVolumeClaim, 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 persistentvolumeclaim from file path.

func (*Handler) GetAccessModes 

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

GetAccessModes get the access modes of the persistentvolumeclaim.

func (*Handler) GetAge added in v0.2.0 

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

GetAge returns age of the persistentvolumeclaim.

func (*Handler) GetByName 

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

GetByName gets persistentvolumeclaim by name.

func (*Handler) GetCapacity 

func (h *Handler) GetCapacity(object interface{}) (int64, error)

GetCapacity get the storage capacity of the persistentvolumeclaim.

func (*Handler) GetFromBytes 

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

GetFromBytes gets persistentvolumeclaim from bytes data.

func (*Handler) GetFromFile 

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

GetFromFile gets persistentvolumeclaim from yaml or json file.

func (*Handler) GetFromMap added in v0.5.0 

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

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

func (*Handler) GetFromObject added in v0.3.0 

func (h *Handler) GetFromObject(obj interface{}) (*corev1.PersistentVolumeClaim, error)

GetFromObject gets persistentvolumeclaim from metav1.Object or runtime.Object.

func (*Handler) GetFromUnstructured added in v0.3.0 

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

GetFromUnstructured gets persistentvolumeclaim from *unstructured.Unstructured.

func (*Handler) GetPV 

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

GetPV get the pv name of the persistentvolumeclaim

func (*Handler) GetStatus added in v0.2.0 

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

GetStatus get the status phase of the persistentvolumeclaim. All supported status are: Pending, Bound, Lost pending used for PersistentVolumeClaims that are not yet bound. Bound used for PersistentVolumeClaims that are bound. Lost used for PersistentVolumeClaims that lost their underlying.

func (*Handler) GetStorageClass 

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

GetStorageClass get the storageclass name of the persistentvolumeclaim.

func (*Handler) GetVolume added in v0.2.0 

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

GetVolume simply calls GetPV.

func (*Handler) GetVolumeMode added in v0.2.0 

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

GetVolumeMode get volume mode of the persistentvolumeclaim. volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

func (*Handler) Informer added in v0.5.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.5.0 

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

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

func (*Handler) List 

func (h *Handler) List() ([]*corev1.PersistentVolumeClaim, error)

List list all persistentvolumeclaims in the k8s cluster, it simply call `ListAll`.

func (*Handler) ListAll 

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

ListAll list all persistentvolumeclaims in the k8s cluster.

func (*Handler) ListByField added in v0.7.0 

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

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

func (*Handler) ListByLabel 

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

ListByLabel list persistentvolumeclaims 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.PersistentVolumeClaim, error)

ListByNamespace list all persistentvolumeclaims in the specified namespace.

func (*Handler) Lister added in v0.5.0 

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

Lister returns underlying PersistentVolumeClaimLister which helps list persistentvolumeclaims.

func (*Handler) Patch added in v0.11.1 

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

Patch use the default patch type(Strategic Merge Patch) to patch persistentvolumeclaim. 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) PersistentVolumeClaimInformer added in v0.5.0 

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

PersistentVolumeClaimInformer returns underlying PersistentVolumeClaimInformer which provides access to a shared informer and lister for persistentvolumeclaim.

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 persistentvolumeclaim 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) Update 

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

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

func (*Handler) UpdateFromBytes 

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

UpdateFromBytes updates persistentvolumeclaim from bytes data.

func (*Handler) UpdateFromFile 

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

UpdateFromFile updates persistentvolumeclaim from yaml or json file.

func (*Handler) UpdateFromMap added in v0.5.0 

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

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

func (*Handler) UpdateFromObject added in v0.3.0 

func (h *Handler) UpdateFromObject(obj interface{}) (*corev1.PersistentVolumeClaim, error)

UpdateFromObject updates persistentvolumeclaim from metav1.Object or runtime.Object.

func (*Handler) UpdateFromUnstructured added in v0.3.0 

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

UpdateFromUnstructured updates persistentvolumeclaim from *unstructured.Unstructured.

func (*Handler) Watch 

func (h *Handler) Watch(addFunc, modifyFunc, deleteFunc func(obj interface{})) error

Watch watch all persistentvolumeclaim 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 PersistentVolumeClaim 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 PersistentVolumeClaim 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 persistentvolumeclaim 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 persistentvolumeclaim 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.

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.