service

Documentation

Index

• Constants
• type Service
  • func New() Service

Constants

const (
	// EnvVarBindFS is the name of the environment variable
	// used to obtain the path to the `bindfs` binary -- a
	// program used to provide bind mounting via FUSE on
	// operating systems that do not natively support bind
	// mounts.
	//
	// If no value is specified and `bindfs` is required, ex.
	// darwin, then `bindfs` is looked up via the path.
	EnvVarBindFS = "X_CSI_VFS_BINDFS"

	// EnvVarDataDir is the name of the environment variable
	// used to obtain the path to the VFS plug-in's data directory.
	//
	// If not specified, the directory defaults to `$HOME/.csi-vfs`.
	EnvVarDataDir = "X_CSI_VFS_DATA"

	// EnvVarDevDir is the name of the environment variable
	// used to obtain the path to the VFS plug-in's `dev` directory.
	//
	// If not specified, the directory defaults to `$X_CSI_VFS_DATA/dev`.
	EnvVarDevDir = "X_CSI_VFS_DEV"

	// EnvVarMntDir is the name of the environment variable
	// used to obtain the path to the VFS plug-in's `mnt` directory.
	//
	// If not specified, the directory defaults to `$X_CSI_VFS_DATA/mnt`.
	EnvVarMntDir = "X_CSI_VFS_MNT"

	// EnvVarVolDir is the name of the environment variable
	// used to obtain the path to the VFS plug-in's `vol` directory.
	//
	// If not specified, the directory defaults to `$X_CSI_VFS_DATA/vol`.
	EnvVarVolDir = "X_CSI_VFS_VOL"

	// EnvVarVolGlob is the name of the environment variable
	// used to obtain the glob pattern used to list the files inside
	// the $X_CSI_VFS_VOL directory. Matching files are considered
	// volumes.
	//
	// If not specified, the glob pattern defaults to `*`.
	//
	// Valid patterns are documented at
	// https://golang.org/pkg/path/filepath/#Match.
	EnvVarVolGlob = "X_CSI_VFS_VOL_GLOB"
)

const (
	// Name is the name of this CSI SP.
	Name = "com.rexray.vfs"

	// VendorVersion is the version of this CSP SP.
	VendorVersion = "0.2.1"

	// SupportedVersions is a list of the CSI versions this SP supports.
	SupportedVersions = "0.0.0, 0.1.0"
)

Types

type Service

type Service interface {
	csi.ControllerServer
	csi.IdentityServer
	csi.NodeServer
	BeforeServe(context.Context, *gocsi.StoragePlugin, net.Listener) error
}

Service is a CSI SP and gocsi.IdempotencyProvider.

func New

func New() Service

New returns a new Service.