contracts

Documentation

Index

• type BlockOperator
• type FileSystemOperator
• type ObjectOperator
• type PoolOperator
• type RestAPIOperator
• type Setup

Types

type BlockOperator

type BlockOperator interface {
	BlockCreate(name string, size int) (string, error)
	BlockDelete(name string) (string, error)
	BlockList() ([]model.BlockImage, error)
	BlockMap(name string, mountpath string) (string, error)
	BlockWrite(name string, mountpath string, data string, filename string, namespace string) (string, error)
	BlockRead(name string, mountpath string, filename string, namespace string) (string, error)
	BlockUnmap(name string, mountpath string) (string, error)
}

BlockOperator - interface for rook block operations

type FileSystemOperator

type FileSystemOperator interface {
	FSCreate(name, namespace string, callAPI bool, k8sh *utils.K8sHelper) error
	FSDelete(name string) (string, error)
	FSList() ([]model.Filesystem, error)
	FSMount(name string, mountpath string) (string, error)
	FSWrite(name string, mountpath string, data string, filename string, namespace string) (string, error)
	FSRead(name string, mountpath string, filename string, namespace string) (string, error)
	FSUnmount(mountpath string) (string, error)
}

FileSystemOperator - interface for rook fileSystem operations

type ObjectOperator

type ObjectOperator interface {
	ObjectCreate(namespace, storeName string, replicaCount int32, callAPI bool, k8sh *utils.K8sHelper) error
	ObjectDelete(namespace, storeName string, replicaCount int32, callAPI bool, k8sh *utils.K8sHelper) error
	ObjectBucketList(storeName string) ([]model.ObjectBucket, error)
	ObjectConnection(storeName string) (*model.ObjectStoreConnectInfo, error)
	ObjectCreateUser(storeName, userid string, displayname string) (*model.ObjectUser, error)
	ObjectUpdateUser(storeName, userid string, displayname string, emailid string) (*model.ObjectUser, error)
	ObjectDeleteUser(storeName, userid string) error
	ObjectGetUser(storeName, userid string) (*model.ObjectUser, error)
	ObjectListUser(storeName string) ([]model.ObjectUser, error)
}

ObjectOperator - interface for rook object operations

type PoolOperator

type PoolOperator interface {
	PoolList() ([]model.Pool, error)
	PoolCreate(pool model.Pool) (string, error)
}

PoolOperator - interface for rook pool operations

type RestAPIOperator

type RestAPIOperator interface {
	URL() string
	GetNodes() ([]model.Node, error)
	GetPools() ([]model.Pool, error)
	CreatePool(pool model.Pool) (string, error)
	GetBlockImages() ([]model.BlockImage, error)
	CreateBlockImage(image model.BlockImage) (string, error)
	DeleteBlockImage(image model.BlockImage) (string, error)
	GetClientAccessInfo() (model.ClientAccessInfo, error)
	GetFilesystems() ([]model.Filesystem, error)
	CreateFilesystem(fsmodel model.FilesystemRequest) (string, error)
	DeleteFilesystem(fsmodel model.FilesystemRequest) (string, error)
	GetStatusDetails() (model.StatusDetails, error)
	CreateObjectStore(store model.ObjectStore) (string, error)
	DeleteObjectStore(storeName string) error
	GetObjectStoreConnectionInfo(storeName string) (*model.ObjectStoreConnectInfo, error)
	ListBuckets(storeName string) ([]model.ObjectBucket, error)
	ListObjectUsers(storeName string) ([]model.ObjectUser, error)
	GetObjectUser(storeName, id string) (*model.ObjectUser, error)
	CreateObjectUser(storeName string, user model.ObjectUser) (*model.ObjectUser, error)
	UpdateObjectUser(storeName string, user model.ObjectUser) (*model.ObjectUser, error)
	DeleteObjectUser(storeName, id string) error
}

RestAPIOperator - interface for rook rest API operations

type Setup

type Setup interface {
	SetUp()
	TearDown()
}