options

Documentation

Index

• Constants
• func IsBoolOptionSet(options map[string]string, key string) bool
• func NewVolumeAttachOptions(options map[string]string) *api.SdkVolumeAttachOptions
• func NewVolumeUnmountOptions(options map[string]string) *api.SdkVolumeUnmountOptions

Constants

const (
	// OptionsSecret is an option provided to the following Openstorage Volume API
	// - Attach
	// It indicates the name of the secret stored in a secret store
	// SECRET_NAME in case of hashicorp's Vault will be the key from the key-value pair stored in its kv backend.
	// SECRET_NAME for Kubernetes secret, it is the name of the secret object itself
	OptionsSecret = "SECRET_NAME"
	// OptionsSecretKey is an option provided to the following Openstorage Volume API
	// - Attach
	// SECRET_KEY in case of kubernetes will be the key stored in the kubernetes secret with name SECRET_NAME
	OptionsSecretKey = "SECRET_KEY"
	// OptionsSecretContext is an option provided to the following Openstorage Volume API
	// - Attach
	// It indicates the additional context which could be used to retrieve the secret
	// SECRET_CONTEXT in case of kubernetes secret is the namespace in which the secret is created
	OptionsSecretContext = "SECRET_CONTEXT"
	// OptionsUnmountBeforeDetach is an option provided to the following Openstorage Volume API
	// - Detach
	// It indicates the Volume Driver to issue an Unmount before trying the detach operation
	OptionsUnmountBeforeDetach = "UNMOUNT_BEFORE_DETACH"
	// OptionsDeleteAfterUnmount is an option provided to the following Openstorage Volume API
	// - Unmount
	// It indicates the Volume Driver to delete the mount path after a successful Unmount
	OptionsDeleteAfterUnmount = "DELETE_AFTER_UNMOUNT"
	// OptionsWaitBeforeDelete is an option provided to the following Openstorage Volume API
	// - Unmount
	// This option is used in conjunction with OptionsDeleteAfterUnmount.
	// It indicates the Volume Driver to introduce a delay before deleting mount path
	OptionsWaitBeforeDelete = "WAIT_BEFORE_DELETE"
	// OptionsRedirectDetach is an option provided to the following Openstorage Volume API
	// - Detach
	// It indicates the Volume Driver to redirect detach to the node where volume is attached
	OptionsRedirectDetach = "REDIRECT_DETACH"
	// OptionsDetachDuringDelete is an option provided to the following Openstorage Volume API
	// - Detach
	// It indicates the Volume Driver that a Detach is being issued as a part of a Delete request
	OptionsDetachDuringDelete = "DETACH_DURING_DELETE"
	// OptionsDeviceFuseMount is an option provided to the following Openstorage Volume APIs
	// - Mount
	// - Unmount
	// It is used for volume types which use FUSE mounts.
	// It provides the Volume Driver with the underlying name of fuse mount device
	OptionsDeviceFuseMount = "DEV_FUSE_MOUNT"
	// OptionsForceDetach is an option provided to the following Openstorage Volume API
	// - Detach
	// It indicates the Volume Driver to forcefully detach device from kernel
	OptionsForceDetach = "FORCE_DETACH"
	// OptionsAccessMode is an option provided to the following Openstorage Volume API
	// - Mount
	// It indicates the mode in which volume must be mounted
	OptionsAccessMode = "ACCESS_MODE"
	// OptionsFastpath is an option to control IO path
	// - Attach
	// It indicates which IO path to use to complete user IO
	OptionsFastpath = "FASTPATH_STATE"
)

Options specifies keys from a key-value pair that can be passed in to the APIS

Functions

func IsBoolOptionSet

func IsBoolOptionSet(options map[string]string, key string) bool

IsBoolOptionSet checks if a boolean option key is set

func NewVolumeAttachOptions

func NewVolumeAttachOptions(options map[string]string) *api.SdkVolumeAttachOptions

NewVolumeAttachOptions converts a map of options to api.SdkVolumeAttachOptions

func NewVolumeUnmountOptions

func NewVolumeUnmountOptions(options map[string]string) *api.SdkVolumeUnmountOptions

NewVolumeUnmountOptions converts a map of options to api.SdkVolumeUnmounOptions