resources

Documentation

Index

• Constants
• type ActivateRequest
• type ActivateResponse
• type AfterDetachRequest
• type AfterDetachResponse
• type AttachRequest
• type AttachResponse
• type BrokerConfig
• type ConnectionInfo
• type CreateVolumeRequest
• type CreateVolumeResponse
• type CredentialInfo
• type DetachRequest
• type DetachResponse
• type DockerGetResponse
• type GenericRequest
• type GenericResponse
• type GetConfigResponse
• type GetVolumeConfigRequest
• type GetVolumeConfigResponse
• type GetVolumeRequest
• type GetVolumeResponse
• type ListResponse
• type ListVolumesRequest
• type ListVolumesResponse
• type LocalHostConfig
• type MountRequest
• type MountResponse
• type Mounter
• type RemoveVolumeRequest
• type RemoveVolumeResponse
• type RestConfig
• type ScbeConfig
• type ScbeRemoteConfig
• type SpectrumNfsRemoteConfig
• type SpectrumScaleConfig
• type SshConfig
• type StorageClient
• type UbiquityDockerPluginConfig
• type UbiquityPluginConfig
• type UbiquityServerConfig
• type UbiquityServerConnectionInfo
• type UnmountRequest
• type UnmountResponse
• type Volume

Constants

const (
	SpectrumScale    string = "spectrum-scale"
	SpectrumScaleNFS string = "spectrum-scale-nfs"
	SoftlayerNFS     string = "softlayer-nfs"
	SCBE             string = "scbe"
	LocalHost        string = "localhost"
)

const DefaultForScbeConfigParamDefaultFilesystem = "ext4" // if customer don't mention fstype, then the default is ext4

const DefaultForScbeConfigParamDefaultVolumeSize = "1" // if customer don't mention size, then the default is 1gb

const OptionNameForVolumeFsType = "fstype" // the option name of the fstype and also the key in the volumeConfig

const PathToMountUbiquityBlockDevices = "/ubiquity/%s" // %s is the WWN of the volume # TODO this should be moved to docker plugin side

const UbiquityInstanceNameMaxSize = 15

Types

type ActivateRequest

type ActivateRequest struct {
	Backends []string
	Opts     map[string]string
}

type ActivateResponse

type ActivateResponse struct {
	Error error
}

type AfterDetachRequest

type AfterDetachRequest struct {
	VolumeConfig map[string]interface{}
}

type AfterDetachResponse

type AfterDetachResponse struct {
	Error error
}

type AttachRequest

type AttachRequest struct {
	Name string
	Host string
}

type AttachResponse

type AttachResponse struct {
	Mountpoint string
	Error      error
}

type BrokerConfig

type BrokerConfig struct {
	ConfigPath string
	Port       int //for CF Service broker
}

type ConnectionInfo

type ConnectionInfo struct {
	CredentialInfo CredentialInfo
	Port           int
	ManagementIP   string
	SkipVerifySSL  bool
}

type CreateVolumeRequest

type CreateVolumeRequest struct {
	Name          string
	Backend       string
	CapacityBytes uint64
	Metadata      map[string]string
}

type CreateVolumeResponse

type CreateVolumeResponse struct {
	Volume Volume
	Error  error
}

type CredentialInfo

type CredentialInfo struct {
	UserName string `json:"username"`
	Password string `json:"password"`
	Group    string `json:"group"`
}

type DetachRequest

type DetachRequest struct {
	Name string
	Host string
}

type DetachResponse

type DetachResponse struct {
	Error error
}

type DockerGetResponse

type DockerGetResponse struct {
	Volume map[string]interface{}
	Err    string
}

type GenericRequest

type GenericRequest struct {
	Name string
}

type GenericResponse

type GenericResponse struct {
	Err string
}

type GetConfigResponse

type GetConfigResponse struct {
	VolumeConfig map[string]interface{}
	Err          string
}

type GetVolumeConfigRequest

type GetVolumeConfigRequest struct {
	Name string
}

type GetVolumeConfigResponse

type GetVolumeConfigResponse struct {
	VolumeConfig map[string]interface{}
	Error        error
}

type GetVolumeRequest

type GetVolumeRequest struct {
	Name string
}

type GetVolumeResponse

type GetVolumeResponse struct {
	Volume Volume
	Error  error
}

type ListResponse

type ListResponse struct {
	Volumes []Volume
	Err     string
}

type ListVolumesRequest

type ListVolumesRequest struct {
	//TODO add filter
	Backends []string
}

type ListVolumesResponse

type ListVolumesResponse struct {
	Volumes []Volume
	Error   error
}

type LocalHostConfig

type LocalHostConfig struct {
	LocalhostPath string
}

type MountRequest

type MountRequest struct {
	Mountpoint   string
	VolumeConfig map[string]interface{}
}

type MountResponse

type MountResponse struct {
	Mountpoint string
	Error      error
}

type Mounter

type Mounter interface {
	Mount(mountRequest MountRequest) MountResponse
	Unmount(unmountRequest UnmountRequest) UnmountResponse
	ActionAfterDetach(request AfterDetachRequest) AfterDetachResponse
}

type RemoveVolumeRequest

type RemoveVolumeRequest struct {
	Name string
}

type RemoveVolumeResponse

type RemoveVolumeResponse struct {
	Error error
}

type RestConfig

type RestConfig struct {
	Endpoint string
	User     string
	Password string
	Hostname string
}

type ScbeConfig

type ScbeConfig struct {
	ConfigPath           string // TODO consider to remove later
	ConnectionInfo       ConnectionInfo
	DefaultService       string // SCBE storage service to be used by default if not mentioned by plugin
	DefaultVolumeSize    string // The default volume size in case not specified by user
	UbiquityInstanceName string // Prefix for the volume name in the storage side (max length 15 char)

	DefaultFilesystemType string // The default filesystem type to create on new provisioned volume during attachment to the host
}

type ScbeRemoteConfig

type ScbeRemoteConfig struct {
	SkipRescanISCSI bool
}

type SpectrumNfsRemoteConfig

type SpectrumNfsRemoteConfig struct {
	ClientConfig string
}

type SpectrumScaleConfig

type SpectrumScaleConfig struct {
	DefaultFilesystemName string
	NfsServerAddr         string
	SshConfig             SshConfig
	RestConfig            RestConfig
	ForceDelete           bool
}

TODO we should consider to move dedicated backend structs to the backend resource file instead of this one.

type SshConfig

type SshConfig struct {
	User string
	Host string
	Port string
}

type StorageClient

type StorageClient interface {
	Activate(activateRequest ActivateRequest) ActivateResponse
	CreateVolume(createVolumeRequest CreateVolumeRequest) CreateVolumeResponse
	RemoveVolume(removeVolumeRequest RemoveVolumeRequest) RemoveVolumeResponse
	ListVolumes(listVolumeRequest ListVolumesRequest) ListVolumesResponse
	GetVolume(getVolumeRequest GetVolumeRequest) GetVolumeResponse
	GetVolumeConfig(getVolumeConfigRequest GetVolumeConfigRequest) GetVolumeConfigResponse
	Attach(attachRequest AttachRequest) AttachResponse
	Detach(detachRequest DetachRequest) DetachResponse
}

type UbiquityDockerPluginConfig

type UbiquityDockerPluginConfig struct {
	//Address          string
	Port             int
	PluginsDirectory string
}

type UbiquityPluginConfig

type UbiquityPluginConfig struct {
	DockerPlugin            UbiquityDockerPluginConfig
	LogPath                 string
	UbiquityServer          UbiquityServerConnectionInfo
	SpectrumNfsRemoteConfig SpectrumNfsRemoteConfig
	ScbeRemoteConfig        ScbeRemoteConfig
	LocalHostConfig         LocalHostConfig
	Backends                []string
	LogLevel                string
}

type UbiquityServerConfig

type UbiquityServerConfig struct {
	Port                int
	LogPath             string
	ConfigPath          string
	SpectrumScaleConfig SpectrumScaleConfig
	ScbeConfig          ScbeConfig
	LocalHostConfig     LocalHostConfig
	BrokerConfig        BrokerConfig
	DefaultBackend      string
	LogLevel            string
}

type UbiquityServerConnectionInfo

type UbiquityServerConnectionInfo struct {
	Address string
	Port    int
}

type UnmountRequest

type UnmountRequest struct {
	VolumeConfig map[string]interface{}
}

type UnmountResponse

type UnmountResponse struct {
	Error error
}

type Volume

type Volume struct {
	gorm.Model
	Name          string
	CapacityBytes uint64
	Metadata      map[string]string
	Backend       string
	Mountpoint    string
}