storage

Documentation

Overview

Package storage provides an API server facade for managing storage entities.

Index

• type API
  • func NewAPI(st *state.State, resources *common.Resources, authorizer common.Authorizer) (*API, error)
  • func (a *API) AddToUnit(args params.StoragesAddParams) (params.ErrorResults, error)
  • func (a *API) CreatePool(p params.StoragePool) error
  • func (api *API) List() (params.StorageDetailsResults, error)
  • func (a *API) ListFilesystems(filter params.FilesystemFilter) (params.FilesystemDetailsResults, error)
  • func (a *API) ListPools(filter params.StoragePoolFilter) (params.StoragePoolsResult, error)
  • func (a *API) ListVolumes(filter params.VolumeFilter) (params.VolumeDetailsResults, error)
  • func (api *API) Show(entities params.Entities) (params.StorageDetailsResults, error)

Types

type API

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

API implements the storage interface and is the concrete implementation of the api end point.

func NewAPI

func NewAPI(
	st *state.State,
	resources *common.Resources,
	authorizer common.Authorizer,
) (*API, error)

NewAPI returns a new storage API facade.

func (*API) AddToUnit

func (a *API) AddToUnit(args params.StoragesAddParams) (params.ErrorResults, error)

AddToUnit validates and creates additional storage instances for units. This method handles bulk add operations and a failure on one individual storage instance does not block remaining instances from being processed. A "CHANGE" block can block this operation.

func (*API) CreatePool

func (a *API) CreatePool(p params.StoragePool) error

CreatePool creates a new pool with specified parameters.

func (*API) List

func (api *API) List() (params.StorageDetailsResults, error)

List returns all currently known storage. Unlike Show(), if errors encountered while retrieving a particular storage, this error is treated as part of the returned storage detail.

func (*API) ListFilesystems

func (a *API) ListFilesystems(filter params.FilesystemFilter) (params.FilesystemDetailsResults, error)

ListFilesystems returns a list of filesystems in the environment matching the provided filter. Each result describes a filesystem in detail, including the filesystem's attachments.

func (*API) ListPools

func (a *API) ListPools(
	filter params.StoragePoolFilter,
) (params.StoragePoolsResult, error)

ListPools returns a list of pools. If filter is provided, returned list only contains pools that match the filter. Pools can be filtered on names and provider types. If both names and types are provided as filter, pools that match either are returned. This method lists union of pools and environment provider types. If no filter is provided, all pools are returned.

func (*API) ListVolumes

func (a *API) ListVolumes(filter params.VolumeFilter) (params.VolumeDetailsResults, error)

func (*API) Show

func (api *API) Show(entities params.Entities) (params.StorageDetailsResults, error)

Show retrieves and returns detailed information about desired storage identified by supplied tags. If specified storage cannot be retrieved, individual error is returned instead of storage information.