server

README

package apiserver

Package apiserver defines the REST endpoints for volume drivers.

The endpoints defined by the docker volume plugins API is a subset of the exposed REST endpoints.

Documentation

Index

• Constants
• func StartClusterAPI(clusterApiBase string, clusterPort uint16) error
• func StartGraphAPI(name string, restBase string) error
• func StartPluginAPI(name string, mgmtBase string, pluginBase string, mgmtPort uint16, ...) error
• func StartVolumeMgmtAPI(name string, mgmtBase string, mgmtPort uint16) error
• func StartVolumePluginAPI(name string, pluginBase string, pluginPort uint16) error
• type Route
  • func GetClusterAPIRoutes() []*Route
  • func GetVolumeAPIRoutes(name string) []*Route
  • func (r *Route) GetFn() func(http.ResponseWriter, *http.Request)
  • func (r *Route) GetPath() string
  • func (r *Route) GetVerb() string

Constants

const (
	// GraphDriver is the string returned in the handshake protocol.
	GraphDriver = "GraphDriver"
)

const (
	// VolumeDriver is the string returned in the handshake protocol.
	VolumeDriver = "VolumeDriver"
)

Functions

func StartClusterAPI

func StartClusterAPI(clusterApiBase string, clusterPort uint16) error

StartClusterAPI starts a REST server to receive driver configuration commands from the CLI/UX to control the OSD cluster.

func StartGraphAPI

func StartGraphAPI(name string, restBase string) error

StartGraphAPI starts a REST server to receive GraphDriver commands from the Linux container engine.

func StartPluginAPI

func StartPluginAPI(
	name string,
	mgmtBase string,
	pluginBase string,
	mgmtPort uint16,
	pluginPort uint16,
) error

StartPluginAPI starts a REST server to receive volume API commands from the Linux container engine and volume management commands from the CLI/UX.

func StartVolumeMgmtAPI

func StartVolumeMgmtAPI(
	name string,
	mgmtBase string,
	mgmtPort uint16,
) error

StartVolumeMgmtAPI starts a REST server to receive volume management API commands

func StartVolumePluginAPI

func StartVolumePluginAPI(
	name string,
	pluginBase string,
	pluginPort uint16,
) error

StartVolumePluginAPI starts a REST server to receive volume API commands from the linux container engine

Types

type Route

type Route struct {
	// contains filtered or unexported fields
}

Route is a specification and handler for a REST endpoint.

func GetClusterAPIRoutes

func GetClusterAPIRoutes() []*Route

func GetVolumeAPIRoutes

func GetVolumeAPIRoutes(name string) []*Route

func (*Route) GetFn

func (r *Route) GetFn() func(http.ResponseWriter, *http.Request)

func (*Route) GetPath

func (r *Route) GetPath() string

func (*Route) GetVerb

func (r *Route) GetVerb() string