-
Notifications
You must be signed in to change notification settings - Fork 221
/
docker.go
486 lines (403 loc) · 12.1 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
package imgsrc
import (
"context"
"encoding/base64"
"encoding/json"
"fmt"
"os"
"path/filepath"
"time"
"github.com/azazeal/pause"
"github.com/docker/docker/api/types"
"github.com/docker/docker/api/types/filters"
dockerclient "github.com/docker/docker/client"
"github.com/jpillora/backoff"
"github.com/oklog/ulid/v2"
"github.com/pkg/errors"
"github.com/spf13/viper"
"github.com/superfly/flyctl/agent"
"github.com/superfly/flyctl/api"
"github.com/superfly/flyctl/flyctl"
"github.com/superfly/flyctl/helpers"
"github.com/superfly/flyctl/internal/sentry"
"github.com/superfly/flyctl/iostreams"
"github.com/superfly/flyctl/terminal"
)
type dockerClientFactory struct {
mode DockerDaemonType
remote bool
buildFn func(ctx context.Context) (*dockerclient.Client, error)
apiClient *api.Client
appName string
}
func newDockerClientFactory(daemonType DockerDaemonType, apiClient *api.Client, appName string, streams *iostreams.IOStreams) *dockerClientFactory {
remoteFactory := func() *dockerClientFactory {
terminal.Debug("trying remote docker daemon")
var cachedDocker *dockerclient.Client
return &dockerClientFactory{
mode: daemonType,
remote: true,
buildFn: func(ctx context.Context) (*dockerclient.Client, error) {
if cachedDocker != nil {
return cachedDocker, nil
}
c, err := newRemoteDockerClient(ctx, apiClient, appName, streams)
if err != nil {
return nil, err
}
cachedDocker = c
return cachedDocker, nil
},
apiClient: apiClient,
appName: appName,
}
}
localFactory := func() *dockerClientFactory {
terminal.Debug("trying local docker daemon")
c, err := NewLocalDockerClient()
if c != nil && err == nil {
return &dockerClientFactory{
mode: DockerDaemonTypeLocal,
buildFn: func(ctx context.Context) (*dockerclient.Client, error) {
return c, nil
},
}
} else if err != nil && !dockerclient.IsErrConnectionFailed(err) {
terminal.Warn("Error connecting to local docker daemon:", err)
} else {
terminal.Debug("Local docker daemon unavailable")
}
return nil
}
if daemonType.AllowRemote() && !daemonType.PrefersLocal() {
return remoteFactory()
}
if daemonType.AllowLocal() {
if c := localFactory(); c != nil {
return c
}
}
if daemonType.AllowRemote() {
return remoteFactory()
}
return &dockerClientFactory{
mode: DockerDaemonTypeNone,
buildFn: func(ctx context.Context) (*dockerclient.Client, error) {
return nil, errors.New("no docker daemon available")
},
}
}
func NewDockerDaemonType(allowLocal, allowRemote, prefersLocal, useNixpacks bool) DockerDaemonType {
daemonType := DockerDaemonTypeNone
if allowLocal {
daemonType = daemonType | DockerDaemonTypeLocal
}
if allowRemote {
daemonType = daemonType | DockerDaemonTypeRemote
}
if useNixpacks {
daemonType = daemonType | DockerDaemonTypeNixpacks
}
if prefersLocal {
daemonType = daemonType | DockerDaemonTypePrefersLocal
}
return daemonType
}
type DockerDaemonType int
const (
DockerDaemonTypeLocal DockerDaemonType = 1 << iota
DockerDaemonTypeRemote
DockerDaemonTypeNone
DockerDaemonTypePrefersLocal
DockerDaemonTypeNixpacks
)
func (t DockerDaemonType) AllowLocal() bool {
return (t & DockerDaemonTypeLocal) != 0
}
func (t DockerDaemonType) AllowRemote() bool {
return (t & DockerDaemonTypeRemote) != 0
}
func (t DockerDaemonType) AllowNone() bool {
return (t & DockerDaemonTypeNone) != 0
}
func (t DockerDaemonType) IsNone() bool {
return t == DockerDaemonTypeNone
}
func (t DockerDaemonType) IsAvailable() bool {
return !t.IsNone()
}
func (t DockerDaemonType) UseNixpacks() bool {
return (t & DockerDaemonTypeNixpacks) != 0
}
func (t DockerDaemonType) PrefersLocal() bool {
return (t & DockerDaemonTypePrefersLocal) != 0
}
func NewLocalDockerClient() (*dockerclient.Client, error) {
c, err := dockerclient.NewClientWithOpts(dockerclient.WithAPIVersionNegotiation())
if err != nil {
return nil, err
}
if err := dockerclient.FromEnv(c); err != nil {
return nil, err
}
if _, err = c.Ping(context.TODO()); err != nil {
return nil, err
}
return c, nil
}
func newRemoteDockerClient(ctx context.Context, apiClient *api.Client, appName string, streams *iostreams.IOStreams) (*dockerclient.Client, error) {
startedAt := time.Now()
var host string
var app *api.App
var err error
var machine *api.GqlMachine
machine, app, err = remoteBuilderMachine(ctx, apiClient, appName)
if err != nil {
return nil, err
}
remoteBuilderAppName := app.Name
remoteBuilderOrg := app.Organization.Slug
if host != "" {
terminal.Debugf("Remote Docker builder host: %s\n", host)
}
if msg := fmt.Sprintf("Waiting for remote builder %s...", remoteBuilderAppName); streams.IsInteractive() {
streams.StartProgressIndicatorMsg(msg)
} else {
fmt.Fprintln(streams.ErrOut, msg)
}
captureError := func(err error) {
// ignore cancelled errors
if errors.Is(err, context.Canceled) {
return
}
sentry.CaptureException(err,
sentry.WithTag("feature", "remote-build"),
sentry.WithContexts(map[string]interface{}{
"app": map[string]interface{}{
"name": app.Name,
},
"organization": map[string]interface{}{
"name": remoteBuilderOrg,
},
"builder": map[string]interface{}{
"app_name": remoteBuilderAppName,
},
"elapsed": time.Since(startedAt),
}),
)
}
for _, ip := range machine.IPs.Nodes {
terminal.Debugf("checking ip %+v\n", ip)
if ip.Kind == "privatenet" {
host = "tcp://[" + ip.IP + "]:2375"
break
}
}
if host == "" {
return nil, errors.New("machine did not have a private IP")
}
opts, err := buildRemoteClientOpts(ctx, apiClient, appName, host)
if err != nil {
streams.StopProgressIndicator()
err = fmt.Errorf("failed building options: %w", err)
captureError(err)
return nil, err
}
client, err := dockerclient.NewClientWithOpts(opts...)
if err != nil {
streams.StopProgressIndicator()
err = fmt.Errorf("failed creating docker client: %w", err)
captureError(err)
return nil, err
}
switch up, err := waitForDaemon(ctx, client); {
case err != nil:
streams.StopProgressIndicator()
err = fmt.Errorf("failed waiting for docker daemon: %w", err)
captureError(err)
return nil, err
case !up:
streams.StopProgressIndicator()
terminal.Warnf("Remote builder did not start in time. Check remote builder logs with `flyctl logs -a %s`\n", remoteBuilderAppName)
return nil, errors.New("remote builder app unavailable")
default:
if msg := fmt.Sprintf("Remote builder %s ready", remoteBuilderAppName); streams.IsInteractive() {
streams.StopProgressIndicatorMsg(msg)
} else {
fmt.Fprintln(streams.ErrOut, msg)
}
}
return client, nil
}
func buildRemoteClientOpts(ctx context.Context, apiClient *api.Client, appName, host string) (opts []dockerclient.Opt, err error) {
opts = []dockerclient.Opt{
dockerclient.WithAPIVersionNegotiation(),
dockerclient.WithHost(host),
}
if os.Getenv("FLY_REMOTE_BUILDER_HOST_WG") != "" {
terminal.Debug("connecting to remote docker daemon over host wireguard tunnel")
return
}
var app *api.AppBasic
if app, err = apiClient.GetAppBasic(ctx, appName); err != nil {
return nil, fmt.Errorf("error fetching target app: %w", err)
}
var agentclient *agent.Client
if agentclient, err = agent.Establish(ctx, apiClient); err != nil {
return
}
var dialer agent.Dialer
if dialer, err = agentclient.Dialer(ctx, app.Organization.Slug); err != nil {
return
}
if err = agentclient.WaitForTunnel(ctx, app.Organization.Slug); err == nil {
opts = append(opts, dockerclient.WithDialContext(dialer.DialContext))
}
return
}
func waitForDaemon(parent context.Context, client *dockerclient.Client) (up bool, err error) {
ctx, cancel := context.WithTimeout(parent, 2*time.Minute)
defer cancel()
b := &backoff.Backoff{
Min: 50 * time.Millisecond,
Max: 200 * time.Millisecond,
Factor: 1.2,
Jitter: true,
}
var (
consecutiveSuccesses int
healthyStart time.Time
)
for ctx.Err() == nil {
switch _, err := client.Ping(ctx); err {
default:
consecutiveSuccesses = 0
dur := b.Duration()
terminal.Debugf("Remote builder unavailable, retrying in %s (err: %v)\n", dur, err)
pause.For(ctx, dur)
case nil:
if consecutiveSuccesses++; consecutiveSuccesses == 1 {
healthyStart = time.Now()
}
if time.Since(healthyStart) > time.Second {
terminal.Debug("Remote builder is ready to build!")
return true, nil
}
b.Reset()
dur := b.Duration()
terminal.Debugf("Remote builder available, but pinging again in %s to be sure\n", dur)
pause.For(ctx, dur)
}
}
switch {
case parent.Err() != nil:
return false, parent.Err()
default:
return false, nil
}
}
func clearDeploymentTags(ctx context.Context, docker *dockerclient.Client, tag string) error {
filters := filters.NewArgs(filters.Arg("reference", tag))
images, err := docker.ImageList(ctx, types.ImageListOptions{Filters: filters})
if err != nil {
return err
}
for _, image := range images {
for _, tag := range image.RepoTags {
_, err := docker.ImageRemove(ctx, tag, types.ImageRemoveOptions{PruneChildren: true})
if err != nil {
terminal.Debug("Error deleting image", err)
}
}
}
return nil
}
func registryAuth(token string) types.AuthConfig {
return types.AuthConfig{
Username: "x",
Password: token,
ServerAddress: "registry.fly.io",
}
}
func authConfigs() map[string]types.AuthConfig {
authConfigs := map[string]types.AuthConfig{}
authConfigs["registry.fly.io"] = registryAuth(flyctl.GetAPIToken())
dockerhubUsername := os.Getenv("DOCKER_HUB_USERNAME")
dockerhubPassword := os.Getenv("DOCKER_HUB_PASSWORD")
if dockerhubUsername != "" && dockerhubPassword != "" {
cfg := types.AuthConfig{
Username: dockerhubUsername,
Password: dockerhubPassword,
ServerAddress: "index.docker.io",
}
authConfigs["https://index.docker.io/v1/"] = cfg
}
return authConfigs
}
func flyRegistryAuth() string {
accessToken := flyctl.GetAPIToken()
authConfig := registryAuth(accessToken)
encodedJSON, err := json.Marshal(authConfig)
if err != nil {
terminal.Warn("Error encoding fly registry credentials", err)
return ""
}
return base64.URLEncoding.EncodeToString(encodedJSON)
}
// NewDeploymentTag generates a Docker image reference including the current registry,
// the app name, and a timestamp: registry.fly.io/appname:deployment-$timestamp
func NewDeploymentTag(appName string, label string) string {
if tag := os.Getenv("FLY_IMAGE_REF"); tag != "" {
return tag
}
if label == "" {
label = fmt.Sprintf("deployment-%s", ulid.Make())
}
registry := viper.GetString(flyctl.ConfigRegistryHost)
return fmt.Sprintf("%s/%s:%s", registry, appName, label)
}
func newCacheTag(appName string) string {
registry := viper.GetString(flyctl.ConfigRegistryHost)
return fmt.Sprintf("%s/%s:%s", registry, appName, "cache")
}
// resolveDockerfile - Resolve the location of the dockerfile, allowing for upper and lowercase naming
func resolveDockerfile(cwd string) string {
dockerfilePath := filepath.Join(cwd, "Dockerfile")
if helpers.FileExists(dockerfilePath) {
return dockerfilePath
}
dockerfilePath = filepath.Join(cwd, "dockerfile")
if helpers.FileExists(dockerfilePath) {
return dockerfilePath
}
return ""
}
func EagerlyEnsureRemoteBuilder(ctx context.Context, apiClient *api.Client, orgSlug string) {
// skip if local docker is available
if _, err := NewLocalDockerClient(); err == nil {
return
}
org, err := apiClient.GetOrganizationBySlug(ctx, orgSlug)
if err != nil {
terminal.Debugf("error resolving organization for slug %s: %s", orgSlug, err)
return
}
_, app, err := apiClient.EnsureRemoteBuilder(ctx, org.ID, "")
if err != nil {
terminal.Debugf("error ensuring remote builder for organization: %s", err)
return
}
terminal.Debugf("remote builder %s is being prepared", app.Name)
}
func remoteBuilderMachine(ctx context.Context, apiClient *api.Client, appName string) (*api.GqlMachine, *api.App, error) {
if v := os.Getenv("FLY_REMOTE_BUILDER_HOST"); v != "" {
return nil, nil, nil
}
return apiClient.EnsureRemoteBuilder(ctx, "", appName)
}
func (d *dockerClientFactory) IsRemote() bool {
return d.remote
}
func (d *dockerClientFactory) IsLocal() bool {
return !d.remote
}