persistentvolumeclaims

Documentation

Index

• func DescribePVCs(pvcPrefix, namespace string)
• func WaitOnDeleted(pvcPrefix, namespace string, sleep, timeout time.Duration) (bool, error)
• type GetAllByPrefixResult
  • func GetAllByPrefixAsync(prefix, namespace string) GetAllByPrefixResult
• type GetResult
  • func GetAsync(pvcName, namespace string) GetResult
• type List
  • func GetAll(namespace string) (*List, error)
• type Metadata
• type PersistentVolumeClaim
  • func CreatePVCFromFileDeleteIfExist(filename, name, namespace string) (*PersistentVolumeClaim, error)
  • func CreatePersistentVolumeClaimsFromFile(filename, name, namespace string) (*PersistentVolumeClaim, error)
  • func Get(pvcName, namespace string) (*PersistentVolumeClaim, error)
  • func GetAllByPrefix(prefix, namespace string) ([]PersistentVolumeClaim, error)
  • func (pvc *PersistentVolumeClaim) Delete(retries int) error
  • func (pvc *PersistentVolumeClaim) Describe() error
  • func (pvc *PersistentVolumeClaim) WaitOnReady(namespace string, sleep, timeout time.Duration) (bool, error)
• type Spec
• type Status

Functions

func DescribePVCs

func DescribePVCs(pvcPrefix, namespace string)

DescribePVCs describes all pvcs whose name matches a substring

func WaitOnDeleted

func WaitOnDeleted(pvcPrefix, namespace string, sleep, timeout time.Duration) (bool, error)

WaitOnDeleted returns when a pvc is successfully deleted

Types

type GetAllByPrefixResult

type GetAllByPrefixResult struct {
	// contains filtered or unexported fields
}

GetAllByPrefixResult is a return struct for GetAllByPrefixAsync

func GetAllByPrefixAsync

func GetAllByPrefixAsync(prefix, namespace string) GetAllByPrefixResult

GetAllByPrefixAsync wraps Get with a struct response for goroutine + channel usage

type GetResult

type GetResult struct {
	// contains filtered or unexported fields
}

GetResult is a return struct for GetAsync

func GetAsync

func GetAsync(pvcName, namespace string) GetResult

GetAsync wraps Get with a struct response for goroutine + channel usage

type List

type List struct {
	PersistentVolumeClaims []PersistentVolumeClaim `json:"items"`
}

func GetAll

func GetAll(namespace string) (*List, error)

GetAll will return all pvcs in a given namespace

type Metadata

type Metadata struct {
	CreatedAt time.Time `json:"creationTimestamp"`
	Name      string    `json:"name"`
	Namespace string    `json:"namespace"`
}

Metadata holds information like name, create time, and namespace

type PersistentVolumeClaim

type PersistentVolumeClaim struct {
	Metadata Metadata `json:"metadata"`
	Spec     Spec     `json:"spec"`
	Status   Status   `json:"status"`
}

PersistentVolumeClaim is used to parse data from kubectl get pvc

func CreatePVCFromFileDeleteIfExist

func CreatePVCFromFileDeleteIfExist(filename, name, namespace string) (*PersistentVolumeClaim, error)

CreatePVCFromFileDeleteIfExist will create a PVC from file with a name

func CreatePersistentVolumeClaimsFromFile

func CreatePersistentVolumeClaimsFromFile(filename, name, namespace string) (*PersistentVolumeClaim, error)

CreatePersistentVolumeClaimsFromFile will create a PVC from file with a name

func Get

func Get(pvcName, namespace string) (*PersistentVolumeClaim, error)

Get will return a PersistentVolumeClaim with a given name and namespace

func GetAllByPrefix

func GetAllByPrefix(prefix, namespace string) ([]PersistentVolumeClaim, error)

GetAllByPrefix will return all pvcs in a given namespace that match a prefix

func (*PersistentVolumeClaim) Delete

func (pvc *PersistentVolumeClaim) Delete(retries int) error

Delete will delete a PersistentVolumeClaim in a given namespace

func (*PersistentVolumeClaim) Describe

func (pvc *PersistentVolumeClaim) Describe() error

Describe will describe a pv resource

func (*PersistentVolumeClaim) WaitOnReady

func (pvc *PersistentVolumeClaim) WaitOnReady(namespace string, sleep, timeout time.Duration) (bool, error)

WaitOnReady will block until PersistentVolumeClaim is available

type Spec

type Spec struct {
	StorageClassName string `json:"storageClassName"`
	VolumeName       string `json:"volumeName"`
}

Spec holds information like storageClassName, volumeName

type Status

type Status struct {
	Phase string `json:"phase"`
}

Status holds information like phase