building_manager.py 28.1 KB
Newer Older
1
#!/usr/bin/env python
2
3
import bcrypt
import crypt
4
import docker
5
import logging
6
import os
7
# import yaml
8

9
from shutil import copy2
10
from subprocess import run
11
from PyInquirer import prompt
12
13
14
15
16
from ruamel.yaml import YAML

# Configure YAML
yaml = YAML()
yaml.indent(mapping=4, sequence=4, offset=2)
17
18
19

# Log level during development is info
logging.basicConfig(level=logging.WARNING)
20

21
# Directories for config generation
22
23
CUSTOM_DIR = 'custom_configs'
TEMPLATE_DIR = 'template_configs'
24
25
26
COMPOSE_NAME = 'docker-stack.yml'
SKELETON_NAME = 'docker-skeleton.yml'
TEMPLATES_NAME = 'docker-templates.yml'
Dobli's avatar
Dobli committed
27
28
29
30
CONFIG_DIRS = ['mosquitto', 'nodered', 'ssh', 'traefik', 'volumerize']
TEMPLATE_FILES = [
    'mosquitto/mosquitto.conf', 'nodered/nodered_package.json',
    'nodered/nodered_settings.js', 'ssh/sshd_config', 'traefik/traefik.toml'
31
]
32
33
EDIT_FILES = {
    "mosquitto_passwords": "mosquitto/mosquitto_passwords",
34
    "sftp_users": "ssh/sftp_users.conf",
35
36
37
    "traefik_users": "traefik/traefik_users",
    "id_rsa": "ssh/id_rsa",
    "host_key": "ssh/ssh_host_ed25519_key",
38
39
40
    "known_hosts": "ssh/known_hosts",
    "backup_config": "volumerize/backup_config.json"
}
Dobli's avatar
Dobli committed
41
CONSTRAINTS = {"building": "node.labels.building"}
42
43
44
45
46
SERVICES = {
    "sftp": "sftp_X",
    "openhab": "openhab_X",
    "nodered": "nodered_X",
    "mqtt": "mqtt_X"
47
}
48

49
# Default Swarm port
dobli's avatar
dobli committed
50
SWARM_PORT = 2377
51
52
# UID for admin
UID = 9001
Dobli's avatar
Dobli committed
53
54
# Username for admin
ADMIN_USER = 'ohadmin'
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

# ******************************
# Compose file functions {{{
# ******************************


def generate_initial_compose(base_dir):
    """Creates the initial compose using the skeleton

    :base_dir: Folder to place configuration files into
    """
    base_path = base_dir + '/' + CUSTOM_DIR
    template_path = base_dir + '/' + TEMPLATE_DIR
    # compose file
    compose = base_path + '/' + COMPOSE_NAME
    # skeleton file
    skeleton = template_path + '/' + SKELETON_NAME

    with open(skeleton, 'r') as skeleton_f, open(compose, 'w+') as compose_f:
        init_content = yaml.load(skeleton_f)
        yaml.dump(init_content, compose_f)


def add_sftp_service(base_dir, hostname, number=0):
    """Generates an sftp entry and adds it to the compose file

    :base_dir: base directory for configuration files
    :hostname: names of host that the services is added to
    :number: increment of exposed port to prevent overlaps
    """
    base_path = base_dir + '/' + CUSTOM_DIR
    # compose file
    compose_path = base_path + '/' + COMPOSE_NAME
    # template
    template = get_service_template(base_dir, SERVICES['sftp'])
    # service name
    service_name = f'sftp_{hostname}'

    with open(compose_path, 'r+') as compose_f:
        # load compose file
        compose = yaml.load(compose_f)
        # only label contraint is building
        template['deploy']['placement']['constraints'][0] = (
            f"{CONSTRAINTS['building']} == {hostname}")
        template['ports'] = [f'{2222 + number}:22']
        compose['services'][service_name] = template
        # write content starting from first line
        compose_f.seek(0)
        # write new compose content
        yaml.dump(compose, compose_f)
        # reduce file to new size
        compose_f.truncate()


def add_openhab_service(base_dir, hostname):
    """Generates an openhab entry and adds it to the compose file

    :base_dir: base directory for configuration files
    :hostname: names of host that the services is added to
    """
    base_path = base_dir + '/' + CUSTOM_DIR
    # compose file
    compose_path = base_path + '/' + COMPOSE_NAME
    # template
    template = get_service_template(base_dir, SERVICES['openhab'])
    # service name
    service_name = f'openhab_{hostname}'

    with open(compose_path, 'r+') as compose_f:
        # load compose file
        compose = yaml.load(compose_f)
        # only label contraint is building
        template['deploy']['placement']['constraints'][0] = (
            f"{CONSTRAINTS['building']} == {hostname}")
        template['deploy']['labels'].append(f'traefik.backend={service_name}')
        template['deploy']['labels'].append(f'backup={hostname}')
        template['deploy']['labels'].append(
            f'traefik.frontend.rule=HostRegexp:'
            f'{hostname}.{{domain:[a-zA-z0-9-]+}}')
        compose['services'][service_name] = template
        # write content starting from first line
        compose_f.seek(0)
        # write new compose content
        yaml.dump(compose, compose_f)
        # reduce file to new size
        compose_f.truncate()


def add_nodered_service(base_dir, hostname):
    """Generates an nodered entry and adds it to the compose file

    :base_dir: base directory for configuration files
    :hostname: names of host that the services is added to
    """
    base_path = base_dir + '/' + CUSTOM_DIR
    # compose file
    compose_path = base_path + '/' + COMPOSE_NAME
    # template
    template = get_service_template(base_dir, SERVICES['nodered'])
    # service name
    service_name = f'nodered_{hostname}'

    with open(compose_path, 'r+') as compose_f:
        # load compose file
        compose = yaml.load(compose_f)
        # only label contraint is building
        template['deploy']['placement']['constraints'][0] = (
            f"{CONSTRAINTS['building']} == {hostname}")
        template['deploy']['labels'].append(f'traefik.backend={service_name}')
        template['deploy']['labels'].append(f'backup={hostname}')
        template['deploy']['labels'].append(
            f'traefik.frontend.rule=HostRegexp:'
            f'{service_name}.{{domain:[a-zA-z0-9-]+}}')
        compose['services'][service_name] = template
        # write content starting from first line
        compose_f.seek(0)
        # write new compose content
        yaml.dump(compose, compose_f)
        # reduce file to new size
        compose_f.truncate()


def add_mqtt_service(base_dir, hostname, number=0):
    """Generates an mqtt entry and adds it to the compose file

    :base_dir: base directory for configuration files
    :hostname: names of host that the services is added to
    :number: increment of exposed port to prevent overlaps
    """
    base_path = base_dir + '/' + CUSTOM_DIR
    # compose file
    compose_path = base_path + '/' + COMPOSE_NAME
    # template
    template = get_service_template(base_dir, SERVICES['mqtt'])
    # service name
    service_name = f'mqtt_{hostname}'

    with open(compose_path, 'r+') as compose_f:
        # load compose file
        compose = yaml.load(compose_f)
        # only label contraint is building
        template['deploy']['placement']['constraints'][0] = (
            f"{CONSTRAINTS['building']} == {hostname}")
        # ports incremented by number of services
        template['ports'] = [f'{1883 + number}:1883', f'{9001 + number}:9001']
        # write template as service
        compose['services'][service_name] = template
        # write content starting from first line
        compose_f.seek(0)
        # write new compose content
        yaml.dump(compose, compose_f)
        # reduce file to new size
        compose_f.truncate()


def get_service_template(base_dir, service_name):
    """Gets a service template entry from the template yaml

    :return: yaml entry of a service
    """
    template_path = base_dir + '/' + TEMPLATE_DIR
    templates = template_path + '/' + TEMPLATES_NAME

    with open(templates, 'r') as templates_file:
        template_content = yaml.load(templates_file)

    return template_content['services'][service_name]

Dobli's avatar
Dobli committed
223

224
# }}}
dobli's avatar
dobli committed
225

226

227
# ******************************
dobli's avatar
dobli committed
228
# Config file functions {{{
229
# ******************************
230
def generate_config_folders(base_dir):
231
232
    """Generate folders for configuration files

233
    :base_dir: Path to add folders to
234
    """
235
236
237
238
239
240
    base_path = base_dir + '/' + CUSTOM_DIR
    if not os.path.exists(base_dir):
        os.makedirs(base_dir)

    print(f'Initialize configuration in {base_path}')

241
    # generate empty config dirs
242
243
244
245
246
    for d in CONFIG_DIRS:
        new_dir = base_path + '/' + d
        if not os.path.exists(new_dir):
            os.makedirs(new_dir)

247
248
249
250
    # copy template configs
    for template_file in TEMPLATE_FILES:
        copy_template_config(base_dir, template_file)

251

252
253
254
255
256
257
def copy_template_config(base_dir, config_path):
    """Copies template configuration files into custom folder

    :base_dir: path that contains template and custom folders
    :config_path: relative path of config to copy from template
    """
Dobli's avatar
Dobli committed
258
259
260
261
262
    custom_path = base_dir + '/' + CUSTOM_DIR + "/" + config_path
    template_path = base_dir + '/' + TEMPLATE_DIR + "/" + config_path

    logging.info(f'Copy {config_path} from {custom_path} to {template_path}')
    copy2(template_path, custom_path)
263
264


265
266
267
268
269
270
def generate_mosquitto_user_line(username, password):
    """Generates a line for a mosquitto user with a crypt hashed password

    :username: username to use
    :password: password that will be hashed (SHA512)

271
    :returns: a line as expected by mosquitto
272
273
274
275
276
277
    """
    password_hash = crypt.crypt(password, crypt.mksalt(crypt.METHOD_SHA512))
    line = f"{username}:{password_hash}"
    return line


278
279
280
281
def generate_sftp_user_line(username, password, directories=None):
    """Generates a line for a sftp user with a hashed password

    :username: username to use
282
    :password: password that will be hashed (SHA512)
283
284
    :directories: list of directories which the user should have

285
    :returns: a line as expected by sshd
286
287
288
    """
    # generate user line with hashed password
    password_hash = crypt.crypt(password, crypt.mksalt(crypt.METHOD_SHA512))
289
    line = f"{username}:{password_hash}:e:{UID}:{UID}"
290
291
292
293
294
295
296
297
    # add directory entries when available
    if directories:
        # create comma separated string from list
        dir_line = ','.join(d for d in directories)
        line = f"{line}:{dir_line}"
    return line


298
299
300
301
302
303
304
305
306
307
308
309
310
def generate_traefik_user_line(username, password):
    """Generates a line for a traefik user with a bcrypt hashed password

    :username: username to use
    :password: password that will be hashed (bcrypt)

    :returns: a line as expected by traefik
    """
    password_hash = bcrypt.hashpw(password.encode(), bcrypt.gensalt())
    line = f"{username}:{password_hash.decode()}"
    return line


311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
def generate_mosquitto_file(base_dir, username, password):
    """Generates a mosquitto password file using mosquitto_passwd system tool

    :base_dir: path that contains custom config folder
    :username: username to use
    :password: password that will be used
    """
    passwd_path = base_dir + '/' + CUSTOM_DIR + "/" + EDIT_FILES[
        'mosquitto_passwords']

    # ensure file exists
    if not os.path.exists(passwd_path):
        open(passwd_path, 'a').close()

    # execute mosquitto passwd
    mos_result = run(
        ['mosquitto_passwd', '-b', passwd_path, username, password],
        text=True,
        capture_output=True)
    return mos_result.returncode == 0


def generate_sftp_file(base_dir, username, password, direcories=None):
334
    """Generates a sftp password file
335
336
337
338
339
340
341
342
343
344
345
346

    :base_dir: path that contains custom config folder
    :username: username to use
    :password: password that will be used
    :directories: list of directories which the user should have
    """
    # generate line and save it into a file
    file_content = generate_sftp_user_line(username, password, direcories)
    create_or_replace_config_file(base_dir, EDIT_FILES['sftp_users'],
                                  file_content)


347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
def generate_id_rsa_files(base_dir):
    """Generates id_rsa and id_rsa.pub private/public keys using ssh-keygen

    :base_dir: path that contains custom config folder
    """
    id_path = base_dir + '/' + CUSTOM_DIR + "/" + EDIT_FILES['id_rsa']

    # execute ssh-keygen
    id_result = run(
        ['ssh-keygen', '-t', 'rsa', '-b', '4096', '-f', id_path, '-N', ''],
        text=True,
        capture_output=True)
    return id_result.returncode == 0


def generate_host_key_files(base_dir, hosts):
    """Generates ssh host keys and matching known_hosts using ssh-keygen

    :base_dir: path that contains custom config folder
    """
    key_path = base_dir + '/' + CUSTOM_DIR + "/" + EDIT_FILES['host_key']
    # ssh-keygen generates public key with .pub postfix
    pub_path = key_path + '.pub'
370
371
    # host_names with sftp_ postfix
    sftp_hosts = [f'sftp_{host}' for host in hosts]
372
373
374
375
376
377
378
379
380
381
382
383
384

    # execute ssh-keygen
    id_result = run(['ssh-keygen', '-t', 'ed25519', '-f', key_path, '-N', ''],
                    text=True,
                    capture_output=True)

    # read content of public key as known line
    known_line = ""
    with open(pub_path, 'r') as pub_file:
        pub_line = pub_file.readline()
        split_line = pub_line.split()
        # delete last list element
        del split_line[-1]
385
386
        # collect sftp hosts as comma separated string
        hosts_line = ','.join(h for h in sftp_hosts)
387
388
389
390
391
392
393
394
395
396
397
        split_line.insert(0, hosts_line)
        # collect parts as space separated string
        known_line = ' '.join(sp for sp in split_line)

    # write new known_line file
    create_or_replace_config_file(base_dir, EDIT_FILES['known_hosts'],
                                  known_line)

    return id_result.returncode == 0


398
399
400
401
402
403
404
405
406
407
408
409
410
def generate_traefik_file(base_dir, username, password):
    """Generates a traefik password file

    :base_dir: path that contains custom config folder
    :username: username to use
    :password: password that will be used
    """
    # generate line and save it into a file
    file_content = generate_traefik_user_line(username, password)
    create_or_replace_config_file(base_dir, EDIT_FILES['traefik_users'],
                                  file_content)


411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
def generate_volumerize_file(base_dir, hosts):
    """Generates config for volumerize backups

    :base_dir: path that contains custom config folder
    :hosts: names of backup hosts
    """
    configs = []

    for h in hosts:
        host_config = {
            'description': f'Backup Server on {h}',
            'url': f'sftp://ohadmin@sftp_{h}://home/ohadmin/backup_data/{h}'
        }
        configs.append(host_config)

    create_or_replace_config_file(
        base_dir, EDIT_FILES['backup_config'], configs, json=True)


def create_or_replace_config_file(base_dir, config_path, content, json=False):
431
432
433
434
435
436
437
438
    """Creates or replaces a config file with new content

    :base_dir: path that contains custom config folder
    :config_path: relative path of config
    :content: content of the file as a string
    """
    custom_path = base_dir + '/' + CUSTOM_DIR + "/" + config_path
    with open(custom_path, 'w+') as file:
439
440
441
442
443
        if json:
            import json
            json.dump(content, file, indent=2)
        else:
            file.write(content)
444
445


dobli's avatar
dobli committed
446
447
448
# }}}


449
# ******************************
dobli's avatar
dobli committed
450
# Docker machine functions {{{
451
# ******************************
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
def get_machine_list():
    """Get a list of docker machine names using the docker-machine system command

    :returns: a list of machine names managed by docker-machine
    """
    machine_result = run(['docker-machine', 'ls', '-q'],
                         text=True,
                         capture_output=True)
    return machine_result.stdout.splitlines()


def check_machine_exists(machine_name):
    """Checks weather a docker machine exists and is available

    :machine_name: Name of the machine to check
dobli's avatar
dobli committed
467
    :returns: True when machine is available
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
    """
    machines = get_machine_list()

    return machine_name in machines


def get_machine_env(machine_name):
    """Gets dict of env settings from a machine

    :machine_name: Name of the machine to check
    :returns: Dict of env variables for this machine
    """
    env_result = run(['docker-machine', 'env', machine_name],
                     text=True,
                     capture_output=True)

    machine_envs = {}

    lines = env_result.stdout.splitlines()
    for line in lines:
        if 'export' in line:
            assign = line.split('export ', 1)[1]
            env_entry = [a.strip('"') for a in assign.split('=', 1)]
            machine_envs[env_entry[0]] = env_entry[1]
    return machine_envs


dobli's avatar
dobli committed
495
496
497
498
499
500
501
502
def get_machine_ip(machine_name):
    """Asks for the ip of the docker machine

    :machine_name: Name of the machine to use for init
    """
    machine_result = run(['docker-machine', 'ip', machine_name],
                         text=True,
                         capture_output=True)
503
    return machine_result.stdout.strip()
dobli's avatar
dobli committed
504
505
506
507
508
509


def init_swarm_machine(machine_name):
    """Creates a new swarm with the specified machine as leader

    :machine_name: Name of the machine to use for init
510
    :return: True if swarm init was successful
dobli's avatar
dobli committed
511
512
513
    """
    machine_ip = get_machine_ip(machine_name)
    init_command = 'docker swarm init --advertise-addr ' + machine_ip
514
515
516
517
    init_result = run(['docker-machine', 'ssh', machine_name, init_command],
                      text=True,
                      capture_output=True)
    return init_result.returncode == 0
dobli's avatar
dobli committed
518
519
520
521
522
523
524


def join_swarm_machine(machine_name, leader_name):
    """Joins the swarm of the specified leader

    :machine_name: Name of the machine to join a swarm
    :leader_name: Name of the swarm leader machine
525
    :return: True if join to swarm was successful
dobli's avatar
dobli committed
526
527
528
529
530
    """
    token_command = 'docker swarm join-token manager -q'
    token_result = run(['docker-machine', 'ssh', leader_name, token_command],
                       text=True,
                       capture_output=True)
531
    token = token_result.stdout.strip()
dobli's avatar
dobli committed
532
    leader_ip = get_machine_ip(leader_name)
533
    logging.info(f"Swarm leader with ip {leader_ip} uses token {token}")
dobli's avatar
dobli committed
534

535
536
537
    join_cmd = f'docker swarm join --token {token} {leader_ip}:{SWARM_PORT}'
    logging.info(f'Machine {machine_name} joins using command {join_cmd}')
    join_result = run(['docker-machine', 'ssh', machine_name, join_cmd],
dobli's avatar
dobli committed
538
539
540
                      text=True,
                      capture_output=True)

541
    return join_result.returncode == 0
dobli's avatar
dobli committed
542
543


544
545
546
547
548
549
def generate_swarm(machines):
    """Generates a swarm, the first machine will be the initial leader

    :machines: list of machines in the swarm
    """
    leader = None
550
    for machine in machines:
551
552
553
554
555
556
557
558
559
560
        # init swarm with first machine
        if leader is None:
            leader = machine
            print(f'Create initial swarm with leader {leader}')
            if init_swarm_machine(leader):
                print('Swarm init successful\n')
        else:
            print(f'Machine {machine} joins swarm of leader {leader}')
            if (join_swarm_machine(machine, leader)):
                print('Joining swarm successful\n')
Dobli's avatar
Dobli committed
561
562


dobli's avatar
dobli committed
563
564
565
# }}}


566
# ******************************
dobli's avatar
dobli committed
567
# Docker client commands {{{
568
# ******************************
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
def assign_label_to_node(nodeid, label, value):
    """Assigns a label to a node (e.g. building)

    :nodeid: Id or name of the node
    :label: Label you want to add
    :value: The value to assign to the label
    """
    client = docker.from_env()

    node = client.nodes.get(nodeid)
    spec = node.attrs['Spec']
    spec['Labels'][label] = value
    node.update(spec)

    client.close()


586
587
588
589
590
591
592
593
594
595
def run_command_in_service(service, command, building=None):
    """Runs a command in a service based on its name.
    When no matching container is found or the service name is ambigous
    an error will be displayed and the function exits

    :param service: Name of the service to execute command
    :param command: Command to execute
    :param building: Optional building, make service unambigous (Default: None)
    """

596
597
598
599
600
    if building:
        building_env = get_machine_env(building)
        client = docker.from_env(environment=building_env)
    else:
        client = docker.from_env()
601
602
603
604
605
606
607

    # Find containers matching name
    service_name_filter = {"name": service}
    containers = client.containers.list(filters=service_name_filter)

    # Ensure match is unambigous
    if (len(containers) > 1):
608
        print(f'Found multiple containers matching service name {service}, '
609
610
              'ensure service is unambigous')
    elif (len(containers) < 1):
611
        print(f'Found no matching container for service name {service}')
612
613
    else:
        service_container = containers[0]
614
615
        print(f'Executing {command} in container {service_container.name}'
              f'({service_container.id}) on building {building}')
616
        print(service_container.exec_run(command))
617
    client.close()
618
619


dobli's avatar
dobli committed
620
621
622
# }}}


623
# ******************************
dobli's avatar
dobli committed
624
# CLI base commands {{{
625
# ******************************
626
627
628
629
630
631
632
633
def init_config_dirs_command(args):
    """Initialize config directories

    :args: parsed commandline arguments
    """
    base_dir = args.base_dir

    if base_dir is None:
634
        base_dir = os.getcwd()
635

Dobli's avatar
Dobli committed
636
    # generate basic config folder
637
638
639
    generate_config_folders(base_dir)


640
641
642
643
644
645
646
647
def assign_building_command(args):
    """Assigns the role of a building to a node

    :args: parsed commandline arguments
    """
    node = args.node
    building = args.building

648
    print(f'Assign role of building {building} to node {node}')
649
650
651
652

    assign_label_to_node(node, 'building', building)


653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
def execute_command(args):
    """Top level function to manage command executions from CLI

    :args: parsed commandline arguments
    """
    service = args.service
    command = " ".join(str(x) for x in args.command)  # list to string
    building = args.building

    run_command_in_service(service, command, building)


def restore_command(args):
    """Top level function to manage command executions from CLI

    :args: parsed commandline arguments
    """
670
671
672
673
    building = args.building
    target = args.target

    if not check_machine_exists(target):
674
        print(f'Machine with name {target} not found')
675
676
        return

677
    print(f'Restoring building {building} on machine {target}')
678
679

    get_machine_env(target)
680
681


682
683
684
def interactive_command(args):
    """Top level function to start the interactive mode

685
    :args: parsed command line arguments
686
    """
Dobli's avatar
Dobli committed
687
    main_menu(args)
688
689


dobli's avatar
dobli committed
690
691
692
# }}}


693
# ******************************
dobli's avatar
dobli committed
694
# Interactive menu entries {{{
695
# ******************************
696
def main_menu(args):
697
698
    """ Display main menu
    """
699
700
701
702
703
704
705
    # Base directory for configs
    base_dir = args.base_dir

    if base_dir is None:
        base_dir = os.getcwd()

    # Main menu prompts
706
    questions = [{
707
708
709
710
        'type': 'list',
        'name': 'main',
        'message': 'Public Building Manager - Main Menu',
        'choices': load_main_entires(base_dir)
711
712
713
714
    }]
    answers = prompt(questions)

    if 'Create' in answers['main']:
715
        init_menu(args)
716
717
718
719

    return answers


720
def init_menu(args):
721
722
    """Menu entry for initial setup and file generation
    """
723
724
725
726
727
728
729
    # Base directory for configs
    base_dir = args.base_dir

    if base_dir is None:
        base_dir = os.getcwd()

    # Prompts
Dobli's avatar
Dobli committed
730
    questions = [
731
        {
Dobli's avatar
Dobli committed
732
733
734
735
            'type': 'input',
            'name': 'stack_name',
            'message': 'Choose a name for your setup'
        },
736
        {
Dobli's avatar
Dobli committed
737
738
739
740
741
742
743
744
745
746
747
            'type': 'checkbox',
            'name': 'machines',
            'message': 'What docker machines will be used?',
            'choices': generate_checkbox_choices(get_machine_list())
        }
        #  },
        #  {
        #  'type': 'input',
        #  'name': 'username',
        #  'message': 'Choose a username for the admin user'
    ]
748
749
    answers = prompt(questions)

750
751
752
753
    # Ensure passwords match
    password_match = False
    while not password_match:
        password_questions = [{
Dobli's avatar
Dobli committed
754
755
756
757
758
759
            'type':
            'password',
            'name':
            'password',
            'message':
            'Choose a password for the ohadmin user:',
760
761
        },
            {
Dobli's avatar
Dobli committed
762
763
764
765
766
767
            'type':
            'password',
            'name':
            'confirm',
            'message':
            'Repeat password for the ohadmin user',
768
769
770
771
        }]
        password_answers = prompt(password_questions)
        if password_answers['password'] == password_answers['confirm']:
            password_match = True
dobli's avatar
dobli committed
772
        else:
773
            print("Passwords did not match, try again")
774

775
776
    # Initialize custom configuration dirs and templates
    generate_config_folders(base_dir)
777
    generate_initial_compose(base_dir)
778
    # Generate config files based on input
Dobli's avatar
Dobli committed
779
    username = ADMIN_USER
780
781
782
783
784
    password = password_answers['password']
    hosts = answers['machines']
    generate_sftp_file(base_dir, username, password)
    generate_mosquitto_file(base_dir, username, password)
    generate_traefik_file(base_dir, username, password)
785
    generate_volumerize_file(base_dir, hosts)
786
    generate_id_rsa_files(base_dir)
787
788
    generate_host_key_files(base_dir, hosts)

789
790
791
792
793
794
    for i, host in enumerate(hosts):
        add_sftp_service(base_dir, host, i)
        add_openhab_service(base_dir, host)
        add_nodered_service(base_dir, host)
        add_mqtt_service(base_dir, host, i)

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
    # print(answers)
    print(f"Configuration files generated in {base_dir}")

    # Check if changes shall be applied to docker environment
    generate_questions = [{
        'type': 'confirm',
        'name': 'generate',
        'message': 'Apply changes to docker environment?',
        'default': True
    }]
    generate_answers = prompt(generate_questions)

    if generate_answers['generate']:
        generate_swarm(answers['machines'])


def load_main_entires(base_dir):
    """Loads entries for main menu depending on available files

    :base_dir: directory of configuration files
    :returns: entries of main menu
    """
    custom_path = base_dir + '/' + CUSTOM_DIR

    entries = []
    if not os.path.exists(custom_path):
        entries.append('Create initial structure')
    else:
        entries.append('Execute command')

    entries.append('Exit')
826

827
    return entries
828
829


dobli's avatar
dobli committed
830
831
832
833
834
835
836
837
def generate_checkbox_choices(list):
    """Generates checkbox entries for lists of strings

    :returns: A list of dicts with name keys
    """
    return [{'name': m} for m in list]


dobli's avatar
dobli committed
838
839
# }}}

840
# ******************************
841
# Script main ( entry) {{{
842
# ******************************
843
844
845
846
847
848
if __name__ == '__main__':
    import argparse
    parser = argparse.ArgumentParser(
        prog='building_manger',
        description='Generate and manage multi'
        'building configurations of openHAB with docker swarm')
849
850
851
852
    parser.add_argument(
        '--base_dir',
        '-d',
        help='Directory to creat config folders in, default is current dir')
853
854
    subparsers = parser.add_subparsers()

855
856
857
858
859
860
    # Interactive mode
    parser_interactive = subparsers.add_parser(
        'interactive',
        help='Starts the interactive mode of the building manager')
    parser_interactive.set_defaults(func=interactive_command)

861
862
863
    # Restore command
    parser_restore = subparsers.add_parser('restore', help='Restore backups')
    parser_restore.add_argument(
864
        'building', help='Name (label) of the building that shall be restored')
865
866
867
868
    parser_restore.add_argument(
        'target', help='Name of the machine to restore to')
    parser_restore.set_defaults(func=restore_command)

869
870
871
872
873
874
875
876
877
    # Assign building command
    parser_assign_building = subparsers.add_parser(
        'assign_building', help='Assign the role of a building to a node')
    parser_assign_building.add_argument(
        'node', help='Name (or ID) of the node that gets the role assigned')
    parser_assign_building.add_argument(
        'building', help='Name of the building that will be assigned')
    parser_assign_building.set_defaults(func=assign_building_command)

878
879
880
881
882
883
884
885
886
887
888
889
890
891
    # Execute command
    parser_exec = subparsers.add_parser(
        'exec', help='Execute commands in a service container')
    parser_exec.add_argument(
        'service', help='Name of the service that will run the command')
    parser_exec.add_argument(
        'command', help='Command to be executed', nargs=argparse.REMAINDER)
    parser_exec.add_argument(
        '--building',
        '-b',
        help='Building name (label) of the service if '
        'service location is ambiguous')
    parser_exec.set_defaults(func=execute_command)

892
893
894
895
896
897
898
899
900
    # Config commands
    parser_config = subparsers.add_parser(
        'config', help='Manage configuration files')
    parser_config_subs = parser_config.add_subparsers()
    # - Config init
    parser_config_init = parser_config_subs.add_parser(
        'init', help='Initialize config file directories')
    parser_config_init.set_defaults(func=init_config_dirs_command)

901
    # Parse arguments into args dict
902
    args = parser.parse_args()
903
904
905
906
907
908

    # when no subcommand is defined show interactive menu
    try:
        args.func(args)
    except AttributeError:
        interactive_command(args)
dobli's avatar
dobli committed
909
910
911
912
# }}}

# --- vim settings ---
# vim:foldmethod=marker:foldlevel=0