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 ¶
View Source
const ( SpectrumScale string = "spectrum-scale" SpectrumScaleNFS string = "spectrum-scale-nfs" SoftlayerNFS string = "softlayer-nfs" SCBE string = "scbe" LocalHost string = "localhost" )
View Source
const DefaultForScbeConfigParamDefaultFilesystem = "ext4" // if customer don't mention fstype, then the default is ext4
View Source
const DefaultForScbeConfigParamDefaultVolumeSize = "1" // if customer don't mention size, then the default is 1gb
View Source
const OptionNameForVolumeFsType = "fstype" // the option name of the fstype and also the key in the volumeConfig
View Source
const PathToMountUbiquityBlockDevices = "/ubiquity/%s" // %s is the WWN of the volume # TODO this should be moved to docker plugin side
View Source
const UbiquityInstanceNameMaxSize = 15
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ActivateRequest ¶
type ActivateResponse ¶
type ActivateResponse struct {
Error error
}
type AfterDetachRequest ¶
type AfterDetachRequest struct {
VolumeConfig map[string]interface{}
}
type AfterDetachResponse ¶ added in v0.4.1
type AfterDetachResponse struct {
Error error
}
type AttachRequest ¶
type AttachResponse ¶
type BrokerConfig ¶
type ConnectionInfo ¶
type ConnectionInfo struct { CredentialInfo CredentialInfo Port int ManagementIP string SkipVerifySSL bool }
type CreateVolumeRequest ¶
type CreateVolumeResponse ¶ added in v0.4.1
type CredentialInfo ¶
type DetachRequest ¶
type DetachResponse ¶ added in v0.4.1
type DetachResponse struct {
Error error
}
type DockerGetResponse ¶
type GenericRequest ¶
type GenericRequest struct {
Name string
}
type GenericResponse ¶
type GenericResponse struct {
Err string
}
type GetConfigResponse ¶
type GetVolumeConfigRequest ¶
type GetVolumeConfigRequest struct {
Name string
}
type GetVolumeConfigResponse ¶ added in v0.4.1
type GetVolumeRequest ¶
type GetVolumeRequest struct {
Name string
}
type GetVolumeResponse ¶ added in v0.4.1
type ListResponse ¶
type ListVolumesRequest ¶
type ListVolumesRequest struct { //TODO add filter Backends []string }
type ListVolumesResponse ¶ added in v0.4.1
type LocalHostConfig ¶ added in v0.4.1
type LocalHostConfig struct {
LocalhostPath string
}
type MountRequest ¶
type MountResponse ¶
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 ¶ added in v0.4.1
type RemoveVolumeResponse struct {
Error error
}
type RestConfig ¶
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 ¶ added in v0.4.0
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 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 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 UnmountRequest ¶
type UnmountRequest struct {
VolumeConfig map[string]interface{}
}
type UnmountResponse ¶ added in v0.4.1
type UnmountResponse struct {
Error error
}
Click to show internal directories.
Click to hide internal directories.