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 StartGraphAPI(name string, port int, restBase string) error
• func StartPluginAPI(name string, pluginBase string) error
• func StartServerAPI(name string, port int, restBase string) error
• type Route

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 StartGraphAPI

func StartGraphAPI(name string, port int, restBase string) error

StartGraphAPI starts a REST server to receive GraphDriver commands

func StartPluginAPI

func StartPluginAPI(name string, pluginBase string) error

StartPluginAPI starts a REST server to receive volume commands from the Linux container engine.

func StartServerAPI

func StartServerAPI(name string, port int, restBase string) error

StartServerAPI starts a REST server to receive driver configuration commands from the CLI/UX.

Types

type Route

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

Route is a specification and handler for a REST endpoint.