persistentvolumeclaim

package
v0.4.5 Latest Latest
Warning

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

 Go to latest Published: Jul 26, 2022 License: Apache-2.0 Imports: 23 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ERR_TYPE_TOOLS  = fmt.Errorf("type must be string *corev1.PersistentVolumeClaim, or corev1.PersistentVolumeClaim")
	ERR_TYPE_CREATE = fmt.Errorf("type must be string, []byte, *corev1.PersistentVolumeClaim, corev1.PersistentVolumeClaim, runtime.Object 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 ERR_TYPE = fmt.Errorf("type must be *corev1.PersistentVolumeClaim, corev1.PersistentVolumeClaim or string")

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 *Handler, err error)

New returns a Handler 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 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, runtime.Object or map[string]interface{}.

func (*Handler) ApplyFromBytes 

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

ApplyFromBytes pply persistentvolumeclaim from bytes.

func (*Handler) ApplyFromFile 

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

ApplyFromFile applies persistentvolumeclaim from yaml file.

func (*Handler) ApplyFromObject added in v0.3.0 

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

ApplyFromObject applies persistentvolumeclaim from runtime.Object.

func (*Handler) ApplyFromUnstructured added in v0.3.0 

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

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

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, runtime.Object or map[string]interface{}.

func (*Handler) CreateFromBytes 

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

CreateFromBytes creates persistentvolumeclaim from bytes.

func (*Handler) CreateFromFile 

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

CreateFromFile creates persistentvolumeclaim from yaml file.

func (*Handler) CreateFromObject added in v0.3.0 

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

CreateFromObject creates persistentvolumeclaim from runtime.Object.

func (*Handler) CreateFromUnstructured added in v0.3.0 

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

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

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

func (*Handler) DeleteFromFile 

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

DeleteFromFile deletes persistentvolumeclaim from yaml file.

func (*Handler) DeleteFromObject added in v0.3.0 

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

DeleteFromObject deletes persistentvolumeclaim from runtime.Object.

func (*Handler) DeleteFromUnstructured added in v0.3.0 

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

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

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)

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.

func (*Handler) GetFromFile 

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

GetFromFile gets persistentvolumeclaim from yaml file.

func (*Handler) GetFromObject added in v0.3.0 

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

GetFromObject gets persistentvolumeclaim from runtime.Object.

func (*Handler) GetFromUnstructured added in v0.3.0 

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

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

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) List 

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

List list persistentvolumeclaims by labels, alias to "ListByLabel".

func (*Handler) ListAll 

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

ListAll list all persistentvolumeclaims in the k8s cluster.

func (*Handler) ListByLabel 

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

ListByLabel list persistentvolumeclaims by labels.

func (*Handler) ListByNamespace 

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

ListByNamespace list persistentvolumeclaims by namespace.

func (*Handler) Namespace 

func (h *Handler) Namespace() string

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

func (*Handler) SetForceDelete 

func (h *Handler) SetForceDelete(force bool)

func (*Handler) SetLimit 

func (h *Handler) SetLimit(limit int64)

func (*Handler) SetTimeout 

func (h *Handler) SetTimeout(timeout int64)

func (*Handler) Update 

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

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

func (*Handler) UpdateFromBytes 

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

UpdateFromBytes updates persistentvolumeclaim from bytes.

func (*Handler) UpdateFromFile 

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

UpdateFromFile updates persistentvolumeclaim from yaml file.

func (*Handler) UpdateFromObject added in v0.3.0 

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

UpdateFromObject updates persistentvolumeclaim from runtime.Object.

func (*Handler) UpdateFromUnstructured added in v0.3.0 

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

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

func (*Handler) Watch 

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

Watch watch persistentvolumeclaim 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 persistentvolumeclaim by label.

func (*Handler) WatchByName 

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

WatchByName watch persistentvolumeclaim by name.

func (*Handler) WithDryRun 

func (h *Handler) WithDryRun() *Handler

func (*Handler) WithNamespace 

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

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.