1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
|
package network
import (
"net/http"
"github.com/docker/go-plugins-helpers/sdk"
)
const (
manifest = `{"Implements": ["NetworkDriver"]}`
// LocalScope is the correct scope response for a local scope driver
LocalScope = `local`
// GlobalScope is the correct scope response for a global scope driver
GlobalScope = `global`
capabilitiesPath = "/NetworkDriver.GetCapabilities"
allocateNetworkPath = "/NetworkDriver.AllocateNetwork"
freeNetworkPath = "/NetworkDriver.FreeNetwork"
createNetworkPath = "/NetworkDriver.CreateNetwork"
deleteNetworkPath = "/NetworkDriver.DeleteNetwork"
createEndpointPath = "/NetworkDriver.CreateEndpoint"
endpointInfoPath = "/NetworkDriver.EndpointOperInfo"
deleteEndpointPath = "/NetworkDriver.DeleteEndpoint"
joinPath = "/NetworkDriver.Join"
leavePath = "/NetworkDriver.Leave"
discoverNewPath = "/NetworkDriver.DiscoverNew"
discoverDeletePath = "/NetworkDriver.DiscoverDelete"
programExtConnPath = "/NetworkDriver.ProgramExternalConnectivity"
revokeExtConnPath = "/NetworkDriver.RevokeExternalConnectivity"
)
// Driver represent the interface a driver must fulfill.
type Driver interface {
GetCapabilities() (*CapabilitiesResponse, error)
CreateNetwork(*CreateNetworkRequest) error
AllocateNetwork(*AllocateNetworkRequest) (*AllocateNetworkResponse, error)
DeleteNetwork(*DeleteNetworkRequest) error
FreeNetwork(*FreeNetworkRequest) error
CreateEndpoint(*CreateEndpointRequest) (*CreateEndpointResponse, error)
DeleteEndpoint(*DeleteEndpointRequest) error
EndpointInfo(*InfoRequest) (*InfoResponse, error)
Join(*JoinRequest) (*JoinResponse, error)
Leave(*LeaveRequest) error
DiscoverNew(*DiscoveryNotification) error
DiscoverDelete(*DiscoveryNotification) error
ProgramExternalConnectivity(*ProgramExternalConnectivityRequest) error
RevokeExternalConnectivity(*RevokeExternalConnectivityRequest) error
}
// CapabilitiesResponse returns whether or not this network is global or local
type CapabilitiesResponse struct {
Scope string
ConnectivityScope string
}
// AllocateNetworkRequest requests allocation of new network by manager
type AllocateNetworkRequest struct {
// A network ID that remote plugins are expected to store for future
// reference.
NetworkID string
// A free form map->object interface for communication of options.
Options map[string]string
// IPAMData contains the address pool information for this network
IPv4Data, IPv6Data []IPAMData
}
// AllocateNetworkResponse is the response to the AllocateNetworkRequest.
type AllocateNetworkResponse struct {
// A free form plugin specific string->string object to be sent in
// CreateNetworkRequest call in the libnetwork agents
Options map[string]string
}
// FreeNetworkRequest is the request to free allocated network in the manager
type FreeNetworkRequest struct {
// The ID of the network to be freed.
NetworkID string
}
// CreateNetworkRequest is sent by the daemon when a network needs to be created
type CreateNetworkRequest struct {
NetworkID string
Options map[string]interface{}
IPv4Data []*IPAMData
IPv6Data []*IPAMData
}
// IPAMData contains IPv4 or IPv6 addressing information
type IPAMData struct {
AddressSpace string
Pool string
Gateway string
AuxAddresses map[string]interface{}
}
// DeleteNetworkRequest is sent by the daemon when a network needs to be removed
type DeleteNetworkRequest struct {
NetworkID string
}
// CreateEndpointRequest is sent by the daemon when an endpoint should be created
type CreateEndpointRequest struct {
NetworkID string
EndpointID string
Interface *EndpointInterface
Options map[string]interface{}
}
// CreateEndpointResponse is sent as a response to a CreateEndpointRequest
type CreateEndpointResponse struct {
Interface *EndpointInterface
}
// EndpointInterface contains endpoint interface information
type EndpointInterface struct {
Address string
AddressIPv6 string
MacAddress string
}
// DeleteEndpointRequest is sent by the daemon when an endpoint needs to be removed
type DeleteEndpointRequest struct {
NetworkID string
EndpointID string
}
// InterfaceName consists of the name of the interface in the global netns and
// the desired prefix to be appended to the interface inside the container netns
type InterfaceName struct {
SrcName string
DstPrefix string
}
// InfoRequest is send by the daemon when querying endpoint information
type InfoRequest struct {
NetworkID string
EndpointID string
}
// InfoResponse is endpoint information sent in response to an InfoRequest
type InfoResponse struct {
Value map[string]string
}
// JoinRequest is sent by the Daemon when an endpoint needs be joined to a network
type JoinRequest struct {
NetworkID string
EndpointID string
SandboxKey string
Options map[string]interface{}
}
// StaticRoute contains static route information
type StaticRoute struct {
Destination string
RouteType int
NextHop string
}
// JoinResponse is sent in response to a JoinRequest
type JoinResponse struct {
InterfaceName InterfaceName
Gateway string
GatewayIPv6 string
StaticRoutes []*StaticRoute
DisableGatewayService bool
}
// LeaveRequest is send by the daemon when a endpoint is leaving a network
type LeaveRequest struct {
NetworkID string
EndpointID string
}
// ErrorResponse is a formatted error message that libnetwork can understand
type ErrorResponse struct {
Err string
}
// DiscoveryNotification is sent by the daemon when a new discovery event occurs
type DiscoveryNotification struct {
DiscoveryType int
DiscoveryData interface{}
}
// ProgramExternalConnectivityRequest specifies the L4 data
// and the endpoint for which programming has to be done
type ProgramExternalConnectivityRequest struct {
NetworkID string
EndpointID string
Options map[string]interface{}
}
// RevokeExternalConnectivityRequest specifies the endpoint
// for which the L4 programming has to be removed
type RevokeExternalConnectivityRequest struct {
NetworkID string
EndpointID string
}
// NewErrorResponse creates an ErrorResponse with the provided message
func NewErrorResponse(msg string) *ErrorResponse {
return &ErrorResponse{Err: msg}
}
// Handler forwards requests and responses between the docker daemon and the plugin.
type Handler struct {
driver Driver
sdk.Handler
}
// NewHandler initializes the request handler with a driver implementation.
func NewHandler(driver Driver) *Handler {
h := &Handler{driver, sdk.NewHandler(manifest)}
h.initMux()
return h
}
func (h *Handler) initMux() {
h.HandleFunc(capabilitiesPath, func(w http.ResponseWriter, r *http.Request) {
res, err := h.driver.GetCapabilities()
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
if res == nil {
sdk.EncodeResponse(w, NewErrorResponse("Network driver must implement GetCapabilities"), true)
return
}
sdk.EncodeResponse(w, res, false)
})
h.HandleFunc(createNetworkPath, func(w http.ResponseWriter, r *http.Request) {
req := &CreateNetworkRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
err = h.driver.CreateNetwork(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, struct{}{}, false)
})
h.HandleFunc(allocateNetworkPath, func(w http.ResponseWriter, r *http.Request) {
req := &AllocateNetworkRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
res, err := h.driver.AllocateNetwork(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, res, false)
})
h.HandleFunc(deleteNetworkPath, func(w http.ResponseWriter, r *http.Request) {
req := &DeleteNetworkRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
err = h.driver.DeleteNetwork(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, struct{}{}, false)
})
h.HandleFunc(freeNetworkPath, func(w http.ResponseWriter, r *http.Request) {
req := &FreeNetworkRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
err = h.driver.FreeNetwork(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, struct{}{}, false)
})
h.HandleFunc(createEndpointPath, func(w http.ResponseWriter, r *http.Request) {
req := &CreateEndpointRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
res, err := h.driver.CreateEndpoint(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, res, false)
})
h.HandleFunc(deleteEndpointPath, func(w http.ResponseWriter, r *http.Request) {
req := &DeleteEndpointRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
err = h.driver.DeleteEndpoint(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, struct{}{}, false)
})
h.HandleFunc(endpointInfoPath, func(w http.ResponseWriter, r *http.Request) {
req := &InfoRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
res, err := h.driver.EndpointInfo(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, res, false)
})
h.HandleFunc(joinPath, func(w http.ResponseWriter, r *http.Request) {
req := &JoinRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
res, err := h.driver.Join(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, res, false)
})
h.HandleFunc(leavePath, func(w http.ResponseWriter, r *http.Request) {
req := &LeaveRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
err = h.driver.Leave(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, struct{}{}, false)
})
h.HandleFunc(discoverNewPath, func(w http.ResponseWriter, r *http.Request) {
req := &DiscoveryNotification{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
err = h.driver.DiscoverNew(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, struct{}{}, false)
})
h.HandleFunc(discoverDeletePath, func(w http.ResponseWriter, r *http.Request) {
req := &DiscoveryNotification{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
err = h.driver.DiscoverDelete(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, struct{}{}, false)
})
h.HandleFunc(programExtConnPath, func(w http.ResponseWriter, r *http.Request) {
req := &ProgramExternalConnectivityRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
err = h.driver.ProgramExternalConnectivity(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, struct{}{}, false)
})
h.HandleFunc(revokeExtConnPath, func(w http.ResponseWriter, r *http.Request) {
req := &RevokeExternalConnectivityRequest{}
err := sdk.DecodeRequest(w, r, req)
if err != nil {
return
}
err = h.driver.RevokeExternalConnectivity(req)
if err != nil {
sdk.EncodeResponse(w, NewErrorResponse(err.Error()), true)
return
}
sdk.EncodeResponse(w, struct{}{}, false)
})
}
|