forked from tiiuae/ghaf-infra
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tasks.py
500 lines (428 loc) · 14.7 KB
/
tasks.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
#!/usr/bin/env python3
# SPDX-FileCopyrightText: 2023 Technology Innovation Institute (TII)
# SPDX-FileCopyrightText: 2023 Nix community projects
#
# SPDX-License-Identifier: MIT
# This file originates from:
# https://github.com/nix-community/infra/blob/c4c8c32b51/tasks.py
################################################################################
# pylint: disable=invalid-name
################################################################################
# Basic usage:
#
# List tasks:
# $ inv --list
#
# Get help (using 'deploy' task as an example):
# $ inv --help deploy
#
# Run a task (using build-local as an example):
# $ inv build-local
#
# For more pyinvoke usage examples, see:
# https://docs.pyinvoke.org/en/stable/getting-started.html
""" Misc dev and deployment helper tasks """
import json
import os
import subprocess
import sys
import logging
import socket
import time
from pathlib import Path
from tempfile import TemporaryDirectory
from typing import Any, Union
from collections import OrderedDict
from dataclasses import dataclass
from tabulate import tabulate
from colorlog import ColoredFormatter, default_log_colors
from deploykit import DeployHost, HostKeyCheck
from invoke import task
################################################################################
ROOT = Path(__file__).parent.resolve()
os.chdir(ROOT)
LOG = logging.getLogger(os.path.abspath(__file__))
################################################################################
@dataclass(eq=False)
class TargetHost:
"""Represents target host"""
hostname: str
nixosconfig: str
# Below dictionary defines the set of ghaf-infra configuration aliases:
# - Name (e.g. 'ghafhydra-dev) defines the alias name for each target.
# - TargetHost.hostname: host name or IP address of the target.
# - TargetHost.nixosconfig: name of the target nixosConfiguration.
TARGETS = OrderedDict(
{
"ghafhydra-dev": TargetHost(
hostname="ghafhydra.northeurope.cloudapp.azure.com", nixosconfig="ghafhydra"
),
"binarycache-ficolo": TargetHost(
hostname="172.18.20.109", nixosconfig="binarycache"
),
"monitoring-ficolo": TargetHost(
hostname="172.18.20.108", nixosconfig="monitoring"
),
"build3-ficolo": TargetHost(
hostname="172.18.20.104", nixosconfig="ficolobuild"
),
}
)
def _get_target(alias: str) -> TargetHost:
if alias not in TARGETS:
LOG.fatal("Unknown alias '%s'", alias)
sys.exit(1)
return TARGETS[alias]
################################################################################
def set_log_verbosity(verbosity: int = 1) -> None:
"""Set logging verbosity (0=NOTSET, 1=INFO, or 2=DEBUG)"""
log_levels = [logging.NOTSET, logging.INFO, logging.DEBUG]
verbosity = min(len(log_levels) - 1, max(verbosity, 0))
_init_logging(verbosity)
def _init_logging(verbosity: int = 1) -> None:
"""Initialize logging"""
if verbosity == 0:
level = logging.NOTSET
elif verbosity == 1:
level = logging.INFO
else:
level = logging.DEBUG
if level <= logging.DEBUG:
logformat = (
"%(log_color)s%(levelname)-8s%(reset)s "
"%(filename)s:%(funcName)s():%(lineno)d "
"%(message)s"
)
else:
logformat = "%(log_color)s%(levelname)-8s%(reset)s %(message)s"
default_log_colors["INFO"] = "fg_bold_white"
default_log_colors["DEBUG"] = "fg_bold_white"
default_log_colors["SPAM"] = "fg_bold_white"
formatter = ColoredFormatter(logformat, log_colors=default_log_colors)
if LOG.hasHandlers() and len(LOG.handlers) > 0:
stream = LOG.handlers[0]
else:
stream = logging.StreamHandler()
stream.setFormatter(formatter)
if not LOG.hasHandlers():
LOG.addHandler(stream)
LOG.setLevel(level)
# Set logging verbosity (1=INFO, 2=DEBUG)
set_log_verbosity(1)
def exec_cmd(cmd, raise_on_error=True, capture_output=True):
"""Run shell command cmd"""
LOG.info("Running: %s", cmd)
try:
if capture_output:
return subprocess.run(
cmd.split(), capture_output=True, text=True, check=True
)
return subprocess.run(
cmd.split(), text=True, check=True, stdout=subprocess.PIPE
)
except subprocess.CalledProcessError as error:
warn = [f"'{cmd}':"]
if error.stdout:
warn.append(f"{error.stdout}")
if error.stderr:
warn.append(f"{error.stderr}")
LOG.warning("\n".join(warn))
if raise_on_error:
raise error
return None
################################################################################
@task
def alias_list(_c: Any) -> None:
"""
List available targets (i.e. configurations and alias names)
Example usage:
inv list-name
"""
table_rows = []
table_rows.append(["alias", "nixosconfig", "hostname"])
for alias, host in TARGETS.items():
row = [alias, host.nixosconfig, host.hostname]
table_rows.append(row)
table = tabulate(table_rows, headers="firstrow", tablefmt="fancy_outline")
print(f"\nCurrent ghaf-infra targets:\n\n{table}")
@task
def update_sops_files(c: Any) -> None:
"""
Update all sops yaml and json files according to .sops.yaml rules.
Example usage:
inv update-sops-files
"""
c.run(
r"""
find . \
-type f \
\( -iname '*.enc.json' -o -iname 'secrets.yaml' \) \
-exec sops updatekeys --yes {} \;
"""
)
@task
def print_keys(_c: Any, alias: str) -> None:
"""
Decrypt host private key, print ssh and age public keys for `alias` config.
Example usage:
inv print-keys --target ghafhydra-dev
"""
with TemporaryDirectory() as tmpdir:
nixosconfig = _get_target(alias).nixosconfig
decrypt_host_key(nixosconfig, tmpdir)
key = f"{tmpdir}/etc/ssh/ssh_host_ed25519_key"
pubkey = subprocess.run(
["ssh-keygen", "-y", "-f", f"{key}"],
stdout=subprocess.PIPE,
text=True,
check=True,
)
print("###### Public keys ######")
print(pubkey.stdout)
print("###### Age keys ######")
subprocess.run(
["ssh-to-age"],
input=pubkey.stdout,
check=True,
text=True,
)
def get_deploy_host(alias: str = "") -> DeployHost:
"""
Return DeployHost object, given `alias`
"""
hostname = _get_target(alias).hostname
deploy_host = DeployHost(
host=hostname,
host_key_check=HostKeyCheck.NONE,
# verbose_ssh=True,
)
return deploy_host
@task
def deploy(_c: Any, alias: str) -> None:
"""
Deploy the configuration for `alias`.
Example usage:
inv deploy --alias ghafhydra-dev
"""
h = get_deploy_host(alias)
res = h.run_local(
["nix", "flake", "archive", "--to", f"ssh://{h.host}", "--json"],
stdout=subprocess.PIPE,
)
data = json.loads(res.stdout)
path = data["path"]
LOG.debug("data['path']: %s", path)
flags = "--option accept-flake-config true"
nixosconfig = _get_target(alias).nixosconfig
command = "sudo nixos-rebuild"
h.run(f"{command} switch {flags} --flake {path}#{nixosconfig}")
def decrypt_host_key(nixosconfig: str, tmpdir: str) -> None:
"""
Run sops to extract `nixosconfig` secret 'ssh_host_ed25519_key'
"""
def opener(path: str, flags: int) -> Union[str, int]:
return os.open(path, flags, 0o400)
t = Path(tmpdir)
t.mkdir(parents=True, exist_ok=True)
t.chmod(0o755)
host_key = t / "etc/ssh/ssh_host_ed25519_key"
host_key.parent.mkdir(parents=True, exist_ok=True)
with open(host_key, "w", opener=opener, encoding="utf-8") as fh:
try:
subprocess.run(
[
"sops",
"--extract",
'["ssh_host_ed25519_key"]',
"--decrypt",
f"{ROOT}/hosts/{nixosconfig}/secrets.yaml",
],
check=True,
stdout=fh,
)
except subprocess.CalledProcessError:
LOG.warning(
"Failed reading secret 'ssh_host_ed25519_key' for '%s'", nixosconfig
)
ask = input("Still continue? [y/N] ")
if ask != "y":
sys.exit(1)
else:
pub_key = t / "etc/ssh/ssh_host_ed25519_key.pub"
with open(pub_key, "w", encoding="utf-8") as fh:
subprocess.run(
["ssh-keygen", "-y", "-f", f"{host_key}"],
stdout=fh,
text=True,
check=True,
)
pub_key.chmod(0o644)
@task
def install(c: Any, alias) -> None:
"""
Install `alias` configuration using nixos-anywhere, deploying host private key.
Note: this will automatically partition and re-format the target hard drive,
meaning all data on the target will be completely overwritten with no option
to rollback.
Example usage:
inv install --alias ghafscan-dev
"""
h = get_deploy_host(alias)
ask = input(f"Install configuration '{alias}'? [y/N] ")
if ask != "y":
return
# Check ssh and remote user
try:
remote_user = h.run(cmd="whoami", stdout=subprocess.PIPE).stdout.strip()
local_user = exec_cmd("whoami").stdout.strip()
if remote_user and local_user and remote_user != local_user:
LOG.warning(
"Remote user '%s' is not your current local user. "
"You will likely not be able to login to the remote host '%s' "
"after nixos-anywhere installation. Consider adding your local "
"user to the remote host and make sure user '%s' "
"also has access to remote host after nixos-anywhere installation "
"by adding your local user as a user to nixos configuration '%s'. "
"Hint: you might want to try the helper script at "
"'scripts/add-remote-user.sh' to add your current local "
"user to the remote host.",
remote_user,
_get_target(alias).hostname,
local_user,
_get_target(alias).nixosconfig,
)
ask = input("Still continue? [y/N] ")
if ask != "y":
sys.exit(1)
except subprocess.CalledProcessError:
LOG.fatal("No ssh access to the remote host")
sys.exit(1)
# Check sudo nopasswd
try:
h.run("sudo -n true", become_root=True)
except subprocess.CalledProcessError:
LOG.warning(
"sudo on '%s' needs password: installation will likely fail", h.host
)
ask = input("Still continue? [y/N] ")
if ask != "y":
sys.exit(1)
# Check dynamic ip
try:
h.run("ip a | grep dynamic")
except subprocess.CalledProcessError:
pass
else:
LOG.warning("Above address(es) on '%s' use dynamic addressing.", h.host)
LOG.warning(
"This might cause issues if you assume the target host is reachable "
"from any such address also after kexec switch. "
"If you do, consider making the address temporarily static "
"before continuing."
)
ask = input("Still continue? [y/N] ")
if ask != "y":
sys.exit(1)
nixosconfig = _get_target(alias).nixosconfig
with TemporaryDirectory() as tmpdir:
decrypt_host_key(nixosconfig, tmpdir)
gitrev = "0a929da703b18b9191cbbd92c3092b38514d450b"
command = f"nix run github:numtide/nixos-anywhere?rev={gitrev} --"
command += f" {h.host} --extra-files {tmpdir} --flake .#{nixosconfig}"
command += " --option accept-flake-config true"
LOG.warning(command)
c.run(command)
# Reboot
print(f"Wait for {h.host} to start", end="")
wait_for_port(h.host, 22)
reboot(c, alias)
@task
def build_local(_c: Any, alias: str = "") -> None:
"""
Build NixOS configuration `alias` locally.
If `alias` is not specificied, builds all TARGETS.
Example usage:
inv build-local --alias ghafhydra-dev
"""
if alias:
target_configs = [_get_target(alias).nixosconfig]
else:
target_configs = [target.nixosconfig for _, target in TARGETS.items()]
for nixosconfig in target_configs:
cmd = (
"nixos-rebuild build --option accept-flake-config true "
f" -v --flake .#{nixosconfig}"
)
exec_cmd(cmd, capture_output=False)
def wait_for_port(host: str, port: int, shutdown: bool = False) -> None:
"""Wait for `host`:`port`"""
while True:
time.sleep(1)
sys.stdout.write(".")
sys.stdout.flush()
try:
with socket.create_connection((host, port), timeout=1):
if not shutdown:
break
except OSError:
if shutdown:
break
print("")
@task
def reboot(_c: Any, alias: str) -> None:
"""
Reboot host identified as `alias`.
Example usage:
inv reboot --alias ghafhydra-dev
"""
h = get_deploy_host(alias)
h.run("sudo reboot &")
print(f"Wait for {h.host} to shutdown", end="")
sys.stdout.flush()
port = h.port or 22
wait_for_port(h.host, port, shutdown=True)
print(f"Wait for {h.host} to start", end="")
sys.stdout.flush()
wait_for_port(h.host, port)
@task
def pre_push(c: Any) -> None:
"""
Run 'pre-push' checks: black, pylint, pycodestyle, reuse lint, nix fmt.
Also, build all nixosConfiguration targets in this flake.
Example usage:
inv pre-push
"""
cmd = "find . -type f -name *.py ! -path *result* ! -path *eggs*"
ret = exec_cmd(cmd)
pyfiles = ret.stdout.replace("\n", " ")
cmd = f"black -q {pyfiles}"
ret = exec_cmd(cmd, raise_on_error=False)
if not ret:
sys.exit(1)
cmd = f"pylint --disable duplicate-code -rn {pyfiles}"
ret = exec_cmd(cmd, raise_on_error=False)
if not ret:
sys.exit(1)
cmd = f"pycodestyle --max-line-length=90 {pyfiles}"
ret = exec_cmd(cmd, raise_on_error=False)
if not ret:
sys.exit(1)
cmd = "reuse lint"
ret = exec_cmd(cmd, raise_on_error=False)
if not ret:
sys.exit(1)
cmd = "terraform fmt -check -recursive"
ret = exec_cmd(cmd, raise_on_error=False)
if not ret:
LOG.warning("Run `terraform fmt -recursive` locally to fix formatting")
sys.exit(1)
cmd = "nix fmt"
ret = exec_cmd(cmd, raise_on_error=False)
if not ret:
sys.exit(1)
cmd = "nix flake check -v"
ret = exec_cmd(cmd, raise_on_error=False)
if not ret:
sys.exit(1)
build_local(c)
LOG.info("All pre-push checks passed")