/
dockerclient.go
437 lines (397 loc) · 14.4 KB
/
dockerclient.go
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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
/*
###########################################################################
#
# Filename: dockerclient.go
#
# Author: Siva Teja Areti
# Created: June 6, 2017
#
# Description: libnetwork docker client API
#
###########################################################################
#
# Copyright (c) 2017 Nuage Networks
#
###########################################################################
*/
package client
import (
"fmt"
"net"
"os"
"regexp"
"strings"
"time"
log "github.com/Sirupsen/logrus"
"github.com/docker/docker/api/types"
"github.com/docker/docker/api/types/events"
"github.com/docker/docker/api/types/filters"
dockerClient "github.com/docker/docker/client"
nuageApi "github.com/nuagenetworks/nuage-libnetwork/api"
nuageConfig "github.com/nuagenetworks/nuage-libnetwork/config"
"github.com/nuagenetworks/nuage-libnetwork/utils"
"golang.org/x/net/context"
)
//NuageDockerClient structure holds docker client
type NuageDockerClient struct {
socketFile string
dclient *dockerClient.Client
connectionRetry chan bool
connectionActive chan bool
stop chan bool
dockerChannel chan *nuageApi.DockerEvent
vsdChannel chan *nuageApi.VSDEvent
networkParamsTable *utils.HashMap
pluginVersion string
}
//NewNuageDockerClient creates a new docker client
func NewNuageDockerClient(config *nuageConfig.NuageLibNetworkConfig, channels *nuageApi.NuageLibNetworkChannels) (*NuageDockerClient, error) {
var err error
nuagedocker := &NuageDockerClient{}
nuagedocker.stop = channels.Stop
nuagedocker.dockerChannel = channels.DockerChannel
nuagedocker.vsdChannel = channels.VSDChannel
nuagedocker.connectionRetry = make(chan bool)
nuagedocker.connectionActive = make(chan bool)
nuagedocker.networkParamsTable = utils.NewHashMap()
nuagedocker.pluginVersion = config.PluginVersion
nuagedocker.socketFile = config.DockerSocketFile
nuagedocker.dclient, err = connectToDockerDaemon(nuagedocker.socketFile)
if err != nil {
log.Errorf("Connecting to docker client failed with error %v", err)
return nil, err
}
log.Debugf("Finished initializing docker module")
return nuagedocker, nil
}
//GetRunningContainerList fetches the list of running containers from docker
func (nuagedocker *NuageDockerClient) GetRunningContainerList() ([]types.Container, error) {
var activeContainersList []types.Container
var err error
nuagedocker.executeDockerCommand(
func() error {
activeContainersList, err = nuagedocker.dclient.ContainerList(context.Background(), types.ContainerListOptions{})
return err
})
if err != nil {
log.Errorf("Getting list of running containers failed with error: %v", err)
}
log.Debugf("number of containers in docker ps = %d", len(activeContainersList))
return activeContainersList, nil
}
//CheckNetworkList checks if the given params matches existing network params
func (nuagedocker *NuageDockerClient) CheckNetworkList(nuageParams *nuageConfig.NuageNetworkParams) (bool, error) {
networkList, err := nuagedocker.dockerNetworkList()
if err != nil {
log.Errorf("Retrieving existing networks from docker failed with error: %v", err)
return true, err
}
_, newSubnet, err := net.ParseCIDR(nuageParams.SubnetCIDR)
if err != nil {
log.Errorf("ParseCIDR failed for address %s with error: %v", nuageParams.SubnetCIDR, err)
return true, err
}
for _, network := range networkList {
existingNetworkOptions := nuageConfig.ParseNuageParams(network.IPAM.Options)
matchingNetworkOpts := nuageConfig.IsSameNetworkOpts(existingNetworkOptions, nuageParams)
var overlappingSubnets bool
for _, nwConfig := range network.IPAM.Config {
_, existingSubnet, err := net.ParseCIDR(nwConfig.Subnet)
if err != nil {
log.Errorf("ParseCIDR failed for address %s with error: %v", nwConfig.Subnet, err)
return true, err
}
if newSubnet.Contains(existingSubnet.IP) || existingSubnet.Contains(newSubnet.IP) {
overlappingSubnets = true
}
}
if matchingNetworkOpts && overlappingSubnets {
return true, fmt.Errorf("Network options and subnet overlap with existing network")
}
}
return false, nil
}
//GetNetworkOptsFromPoolID fetches network options for a given docker network
func (nuagedocker *NuageDockerClient) GetNetworkOptsFromPoolID(poolID string) (*nuageConfig.NuageNetworkParams, error) {
networkOpts := &nuageConfig.NuageNetworkParams{}
networkList, err := nuagedocker.dockerNetworkList()
if err != nil {
log.Errorf("Retrieving existing networks from docker failed with error: %v", err)
return nil, err
}
for _, network := range networkList {
if network.IPAM.Options == nil || len(network.IPAM.Config) == 0 {
continue
}
networkOpts = nuageConfig.ParseNuageParams(network.IPAM.Options)
networkOpts.SubnetCIDR = network.IPAM.Config[0].Subnet
if poolID == nuageConfig.MD5Hash(networkOpts) {
return networkOpts, nil
}
}
return nil, fmt.Errorf("network options with matching poolID not found")
}
//GetNetworkOptsFromNetworkID fetches a network from docker
func (nuagedocker *NuageDockerClient) GetNetworkOptsFromNetworkID(networkID string) (*nuageConfig.NuageNetworkParams, error) {
var networkInspect types.NetworkResource
var err error
nuagedocker.executeDockerCommand(
func() error {
networkInspect, err = nuagedocker.dclient.NetworkInspect(context.Background(), networkID)
return err
})
if err != nil {
log.Errorf("Retrieving existing networks from docker failed with error: %v", err)
return nil, err
}
if networkInspect.IPAM.Options == nil || len(networkInspect.IPAM.Config) == 0 {
return nil, fmt.Errorf("error reading network %s information from docker", networkID)
}
networkParams := nuageConfig.ParseNuageParams(networkInspect.IPAM.Options)
networkParams.SubnetCIDR = networkInspect.IPAM.Config[0].Subnet
networkParams.Gateway = networkInspect.IPAM.Config[0].Gateway
nuagedocker.networkParamsTable.Write(networkID, networkParams)
return networkParams, nil
}
//GetContainerInspect returns the container inspect output of a container
func (nuagedocker *NuageDockerClient) GetContainerInspect(uuid string) (types.ContainerJSON, error) {
var containerInspect types.ContainerJSON
var err error
nuagedocker.executeDockerCommand(
func() error {
containerInspect, err = nuagedocker.dclient.ContainerInspect(context.Background(), uuid)
return err
})
if err != nil {
log.Errorf("Inspect on container %s failed with error %v", uuid, err)
return types.ContainerJSON{}, err
}
return containerInspect, nil
}
//GetNetworkConnectEvents listens for event when a container is connected to "nuage" network
func (nuagedocker *NuageDockerClient) GetNetworkConnectEvents() {
log.Debugf("docker listening for network connect events")
filterArgs := filters.NewArgs()
filterArgs.Add("type", "network")
filterArgs.Add("event", "connect")
options := types.EventsOptions{
Filters: filterArgs,
}
eventsChanRO, errChan := nuagedocker.dclient.Events(context.Background(), options)
for {
select {
case eventMsg := <-eventsChanRO:
if eventMsg.Actor.Attributes["type"] == nuageConfig.DockerNetworkType[nuagedocker.pluginVersion] {
log.Debugf("got docker event %+v", eventMsg)
dockerResp := nuageApi.DockerChanRequest(nuagedocker.dockerChannel, nuageApi.DockerNetworkConnectEvent, eventMsg)
if dockerResp.Error != nil {
log.Errorf("handling docker event %+v failed with error: %v", eventMsg, dockerResp.Error)
}
}
case <-errChan:
nuagedocker.connectionRetry <- true
<-nuagedocker.connectionActive
go nuagedocker.GetNetworkConnectEvents()
return
}
}
}
func (nuagedocker *NuageDockerClient) GetOptsAllNetworks() (map[string]*nuageConfig.NuageNetworkParams, error) {
table := make(map[string]*nuageConfig.NuageNetworkParams)
for _, networkID := range nuagedocker.networkParamsTable.GetKeys() {
networkParams, ok := nuagedocker.networkParamsTable.Read(networkID)
if ok {
table[networkID] = networkParams.(*nuageConfig.NuageNetworkParams)
}
}
return table, nil
}
func (nuagedocker *NuageDockerClient) buildCache() {
log.Debugf("building cache from docker")
networkList, err := nuagedocker.dockerNetworkList()
if err != nil {
log.Errorf("Fetching network list from docker failed with error %v", err)
return
}
for _, network := range networkList {
networkOpts := nuageConfig.ParseNuageParams(network.IPAM.Options)
networkParams := &nuageConfig.NuageNetworkParams{
Organization: networkOpts.Organization,
Domain: networkOpts.Domain,
Zone: networkOpts.Zone,
SubnetName: networkOpts.SubnetName,
User: networkOpts.User,
}
for _, nwConfig := range network.IPAM.Config {
networkParams.SubnetCIDR = nwConfig.Subnet
networkParams.Gateway = nwConfig.Gateway
}
nuagedocker.networkParamsTable.Write(network.ID, networkParams)
}
return
}
func (nuagedocker *NuageDockerClient) dockerNetworkList() ([]types.NetworkResource, error) {
var networkList []types.NetworkResource
var err error
nuagedocker.executeDockerCommand(
func() error {
filterArgs := filters.NewArgs()
filterArgs.Add("driver", nuageConfig.DockerNetworkType[nuagedocker.pluginVersion])
options := types.NetworkListOptions{
Filters: filterArgs,
}
networkList, err = nuagedocker.dclient.NetworkList(context.Background(), options)
return err
})
if err != nil {
log.Errorf("Retrieving existing networks from docker failed with error: %v", err)
return networkList, err
}
return networkList, nil
}
//for every network connect assign the ip for the relavent endpoint id
func (nuagedocker *NuageDockerClient) processEvent(msg events.Message) {
log.Debugf("%+v", msg)
id := msg.Actor.Attributes["container"]
inspect, err := nuagedocker.dclient.ContainerInspect(context.Background(), id)
if err != nil {
log.Errorf("Inspect on container %s failed with error %v", id, err)
} else {
var ip string
networkParamsIntf, ok := nuagedocker.networkParamsTable.Read(msg.Actor.ID)
if !ok {
log.Errorf("NuageDockerClient: NetworkID not found in local cache")
return
}
networkParams := networkParamsIntf.(*nuageConfig.NuageNetworkParams)
for _, nwConfig := range inspect.NetworkSettings.Networks {
if msg.Actor.ID == nwConfig.NetworkID {
ip = nwConfig.IPAddress
}
}
pg, _ := checkPolicyGroup(inspect.Config.Env)
orchestrationID, _ := checkOrchestrationID(inspect.Config.Env)
newReq := nuageConfig.NuageEventMetadata{
Name: strings.Replace(inspect.Name, "/", "", -1),
UUID: inspect.ID,
PolicyGroup: pg,
OrchestrationID: orchestrationID,
IPAddress: ip,
NetworkParams: networkParams,
}
nuageApi.VSDChanRequest(nuagedocker.vsdChannel, nuageApi.VSDUpdateContainerEvent, newReq)
}
}
func checkPolicyGroup(vars []string) (string, bool) {
return checkEnvVar("NUAGE-POLICY-GROUP", vars)
}
func checkOrchestrationID(vars []string) (string, bool) {
return checkEnvVar("MESOS_TASK_ID", vars)
}
func checkEnvVar(key string, envVars []string) (string, bool) {
for _, variable := range envVars {
if ok, err := regexp.MatchString(key, variable); ok {
kv := strings.Split(variable, "=")
if len(kv) == 0 {
log.Errorf("Splitting %s in KV pair failed with error: %v", variable, err)
return "", false
}
return kv[1], true
}
}
return "", false
}
//Start listen for events on docker channel
func (nuagedocker *NuageDockerClient) Start() {
log.Infof("Starting docker client")
go func() {
<-nuagedocker.connectionActive
go nuagedocker.buildCache()
go nuagedocker.GetNetworkConnectEvents()
}()
nuagedocker.handleConnectionRetry()
for {
select {
case dockerEvent := <-nuagedocker.dockerChannel:
go nuagedocker.handleDockerEvent(dockerEvent)
case <-nuagedocker.connectionRetry:
nuagedocker.handleConnectionRetry()
case <-nuagedocker.stop:
return
}
}
}
func (nuagedocker *NuageDockerClient) handleDockerEvent(event *nuageApi.DockerEvent) {
var data interface{}
var err error
log.Debugf("Received a docker event %+v", event)
switch event.EventType {
case nuageApi.DockerCheckNetworkListEvent:
data, err = nuagedocker.CheckNetworkList(event.DockerReqObject.(*nuageConfig.NuageNetworkParams))
case nuageApi.DockerNetworkIDInspectEvent:
data, err = nuagedocker.GetNetworkOptsFromNetworkID(event.DockerReqObject.(string))
case nuageApi.DockerPoolIDNetworkOptsEvent:
data, err = nuagedocker.GetNetworkOptsFromPoolID(event.DockerReqObject.(string))
case nuageApi.DockerContainerListEvent:
data, err = nuagedocker.GetRunningContainerList()
case nuageApi.DockerGetOptsAllNetworksEvent:
data, err = nuagedocker.GetOptsAllNetworks()
case nuageApi.DockerNetworkConnectEvent:
nuagedocker.processEvent(event.DockerReqObject.(events.Message))
default:
log.Errorf("NuageDockerClient: unknown api invocation")
}
event.DockerRespObjectChan <- &nuageApi.DockerRespObject{DockerData: data, Error: err}
log.Debugf("Served docker event %+v", event)
}
func (nuagedocker *NuageDockerClient) handleConnectionRetry() {
if _, err := nuagedocker.dclient.Ping(context.Background()); err != nil {
log.Errorf("Ping to docker host failed with error = %v. trying to reconnect", err)
log.Errorf("will try to reconnect in every 3 seconds")
var err error
for {
nuagedocker.dclient, err = connectToDockerDaemon(nuagedocker.socketFile)
_, err = nuagedocker.dclient.Ping(context.Background())
if err != nil {
time.Sleep(3 * time.Second)
} else {
log.Infof("docker connection is now active")
nuagedocker.connectionActive <- true
break
}
}
} else {
nuagedocker.connectionActive <- true
}
}
func connectToDockerDaemon(socketFile string) (*dockerClient.Client, error) {
err := os.Setenv("DOCKER_HOST", socketFile)
if err != nil {
log.Errorf("Setting DOCKER_HOST failed with error: %v", err)
return nil, err
}
client, err := dockerClient.NewEnvClient()
if err != nil {
log.Errorf("Connecting to docker client failed with error %v", err)
return nil, err
}
return client, nil
}
func (nuagedocker *NuageDockerClient) executeDockerCommand(dockerCommand func() error) {
err := dockerCommand()
if err != nil && isDockerConnectionError(err.Error()) {
log.Errorf(err.Error())
nuagedocker.connectionRetry <- true
<-nuagedocker.connectionActive
nuagedocker.executeDockerCommand(dockerCommand)
return
}
return
}
func isDockerConnectionError(errMsg string) bool {
ok, err := regexp.MatchString("Cannot connect to the Docker daemon", errMsg)
if err != nil {
log.Errorf("NuageDockerClient: matching strings failed with error %v", err)
}
return ok
}