persistentvolumeclaims

Documentation

Index

• func Describe(pvcName, namespace string) error
• func WaitOnDeleted(pvcPrefix, namespace string, sleep, duration time.Duration) (bool, error)
• 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) WaitOnReady(namespace string, sleep, duration time.Duration) (bool, error)
• type Spec
• type Status

Functions

func Describe

func Describe(pvcName, namespace string) error

Describe gets the description for the given pvc and namespace.

func WaitOnDeleted

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

WaitOnDeleted returns when a pvc is successfully deleted

Types

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 jobs 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) WaitOnReady

func (pvc *PersistentVolumeClaim) WaitOnReady(namespace string, sleep, duration 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