/
driver.go
726 lines (649 loc) · 19 KB
/
driver.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
717
718
719
720
721
722
723
724
725
726
// Copyright 2016 Skytap Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package driver
import (
"fmt"
"errors"
"github.com/Sirupsen/logrus"
"github.com/docker/machine/libmachine/drivers"
"github.com/docker/machine/libmachine/log"
"github.com/docker/machine/libmachine/mcnflag"
dockerSsh "github.com/docker/machine/libmachine/ssh"
"github.com/docker/machine/libmachine/state"
"github.com/skytap/skytap-sdk-go/api"
"github.com/tmc/scp"
"golang.org/x/crypto/ssh"
"regexp"
"time"
)
const (
defaultEnvironmentId = "New"
defaultSSHUser = "docker"
defaultVPNId = ""
defaultCPUs = 0
defaultCPUsPerSocket = 0
defaultRAM = 0
driverName = "skytap"
)
// Driver is the driver used when no driver is selected. It is used to
// connect to existing Docker hosts by specifying the URL of the host as
// an option.
type Driver struct {
*drivers.BaseDriver
ClientCredentials api.SkytapCredentials
DeviceConfig deviceConfig
Vm api.VirtualMachine
LogLevel logrus.Level
LastState state.State
HardwareConfig *api.Hardware
ContainerHost bool
}
type deviceConfig struct {
SourceVMId string
EnvironmentId string
VPNId string
}
func NewDriver(hostName, storePath string) drivers.Driver {
return &Driver{
ClientCredentials: api.SkytapCredentials{},
DeviceConfig: deviceConfig{},
Vm: api.VirtualMachine{},
LogLevel: logrus.WarnLevel,
LastState: state.None,
BaseDriver: &drivers.BaseDriver{
MachineName: hostName,
StorePath: storePath,
},
}
}
func (d *Driver) GetCreateFlags() []mcnflag.Flag {
return []mcnflag.Flag{
mcnflag.StringFlag{
Name: "skytap-user-id",
Usage: "Skytap user ID",
EnvVar: "SKYTAP_USER_ID",
},
mcnflag.StringFlag{
Name: "skytap-api-security-token",
Usage: "Your secret security token",
EnvVar: "SKYTAP_API_SECURITY_TOKEN",
},
mcnflag.StringFlag{
Name: "skytap-vm-id",
Usage: "ID for the VM template to use",
EnvVar: "SKYTAP_VM_ID",
},
mcnflag.StringFlag{
Name: "skytap-env-id",
Usage: "ID for the environment to add the VM to. Leave blank to create to a new environment",
Value: defaultEnvironmentId,
EnvVar: "SKYTAP_ENV_ID",
},
mcnflag.StringFlag{
Name: "skytap-vpn-id",
Usage: "VPN ID to connect to the environment",
Value: defaultVPNId,
EnvVar: "SKYTAP_VPN_ID",
},
mcnflag.StringFlag{
Name: "skytap-ssh-user",
Usage: "SSH user",
Value: defaultSSHUser,
EnvVar: "SKYTAP_SSH_USER",
},
mcnflag.StringFlag{
Name: "skytap-ssh-key",
Usage: "SSH private key path (if not provided, identities in ssh-agent will be used)",
Value: "",
EnvVar: "SKYTAP_SSH_KEY",
},
mcnflag.IntFlag{
Name: "skytap-ssh-port",
Usage: "SSH port",
Value: drivers.DefaultSSHPort,
EnvVar: "SKYTAP_SSH_PORT",
},
mcnflag.StringFlag{
Name: "skytap-api-logging-level",
Usage: "The logging level to use when running api commands.",
Value: "info",
EnvVar: "SKYTAP_API_LOGGING_LEVEL",
},
mcnflag.IntFlag{
Name: "skytap-vm-cpus",
Usage: "Number of CPUs to configure in target VM",
EnvVar: "SKYTAP_VM_CPUS",
},
mcnflag.IntFlag{
Name: "skytap-vm-cpuspersocket",
Usage: "Specifies how the total number of CPUs should be distributed across virtual sockets. The default is what’s configured for the source VM.",
EnvVar: "SKYTAP_VM_CPUSPERSOCKET",
},
mcnflag.IntFlag{
Name: "skytap-vm-ram",
Usage: "The amount of ram, in megabytes, allocated to the VM. The default is what’s configured for the source VM.",
EnvVar: "SKYTAP_VM_RAM",
},
mcnflag.BoolFlag{
Name: "skytap-container-host",
Usage: "Configures the VM as a container host.",
EnvVar: "SKYTAP_CONTAINER_HOST",
},
}
}
func (d *Driver) PreCreateCheck() error {
/*
The following checks are performed:
1. Check the source VM exists
2. Check the target environment exists; if adding the machine to an existing environment
3. Check the Machine name won't collide with an existing VM's hostname
4. If running outside Skytap ensure a VPN Id is provided
5. If VPN provided check it exists
*/
d.SetLogLevel()
log.Debugf("Skytap client auth: %+v", d.ClientCredentials)
client := *api.NewSkytapClientFromCredentials(d.ClientCredentials)
log.Debug("Checking if source VM exists.")
vm, err := api.GetVirtualMachine(client, d.DeviceConfig.SourceVMId)
if err != nil {
return err
}
log.Debugf("Found VM %s.", vm.Id)
log.Debug("Checking if target environment exists.")
if d.DeviceConfig.EnvironmentId != defaultEnvironmentId {
env, err := api.GetEnvironment(client, d.DeviceConfig.EnvironmentId)
if err != nil {
return err
}
log.Debugf("Found environment %s.", env.Id)
// Check if VM hostname already exists
for _, vm := range env.Vms {
log.Debugf("VM Name: %s", vm.Name)
for _, network := range vm.Interfaces {
log.Debugf(" VM Hostname: %s", network.Hostname)
if network.Hostname == d.MachineName {
return fmt.Errorf("A VM (%s) with hostname %s already exists in this environment.", vm.Name, network.Hostname )
}
}
}
}
// If we're running outside a Skytap VM a VPN connection is required.
log.Debug("Checking if we require a VPN")
resp := api.IsRunningInSkytap()
if resp == false && d.DeviceConfig.VPNId == "" {
return fmt.Errorf("When running Docker Machine outside Skytap a VPN is required.")
}
// Check if VPN exists
if d.DeviceConfig.VPNId != "" {
log.Debug("Checking if VPN exists.")
vpn, err := api.GetVpn(client, d.DeviceConfig.VPNId)
if err != nil {
return err
}
log.Debugf("Found VPN %s.", vpn.Name)
}
return nil
}
func (d *Driver) Create() error {
d.SetLogLevel()
log.Info("Creating docker machine in Skytap")
log.Debugf("Skytap client auth: %+v", d.ClientCredentials)
client := *api.NewSkytapClientFromCredentials(d.ClientCredentials)
var env *api.Environment = nil
var err error = nil
if d.DeviceConfig.EnvironmentId == defaultEnvironmentId {
vm, err := api.GetVirtualMachine(client, d.DeviceConfig.SourceVMId)
if err != nil {
return err
}
template, err := vm.GetTemplate(client)
if err != nil {
return err
}
if template != nil {
env, err = api.CreateNewEnvironmentWithVms(client, template.Id, []string{vm.Id})
if err != nil {
return err
}
} else {
sourceEnv, err := vm.GetEnvironment(client)
if err != nil {
return err
}
if sourceEnv == nil {
return fmt.Errorf("VM not associated with template or environment, don't know how to build new environment with VM")
}
env, err = api.CopyEnvironmentWithVms(client, sourceEnv.Id, []string{vm.Id})
if err != nil {
return err
}
}
d.DeviceConfig.EnvironmentId = env.Id
env, err = env.WaitUntilReady(client)
if err != nil {
return err
}
} else {
env, err = api.GetEnvironment(client, d.DeviceConfig.EnvironmentId)
if err != nil {
return err
}
env, err = env.WaitUntilReady(client)
if err != nil {
return err
}
env, err = env.AddVirtualMachine(client, d.DeviceConfig.SourceVMId)
if err != nil {
return err
}
}
//TODO: Multiple networks?
vpnId := d.DeviceConfig.VPNId
if vpnId != "" {
attached := false
for _, network := range env.Networks {
// Look to see if there is an attached VPN that we simply need to connect
for _, attachment := range network.VpnAttachments {
if attachment.Vpn.Id == vpnId {
attached = true
if !attachment.Connected {
if err = network.ConnectToVpn(client, env.Id, vpnId); err != nil {
return err
}
}
break
}
}
}
if !attached {
_, err := env.Networks[0].AttachToVpn(client, env.Id, vpnId)
if err != nil {
return err
}
if err = env.Networks[0].ConnectToVpn(client, env.Id, vpnId); err != nil {
return err
}
}
env, err = env.WaitUntilReady(client)
if err != nil {
return err
}
}
sleepTime := 2 * time.Second
time.Sleep(sleepTime)
env, err = env.WaitUntilReady(client)
if err != nil {
return err
}
vm := env.Vms[len(env.Vms)-1]
vm, err = vm.WaitUntilReady(client)
if err != nil {
return err
}
// Rename interface to match name of machine from docker-machine's perspective.
log.Infof("Naming network interface")
_, err = vm.RenameNetworkInterface(client, env.Id, vm.Interfaces[0].Id, d.MachineName)
if err != nil {
sleepTime := 10 * time.Second
log.Infof("Got error renaming NIC, sleeping %s and trying again.", sleepTime)
time.Sleep(sleepTime)
vm, err = vm.WaitUntilReady(client)
if err != nil {
return err
}
_, err = vm.RenameNetworkInterface(client, env.Id, vm.Interfaces[0].Id, d.MachineName)
if err != nil {
log.Infof("Unable to rename NIC to '%s', check that name is not already in use by another VM.", d.MachineName)
return err
}
}
// Also set VM name to the docker-machine name
log.Infof("Naming VM")
vm, err = vm.SetName(client, d.MachineName)
if err != nil {
return err
}
// Change hardware options if requested
if d.HardwareConfig != nil {
log.Infof("Updating hardware")
vm, err = vm.UpdateHardware(client, *d.HardwareConfig, false)
if err != nil {
return err
}
}
// Mark as container host if requested
if d.ContainerHost == true {
log.Infof("Configuring VM as a container host")
vm, err = vm.SetContainerHost(client)
if err != nil {
return err
}
log.Infof("# To complete the configuration of this VM as a container host, wait for Docker Machine to finish")
log.Infof("# and then run the following commands to set the VM as the active machine and deploy the Skytap VM agent:")
log.Infof("# eval $(docker-machine env " + d.MachineName + ")")
log.Infof("# docker run -itd --name=skytap_agent --restart=always -v /var/run/docker.sock:/var/run/docker.sock skytap/agent")
}
// Just added a VM so pick the last one
log.Infof("Starting ...")
started, err := vm.Start(client)
if err != nil {
return err
}
renamed, err := started.WaitUntilReady(client)
if err != nil {
return err
}
d.Vm = *renamed
if err = d.refreshIpAddress(); err != nil {
return err
}
log.Infof("Generating SSH key and deploying")
err = d.GenerateSshKeyAndCopy()
if err != nil {
return err
}
return nil
}
func (d *Driver) refreshVm() error {
client := *api.NewSkytapClientFromCredentials(d.ClientCredentials)
vm, err := api.GetVirtualMachine(client, d.Vm.Id)
if err != nil {
return err
}
d.Vm = *vm
return nil
}
func (d *Driver) refreshIpAddress() error {
//TODO: What about multiple interfaces?
if d.DeviceConfig.VPNId != defaultVPNId {
var correctNat api.VpnNatAddress
for _, a := range d.Vm.Interfaces[0].NatAddresses.VpnNatAddresses {
if a.VpnId == d.DeviceConfig.VPNId {
correctNat = a
}
}
if correctNat.IpAddress == "" {
return errors.New(fmt.Sprintf("Unable to find network NAT address for correct VPN in VM %s", d.Vm.Id))
}
d.IPAddress = correctNat.IpAddress
} else {
d.IPAddress = d.Vm.Interfaces[0].Ip
}
return nil
}
/*
Generates a new SSH keypair, uses password auth to create the .ssh/authorized_keys file for later docker-machine access.
*/
func (d *Driver) GenerateSshKeyAndCopy() error {
d.SetLogLevel()
client := *api.NewSkytapClientFromCredentials(d.ClientCredentials)
creds, err := d.Vm.GetCredentials(client)
if err != nil {
return err
}
var foundCred *api.VmCredential
for _, c := range creds {
user, err := c.Username()
if err != nil {
return err
}
if user == d.SSHUser {
foundCred = &c
break
}
}
if foundCred == nil {
return fmt.Errorf("Virtual machine does not have credentials stored for specified SSH user %s", d.SSHUser)
}
password, err := foundCred.Password()
if err != nil {
return err
}
success := false
for i := 0; i < 5 && !success; i++ {
sleepTime := 10 * time.Second
log.Infof("Sleeping for %s, so that SSH services can come up properly", sleepTime)
time.Sleep(sleepTime)
err = d.DoSshCopy(client, password)
if err != nil {
log.Warnf("Error attempting to connect to SSH, will retry %d times: %s", 5-i, err)
} else {
success = true
}
}
if !success {
log.Infof("Unable to SSH to target machine to copy public key credentials after retries: %s", err)
return err
}
return nil
}
func (d *Driver) DoSshCopy(client api.SkytapClient, password string) error {
sshClient, err := ssh.Dial("tcp", fmt.Sprintf("%s:%d", d.IPAddress, d.SSHPort), &ssh.ClientConfig{
User: d.SSHUser,
Auth: []ssh.AuthMethod{
ssh.Password(password),
},
})
if err != nil {
log.Infof("Error connecting with password credentials: %s", err)
return err
}
if err = runRemoteBashCommand(sshClient, "mkdir -p ~/.ssh"); err != nil {
log.Infof("Error ensuring existence of ~/.ssh directory: %s", err)
return err
}
if err = dockerSsh.GenerateSSHKey(d.GetSSHKeyPath()); err != nil {
log.Infof("Error generating keypair locally: %s", err)
return err
}
scpSession, err := sshClient.NewSession()
if err != nil {
log.Infof("Error creating ssh copy session: %s", err)
return err
}
pubKeyFile := d.GetSSHKeyPath() + ".pub"
destFile := "docker-machine-id_rsa.pub"
if err = scp.CopyPath(pubKeyFile, destFile, scpSession); err != nil {
log.Infof("Error performing scp of public keyfile: %s", err)
return err
}
if err = runRemoteBashCommand(sshClient, fmt.Sprintf("chmod 700 ~/.ssh; cat %s >> ~/.ssh/authorized_keys; chmod 600 ~/.ssh/authorized_keys", destFile)); err != nil {
log.Infof("Error adding public key to ~/.ssh/authorized_keys: %s", err)
return err
}
return nil
}
func runRemoteBashCommand(sshClient *ssh.Client, cmd string) error {
session, err := sshClient.NewSession()
if err != nil {
return err
}
defer session.Close()
err = session.Run(cmd)
return err
}
// DriverName returns the name of the driver
func (d *Driver) DriverName() string {
return driverName
}
func (d *Driver) GetIP() (string, error) {
if d.IPAddress == "" {
return "", errors.New("No IP address available in Skytap driver")
}
log.Debugf("IP Address: %s", d.IPAddress)
return d.IPAddress, nil
}
func (d *Driver) GetSSHHostname() (string, error) {
return d.GetIP()
}
func (d *Driver) GetMachineName() string {
return d.MachineName
}
func (d *Driver) GetURL() (string, error) {
// Driver code will only get current state if we return a blank string here, so
// only return a valid URL if we believe we are running
if d.LastState == state.Running {
d.SetLogLevel()
d.refreshVm()
d.refreshIpAddress()
ip, err := d.GetIP()
if err != nil {
return "", err
}
if d.Vm.Runstate == api.RunStateStart {
return fmt.Sprintf("tcp://%s:2376", ip), nil
} else {
return "", nil
}
} else {
return "", nil
}
}
func (d *Driver) GetState() (state.State, error) {
d.SetLogLevel()
client := *api.NewSkytapClientFromCredentials(d.ClientCredentials)
vm, err := api.GetVirtualMachine(client, d.Vm.Id)
if err != nil {
return state.None, err
}
switch vm.Runstate {
case api.RunStateBusy:
d.LastState = state.None
return state.None, errors.New("VM is busy, wait and try again")
case api.RunStateStop:
d.LastState = state.Stopped
return state.Stopped, nil
case api.RunStateStart:
d.LastState = state.Running
return state.Running, nil
case api.RunStatePause:
d.LastState = state.Paused
return state.Paused, nil
default:
d.LastState = state.None
return state.None, errors.New("Unhandled VM state: " + vm.Runstate)
}
}
func (d *Driver) Kill() error {
d.SetLogLevel()
client := *api.NewSkytapClientFromCredentials(d.ClientCredentials)
_, err := d.Vm.Kill(client)
return err
}
func (d *Driver) Remove() error {
d.SetLogLevel()
client := *api.NewSkytapClientFromCredentials(d.ClientCredentials)
err := api.DeleteVirtualMachine(client, d.Vm.Id)
return err
}
func (d *Driver) Restart() error {
if err := d.Stop(); err != nil {
return err
}
return d.Start()
}
func (d *Driver) SetConfigFromFlags(flags drivers.DriverOptions) error {
user := flags.String("skytap-user-id")
key := flags.String("skytap-api-security-token")
d.ClientCredentials = api.SkytapCredentials{user, key}
d.SetSwarmConfigFromFlags(flags)
d.SSHUser = flags.String("skytap-ssh-user")
d.SSHPort = flags.Int("skytap-ssh-port")
envId := flags.String("skytap-env-id")
if envId == "" {
envId = defaultEnvironmentId
}
d.DeviceConfig = deviceConfig{
SourceVMId: flags.String("skytap-vm-id"),
EnvironmentId: envId,
VPNId: flags.String("skytap-vpn-id"),
}
d.ContainerHost = flags.Bool("skytap-container-host")
cpus := flags.Int("skytap-vm-cpus")
cpuspersocket := flags.Int("skytap-vm-cpuspersocket")
ram := flags.Int("skytap-vm-ram")
hc := api.Hardware{}
hasHardware := false
if cpus != defaultCPUs {
hasHardware = true
hc.Cpus = &cpus
}
if cpuspersocket != defaultCPUsPerSocket {
hasHardware = true
hc.CpusPerSocket = &cpuspersocket
}
if ram != defaultRAM {
hasHardware = true
hc.Ram = &ram
}
if hasHardware {
if hc.CpusPerSocket != nil {
if hc.Cpus != nil && *hc.CpusPerSocket != defaultCPUsPerSocket && *hc.Cpus%*hc.CpusPerSocket != 0 {
return fmt.Errorf("Specified CPUs (%d) must be a multiple of CPUs per socket (%d)", *hc.Cpus, *hc.CpusPerSocket)
} else if hc.Cpus == nil {
return fmt.Errorf("Specified CPUs per socket but not CPUs, you must specify CPUs in VM when using this option.")
}
}
d.HardwareConfig = &hc
}
if err := validateDeviceConfig(d.DeviceConfig); err != nil {
return err
}
log.Debugf("Skytap driver configuration: %+v", d)
logLvlStr := flags.String("skytap-api-logging-level")
logLevel, err := logrus.ParseLevel(logLvlStr)
if err != nil {
log.Infof("Unable to parse log level as specified '%s'", logLvlStr)
}
d.LogLevel = logLevel
d.SetLogLevel()
var validHostname = regexp.MustCompile(`^[a-z0-9\-]+$`)
if !validHostname.MatchString(d.MachineName) {
return fmt.Errorf("Invalid machine name '%s', must match regex ^[a-z0-9\\-]+$ in order to allow VM hostname to match machine name", d.MachineName)
}
return nil
}
func validateDeviceConfig(deviceConfig deviceConfig) error {
if deviceConfig.SourceVMId == "" {
return errors.New("No source VPN specified")
}
return nil
}
func (d *Driver) Start() error {
d.SetLogLevel()
client := *api.NewSkytapClientFromCredentials(d.ClientCredentials)
d.LastState = state.Starting
_, err := d.Vm.Start(client)
if err != nil {
d.LastState = state.Error
return err
}
d.LastState = state.Running
return nil
}
func (d *Driver) Stop() error {
d.SetLogLevel()
client := *api.NewSkytapClientFromCredentials(d.ClientCredentials)
d.LastState = state.Stopping
_, err := d.Vm.Stop(client)
if err != nil {
d.LastState = state.Error
return err
}
d.LastState = state.Stopped
return err
}
func (d *Driver) SetLogLevel() {
logrus.SetLevel(d.LogLevel)
}