Documentation
¶
Index ¶
- Variables
- func GVK() schema.GroupVersionKind
- func GVR() schema.GroupVersionResource
- func Group() string
- func Kind() string
- func Resource() string
- func Version() string
- type Handler
- func (h *Handler) Apply(obj interface{}) (*corev1.PersistentVolume, error)
- func (h *Handler) ApplyFromBytes(data []byte) (pv *corev1.PersistentVolume, err error)
- func (h *Handler) ApplyFromFile(filename string) (pv *corev1.PersistentVolume, err error)
- func (h *Handler) ApplyFromMap(u map[string]interface{}) (*corev1.PersistentVolume, error)
- func (h *Handler) ApplyFromObject(obj runtime.Object) (*corev1.PersistentVolume, error)
- func (h *Handler) ApplyFromUnstructured(u *unstructured.Unstructured) (*corev1.PersistentVolume, error)
- func (h *Handler) Clientset() *kubernetes.Clientset
- func (h *Handler) Create(obj interface{}) (*corev1.PersistentVolume, error)
- func (h *Handler) CreateFromBytes(data []byte) (*corev1.PersistentVolume, error)
- func (h *Handler) CreateFromFile(filename string) (*corev1.PersistentVolume, error)
- func (h *Handler) CreateFromMap(u map[string]interface{}) (*corev1.PersistentVolume, error)
- func (h *Handler) CreateFromObject(obj runtime.Object) (*corev1.PersistentVolume, error)
- func (h *Handler) CreateFromUnstructured(u *unstructured.Unstructured) (*corev1.PersistentVolume, error)
- func (in *Handler) DeepCopy() *Handler
- func (h *Handler) Delete(obj interface{}) 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) DeleteFromMap(u map[string]interface{}) error
- func (h *Handler) DeleteFromObject(obj runtime.Object) error
- func (h *Handler) DeleteFromUnstructured(u *unstructured.Unstructured) error
- func (h *Handler) DiscoveryClient() *discovery.DiscoveryClient
- func (h *Handler) DynamicClient() dynamic.Interface
- func (h *Handler) Get(obj interface{}) (*corev1.PersistentVolume, error)
- func (h *Handler) GetAccessModes(object interface{}) (accessModes []string, err error)
- func (h *Handler) GetAge(object interface{}) (time.Duration, error)
- func (h *Handler) GetByName(name string) (*corev1.PersistentVolume, error)
- func (h *Handler) GetCapacity(object interface{}) (int64, error)
- func (h *Handler) GetClaim(object interface{}) (string, error)
- func (h *Handler) GetFromBytes(data []byte) (*corev1.PersistentVolume, error)
- func (h *Handler) GetFromFile(filename string) (*corev1.PersistentVolume, error)
- func (h *Handler) GetFromMap(u map[string]interface{}) (*corev1.PersistentVolume, error)
- func (h *Handler) GetFromObject(obj runtime.Object) (*corev1.PersistentVolume, error)
- func (h *Handler) GetFromUnstructured(u *unstructured.Unstructured) (*corev1.PersistentVolume, error)
- func (h *Handler) GetPVC(object interface{}) (string, error)
- func (h *Handler) GetReclaimPolicy(object interface{}) (string, error)
- func (h *Handler) GetStatus(object interface{}) (string, error)
- func (h *Handler) GetStorageClass(object interface{}) (string, error)
- func (h *Handler) GetVolumeMode(object interface{}) (string, error)
- func (h *Handler) GetVolumeSource(object interface{}) (string, error)
- func (h *Handler) Informer() cache.SharedIndexInformer
- func (h *Handler) InformerFactory() informers.SharedInformerFactory
- func (h *Handler) List() ([]*corev1.PersistentVolume, error)
- func (h *Handler) ListAll() ([]*corev1.PersistentVolume, error)
- func (h *Handler) ListByField(field string) ([]*corev1.PersistentVolume, error)
- func (h *Handler) ListByLabel(labels string) ([]*corev1.PersistentVolume, error)
- func (h *Handler) Lister() listerscore.PersistentVolumeLister
- func (h *Handler) PersistentVolumeInformer() informerscore.PersistentVolumeInformer
- func (h *Handler) RESTClient() *rest.RESTClient
- func (h *Handler) RESTConfig() *rest.Config
- func (h *Handler) RunInformer(stopCh <-chan struct{}, addFunc func(obj interface{}), ...)
- func (h *Handler) SetForceDelete(force bool)
- func (h *Handler) SetInformerFactoryNamespace(namespace string)
- func (h *Handler) SetInformerFactoryResyncPeriod(resyncPeriod time.Duration)
- func (h *Handler) SetInformerFactoryTweakListOptions(tweakListOptions internalinterfaces.TweakListOptionsFunc)
- func (h *Handler) SetLimit(limit int64)
- func (h *Handler) SetTimeout(timeout int64)
- func (h *Handler) StartInformer(stopCh <-chan struct{}, addFunc func(obj interface{}), ...)
- func (h *Handler) Update(obj interface{}) (*corev1.PersistentVolume, error)
- func (h *Handler) UpdateFromBytes(data []byte) (*corev1.PersistentVolume, error)
- func (h *Handler) UpdateFromFile(filename string) (*corev1.PersistentVolume, error)
- func (h *Handler) UpdateFromMap(u map[string]interface{}) (*corev1.PersistentVolume, error)
- func (h *Handler) UpdateFromObject(obj runtime.Object) (*corev1.PersistentVolume, error)
- func (h *Handler) UpdateFromUnstructured(u *unstructured.Unstructured) (*corev1.PersistentVolume, error)
- func (h *Handler) Watch(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), ...) (err error)
- func (h *Handler) WatchByLabel(labels string, addFunc, modifyFunc, deleteFunc func(x interface{}), ...) (err error)
- func (h *Handler) WatchByName(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), ...) (err error)
- func (h *Handler) WithDryRun() *Handler
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidToolsType = fmt.Errorf("type must be string, *corev1.PersistentVolume, or corev1.PersistentVolume") ErrInvalidCreateType = fmt.Errorf("type must be string, []byte, *corev1.PersistentVolume, corev1.PersistentVolume, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}") ErrInvalidUpdateType = ErrInvalidCreateType ErrInvalidApplyType = ErrInvalidCreateType ErrInvalidDeleteType = ErrInvalidCreateType ErrInvalidGetType = ErrInvalidCreateType )
Functions ¶
func GVK ¶ added in v0.6.1
func GVK() schema.GroupVersionKind
GVK returns the name of Group, Version, Kind of persistentvolume resource.
func GVR ¶ added in v0.5.0
func GVR() schema.GroupVersionResource
GVR returns the name of Group, Version, Resource of persistentvolume resource.
func Group ¶ added in v0.5.0
func Group() string
Group returns the Group name of persistentvolume resource.
func Kind ¶ added in v0.6.1
func Kind() string
Kind returns the Kind name of persistentvolume resource.
Types ¶
type Handler ¶
type Handler struct { Options *types.HandlerOptions // contains filtered or unexported fields }
func New ¶
New returns a persistentvolume 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
NewOrDie simply call New() to get a persistentvolume handler. panic if there is any error occurs.
func (*Handler) Apply ¶
func (h *Handler) Apply(obj interface{}) (*corev1.PersistentVolume, error)
Apply applies persistentvolume from type string, []byte, *corev1.PersistentVolume, corev1.PersistentVolume, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) ApplyFromBytes ¶
func (h *Handler) ApplyFromBytes(data []byte) (pv *corev1.PersistentVolume, err error)
ApplyFromBytes pply persistentvolume from bytes.
func (*Handler) ApplyFromFile ¶
func (h *Handler) ApplyFromFile(filename string) (pv *corev1.PersistentVolume, err error)
ApplyFromFile applies persistentvolume from yaml file.
func (*Handler) ApplyFromMap ¶ added in v0.5.0
func (h *Handler) ApplyFromMap(u map[string]interface{}) (*corev1.PersistentVolume, error)
ApplyFromMap applies persistentvolume from map[string]interface{}.
func (*Handler) ApplyFromObject ¶ added in v0.3.0
ApplyFromObject applies persistentvolume from runtime.Object.
func (*Handler) ApplyFromUnstructured ¶ added in v0.3.0
func (h *Handler) ApplyFromUnstructured(u *unstructured.Unstructured) (*corev1.PersistentVolume, error)
ApplyFromUnstructured applies persistentvolume 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.PersistentVolume, error)
Create creates persistentvolume from type string, []byte, *corev1.PersistentVolume, corev1.PersistentVolume, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) CreateFromBytes ¶
func (h *Handler) CreateFromBytes(data []byte) (*corev1.PersistentVolume, error)
CreateFromBytes creates persistentvolume from bytes.
func (*Handler) CreateFromFile ¶
func (h *Handler) CreateFromFile(filename string) (*corev1.PersistentVolume, error)
CreateFromFile creates persistentvolume from yaml file.
func (*Handler) CreateFromMap ¶ added in v0.5.0
func (h *Handler) CreateFromMap(u map[string]interface{}) (*corev1.PersistentVolume, error)
CreateFromMap creates persistentvolume from map[string]interface{}.
func (*Handler) CreateFromObject ¶ added in v0.3.0
CreateFromObject creates persistentvolume from runtime.Object.
func (*Handler) CreateFromUnstructured ¶ added in v0.3.0
func (h *Handler) CreateFromUnstructured(u *unstructured.Unstructured) (*corev1.PersistentVolume, error)
CreateFromUnstructured creates persistentvolume from *unstructured.Unstructured.
func (*Handler) Delete ¶
Delete deletes persistentvolume from type string, []byte, *corev1.PersistentVolume, corev1.PersistentVolume, 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 persistentvolume from file path.
func (*Handler) DeleteByName ¶
DeleteByName deletes persistentvolume by name.
func (*Handler) DeleteFromBytes ¶
DeleteFromBytes deletes persistentvolume from bytes.
func (*Handler) DeleteFromFile ¶
DeleteFromFile deletes persistentvolume from yaml file.
func (*Handler) DeleteFromMap ¶ added in v0.5.0
DeleteFromMap deletes persistentvolume from map[string]interface{}.
func (*Handler) DeleteFromObject ¶ added in v0.3.0
DeleteFromObject deletes persistentvolume from runtime.Object.
func (*Handler) DeleteFromUnstructured ¶ added in v0.3.0
func (h *Handler) DeleteFromUnstructured(u *unstructured.Unstructured) error
DeleteFromUnstructured deletes persistentvolume 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
DynamicClient returns underlying dynamic client.
func (*Handler) Get ¶
func (h *Handler) Get(obj interface{}) (*corev1.PersistentVolume, error)
Get gets persistentvolume from type string, []byte, *corev1.PersistentVolume, corev1.PersistentVolume, 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 persistentvolume from file path.
func (*Handler) GetAccessModes ¶
GetAccessModes get the accessModes of the persistentvolume.
func (*Handler) GetByName ¶
func (h *Handler) GetByName(name string) (*corev1.PersistentVolume, error)
GetByName gets persistentvolume by name.
func (*Handler) GetCapacity ¶
GetCapacity get the the storage capacity of the persistentvolume.
func (*Handler) GetFromBytes ¶
func (h *Handler) GetFromBytes(data []byte) (*corev1.PersistentVolume, error)
GetFromBytes gets persistentvolume from bytes.
func (*Handler) GetFromFile ¶
func (h *Handler) GetFromFile(filename string) (*corev1.PersistentVolume, error)
GetFromFile gets persistentvolume from yaml file.
func (*Handler) GetFromMap ¶ added in v0.5.0
func (h *Handler) GetFromMap(u map[string]interface{}) (*corev1.PersistentVolume, error)
GetFromMap gets persistentvolume from map[string]interface{}.
func (*Handler) GetFromObject ¶ added in v0.3.0
GetFromObject gets persistentvolume from runtime.Object.
func (*Handler) GetFromUnstructured ¶ added in v0.3.0
func (h *Handler) GetFromUnstructured(u *unstructured.Unstructured) (*corev1.PersistentVolume, error)
GetFromUnstructured gets persistentvolume from *unstructured.Unstructured.
func (*Handler) GetReclaimPolicy ¶
GetReclaimPolicy get the reclaim policy of the persistentvolume.
func (*Handler) GetStatus ¶ added in v0.2.0
GetStatus get the status phase of the persistentvolume. All supported pv status are: Pending, Available, Bound, Released, Failed. Pending used for PersistentVolumes that are not available. Available used for PersistentVolumes that are not yet bound. Bound used for PersistentVolumes that are bound. Released used for PersistentVolumes where the bound PersistentVolumeClaim was deleted. Failed used for PersistentVolumes that failed to be correctly recycled or deleted after being released from a claim.
func (*Handler) GetStorageClass ¶
GetStorageClass get the storageclass name of the persistentvolume.
func (*Handler) GetVolumeMode ¶ added in v0.2.0
GetVolumeMode get volume mode of the persistentvolume. volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.
func (*Handler) GetVolumeSource ¶ added in v0.2.0
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.PersistentVolume, error)
List list all persistentvolumes in the k8s cluster, it simply call `ListAll`.
func (*Handler) ListAll ¶
func (h *Handler) ListAll() ([]*corev1.PersistentVolume, error)
ListAll list all persistentvolumes in the k8s cluster.
func (*Handler) ListByField ¶ added in v0.7.0
func (h *Handler) ListByField(field string) ([]*corev1.PersistentVolume, error)
ListByField list persistentvolumes by field, work like `kubectl get xxx --field-selector=xxx`.
func (*Handler) ListByLabel ¶
func (h *Handler) ListByLabel(labels string) ([]*corev1.PersistentVolume, error)
ListByLabel list persistentvolumes by labels. Multiple labels separated by comma(",") eg: "name=myapp,role=devops", and there is an "And" relationship between multiple labels.
func (*Handler) Lister ¶ added in v0.5.0
func (h *Handler) Lister() listerscore.PersistentVolumeLister
Lister returns underlying PersistentVolumeLister which helps list persistentvolumes.
func (*Handler) PersistentVolumeInformer ¶ added in v0.5.0
func (h *Handler) PersistentVolumeInformer() informerscore.PersistentVolumeInformer
PersistentVolumeInformer returns underlying PersistentVolumeInformer which provides access to a shared informer and lister for persistentvolume.
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
RESTConfig returns underlying rest config.
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 persistentvolume resource, respectively.
func (*Handler) SetForceDelete ¶
func (*Handler) SetInformerFactoryNamespace ¶ added in v0.10.4
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
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) SetTimeout ¶
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.PersistentVolume, error)
Update updates persistentvolume from type string, []byte, *corev1.PersistentVolume, corev1.PersistentVolume, runtime.Object, *unstructured.Unstructured, unstructured.Unstructured or map[string]interface{}.
func (*Handler) UpdateFromBytes ¶
func (h *Handler) UpdateFromBytes(data []byte) (*corev1.PersistentVolume, error)
UpdateFromBytes updates persistentvolume from bytes.
func (*Handler) UpdateFromFile ¶
func (h *Handler) UpdateFromFile(filename string) (*corev1.PersistentVolume, error)
UpdateFromFile updates persistentvolume from yaml file.
func (*Handler) UpdateFromMap ¶ added in v0.5.0
func (h *Handler) UpdateFromMap(u map[string]interface{}) (*corev1.PersistentVolume, error)
UpdateFromMap updates persistentvolume from map[string]interface{}.
func (*Handler) UpdateFromObject ¶ added in v0.3.0
UpdateFromObject updates persistentvolume from runtime.Object.
func (*Handler) UpdateFromUnstructured ¶ added in v0.3.0
func (h *Handler) UpdateFromUnstructured(u *unstructured.Unstructured) (*corev1.PersistentVolume, error)
UpdateFromUnstructured updates persistentvolume from *unstructured.Unstructured.
func (*Handler) Watch ¶
func (h *Handler) Watch(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)
Watch watch persistentvolume by name, alias to "WatchByName".
func (*Handler) WatchByLabel ¶
func (h *Handler) WatchByLabel(labels string, addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)
WatchByLabel watch persistentvolume by labels.
func (*Handler) WatchByName ¶
func (h *Handler) WatchByName(name string, addFunc, modifyFunc, deleteFunc func(x interface{}), x interface{}) (err error)
WatchByName watch persistentvolume by name.
func (*Handler) WithDryRun ¶
WithDryRun deep copies a new handler and prints the create/update/apply/delete operations, without sending it to apiserver.