Categorygithub.com/stffabi/go-plugins-helpersvolume
package
0.0.0-20170102144606-65a562254f78
Repository: https://github.com/stffabi/go-plugins-helpers.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
2
Dependents
0
Files
134 SLOC

# README

Docker volume extension api.

Go handler to create external volume extensions for Docker.

Usage

This library is designed to be integrated in your program.

  1. Implement the volume.Driver interface.
  2. Initialize a volume.Handler with your implementation.
  3. Call either ServeTCP or ServeUnix from the volume.Handler.

Example using TCP sockets:

  d := MyVolumeDriver{}
  h := volume.NewHandler(d)
  h.ServeTCP("test_volume", ":8080")

Example using Unix sockets:

  d := MyVolumeDriver{}
  h := volume.NewHandler(d)
  h.ServeUnix("root", "test_volume")

Full example plugins

# Packages

No description provided by the author

# Functions

NewHandler initializes the request handler with a driver implementation.

# Constants

DefaultDockerRootDirectory is the default directory where volumes will be created.

# Structs

Capability represents the list of capabilities a volume driver can return.
Handler forwards requests and responses between the docker daemon and the plugin.
MountRequest structure for a volume mount request.
Request is the structure that docker's requests are deserialized to.
Response is the strucutre that the plugin's responses are serialized to.
UnmountRequest structure for a volume unmount request.
Volume represents a volume object for use with `Get` and `List` requests.

# Interfaces

Driver represent the interface a driver must fulfill.