storage

Documentation

Index

• func Delete(client *occlient.Client, name string, applicationName string) (string, error)
• func Exists(client *occlient.Client, storageName string, applicationName string) (bool, error)
• func GetComponentNameFromStorageName(client *occlient.Client, storageName string) (string, error)
• func GetMountPath(client *occlient.Client, storageName string, componentName string, ...) string
• func GetStorageNameFromMountPath(client *occlient.Client, path string, componentName string, ...) (string, error)
• func IsMounted(client *occlient.Client, storageName string, componentName string, ...) (bool, error)
• func Mount(client *occlient.Client, path string, storageName string, componentName string, ...) error
• func Unmount(client *occlient.Client, storageName string, componentName string, ...) error
• type Storage
  • func Create(client *occlient.Client, name string, size string, path string, ...) (Storage, error)
• type StorageList
  • func List(client *occlient.Client, componentName string, applicationName string) (StorageList, error)
  • func ListMounted(client *occlient.Client, componentName string, applicationName string) (StorageList, error)
  • func ListUnmounted(client *occlient.Client, applicationName string) (StorageList, error)
  • func (storages StorageList) Get(storageName string) Storage
• type StorageSpec
• type StorageStatus

Functions

func Delete

func Delete(client *occlient.Client, name string, applicationName string) (string, error)

Delete removes storage from the given application. Delete returns the component name, if it is mounted to a component, or "" and the error, if any

func Exists

func Exists(client *occlient.Client, storageName string, applicationName string) (bool, error)

Exists checks if the given storage exists in the given application

func GetComponentNameFromStorageName

func GetComponentNameFromStorageName(client *occlient.Client, storageName string) (string, error)

GetComponentNameFromStorageName returns the component name associated with the storageName, if any, or ""

func GetMountPath

func GetMountPath(client *occlient.Client, storageName string, componentName string, applicationName string) string

GetMountPath returns mount path for given storage

func GetStorageNameFromMountPath

func GetStorageNameFromMountPath(client *occlient.Client, path string, componentName string, applicationName string) (string, error)

Gets the storageName mounted to the given path in the given component and application GetStorageNameFromMountPath returns the name of the storage or the error

func IsMounted

func IsMounted(client *occlient.Client, storageName string, componentName string, applicationName string) (bool, error)

IsMounted checks if the given storage is mounted to the given component IsMounted returns a bool indicating the storage is mounted to the component or not

func Mount

func Mount(client *occlient.Client, path string, storageName string, componentName string, applicationName string) error

Mount mounts the given storage to the given component

func Unmount

func Unmount(client *occlient.Client, storageName string, componentName string, applicationName string, updateLabels bool) error

Unmount unmounts the given storage from the given component updateLabels is a flag to whether update Label or not, so updation of label is not required in delete call but required in unmount call this is introduced as causing unnecessary delays

Types

type Storage

type Storage struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              StorageSpec   `json:"spec,omitempty"`
	Status            StorageStatus `json:"status,omitempty"`
}

Storage

func Create

func Create(client *occlient.Client, name string, size string, path string, componentName string, applicationName string) (Storage, error)

Create adds storage to given component of given application

type StorageList

type StorageList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Storage `json:"items"`
}

StorageList is a list of storages

func List

func List(client *occlient.Client, componentName string, applicationName string) (StorageList, error)

List lists all the mounted storage associated with the given component of the given application and the unmounted storages in the given application

func ListMounted

func ListMounted(client *occlient.Client, componentName string, applicationName string) (StorageList, error)

ListMounted lists all the mounted storage associated with the given component and application

func ListUnmounted

func ListUnmounted(client *occlient.Client, applicationName string) (StorageList, error)

ListUnmounted lists all the unmounted storage associated with the given application

func (StorageList) Get

func (storages StorageList) Get(storageName string) Storage

Get returns Storage defination for given Storage name

type StorageSpec

type StorageSpec struct {
	Size string `json:"size,omitempty"`
}

StorageSpec indicates size and path of storage

type StorageStatus

type StorageStatus struct {
	// if path is empty, it indicates that the storage is not mounted in any component
	Path string `json:"path,omitempty"`
}

StorageStatus is status of storage