storageclass

Documentation

Index

• type GetResult
  • func GetAsync(scName string) GetResult
• type Metadata
• type Parameters
• type StorageClass
  • func CreateStorageClassFromFile(filename, name string) (*StorageClass, error)
  • func Get(scName string) (*StorageClass, error)
  • func (sc *StorageClass) Describe() error
  • func (sc *StorageClass) WaitOnReady(sleep, timeout time.Duration) (bool, error)

Types

type GetResult

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

GetResult is a return struct for GetAsync

func GetAsync

func GetAsync(scName string) GetResult

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

type Metadata

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

Metadata holds information like name, create time

type Parameters

type Parameters struct {
	SkuName string `json:"skuName"`
}

Parameters holds information like skuName

type StorageClass

type StorageClass struct {
	Metadata   Metadata   `json:"metadata"`
	Parameters Parameters `json:"parameters"`
}

StorageClass is used to parse data from kubectl get storageclass

func CreateStorageClassFromFile

func CreateStorageClassFromFile(filename, name string) (*StorageClass, error)

CreateStorageClassFromFile will create a StorageClass from file with a name

func Get

func Get(scName string) (*StorageClass, error)

Get will return a StorageClass with a given name and namespace

func (*StorageClass) Describe

func (sc *StorageClass) Describe() error

Describe will describe a storageclass resource

func (*StorageClass) WaitOnReady

func (sc *StorageClass) WaitOnReady(sleep, timeout time.Duration) (bool, error)

WaitOnReady will block until StorageClass is available