-
-
Notifications
You must be signed in to change notification settings - Fork 363
/
deployment.py
1103 lines (881 loc) · 45.3 KB
/
deployment.py
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
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
import sys
import os.path
import subprocess
import json
import string
import tempfile
import shutil
import threading
import exceptions
import errno
from collections import defaultdict
from xml.etree import ElementTree
import nixops.statefile
import nixops.backends
import nixops.logger
import nixops.parallel
import nixops.resources.ssh_keypair
import nixops.resources.ec2_keypair
import nixops.resources.sqs_queue
import nixops.resources.iam_role
import nixops.resources.s3_bucket
import nixops.resources.ec2_security_group
import nixops.resources.ebs_volume
import nixops.resources.elastic_ip
from nixops.nix_expr import RawValue, Function, nixmerge, py2nix
import re
from datetime import datetime
import getpass
import traceback
import glob
import fcntl
import itertools
import platform
class NixEvalError(Exception):
pass
class UnknownBackend(Exception):
pass
debug = False
class Deployment(object):
"""NixOps top-level deployment manager."""
default_description = "Unnamed NixOps network"
name = nixops.util.attr_property("name", None)
nix_exprs = nixops.util.attr_property("nixExprs", [], 'json')
nix_path = nixops.util.attr_property("nixPath", [], 'json')
args = nixops.util.attr_property("args", {}, 'json')
description = nixops.util.attr_property("description", default_description)
configs_path = nixops.util.attr_property("configsPath", None)
rollback_enabled = nixops.util.attr_property("rollbackEnabled", False)
def __init__(self, statefile, uuid, log_file=sys.stderr):
self._statefile = statefile
self._db = statefile._db
self.uuid = uuid
self._last_log_prefix = None
self.extra_nix_path = []
self.extra_nix_flags = []
self.extra_nix_eval_flags = []
self.nixos_version_suffix = None
self.logger = nixops.logger.Logger(log_file)
self._lock_file_path = None
self.expr_path = os.path.realpath(os.path.dirname(__file__) + "/../../../../share/nix/nixops")
if not os.path.exists(self.expr_path):
self.expr_path = os.path.realpath(os.path.dirname(__file__) + "/../../../../../share/nix/nixops")
if not os.path.exists(self.expr_path):
self.expr_path = os.path.dirname(__file__) + "/../nix"
self.tempdir = nixops.util.SelfDeletingDir(tempfile.mkdtemp(prefix="nixops-tmp"))
self.resources = {}
with self._db:
c = self._db.cursor()
c.execute("select id, name, type from Resources where deployment = ?", (self.uuid,))
for (id, name, type) in c.fetchall():
r = nixops.backends.create_state(self, type, name, id)
self.resources[name] = r
self.logger.update_log_prefixes()
self.definitions = None
@property
def machines(self):
return {n: r for n, r in self.resources.items() if is_machine(r)}
@property
def active(self): # FIXME: rename to "active_machines"
return {n: r for n, r in self.resources.items() if is_machine(r) and not r.obsolete}
@property
def active_resources(self):
return {n: r for n, r in self.resources.items() if not r.obsolete}
def get_typed_resource(self, name, type):
res = self.active_resources.get(name, None)
if not res:
raise Exception("resource ‘{0}’ does not exist".format(name))
if res.get_type() != type:
raise Exception("resource ‘{0}’ is not of type ‘{1}’".format(name, type))
return res
def _set_attrs(self, attrs):
"""Update deployment attributes in the state file."""
with self._db:
c = self._db.cursor()
for n, v in attrs.iteritems():
if v == None:
c.execute("delete from DeploymentAttrs where deployment = ? and name = ?", (self.uuid, n))
else:
c.execute("insert or replace into DeploymentAttrs(deployment, name, value) values (?, ?, ?)",
(self.uuid, n, v))
def _set_attr(self, name, value):
"""Update one deployment attribute in the state file."""
self._set_attrs({name: value})
def _del_attr(self, name):
"""Delete a deployment attribute from the state file."""
with self._db:
self._db.execute("delete from DeploymentAttrs where deployment = ? and name = ?", (self.uuid, name))
def _get_attr(self, name, default=nixops.util.undefined):
"""Get a deployment attribute from the state file."""
with self._db:
c = self._db.cursor()
c.execute("select value from DeploymentAttrs where deployment = ? and name = ?", (self.uuid, name))
row = c.fetchone()
if row != None: return row[0]
return nixops.util.undefined
def _create_resource(self, name, type):
c = self._db.cursor()
c.execute("select 1 from Resources where deployment = ? and name = ?", (self.uuid, name))
if len(c.fetchall()) != 0:
raise Exception("resource already exists in database!")
c.execute("insert into Resources(deployment, name, type) values (?, ?, ?)",
(self.uuid, name, type))
id = c.lastrowid
r = nixops.backends.create_state(self, type, name, id)
self.resources[name] = r
return r
def export(self):
with self._db:
c = self._db.cursor()
c.execute("select name, value from DeploymentAttrs where deployment = ?", (self.uuid,))
rows = c.fetchall()
res = {row[0]: row[1] for row in rows}
res['resources'] = {r.name: r.export() for r in self.resources.itervalues()}
return res
def import_(self, attrs):
with self._db:
for k, v in attrs.iteritems():
if k == 'resources': continue
self._set_attr(k, v)
for k, v in attrs['resources'].iteritems():
if 'type' not in v: raise Exception("imported resource lacks a type")
r = self._create_resource(k, v['type'])
r.import_(v)
def clone(self):
with self._db:
new = self._statefile.create_deployment()
self._db.execute("insert into DeploymentAttrs (deployment, name, value) " +
"select ?, name, value from DeploymentAttrs where deployment = ?",
(new.uuid, self.uuid))
new.configs_path = None
return new
def _get_deployment_lock(self):
if self._lock_file_path is None:
lock_dir = os.environ.get("HOME", "") + "/.nixops/locks"
if not os.path.exists(lock_dir): os.makedirs(lock_dir, 0700)
self._lock_file_path = lock_dir + "/" + self.uuid
class DeploymentLock(object):
def __init__(self, depl):
self._lock_file_path = depl._lock_file_path
self._logger = depl.logger
self._lock_file = None
def __enter__(self):
self._lock_file = open(self._lock_file_path, "w")
fcntl.fcntl(self._lock_file, fcntl.F_SETFD, fcntl.FD_CLOEXEC)
try:
fcntl.flock(self._lock_file, fcntl.LOCK_EX | fcntl.LOCK_NB)
except IOError:
self._logger.log(
"waiting for exclusive deployment lock..."
)
fcntl.flock(self._lock_file, fcntl.LOCK_EX)
def __exit__(self, exception_type, exception_value, exception_traceback):
self._lock_file.close()
return DeploymentLock(self)
def delete_resource(self, m):
del self.resources[m.name]
with self._db:
self._db.execute("delete from Resources where deployment = ? and id = ?", (self.uuid, m.id))
def delete(self, force=False):
"""Delete this deployment from the state file."""
with self._db:
if not force and len(self.resources) > 0:
raise Exception("cannot delete this deployment because it still has resources")
# Delete the profile, if any.
profile = self.get_profile()
assert profile
for p in glob.glob(profile + "*"):
if os.path.islink(p): os.remove(p)
# Delete the deployment from the database.
self._db.execute("delete from Deployments where uuid = ?", (self.uuid,))
def _nix_path_flags(self):
flags = list(itertools.chain(*[["-I", x] for x in (self.extra_nix_path + self.nix_path)])) + self.extra_nix_flags
flags.extend(["-I", "nixops=" + self.expr_path])
return flags
def _eval_flags(self, exprs):
flags = self._nix_path_flags()
args = {key: RawValue(val) for key, val in self.args.iteritems()}
flags.extend(
["--arg", "networkExprs", py2nix(exprs, inline=True),
"--arg", "args", py2nix(args, inline=True),
"--argstr", "uuid", self.uuid,
"<nixops/eval-machine-info.nix>"])
return flags
def set_arg(self, name, value):
"""Set a persistent argument to the deployment specification."""
assert isinstance(name, basestring)
assert isinstance(value, basestring)
args = self.args
args[name] = value
self.args = args
def set_argstr(self, name, value):
"""Set a persistent argument to the deployment specification."""
assert isinstance(value, basestring)
self.set_arg(name, py2nix(value, inline=True))
def unset_arg(self, name):
"""Unset a persistent argument to the deployment specification."""
assert isinstance(name, str)
args = self.args
args.pop(name, None)
self.args = args
def evaluate(self):
"""Evaluate the Nix expressions belonging to this deployment into a deployment specification."""
self.definitions = {}
try:
xml = subprocess.check_output(
["nix-instantiate"]
+ self.extra_nix_eval_flags
+ self._eval_flags(self.nix_exprs) +
["--eval-only", "--xml", "--strict",
"--arg", "checkConfigurationOptions", "false",
"-A", "info"], stderr=self.logger.log_file)
if debug: print >> sys.stderr, "XML output of nix-instantiate:\n" + xml
except subprocess.CalledProcessError:
raise NixEvalError
tree = ElementTree.fromstring(xml)
# Extract global deployment attributes.
info = tree.find("attrs/attr[@name='network']")
assert info != None
elem = info.find("attrs/attr[@name='description']/string")
self.description = elem.get("value") if elem != None else self.default_description
elem = info.find("attrs/attr[@name='enableRollback']/bool")
self.rollback_enabled = elem != None and elem.get("value") == "true"
# Extract machine information.
for x in tree.find("attrs/attr[@name='machines']/attrs").findall("attr"):
defn = nixops.backends.create_definition(x)
self.definitions[defn.name] = defn
# Extract info about other kinds of resources.
res = tree.find("attrs/attr[@name='resources']/attrs")
for x in res.find("attr[@name='ec2KeyPairs']/attrs").findall("attr"):
defn = nixops.resources.ec2_keypair.EC2KeyPairDefinition(x)
self.definitions[defn.name] = defn
for x in res.find("attr[@name='sshKeyPairs']/attrs").findall("attr"):
defn = nixops.resources.ssh_keypair.SSHKeyPairDefinition(x)
self.definitions[defn.name] = defn
for x in res.find("attr[@name='sqsQueues']/attrs").findall("attr"):
defn = nixops.resources.sqs_queue.SQSQueueDefinition(x)
self.definitions[defn.name] = defn
for x in res.find("attr[@name='iamRoles']/attrs").findall("attr"):
defn = nixops.resources.iam_role.IAMRoleDefinition(x)
self.definitions[defn.name] = defn
for x in res.find("attr[@name='s3Buckets']/attrs").findall("attr"):
defn = nixops.resources.s3_bucket.S3BucketDefinition(x)
self.definitions[defn.name] = defn
for x in res.find("attr[@name='ec2SecurityGroups']/attrs").findall("attr"):
defn = nixops.resources.ec2_security_group.EC2SecurityGroupDefinition(x)
self.definitions[defn.name] = defn
for x in res.find("attr[@name='ebsVolumes']/attrs").findall("attr"):
defn = nixops.resources.ebs_volume.EBSVolumeDefinition(x)
self.definitions[defn.name] = defn
for x in res.find("attr[@name='elasticIPs']/attrs").findall("attr"):
defn = nixops.resources.elastic_ip.ElasticIPDefinition(x)
self.definitions[defn.name] = defn
def evaluate_option_value(self, machine_name, option_name, xml=False, include_physical=False):
"""Evaluate a single option of a single machine in the deployment specification."""
exprs = self.nix_exprs
if include_physical:
phys_expr = self.tempdir + "/physical.nix"
with open(phys_expr, 'w') as f:
f.write(self.get_physical_spec())
exprs.append(phys_expr)
try:
return subprocess.check_output(
["nix-instantiate"]
+ self.extra_nix_eval_flags
+ self._eval_flags(exprs) +
["--eval-only", "--strict",
"--arg", "checkConfigurationOptions", "false",
"-A", "nodes.{0}.config.{1}".format(machine_name, option_name)]
+ (["--xml"] if xml else []),
stderr=self.logger.log_file)
except subprocess.CalledProcessError:
raise NixEvalError
def get_physical_spec(self):
"""Compute the contents of the Nix expression specifying the computed physical deployment attributes"""
active_machines = self.active
active_resources = self.active_resources
attrs_per_resource = {m.name: [] for m in active_resources.itervalues()}
authorized_keys = {m.name: [] for m in active_machines.itervalues()}
kernel_modules = {m.name: set() for m in active_machines.itervalues()}
trusted_interfaces = {m.name: set() for m in active_machines.itervalues()}
# Hostnames should be accumulated like this:
#
# hosts[local_name][remote_ip] = [name1, name2, ...]
#
# This makes hosts deterministic and is more in accordance to the
# format in hosts(5), which is like this:
#
# ip_address canonical_hostname [aliases...]
#
# This is critical for example when using host names for access
# control, because the canonical_hostname is returned in reverse
# lookups.
hosts = defaultdict(lambda: defaultdict(list))
for m in active_machines.itervalues():
for m2 in active_machines.itervalues():
ip = m.address_to(m2)
if ip:
hosts[m.name][ip] += [m2.name, m2.name + "-unencrypted"]
# Always use the encrypted/unencrypted suffixes for aliases rather
# than for the canonical name!
hosts[m.name]["127.0.0.1"].append(m.name + "-encrypted")
def index_to_private_ip(index):
n = 105 + index / 256
assert n <= 255
return "192.168.{0}.{1}".format(n, index % 256)
def do_machine(m):
defn = self.definitions[m.name]
attrs_list = attrs_per_resource[m.name]
# Emit configuration to realise encrypted peer-to-peer links.
for m2_name in defn.encrypted_links_to:
if m2_name not in active_machines:
raise Exception("‘deployment.encryptedLinksTo’ in machine ‘{0}’ refers to an unknown machine ‘{1}’"
.format(m.name, m2_name))
m2 = active_machines[m2_name]
# Don't create two tunnels between a pair of machines.
if m.name in self.definitions[m2.name].encrypted_links_to and m.name >= m2.name:
continue
local_ipv4 = index_to_private_ip(m.index)
remote_ipv4 = index_to_private_ip(m2.index)
local_tunnel = 10000 + m2.index
remote_tunnel = 10000 + m.index
attrs_list.append({
('networking', 'p2pTunnels', 'ssh', m2.name): {
'target': '{0}-unencrypted'.format(m2.name),
'localTunnel': local_tunnel,
'remoteTunnel': remote_tunnel,
'localIPv4': local_ipv4,
'remoteIPv4': remote_ipv4,
'privateKey': '/root/.ssh/id_charon_vpn',
}
})
# FIXME: set up the authorized_key file such that ‘m’
# can do nothing more than create a tunnel.
authorized_keys[m2.name].append(m.public_vpn_key)
kernel_modules[m.name].add('tun')
kernel_modules[m2.name].add('tun')
hosts[m.name][remote_ipv4] += [m2.name, m2.name + "-encrypted"]
hosts[m2.name][local_ipv4] += [m.name, m.name + "-encrypted"]
trusted_interfaces[m.name].add('tun' + str(local_tunnel))
trusted_interfaces[m2.name].add('tun' + str(remote_tunnel))
private_ipv4 = m.private_ipv4
if private_ipv4:
attrs_list.append({
('networking', 'privateIPv4'): private_ipv4
})
public_ipv4 = m.public_ipv4
if public_ipv4:
attrs_list.append({
('networking', 'publicIPv4'): public_ipv4
})
if self.nixos_version_suffix:
attrs_list.append({
('system', 'nixosVersionSuffix'): self.nixos_version_suffix
})
for m in active_machines.itervalues():
do_machine(m)
def emit_resource(r):
config = []
config.extend(attrs_per_resource[r.name])
if is_machine(r):
# Sort the hosts by its canonical host names.
sorted_hosts = sorted(hosts[r.name].iteritems(),
key=lambda item: item[1][0])
# Just to remember the format:
# ip_address canonical_hostname [aliases...]
extra_hosts = ["{0} {1}".format(ip, ' '.join(names))
for ip, names in sorted_hosts]
if authorized_keys[r.name]:
config.append({
('users', 'extraUsers', 'root'): {
('openssh', 'authorizedKeys', 'keys'): authorized_keys[r.name]
},
('services', 'openssh'): {
'extraConfig': "PermitTunnel yes\n"
},
})
config.append({
('boot', 'kernelModules'): list(kernel_modules[r.name]),
('networking', 'firewall'): {
'trustedInterfaces': list(trusted_interfaces[r.name])
},
('networking', 'extraHosts'): '\n'.join(extra_hosts) + "\n"
})
# Add SSH public host keys for all machines in network
for m2 in active_machines.itervalues():
if hasattr(m2, 'public_host_key') and m2.public_host_key:
# Using references to files in same tempdir for now, until NixOS has support
# for adding the keys directly as string. This way at least it is compatible
# with older versions of NixOS as well.
# TODO: after reasonable amount of time replace with string option
config.append({
('services', 'openssh', 'knownHosts', m2.name): {
'hostNames': [m2.name + "-unencrypted",
m2.name + "-encrypted",
m2.name],
'publicKeyFile': RawValue(
"./{0}.public_host_key".format(m2.name)
),
}
})
merged = reduce(nixmerge, config) if len(config) > 0 else {}
physical = r.get_physical_spec()
if len(merged) == 0 and len(physical) == 0:
return {}
else:
return r.prefix_definition({
r.name: Function("{ config, pkgs, ... }", {
'config': merged,
'imports': [physical],
})
})
return py2nix(reduce(nixmerge, [
emit_resource(r) for r in active_resources.itervalues()
])) + "\n"
def get_profile(self):
profile_dir = "/nix/var/nix/profiles/per-user/" + getpass.getuser()
if os.path.exists(profile_dir + "/charon") and not os.path.exists(profile_dir + "/nixops"):
os.rename(profile_dir + "/charon", profile_dir + "/nixops")
return profile_dir + "/nixops/" + self.uuid
def create_profile(self):
profile = self.get_profile()
dir = os.path.dirname(profile)
if not os.path.exists(dir): os.makedirs(dir, 0755)
return profile
def build_configs(self, include, exclude, dry_run=False, repair=False):
"""Build the machine configurations in the Nix store."""
def write_temp_file(tmpfile, contents):
f = open(tmpfile, "w")
f.write(contents)
f.close()
self.logger.log("building all machine configurations...")
# Set the NixOS version suffix, if we're building from Git.
# That way ‘nixos-version’ will show something useful on the
# target machines.
nixos_path = subprocess.check_output(
["nix-instantiate", "--find-file", "nixos"] + self._nix_path_flags()).rstrip()
get_version_script = nixos_path + "/modules/installer/tools/get-version-suffix"
if os.path.exists(nixos_path + "/.git") and os.path.exists(get_version_script):
self.nixos_version_suffix = subprocess.check_output(["/bin/sh", get_version_script] + self._nix_path_flags()).rstrip()
phys_expr = self.tempdir + "/physical.nix"
p = self.get_physical_spec()
write_temp_file(phys_expr, p)
if debug: print >> sys.stderr, "generated physical spec:\n" + p
for m in self.active.itervalues():
if hasattr(m, "public_host_key") and m.public_host_key: # FIXME: use a method in MachineState.
write_temp_file("{0}/{1}.public_host_key".format(self.tempdir, m.name), m.public_host_key + "\n")
selected = [m for m in self.active.itervalues() if should_do(m, include, exclude)]
names = map(lambda m: m.name, selected)
# If we're not running on Linux, then perform the build on the
# target machines. FIXME: Also enable this if we're on 32-bit
# and want to deploy to 64-bit.
if platform.system() != 'Linux' and os.environ.get('NIX_REMOTE') != 'daemon':
remote_machines = []
for m in sorted(selected, key=lambda m: m.index):
key_file = m.get_ssh_private_key_file()
if not key_file: raise Exception("do not know private SSH key for machine ‘{0}’".format(m.name))
# FIXME: Figure out the correct machine type of ‘m’ (it might not be x86_64-linux).
remote_machines.append("root@{0} {1} {2} 2 1\n".format(m.get_ssh_name(), 'i686-linux,x86_64-linux', key_file))
# Use only a single machine for now (issue #103).
break
remote_machines_file = "{0}/nix.machines".format(self.tempdir)
with open(remote_machines_file, "w") as f:
f.write("".join(remote_machines))
os.environ['NIX_REMOTE_SYSTEMS'] = remote_machines_file
# FIXME: Use ‘--option use-build-hook true’ instead of setting
# $NIX_BUILD_HOOK, once Nix supports that.
os.environ['NIX_BUILD_HOOK'] = os.path.dirname(os.path.realpath(nixops.util.which("nix-build"))) + "/../libexec/nix/build-remote.pl"
load_dir = "{0}/current-load".format(self.tempdir)
if not os.path.exists(load_dir): os.makedirs(load_dir, 0700)
os.environ['NIX_CURRENT_LOAD'] = load_dir
try:
configs_path = subprocess.check_output(
["nix-build"]
+ self._eval_flags(self.nix_exprs + [phys_expr]) +
["--arg", "names", py2nix(names, inline=True),
"-A", "machines", "-o", self.tempdir + "/configs"]
+ (["--dry-run"] if dry_run else [])
+ (["--repair"] if repair else []),
stderr=self.logger.log_file).rstrip()
except subprocess.CalledProcessError:
raise Exception("unable to build all machine configurations")
if self.rollback_enabled:
profile = self.create_profile()
if subprocess.call(["nix-env", "-p", profile, "--set", configs_path]) != 0:
raise Exception("cannot update profile ‘{0}’".format(profile))
return configs_path
def copy_closures(self, configs_path, include, exclude, max_concurrent_copy):
"""Copy the closure of each machine configuration to the corresponding machine."""
def worker(m):
if not should_do(m, include, exclude): return
m.logger.log("copying closure...")
m.new_toplevel = os.path.realpath(configs_path + "/" + m.name)
if not os.path.exists(m.new_toplevel):
raise Exception("can't find closure of machine ‘{0}’".format(m.name))
m.copy_closure_to(m.new_toplevel)
nixops.parallel.run_tasks(
nr_workers=max_concurrent_copy,
tasks=self.active.itervalues(), worker_fun=worker)
def activate_configs(self, configs_path, include, exclude, allow_reboot,
force_reboot, check, sync, always_activate):
"""Activate the new configuration on a machine."""
def worker(m):
if not should_do(m, include, exclude): return
try:
# Set the system profile to the new configuration.
setprof = 'nix-env -p /nix/var/nix/profiles/system --set "{0}"'
if always_activate or self.definitions[m.name].always_activate:
m.run_command(setprof.format(m.new_toplevel))
else:
# Only activate if the profile has changed.
new_profile_cmd = '; '.join([
'old_gen="$(readlink -f /nix/var/nix/profiles/system)"',
'new_gen="$(readlink -f "{0}")"',
'[ "x$old_gen" != "x$new_gen" ] || exit 111',
setprof
]).format(m.new_toplevel)
ret = m.run_command(new_profile_cmd, check=False)
if ret == 111:
m.log("configuration already up to date")
return
elif ret != 0:
raise Exception("unable to set new system profile")
m.send_keys()
if force_reboot or m.state == m.RESCUE:
switch_method = "boot"
else:
switch_method = "switch"
# Run the switch script. This will also update the
# GRUB boot loader.
res = m.switch_to_configuration(switch_method, sync)
if res != 0 and res != 100:
raise Exception("unable to activate new configuration")
if res == 100 or force_reboot or m.state == m.RESCUE:
if not allow_reboot and not force_reboot:
raise Exception("the new configuration requires a "
"reboot to take effect (hint: use "
"‘--allow-reboot’)".format(m.name))
m.reboot_sync()
res = 0
# FIXME: should check which systemd services
# failed to start after the reboot.
if res == 0:
m.success("activation finished successfully")
# Record that we switched this machine to the new
# configuration.
m.cur_configs_path = configs_path
m.cur_toplevel = m.new_toplevel
except Exception as e:
# This thread shouldn't throw an exception because
# that will cause NixOps to exit and interrupt
# activation on the other machines.
m.logger.error(traceback.format_exc() if debug else str(e))
return m.name
return None
res = nixops.parallel.run_tasks(nr_workers=-1, tasks=self.active.itervalues(), worker_fun=worker)
failed = [x for x in res if x != None]
if failed != []:
raise Exception("activation of {0} of {1} machines failed (namely on {2})"
.format(len(failed), len(res), ", ".join(["‘{0}’".format(x) for x in failed])))
def _get_free_resource_index(self):
index = 0
for r in self.resources.itervalues():
if r.index != None and index <= r.index:
index = r.index + 1
return index
def get_backups(self, include=[], exclude=[]):
self.evaluate_active(include, exclude) # unnecessary?
machine_backups = {}
for m in self.active.itervalues():
if should_do(m, include, exclude):
machine_backups[m.name] = m.get_backups()
# merging machine backups into network backups
backup_ids = [b for bs in machine_backups.values() for b in bs.keys()]
backups = {}
for backup_id in backup_ids:
backups[backup_id] = {}
backups[backup_id]['machines'] = {}
backups[backup_id]['info'] = []
backups[backup_id]['status'] = 'complete'
backup = backups[backup_id]
for m in self.active.itervalues():
if should_do(m, include, exclude):
if backup_id in machine_backups[m.name].keys():
backup['machines'][m.name] = machine_backups[m.name][backup_id]
backup['info'].extend(backup['machines'][m.name]['info'])
# status is always running when one of the backups is still running
if backup['machines'][m.name]['status'] != "complete" and backup['status'] != "running":
backup['status'] = backup['machines'][m.name]['status']
else:
backup['status'] = 'incomplete'
backup['info'].extend(["No backup available for {0}".format(m.name)]);
return backups
def clean_backups(self, keep=10):
_backups = self.get_backups()
backup_ids = [b for b in _backups.keys()]
backup_ids.sort()
index = len(backup_ids)-keep
for backup_id in backup_ids[:index]:
print 'Removing backup {0}'.format(backup_id)
self.remove_backup(backup_id)
def remove_backup(self, backup_id):
with self._get_deployment_lock():
def worker(m):
m.remove_backup(backup_id)
nixops.parallel.run_tasks(nr_workers=len(self.active), tasks=self.machines.itervalues(), worker_fun=worker)
def backup(self, include=[], exclude=[]):
self.evaluate_active(include, exclude) # unnecessary?
backup_id = datetime.now().strftime("%Y%m%d%H%M%S");
def worker(m):
if not should_do(m, include, exclude): return
ssh_name = m.get_ssh_name()
res = subprocess.call(["ssh", "root@" + ssh_name] + m.get_ssh_flags() + ["sync"])
if res != 0:
m.logger.log("Running sync failed on {0}.".format(m.name))
m.backup(self.definitions[m.name], backup_id)
nixops.parallel.run_tasks(nr_workers=5, tasks=self.active.itervalues(), worker_fun=worker)
return backup_id
def restore(self, include=[], exclude=[], backup_id=None, devices=[]):
with self._get_deployment_lock():
self.evaluate_active(include, exclude)
def worker(m):
if not should_do(m, include, exclude): return
m.restore(self.definitions[m.name], backup_id, devices)
nixops.parallel.run_tasks(nr_workers=-1, tasks=self.active.itervalues(), worker_fun=worker)
self.start_machines(include=include, exclude=exclude)
self.logger.warn("restore finished; please note that you might need to run ‘nixops deploy’ to fix configuration issues regarding changed IP addresses")
def evaluate_active(self, include=[], exclude=[], kill_obsolete=False):
self.evaluate()
# Create state objects for all defined resources.
with self._db:
for m in self.definitions.itervalues():
if m.name not in self.resources:
self._create_resource(m.name, m.get_type())
self.logger.update_log_prefixes()
# Determine the set of active resources. (We can't just
# delete obsolete resources from ‘self.resources’ because they
# contain important state that we don't want to forget about.)
for m in self.resources.values():
if m.name in self.definitions:
if m.obsolete:
self.logger.log("resource ‘{0}’ is no longer obsolete".format(m.name))
m.obsolete = False
else:
self.logger.log("resource ‘{0}’ is obsolete".format(m.name))
if not m.obsolete: m.obsolete = True
if not should_do(m, include, exclude): continue
if kill_obsolete and m.destroy(): self.delete_resource(m)
def _deploy(self, dry_run=False, build_only=False, create_only=False, copy_only=False,
include=[], exclude=[], check=False, kill_obsolete=False,
allow_reboot=False, allow_recreate=False, force_reboot=False,
max_concurrent_copy=5, sync=True, always_activate=False, repair=False):
"""Perform the deployment defined by the deployment specification."""
self.evaluate_active(include, exclude, kill_obsolete)
# Assign each resource an index if it doesn't have one.
for r in self.active_resources.itervalues():
if r.index == None:
r.index = self._get_free_resource_index()
# FIXME: Logger should be able to do coloring without the need
# for an index maybe?
r.logger.register_index(r.index)
self.logger.update_log_prefixes()
# Start or update the active resources. Non-machine resources
# are created first, because machines may depend on them
# (e.g. EC2 machines depend on EC2 key pairs or EBS volumes).
# FIXME: would be nice to have a more fine-grained topological
# sort.
if not dry_run and not build_only:
for r in self.active_resources.itervalues():
defn = self.definitions[r.name]
if r.get_type() != defn.get_type():
raise Exception("the type of resource ‘{0}’ changed from ‘{1}’ to ‘{2}’, which is currently unsupported"
.format(r.name, r.get_type(), defn.get_type()))
r._created_event = threading.Event()
r._errored = False
def worker(r):
try:
if not should_do(r, include, exclude): return
# Sleep until all dependencies of this resource have
# been created.
deps = r.create_after(self.active_resources.itervalues())
for dep in deps:
dep._created_event.wait()
# !!! Should we print a message here?
if dep._errored:
r._errored = True
return
# Now create the resource itself.
r.create(self.definitions[r.name], check=check, allow_reboot=allow_reboot, allow_recreate=allow_recreate)
if is_machine(r):
r.wait_for_ssh(check=check)
r.generate_vpn_key()
except:
r._errored = True
raise
finally:
r._created_event.set()
nixops.parallel.run_tasks(nr_workers=-1, tasks=self.active_resources.itervalues(), worker_fun=worker)
if create_only: return
# Build the machine configurations.
if dry_run:
self.build_configs(dry_run=True, repair=repair, include=include, exclude=exclude)
return
# Record configs_path in the state so that the ‘info’ command
# can show whether machines have an outdated configuration.
self.configs_path = self.build_configs(repair=repair, include=include, exclude=exclude)
if build_only: return
# Copy the closures of the machine configurations to the
# target machines.
self.copy_closures(self.configs_path, include=include, exclude=exclude,
max_concurrent_copy=max_concurrent_copy)
if copy_only: return
# Active the configurations.
self.activate_configs(self.configs_path, include=include,
exclude=exclude, allow_reboot=allow_reboot,
force_reboot=force_reboot, check=check,
sync=sync, always_activate=always_activate)
# Trigger cleanup of resources, e.g. disks that need to be detached etc. Needs to be
# done after activation to make sure they are not in use anymore.
def cleanup_worker(r):
if not should_do(r, include, exclude): return
# Now create the resource itself.
r.after_activation(self.definitions[r.name])
nixops.parallel.run_tasks(nr_workers=-1, tasks=self.active_resources.itervalues(), worker_fun=cleanup_worker)
def deploy(self, **kwargs):
with self._get_deployment_lock():
self._deploy(**kwargs)
def _rollback(self, generation, include=[], exclude=[], check=False,
allow_reboot=False, force_reboot=False,
max_concurrent_copy=5, sync=True):
if not self.rollback_enabled:
raise Exception("rollback is not enabled for this network; please set ‘network.enableRollback’ to ‘true’ and redeploy"
)
profile = self.get_profile()
if subprocess.call(["nix-env", "-p", profile, "--switch-generation", str(generation)]) != 0:
raise Exception("nix-env --switch-generation failed")
self.configs_path = os.path.realpath(profile)
assert os.path.isdir(self.configs_path)
names = set()
for filename in os.listdir(self.configs_path):
if not os.path.islink(self.configs_path + "/" + filename): continue
if should_do_n(filename, include, exclude) and filename not in self.machines:
raise Exception("cannot roll back machine ‘{0}’ which no longer exists".format(filename))
names.add(filename)
# Update the set of active machines.
for m in self.machines.values():
if m.name in names:
if m.obsolete:
self.logger.log("machine ‘{0}’ is no longer obsolete".format(m.name))
m.obsolete = False
else:
self.logger.log("machine ‘{0}’ is obsolete".format(m.name))
if not m.obsolete: m.obsolete = True
self.copy_closures(self.configs_path, include=include, exclude=exclude,
max_concurrent_copy=max_concurrent_copy)
self.activate_configs(self.configs_path, include=include,
exclude=exclude, allow_reboot=allow_reboot,
force_reboot=force_reboot, check=check,
sync=sync, always_activate=True)
def rollback(self, **kwargs):
with self._get_deployment_lock():
self._rollback(**kwargs)
def destroy_resources(self, include=[], exclude=[], wipe=False):
"""Destroy all active or obsolete resources."""
with self._get_deployment_lock():
for r in self.resources.itervalues():
r._destroyed_event = threading.Event()
r._errored = False
for rev_dep in r.destroy_before(self.resources.itervalues()):
try:
rev_dep._wait_for.append(r)
except AttributeError:
rev_dep._wait_for = [ r ]
def worker(m):
try:
if not should_do(m, include, exclude): return
try:
for dep in m._wait_for:
dep._destroyed_event.wait()
# !!! Should we print a message here?
if dep._errored:
m._errored = True
return
except AttributeError:
pass
if m.destroy(wipe=wipe): self.delete_resource(m)
except:
m._errored = True