Skip to content
Navigation Menu
{{ message }}
forked from gijzelaerr/python-docker-machine
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmachine.py
More file actions
385 lines (325 loc) · 10.9 KB
/
Copy pathmachine.py
File metadata and controls
385 lines (325 loc) · 10.9 KB
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
import re
from subprocess import Popen, PIPE
import json
from docker.tls import TLSConfig
from .helper import which
LS_FIELDS = ["Name", "Active", "ActiveHost", "ActiveSwarm", "DriverName", "State", "URL", "Swarm", "Error",
"DockerVersion", "ResponseTime"]
class Machine:
def __init__(self, path="docker-machine"):
"""
Args:
path (str): path to docker-machine binary
"""
where = which(path)
if not where:
raise RuntimeError("Cant find docker-machine binary (%s)" % path)
self.path = where
def _run(self, cmd, raise_error=True):
"""
Run a docker-machine command, optionally raise error if error code != 0
Args:
cmd (List[str]): a list of the docker-machine command with the arguments to run
raise_error (bool): raise an exception on non 0 return code
Returns:
tuple: stdout, stderr, error_code
"""
cmd = [self.path] + cmd
p = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
stdout, stderr = p.communicate()
error_code = p.returncode
if raise_error and error_code:
raise RuntimeError("cmd returned error %s: %s" % (error_code, stderr.decode('utf-8').strip()))
return stdout.decode('utf-8'), stderr.decode('utf-8'), error_code
def _run_blocking(self, cmd, raise_error=True):
"""
Run a docker-machine command, optionally raise error if error code != 0
Args:
cmd (List[str]): a list of the docker-machine command with the arguments to run
raise_error (bool): raise an exception on non 0 return code
Returns:
tuple: stdout, stderr, error_code
"""
cmd = [self.path] + cmd
p = Popen(cmd, stdin=PIPE, stdout=PIPE, stderr=PIPE)
stdout, stderr = p.communicate()
error_code = p.wait()
if raise_error and error_code:
raise RuntimeError("cmd returned error %s: %s" % (error_code, stderr.decode('utf-8').strip()))
return stdout.decode('utf-8'), stderr.decode('utf-8'), error_code
def _match(self, cmd, regexp):
"""
Run cmd and match regular expression regexp on it, return results.
Args:
cmd (List[str]): docker-machine command to run
regexp (str): regular expression to match with
Return:
bool or regexp match
"""
stdout, stderr, errorcode = self._run(cmd)
cleaned = stdout.strip()
match = re.match(regexp, cleaned)
if not match:
raise RuntimeError("can't parse output (\"%s\")" % cleaned)
return match
def version(self):
"""
Get the docker-machine binary version.
Returns:
str: the docker-machine binary version
"""
cmd = ["version"]
regexp = "docker-machine version (.+), build (.+)"
match = self._match(cmd, regexp)
return match.group(1)
def create(self, name, driver='virtualbox', blocking=True, xarg=None):
"""
Create a docker machine using the provided name and driver
NOTE: This takes a loooooong time
Args:
name (str): the name to give to the machine (must be unique)
driver: the driver to use to create the machine
blocking (bool): should wait for completion before exiting
Returns:
int: error code from the run
"""
if xarg is None:
xarg = []
cmd = ['create', '--driver', driver] + xarg + [name]
if blocking:
stdout, stderr, errorcode = self._run_blocking(cmd)
else:
stdout, stderr, errorcode = self._run(cmd)
return errorcode
def config(self, machine="default"):
"""
Returns the docker configuration for the given machine.
Args:
machine: The machine name
Returns:
dict: base_url, tls
"""
cmd = ["config", machine]
regexp = """(--tlsverify\n)?--tlscacert="(.+)"\n--tlscert="(.+)"\n--tlskey="(.+)"\n-H=(.+)"""
match = self._match(cmd, regexp)
tlsverify, tlscacert, tlscert, tlskey, host = match.group(1, 2, 3, 4, 5)
tlsverify = bool(tlsverify)
params = {
'base_url': host.replace('tcp://', 'https://') if tlsverify else host,
'tls': TLSConfig(
client_cert=(tlscert, tlskey),
ca_cert=tlscacert,
verify=True
)
}
return params
def ls(self):
"""
List machines.
Returns:
list: of machines
"""
seperator = "\t"
fields = seperator.join(["{{.%s}}" % i for i in LS_FIELDS])
cmd = ["ls", "-f", fields]
stdout, stderr, errorcode = self._run(cmd)
machines = []
for line in stdout.strip().split("\n"):
if line:
machine = {LS_FIELDS[index]: value for index, value in enumerate(line.split(seperator))}
machines.append(machine)
return machines
def exists(self, machine="default"):
"""
Checks if machine exists.
Args:
machine (str): name of the machine
Returns:
bool
"""
cmd = ["ls", "--filter", "NAME=" + machine, "--format", "{{.Name}}"]
stdout, _, _ = self._run(cmd)
for line in stdout.split():
if line == machine:
return True
return False
def status(self, machine="default"):
"""
Get the status for the machine.
Args:
machine (str): the name of the machine
Returns:
bool: status of machine
"""
cmd = ["status", machine]
stdout, _, _ = self._run(cmd)
return stdout.strip() == "Running"
def stop(self, machine="default"):
"""
Stop the specified machine.
Args:
machine (str): the name of the machine
"""
cmd = ["stop", machine]
self._run(cmd)
return True
def start(self, machine="default"):
"""
Start the specified machine.
Args:
machine (str): the name of the machine
Returns:
bool: True if successful
"""
cmd = ["start", machine]
self._run(cmd)
return True
def provision(self, machine="default"):
"""
Provision the specified machine.
Args:
machine (str): the name of the machine
Returns:
bool: True if successful
"""
cmd = ["provision", machine]
self._run(cmd)
return True
def regenerate_certs(self, machine="default"):
"""
Regenerate certificats for the specified machine.
Args:
machine (str): the name of the machine
Returns:
bool: True if successful
"""
cmd = ["regenerate-certs", "--force", machine]
self._run(cmd)
return True
def rm(self, machine="default", force=False):
"""
Remove the specified machine.
Args:
machine (str): the name of the machine
force (bool): Remove local configuration even if machine cannot be removed
Returns:
bool: True if successful
"""
f = ["-f"] if force else []
cmd = ["rm", "-y"] + f + [machine]
self._run(cmd)
return True
def env(self, machine="default"):
"""
Get the environment variables to configure docker to connect to the specified docker machine.
Args:
machine (str): the name of the machine
Returns:
str: A set of environment variables
"""
cmd = ["env", machine]
stdout, _, _ = self._run(cmd)
return stdout.split()
def inspect(self, machine="default"):
"""
Inspect information about a machine.
Args:
machine (str): the name of the machine
Returns:
dict: A nested dicht with inspect information about the machine.
"""
cmd = ["inspect", machine]
stdout, _, _ = self._run(cmd)
return json.loads(stdout)
def ip(self, machine="default"):
"""
Get the IP address of a machine.
Args:
machine (str): the name of the machine
Returns:
str: the IP address of a machine.
"""
cmd = ["ip", machine]
stdout, _, _ = self._run(cmd)
return stdout.strip()
def kill(self, machine="default"):
"""
Kill a machine
Args:
machine (str): the name of the machine
Returns:
bool: True if successful
"""
cmd = ["kill", machine]
self._run(cmd)
return True
def restart(self, machine="default"):
"""
Restart a machine
Args:
machine (str): the name of the machine
Returns:
bool: True if successful
"""
cmd = ["restart", machine]
self._run(cmd)
return True
def upgrade(self, machine="default"):
"""
Upgrade a machine
Args:
machine (str): the name of the machine
Returns:
bool: True if successful
"""
cmd = ["upgrade", machine]
self._run(cmd)
return True
def url(self, machine="default"):
"""
Get the URL of a machine
Args:
machine (str): the name of the machine
Returns:
str: the URL of a machine
"""
cmd = ["url", machine]
stdout, _, _ = self._run(cmd)
return stdout.strip()
def active(self):
"""
Print which machine is active
Returns:
List[str]: a list of machines that are active
"""
cmd = ["active"]
stdout, stderr, error_code = self._run(cmd, raise_error=False)
if error_code == 1 and stderr.strip() == "No active host found":
return None
return stdout.strip()
def scp(self, source, destination, recursive=False):
"""
Copy files between machines
Args:
source (str): [machine:][path]
destination (str): [machine:][path]
recursive (bool): Copy files recursively (required to copy directories)
Returns:
List[str}: output of the scp command
"""
r = ["-r"] if recursive else []
cmd = ["scp"] + r + [source, destination]
stdout, _, _ = self._run(cmd)
return stdout.split()
def ssh(self, machine, cmd):
"""
Run a command on a machine through docker-machine ssh
Args:
machine (str): machine name
cmd (str): command to run
Returns:
List[str]: output of the ssh command
"""
ssh_cmd = ['ssh', machine, cmd]
stdout, _, _ = self._run(ssh_cmd)
return stdout.split()
You can’t perform that action at this time.