/
docker.go
716 lines (617 loc) · 19.2 KB
/
docker.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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
package driver
import (
"bytes"
"context"
"encoding/base64"
"encoding/json"
"fmt"
"io"
"strings"
// "strings"
"sync"
"time"
dockertypes "github.com/docker/docker/api/types"
dockercontainer "github.com/docker/docker/api/types/container"
dockerfilters "github.com/docker/docker/api/types/filters"
dockermounttypes "github.com/docker/docker/api/types/mount"
"github.com/docker/docker/api/types/network"
dockernetworktypes "github.com/docker/docker/api/types/network"
dockerapi "github.com/docker/docker/client"
dockermessage "github.com/docker/docker/pkg/jsonmessage"
dockerstdcopy "github.com/docker/docker/pkg/stdcopy"
// "github.com/ajssmith/skupper-exp/driver"
skupperutils "github.com/skupperproject/skupper/pkg/utils"
)
const (
// defaultTimeout is the default timeout of short running docker operations.
// Value is slightly offset from 2 minutes to make timeouts due to this
// constant recognizable.
defaultTimeout = 2*time.Minute - 1*time.Second
// defaultShmSize is the default ShmSize to use (in bytes) if not specified.
defaultShmSize = int64(1024 * 1024 * 64)
// defaultImagePullingProgressReportInterval is the default interval of image pulling progress reporting.
defaultImagePullingProgressReportInterval = 10 * time.Second
)
type dockerClient struct {
client *dockerapi.Client
timeout time.Duration
imagePullProgessDeadline time.Duration
}
type ImageNotFoundError struct {
ID string
}
var DockerDriver dockerClient
func getTimeoutContext(d *dockerClient) (context.Context, context.CancelFunc) {
return context.WithTimeout(context.Background(), d.timeout)
}
func newDockerContainerSpec(options ContainerCreateOptions) *dockertypes.ContainerCreateConfig {
var mounts []dockermounttypes.Mount
for _, mount := range options.HostConfig.Mounts {
mounts = append(mounts, dockermounttypes.Mount{
Type: dockermounttypes.TypeBind,
Source: mount.Source,
Target: mount.Destination,
})
}
endpoints := make(map[string]*dockernetworktypes.EndpointSettings)
for i := range options.NetworkingConfig.EndpointsConfig {
endpoints[i] = &network.EndpointSettings{}
}
envVars := []string{}
for key, value := range options.ContainerConfig.Env {
envVars = append(envVars, key+"="+value)
}
opts := &dockertypes.ContainerCreateConfig{
Name: options.Name,
Config: &dockercontainer.Config{
Hostname: options.ContainerConfig.Hostname,
Image: options.ContainerConfig.Image,
Env: envVars,
Cmd: options.ContainerConfig.Cmd,
Healthcheck: &dockercontainer.HealthConfig{
Test: options.ContainerConfig.HealthCheck.Test,
StartPeriod: options.ContainerConfig.HealthCheck.StartPeriod,
},
Labels: options.ContainerConfig.Labels,
ExposedPorts: options.ContainerConfig.ExposedPorts,
},
HostConfig: &dockercontainer.HostConfig{
Mounts: mounts,
Privileged: options.HostConfig.Privileged,
},
NetworkingConfig: &dockernetworktypes.NetworkingConfig{
EndpointsConfig: endpoints,
},
}
return opts
}
func (c *dockerClient) New() error {
fmt.Println("Inside docker plugin new")
client, err := dockerapi.NewClientWithOpts(dockerapi.FromEnv, dockerapi.WithAPIVersionNegotiation())
if err != nil {
return fmt.Errorf("Couldn't connect to docker: %w", err)
}
DockerDriver.client = client
DockerDriver.timeout = DefaultTimeout
DockerDriver.imagePullProgessDeadline = DefaultImagePullingProgressReportInterval
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
DockerDriver.client.NegotiateAPIVersion(ctx)
return nil
}
func getCancelableContext() (context.Context, context.CancelFunc) {
return context.WithCancel(context.Background())
}
func contextError(ctx context.Context) error {
if ctx.Err() == context.DeadlineExceeded {
return operationTimeout{err: ctx.Err()}
}
return ctx.Err()
}
type operationTimeout struct {
err error
}
func (e operationTimeout) Error() string {
return fmt.Sprintf("operation timeout: %v", e.err)
}
func base64EncodeAuth(auth dockertypes.AuthConfig) (string, error) {
var buf bytes.Buffer
if err := json.NewEncoder(&buf).Encode(auth); err != nil {
return "", err
}
return base64.URLEncoding.EncodeToString(buf.Bytes()), nil
}
// progress is a wrapper of dockermessage.JSONMessage with a lock protecting it.
type progress struct {
sync.RWMutex
// message stores the latest docker json message.
message *dockermessage.JSONMessage
// timestamp of the latest update.
timestamp time.Time
}
func newProgress() *progress {
return &progress{timestamp: time.Now()}
}
func (p *progress) set(msg *dockermessage.JSONMessage) {
p.Lock()
defer p.Unlock()
p.message = msg
p.timestamp = time.Now()
}
func (p *progress) get() (string, time.Time) {
p.RLock()
defer p.RUnlock()
if p.message == nil {
return "No progress", p.timestamp
}
// The following code is based on JSONMessage.Display
var prefix string
if p.message.ID != "" {
prefix = fmt.Sprintf("%s: ", p.message.ID)
}
if p.message.Progress == nil {
return fmt.Sprintf("%s%s", prefix, p.message.Status), p.timestamp
}
return fmt.Sprintf("%s%s %s", prefix, p.message.Status, p.message.Progress.String()), p.timestamp
}
type progressReporter struct {
*progress
image string
cancel context.CancelFunc
stopCh chan struct{}
imagePullProgressDeadline time.Duration
}
func newProgressReporter(image string, cancel context.CancelFunc, imagePullProgressDeadline time.Duration) *progressReporter {
return &progressReporter{
progress: newProgress(),
image: image,
cancel: cancel,
stopCh: make(chan struct{}),
imagePullProgressDeadline: imagePullProgressDeadline,
}
}
func (p *progressReporter) start() {
go func() {
ticker := time.NewTicker(defaultImagePullingProgressReportInterval)
defer ticker.Stop()
for {
select {
case <-ticker.C:
_, timestamp := p.progress.get()
// If there is no progress for p.imagePullProgressDeadline, cancel the operation.
if time.Since(timestamp) > p.imagePullProgressDeadline {
//log.Printf("Cancel pulling image %q because of no progress for %v, latest progress: %q", p.image, p.imagePullProgressDeadline, progress)
//log.Println()
p.cancel()
return
}
//log.Printf("Pulling image %q: %q", p.image, progress)
//log.Println()
case <-p.stopCh:
//progress, _ := p.progress.get()
//log.Printf("Stop pulling image %q: %q", p.image, progress)
//log.Println()
return
}
}
}()
}
func (p *progressReporter) stop() {
close(p.stopCh)
}
func (c *dockerClient) ImagesPull(refStr string, options ImagePullOptions) ([]string, error) {
// TODO: return common []string
fmt.Println("In docker pull images")
// RegistryAuth is the base64 encoded credentials for the registry
auth := dockertypes.AuthConfig{}
base64Auth, err := base64EncodeAuth(auth)
if err != nil {
return nil, err
}
opts := dockertypes.ImagePullOptions{}
opts.RegistryAuth = base64Auth
ctx, cancel := getCancelableContext()
defer cancel()
resp, err := c.client.ImagePull(ctx, refStr, opts)
if err != nil {
return nil, err
}
defer resp.Close()
reporter := newProgressReporter(refStr, cancel, 10*time.Second)
reporter.start()
defer reporter.stop()
decoder := json.NewDecoder(resp)
for {
var msg dockermessage.JSONMessage
err := decoder.Decode(&msg)
if err == io.EOF {
break
}
if err != nil {
return nil, err
}
if msg.Error != nil {
return nil, msg.Error
}
reporter.set(&msg)
}
return nil, nil
}
func (c *dockerClient) ImageInspect(id string) (*ImageInspect, error) {
fmt.Println("In docker inspect image")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
data, _, err := c.client.ImageInspectWithRaw(ctx, id)
if ctxErr := contextError(ctx); ctxErr != nil {
return nil, ctxErr
}
if err != nil {
return nil, err
}
image := &ImageInspect{
ID: data.ID,
Size: data.Size,
RepoTags: data.RepoTags,
}
return image, nil
}
func (c *dockerClient) ImagesList(options ImageListOptions) ([]ImageSummary, error) {
fmt.Println("In docker list images")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
images, err := c.client.ImageList(ctx, dockertypes.ImageListOptions{})
if ctxErr := contextError(ctx); ctxErr != nil {
return nil, ctxErr
}
if err != nil {
return nil, err
}
var summary []ImageSummary
for _, image := range images {
summary = append(summary, ImageSummary{
ID: image.ID,
Labels: image.Labels,
RepoTags: image.RepoTags,
RepoDigests: image.RepoDigests,
})
}
return summary, nil
}
func (c *dockerClient) ImageVersion(id string) (string, error) {
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
iibd, _, err := c.client.ImageInspectWithRaw(ctx, id)
if ctxErr := contextError(ctx); ctxErr != nil {
return "", ctxErr
}
if err != nil {
// if dockerapi.IsErrNotFound(err) {
// err = ImageNotFoundError{ID: ref}
// }
return "", err
}
digest := iibd.RepoDigests[0]
parts := strings.Split(digest, "@")
if len(parts) > 1 && len(parts[1]) >= 19 {
return fmt.Sprintf("%s (%s)", id, parts[1][:19]), nil
} else {
return fmt.Sprintf("%s", digest), nil
}
}
func (c *dockerClient) ContainerCreate(options ContainerCreateOptions) (ContainerCreateResponse, error) {
fmt.Println("Inside docker container create")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
opts := newDockerContainerSpec(options)
ccb, err := c.client.ContainerCreate(ctx, opts.Config, opts.HostConfig, opts.NetworkingConfig, nil, opts.Name)
if err != nil {
return ContainerCreateResponse{}, err
}
return ContainerCreateResponse{ID: ccb.ID}, nil
}
func (c *dockerClient) ContainerStart(id string) error {
fmt.Println("Inside docker start container")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
err := c.client.ContainerStart(ctx, id, dockertypes.ContainerStartOptions{})
if ctxErr := contextError(ctx); ctxErr != nil {
return ctxErr
}
return err
}
func (c *dockerClient) ContainerWait(id string, status string, timeout time.Duration, interval time.Duration) error {
fmt.Println("Inside docker container wait")
var container dockertypes.ContainerJSON
var err error
ctx, cancel := context.WithTimeout(context.TODO(), timeout)
defer cancel()
err = skupperutils.RetryWithContext(ctx, interval, func() (bool, error) {
container, err = c.client.ContainerInspect(ctx, id)
if err != nil {
return false, nil
}
return container.State.Status == status, nil
})
return err
}
func (c *dockerClient) ContainerList(opts ContainerListOptions) ([]ContainerSummary, error) {
fmt.Println("Inside docker container list")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
//TODO is this correct conversion of map[string][]string to filters
filters := dockerfilters.NewArgs()
for i, j := range opts.Filters {
filters.Add(i, j[0])
//filters.Add(i, strings.Join(j,","))
}
containers, err := c.client.ContainerList(ctx, dockertypes.ContainerListOptions{
Filters: filters,
All: opts.All,
})
var dc []ContainerSummary
if ctxErr := contextError(ctx); ctxErr != nil {
return dc, ctxErr
}
if err != nil {
return dc, err
}
for _, container := range containers {
// TODO all fields
dc = append(dc, ContainerSummary{
ID: container.ID,
Names: container.Names,
Image: container.Image,
ImageID: container.ImageID,
Command: container.Command,
//Ports: container.Ports,
Labels: container.Labels,
State: container.State,
Status: container.Status,
//Mounts: container.Mounts,
})
}
return dc, nil
}
func (c *dockerClient) ContainerInspect(id string) (*ContainerInspect, error) {
fmt.Println("Inside docker container inspect")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
container, err := c.client.ContainerInspect(ctx, id)
if ctxErr := contextError(ctx); ctxErr != nil {
return nil, ctxErr
}
if err != nil {
return nil, err
}
mounts := []MountPoint{}
for _, mount := range container.Mounts {
mounts = append(mounts, MountPoint{
Type: TypeBind,
Name: mount.Name,
Source: mount.Source,
Destination: mount.Destination,
Driver: mount.Driver,
Mode: mount.Mode,
RW: mount.RW,
})
}
envVars := make(map[string]string)
for _, env := range container.Config.Env {
pos := strings.Index(env, "=")
name := env[:pos]
value := env[pos+1:]
if value != "" {
envVars[name] = value
}
}
icd := &ContainerInspect{
ID: container.ID,
//Created: container.Created,
Path: container.Path,
Args: container.Args,
State: &ContainerState{
Status: container.State.Status,
},
Image: container.Image,
//ImageName: container.ImageName,
Name: container.Name,
Mounts: mounts,
Config: ContainerConfig{
Hostname: container.Config.Hostname,
ExposedPorts: container.Config.ExposedPorts,
Env: envVars,
Healthcheck: &HealthConfig{
Test: container.Config.Healthcheck.Test,
Interval: container.Config.Healthcheck.Interval,
Timeout: container.Config.Healthcheck.Timeout,
StartPeriod: container.Config.Healthcheck.StartPeriod,
Retries: container.Config.Healthcheck.Retries,
},
Image: container.Config.Image,
Labels: container.Config.Labels,
},
NetworkSettings: ContainerNetworkConfig{
Gateway: container.NetworkSettings.DefaultNetworkSettings.Gateway,
IPAddress: container.NetworkSettings.DefaultNetworkSettings.IPAddress,
IPPrefixLen: container.NetworkSettings.DefaultNetworkSettings.IPPrefixLen,
},
}
if len(container.NetworkSettings.Networks) > 0 {
icd.NetworkSettings.Networks = make(map[string]*NetworkEndpointSetting)
for net, setting := range container.NetworkSettings.Networks {
endpoint := new(NetworkEndpointSetting)
endpoint.NetworkID = net
endpoint.Gateway = setting.Gateway
endpoint.IPAddress = setting.IPAddress
endpoint.IPPrefixLen = setting.IPPrefixLen
icd.NetworkSettings.Networks[net] = endpoint
}
}
return icd, err
}
func (c *dockerClient) ContainerRestart(id string) error {
fmt.Println("Inside docker restart container")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
timeout := 10 * time.Second
err := c.client.ContainerRestart(ctx, id, &timeout)
if ctxErr := contextError(ctx); ctxErr != nil {
return ctxErr
}
return err
}
func (c *dockerClient) ContainerStop(id string) error {
fmt.Println("Inside docker stop container")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
err := c.client.ContainerStop(ctx, id, nil)
if ctxErr := contextError(ctx); ctxErr != nil {
return ctxErr
}
return err
}
func (c *dockerClient) ContainerRemove(id string) error {
fmt.Println("Inside docker container remove")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
err := c.client.ContainerRemove(ctx, id, dockertypes.ContainerRemoveOptions{})
if ctxErr := contextError(ctx); ctxErr != nil {
return ctxErr
}
return err
}
func (c *dockerClient) NetworkCreate(name string, options NetworkCreateOptions) (NetworkCreateResponse, error) {
fmt.Println("Inside docker network create")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
ncr, err := c.client.NetworkCreate(ctx, name, dockertypes.NetworkCreate{
CheckDuplicate: true,
Driver: "bridge",
Options: map[string]string{
"com.docker.network.bridge.name": "skupper0",
"com.docker.network.bridge.enable_icc": "true",
"com.docker.network.bridge.enable_ip_masquerade": "true",
},
})
if ctxErr := contextError(ctx); ctxErr != nil {
return NetworkCreateResponse{}, ctxErr
}
return NetworkCreateResponse{ID: ncr.ID, Warning: ncr.Warning}, err
}
func (c *dockerClient) NetworkInspect(id string) (NetworkInspect, error) {
var netResource NetworkInspect
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
nr, err := c.client.NetworkInspect(ctx, id, dockertypes.NetworkInspectOptions{})
if ctxErr := contextError(ctx); ctxErr != nil {
return netResource, ctxErr
}
if len(nr.Containers) > 0 {
netResource.Containers = make(map[string]EndpointResource)
for container, endPoint := range nr.Containers {
netResource.Containers[container] = EndpointResource{
Name: endPoint.Name,
EndpointID: endPoint.EndpointID,
}
}
}
return netResource, err
}
func (c *dockerClient) NetworkRemove(id string) error {
// force := true
fmt.Println("Inside docker network remove for: ", id)
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
err := c.client.NetworkRemove(ctx, id)
if ctxErr := contextError(ctx); ctxErr != nil {
return ctxErr
}
return err
}
func (c *dockerClient) NetworkConnect(id string, container string, aliases []string) error {
fmt.Println("Inside docker network connect: ", id, container)
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
err := c.client.NetworkConnect(ctx, id, container, &dockernetworktypes.EndpointSettings{})
if ctxErr := contextError(ctx); ctxErr != nil {
return ctxErr
}
if err != nil {
return err
}
return nil
}
func (c *dockerClient) NetworkDisconnect(id string, container string, force bool) error {
fmt.Println("Inside docker network disconnect: ", id, container)
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
err := c.client.NetworkDisconnect(ctx, id, container, force)
if ctxErr := contextError(ctx); ctxErr != nil {
return ctxErr
}
if err != nil {
return err
}
return nil
}
func (c *dockerClient) ContainerExec(id string, cmd []string) (ExecResult, error) {
fmt.Println("Inside docker container exec")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
execConfig := dockertypes.ExecConfig{
AttachStdout: true,
AttachStderr: true,
Cmd: cmd,
}
createResponse, err := c.client.ContainerExecCreate(ctx, id, execConfig)
if err != nil {
return ExecResult{}, err
}
execID := createResponse.ID
// run with stdout and stderr attached
attachResponse, err := c.client.ContainerExecAttach(ctx, execID, dockertypes.ExecStartCheck{})
if err != nil {
return ExecResult{}, err
}
defer attachResponse.Close()
var outBuf, errBuf bytes.Buffer
outputDone := make(chan error, 1)
go func() {
_, err = dockerstdcopy.StdCopy(&outBuf, &errBuf, attachResponse.Reader)
outputDone <- err
}()
select {
case err := <-outputDone:
if err != nil {
return ExecResult{}, err
}
break
}
inspectResponse, err := c.client.ContainerExecInspect(ctx, execID)
if err != nil {
return ExecResult{}, err
}
return ExecResult{ExitCode: inspectResponse.ExitCode, OutBuffer: &outBuf, ErrBuffer: &errBuf}, nil
}
func (c *dockerClient) Info() (Info, error) {
fmt.Println("Inside docker info")
ctx, cancel := getTimeoutContext(&DockerDriver)
defer cancel()
driverInfo := Info{}
info, err := c.client.Info(ctx)
if ctxErr := contextError(ctx); ctxErr != nil {
return driverInfo, ctxErr
}
if err != nil {
return driverInfo, err
}
driverInfo.ID = info.ID
driverInfo.Name = info.Name
driverInfo.KernelVersion = info.KernelVersion
driverInfo.OperatingSystem = info.OperatingSystem
driverInfo.OSVersion = info.OSVersion
driverInfo.OSType = info.OSType
driverInfo.Architecture = info.Architecture
driverInfo.ServerVersion = info.ServerVersion
return driverInfo, nil
}