persistentvolume

Documentation

Index

• func AreAllReady(pvCount int) bool
• func DescribePVs()
• func WaitOnReady(pvCount int, sleep, timeout time.Duration) bool
• type List
  • func Get() (*List, error)
• type Metadata
• type NodeAffinity
• type NodeSelector
• type NodeSelectorRequirement
• type NodeSelectorTerm
• type PersistentVolume
  • func (pv *PersistentVolume) Describe() error
• type Spec
• type Status

Functions

func AreAllReady

func AreAllReady(pvCount int) bool

AreAllReady returns a bool depending on cluster state

func DescribePVs

func DescribePVs()

DescribePVs describes all persistent volume resources

func WaitOnReady

func WaitOnReady(pvCount int, sleep, timeout time.Duration) bool

WaitOnReady will block until all pvs are in ready state

Types

type List

type List struct {
	PersistentVolumes []PersistentVolume `json:"items"`
}

List is used to parse out PersistentVolume from a list

func Get

func Get() (*List, error)

Get returns the current pvs for a given kubeconfig

type Metadata

type Metadata struct {
	CreatedAt time.Time         `json:"creationTimestamp"`
	Labels    map[string]string `json:"labels"`
	Name      string            `json:"name"`
}

Metadata holds information like name, create time, and namespace

type NodeAffinity

type NodeAffinity struct {
	Required *NodeSelector `json:"required"`
}

NodeAffinity holds information like required nodeselector

type NodeSelector

type NodeSelector struct {
	//Required. A list of node selector terms. The terms are ORed.
	NodeSelectorTerms []NodeSelectorTerm `json:"nodeSelectorTerms"`
}

NodeSelector represents the union of the results of one or more label queries

type NodeSelectorRequirement

type NodeSelectorRequirement struct {
	Key    string   `json:"key"`
	Values []string `json:"values,omitempty"`
}

NodeSelectorRequirement is a selector that contains values, a key, and an operator

type NodeSelectorTerm

type NodeSelectorTerm struct {
	MatchExpressions []NodeSelectorRequirement `json:"matchExpressions,omitempty"`
	MatchFields      []NodeSelectorRequirement `json:"matchFields,omitempty"`
}

NodeSelectorTerm represents node selector requirements

type PersistentVolume

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

PersistentVolume is used to parse data from kubectl get pv

func (*PersistentVolume) Describe

func (pv *PersistentVolume) Describe() error

Describe will describe a pv resource

type Spec

type Spec struct {
	StorageClassName string       `json:"storageClassName"`
	NodeAffinity     NodeAffinity `json:"nodeAffinity"`
}

Spec holds information like storageClassName, nodeAffinity

type Status

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

Status holds information like phase