Documentation
¶
Index ¶
Constants ¶
View Source
const ( // StatusSuccess represents the successful completion of command. StatusSuccess = "Success" // StatusNotSupported represents that the command is not supported. StatusNotSupported = "Not supported" )
Variables ¶
View Source
var (
TimeoutError = fmt.Errorf("Timeout")
)
Functions ¶
func NewFlexVolumePlugin ¶ added in v1.7.0
func NewFlexVolumePlugin(pluginDir, name string) (volume.VolumePlugin, error)
func ProbeVolumePlugins ¶
func ProbeVolumePlugins(pluginDir string) []volume.VolumePlugin
This is the primary entrypoint for volume plugins.
Types ¶
type DriverCall ¶ added in v1.6.0
type DriverCall struct {
Command string
Timeout time.Duration
// contains filtered or unexported fields
}
DriverCall implements the basic contract between FlexVolume and its driver. The caller is responsible for providing the required args.
func (*DriverCall) Append ¶ added in v1.6.0
func (dc *DriverCall) Append(arg string)
func (*DriverCall) AppendSpec ¶ added in v1.6.0
func (dc *DriverCall) AppendSpec(spec *volume.Spec, host volume.VolumeHost, extraOptions map[string]string) error
func (*DriverCall) Run ¶ added in v1.6.0
func (dc *DriverCall) Run() (*DriverStatus, error)
type DriverStatus ¶ added in v1.6.0
type DriverStatus struct {
// Status of the callout. One of "Success", "Failure" or "Not supported".
Status string `json:"status"`
// Reason for success/failure.
Message string `json:"message,omitempty"`
// Path to the device attached. This field is valid only for attach calls.
// ie: /dev/sdx
DevicePath string `json:"device,omitempty"`
// Cluster wide unique name of the volume.
VolumeName string `json:"volumeName,omitempty"`
// Represents volume is attached on the node
Attached bool `json:"attached,omitempty"`
// Returns capabilities of the driver.
// By default we assume all the capabilities are supported.
// If the plugin does not support a capability, it can return false for that capability.
Capabilities map[string]bool
}
DriverStatus represents the return value of the driver callout.
type OptionsForDriver ¶ added in v1.6.0
OptionsForDriver represents the spec given to the driver.
func NewOptionsForDriver ¶ added in v1.6.0
func NewOptionsForDriver(spec *volume.Spec, host volume.VolumeHost, extraOptions map[string]string) (OptionsForDriver, error)
Source Files
Click to show internal directories.
Click to hide internal directories.