An error occurred while loading the file. Please try again.
-
dobli authored999af97c
#!/usr/bin/env python3
""" Python module to assist creating and maintaining docker openHab stacks."""
import crypt
from enum import Enum
import logging
import os
import sys
from hashlib import md5
from shutil import copy2
from subprocess import PIPE, run
import bcrypt
import docker
import questionary as qust
from ruamel.yaml import YAML
from prompt_toolkit.styles import Style
# Configure YAML
yaml = YAML()
yaml.indent(mapping=4, sequence=4, offset=2)
# Log level during development is info
logging.basicConfig(level=logging.WARNING)
# Prompt style
st = Style([
('qmark', 'fg:#00c4b4 bold'), # token in front of question
('question', 'bold'), # question text
('answer', 'fg:#00c4b4 bold'), # submitted answer question
('pointer', 'fg:#00c4b4 bold'), # pointer for select and checkbox
('selected', 'fg:#00c4b4'), # selected item checkbox
('separator', 'fg:#00c4b4'), # separator in lists
('instruction', '') # user instructions for selections
])
# ******************************
# Constants <<<
# ******************************
# Directories for config generation
CUSTOM_DIR = 'custom_configs'
TEMPLATE_DIR = 'template_configs'
COMPOSE_NAME = 'docker-stack.yml'
SKELETON_NAME = 'docker-skeleton.yml'
TEMPLATES_NAME = 'docker-templates.yml'
CONFIG_DIRS = ['mosquitto', 'nodered', 'ssh', 'filebrowser',
'traefik', 'volumerize', 'postgres', 'pb-framr']
TEMPLATE_FILES = [
'mosquitto/mosquitto.conf', 'nodered/nodered_package.json',
'pb-framr/logo.svg', 'nodered/nodered_settings.js',
'ssh/sshd_config', 'traefik/traefik.toml'
]
EDIT_FILES = {
"mosquitto_passwords": "mosquitto/mosquitto_passwords",
"sftp_users": "ssh/sftp_users.conf",
"traefik_users": "traefik/traefik_users",
"id_rsa": "ssh/id_rsa",
"host_key": "ssh/ssh_host_ed25519_key",
"known_hosts": "ssh/known_hosts",
"backup_config": "volumerize/backup_config.json",
"postgres_user": "postgres/user",
"postgres_passwd": "postgres/passwd",
"pb_framr_pages": "pb-framr/pages.json",
"filebrowser_conf": "filebrowser/filebrowser.json"
}
CONSTRAINTS = {"building": "node.labels.building"}
# Default Swarm port
SWARM_PORT = 2377
# UID for admin
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
UID = 9001
# Username for admin
ADMIN_USER = 'ohadmin'
# USB DEVICES (e.g. Zwave stick)
USB_DEVICES = [{
"name": "Aeotec Z-Stick Gen5 (ttyACM0)",
"value": "zwave_stick"
}]
class Service(Enum):
SFTP = ("SFTP", "sftp", False, False)
OPENHAB = ("OpenHAB", "openhab", True, True, 'dashboard')
NODERED = ("Node-RED", "nodered", False, True, 'ballot')
POSTGRES = ("Postgre SQL", "postgres", True, False)
MQTT = ("Mosquitto MQTT Broker", "mqtt", True, False)
FILES = ("File Manager", "files", False, True, 'folder')
def __init__(self, fullname, prefix, additional, frontend, icon=None):
self.fullname = fullname
self.prefix = prefix
self.additional = additional
self.frontend = frontend
self.icon = icon
# >>>
# ******************************
# Compose file functions <<<
# ******************************
# Functions to generate initial file
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
# service name
service_name = f'sftp_{hostname}'
# template
template = get_service_template(base_dir, Service.SFTP.prefix)
# only label contraint is building
template['deploy']['placement']['constraints'][0] = (
f"{CONSTRAINTS['building']} == {hostname}")
template['ports'] = [f'{2222 + number}:22']
add_or_update_compose_service(compose_path, service_name, template)
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
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
# service name
service_name = f'openhab_{hostname}'
# template
template = get_service_template(base_dir, Service.OPENHAB.prefix)
# only label contraint is building
template['deploy']['placement']['constraints'][0] = (
f"{CONSTRAINTS['building']} == {hostname}")
# include in backups of this building
template['deploy']['labels'].append(f'backup={hostname}')
# traefik backend
template['deploy']['labels'].append(f'traefik.backend={service_name}')
# traefik frontend domain->openhab
template['deploy']['labels'].extend(
generate_traefik_host_labels(hostname, segment='main'))
# traefik frontend subdomain openhab_hostname.* -> openhab
template['deploy']['labels'].append(
f'traefik.sub.frontend.rule=HostRegexp:'
f'{service_name}.{{domain:[a-zA-z0-9-]+}}')
template['deploy']['labels'].append('traefik.sub.frontend.priority=2')
add_or_update_compose_service(compose_path, service_name, template)
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
# service name
service_name = f'nodered_{hostname}'
# template
template = get_service_template(base_dir, Service.NODERED.prefix)
# 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'].extend(
generate_traefik_path_labels(service_name, segment='main'))
template['deploy']['labels'].extend(
generate_traefik_subdomain_labels(service_name, segment='sub'))
add_or_update_compose_service(compose_path, service_name, template)
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
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
# service name
service_name = f'mqtt_{hostname}'
# template
template = get_service_template(base_dir, Service.MQTT.prefix)
# 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']
add_or_update_compose_service(compose_path, service_name, template)
def add_postgres_service(base_dir, hostname, postfix=None):
"""Generates an postgres 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
:postfix: an identifier for this service
"""
base_path = base_dir + '/' + CUSTOM_DIR
# compose file
compose_path = base_path + '/' + COMPOSE_NAME
# use hostname as postfix when empty
postfix = hostname if postfix is None else postfix
# service name
service_name = f'postgres_{postfix}'
# template
template = get_service_template(base_dir, Service.POSTGRES.prefix)
# only label constraint is building
template['deploy']['placement']['constraints'][0] = (
f"{CONSTRAINTS['building']} == {hostname}")
add_or_update_compose_service(compose_path, service_name, template)
def add_file_service(base_dir, hostname):
"""Generates an file manager 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
# service name
service_name = f'files_{hostname}'
# template
template = get_service_template(base_dir, Service.FILES.prefix)
# add command that sets base url
template['command'] = f'-b /{service_name}'
# 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'].extend(
generate_traefik_path_labels(service_name, segment='main',
redirect=False))
add_or_update_compose_service(compose_path, service_name, template)
# Functions to delete services
def delete_service(base_dir, service_name):
"""Deletes a service from the compose file
:base_dir: dir to find files in
:returns: list of current services
"""
base_path = base_dir + '/' + CUSTOM_DIR
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
# compose file
compose_path = base_path + '/' + COMPOSE_NAME
with open(compose_path, 'r+') as compose_f:
# load compose file
compose = yaml.load(compose_f)
# generate list of names
compose['services'].pop(service_name, None)
# start writing from file start
compose_f.seek(0)
# write new compose content
yaml.dump(compose, compose_f)
# reduce file to new size
compose_f.truncate()
# Functions to extract information
def get_current_services(base_dir):
"""Gets a list of currently used services
:base_dir: dir to find files in
:returns: list of current services
"""
base_path = base_dir + '/' + CUSTOM_DIR
# compose file
compose_path = base_path + '/' + COMPOSE_NAME
with open(compose_path, 'r') as compose_f:
# load compose file
compose = yaml.load(compose_f)
# generate list of names
service_names = [n for n in compose['services']]
return service_names
# Helper functions
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]
def generate_traefik_host_labels(hostname, segment=None, priority=1):
"""Generates a traefik path url with necessary redirects
:hostname: Hostname that gets assigned by the label
:segment: Optional traefik segment when using multiple rules
:priority: Priority of frontend rule
:returns: list of labels for traefik
"""
label_list = []
# check segment
segment = f'.{segment}' if segment is not None else ''
# fill list
label_list.append(
f'traefik{segment}.frontend.rule=HostRegexp:{{domain:{hostname}}}')
label_list.append(f'traefik{segment}.frontend.priority={priority}')
return label_list
def generate_traefik_subdomain_labels(subdomain, segment=None, priority=2):
"""Generates a traefik subdomain with necessary redirects
:subdomain: subdomain that will be assigned to a service
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
:segment: Optional traefik segment when using multiple rules
:priority: Priority of frontend rule
:returns: list of labels for traefik
"""
label_list = []
# check segment
segment = f'.{segment}' if segment is not None else ''
# fill list
label_list.append(
f'traefik{segment}.frontend.rule='
f'HostRegexp:{subdomain}.{{domain:[a-zA-z0-9-]+}}')
label_list.append(f'traefik{segment}.frontend.priority={priority}')
return label_list
def generate_traefik_path_labels(url_path, segment=None, priority=2,
redirect=True):
"""Generates a traefik path url with necessary redirects
:url_path: path that should be used for the site
:segment: Optional traefik segment when using multiple rules
:priority: Priority of frontend rule
:redirect: Redirect to path with trailing slash
:returns: list of labels for traefik
"""
label_list = []
# check segment
segment = f'.{segment}' if segment is not None else ''
# fill list
label_list.append(f'traefik{segment}.frontend.priority={priority}')
if redirect:
label_list.append(
f'traefik{segment}.frontend.redirect.regex=^(.*)/{url_path}$$')
label_list.append(
f'traefik{segment}.frontend.redirect.replacement=$$1/{url_path}/')
label_list.append(
f'traefik{segment}.frontend.rule=PathPrefix:/{url_path};'
f'ReplacePathRegex:^/{url_path}/(.*) /$$1')
else:
label_list.append(
f'traefik{segment}.frontend.rule=PathPrefix:/{url_path}')
return label_list
def add_or_update_compose_service(compose_path, service_name, service_content):
"""Adds or replaces a service in a compose file
:compose_path: path of the compose file to change
:service_name: name of the service to add/replace
:service_content: service definition to add
"""
with open(compose_path, 'r+') as compose_f:
# load compose file
compose = yaml.load(compose_f)
# add / update service with template
compose['services'][service_name] = service_content
# 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()
# >>>
# ******************************
# Config file functions <<<
# ******************************
def generate_config_folders(base_dir):
"""Generate folders for configuration files
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
:base_dir: Path to add folders to
"""
base_path = base_dir + '/' + CUSTOM_DIR
if not os.path.exists(base_dir):
os.makedirs(base_dir)
print(f'Initialize configuration in {base_path}')
# generate empty config dirs
for d in CONFIG_DIRS:
new_dir = base_path + '/' + d
if not os.path.exists(new_dir):
os.makedirs(new_dir)
# copy template configs
for template_file in TEMPLATE_FILES:
copy_template_config(base_dir, template_file)
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
"""
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)
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)
:returns: a line as expected by mosquitto
"""
password_hash = crypt.crypt(password, crypt.mksalt(crypt.METHOD_SHA512))
line = f"{username}:{password_hash}"
return line
def generate_sftp_user_line(username, password, directories=None):
"""Generates a line for a sftp user with a hashed password
:username: username to use
:password: password that will be hashed (SHA512)
:directories: list of directories which the user should have
:returns: a line as expected by sshd
"""
# generate user line with hashed password
password_hash = crypt.crypt(password, crypt.mksalt(crypt.METHOD_SHA512))
line = f"{username}:{password_hash}:e:{UID}:{UID}"
# 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
def generate_traefik_user_line(username, password):
"""Generates a line for a traefik user with a bcrypt hashed password
:username: username to use
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
:password: password that will be hashed (bcrypt)
:returns: a line as expected by traefik
"""
password_hash = get_bcrypt_hash(password)
line = f"{username}:{password_hash}"
return line
def generate_pb_framr_entry(host, service):
"""Generates a single entry of the framr file
:host: host this entry is intended for
:service: entry from service enum
:returns: a dict fitting the asked entry
"""
entry = {}
entry['title'] = service.fullname
if service == Service.OPENHAB:
entry['url'] = f'http://{host}/'
pass
else:
entry['url'] = f'/{service.prefix}_{host}/'
entry['icon'] = service.icon
return entry
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],
universal_newlines=True)
return mos_result.returncode == 0
def generate_sftp_file(base_dir, username, password, direcories=None):
"""Generates a sftp password file
: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)
def generate_postgres_files(base_dir, username, password):
"""Generates postgres user and password files
:base_dir: path that contains custom config folder
:username: username to use
:password: password that will be used
"""
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
# content is purely username and (hashed) password
hashed_password = 'md5' + \
md5(username.encode() + password.encode()).hexdigest()
create_or_replace_config_file(
base_dir, EDIT_FILES['postgres_user'], username)
create_or_replace_config_file(
base_dir, EDIT_FILES['postgres_passwd'], hashed_password)
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', ''],
universal_newlines=True, stdout=PIPE)
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'
# host_names with sftp_ postfix
sftp_hosts = [f'sftp_{host}' for host in hosts]
# execute ssh-keygen
id_result = run(['ssh-keygen', '-t', 'ed25519', '-f', key_path, '-N', ''],
universal_newlines=True, stdout=PIPE)
# 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]
# collect sftp hosts as comma separated string
hosts_line = ','.join(h for h in sftp_hosts)
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
def generate_filebrowser_file(base_dir, username, password):
"""Generates a configuration for the filebrowser web app
: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 = {
"port": "80",
"address": "",
"username": f"{username}",
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
"password": f"{get_bcrypt_hash(password)}",
"log": "stdout",
"root": "/srv"
}
create_or_replace_config_file(base_dir, EDIT_FILES['filebrowser_conf'],
file_content, json=True)
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)
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 generate_pb_framr_file(base_dir, frames):
"""Generates config for pb framr landing page
:base_dir: path that contains custom config folder
:frames: a dict that contains hosts with matching name and services
"""
configs = []
for f in frames:
building = {
'instance': f['building'],
'entries': [generate_pb_framr_entry(f['host'], s)
for s in f['services'] if s.frontend]
}
configs.append(building)
create_or_replace_config_file(
base_dir, EDIT_FILES['pb_framr_pages'], configs, json=True)
def create_or_replace_config_file(base_dir, config_path, content, json=False):
"""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:
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
if json:
import json
json.dump(content, file, indent=2)
else:
file.write(content)
# Functions to modify existing files
def add_user_to_traefik_file(base_dir, username, password):
"""Adds or modifies user in traefik file
:base_dir: path that contains custom config folder
:username: username to use
:password: password that will be used
"""
# get current users
current_users = get_traefik_users(base_dir)
# ensure to delete old entry if user exists
users = [u for u in current_users if u['username'] != username]
# collect existing users lines
user_lines = []
for u in users:
user_lines.append(f"{u['username']}:{u['password']}")
# add new/modified user
user_lines.append(generate_traefik_user_line(username, password))
# generate content
file_content = "\n".join(user_lines)
create_or_replace_config_file(base_dir, EDIT_FILES['traefik_users'],
file_content)
def remove_user_from_traefik_file(base_dir, username):
"""Removes user from traefik file
:base_dir: path that contains custom config folder
:username: username to delete
"""
# get current users
current_users = get_traefik_users(base_dir)
# ensure to delete entry if user exists
users = [u for u in current_users if u['username'] != username]
# collect other user lines
user_lines = []
for u in users:
user_lines.append(f"{u['username']}:{u['password']}")
# generate content and write file
file_content = "\n".join(user_lines)
create_or_replace_config_file(base_dir, EDIT_FILES['traefik_users'],
file_content)
# Functions to get content from files
def get_users_from_files(base_dir):
"""Gets a list of users in files
:base_dir: dir to find files in
:returns: list of users
"""
users = []
# add treafik users
users.extend([u['username'] for u in get_traefik_users(base_dir)])
return users
def get_traefik_users(base_dir):
"""Gets a list of dicts containing users and password hashes
:base_dir: dir to find files in
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
:returns: list of users / password dicts
"""
users = []
# get treafik users
traefik_file = f"{base_dir}/{CUSTOM_DIR}/{EDIT_FILES['traefik_users']}"
with open(traefik_file, 'r') as file:
lines = file.read().splitlines()
for line in lines:
# username in traefik file is first entry unitl colon
username = line.split(':')[0]
password = line.split(':')[1]
users.append({"username": username, "password": password})
return users
# Additional helper functions
def get_bcrypt_hash(password):
"""Returns bcrypt hash for a password
:password: password to hash
:returns: bcrypt hash of password
"""
return bcrypt.hashpw(password.encode(), bcrypt.gensalt()).decode()
# >>>
# ******************************
# Docker machine functions <<<
# ******************************
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'],
universal_newlines=True,
stdout=PIPE)
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
:returns: True when machine is available
"""
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],
universal_newlines=True,
stdout=PIPE)
machine_envs = {}
lines = env_result.stdout.splitlines()
for line in lines:
if 'export' in line:
assign = line.split('export ', 1)[1]
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
env_entry = [a.strip('"') for a in assign.split('=', 1)]
machine_envs[env_entry[0]] = env_entry[1]
return machine_envs
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],
universal_newlines=True,
stdout=PIPE)
return machine_result.stdout.strip()
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
:return: True if swarm init was successful
"""
machine_ip = get_machine_ip(machine_name)
init_command = 'docker swarm init --advertise-addr ' + machine_ip
init_result = run(['docker-machine', 'ssh', machine_name, init_command],
universal_newlines=True)
return init_result.returncode == 0
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
:return: True if join to swarm was successful
"""
token_command = 'docker swarm join-token manager -q'
token_result = run(['docker-machine', 'ssh', leader_name, token_command],
universal_newlines=True,
stdout=PIPE)
token = token_result.stdout.strip()
leader_ip = get_machine_ip(leader_name)
logging.info(f"Swarm leader with ip {leader_ip} uses token {token}")
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],
universal_newlines=True)
return join_result.returncode == 0
def generate_swarm(machines):
"""Generates a swarm, the first machine will be the initial leader
:machines: list of machines in the swarm
"""
leader = None
for machine in machines:
# 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')
assign_label_to_node(leader, 'building',
leader, manager=leader)
else:
print(f'Machine {machine} joins swarm of leader {leader}')
if (join_swarm_machine(machine, leader)):
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
print('Joining swarm successful\n')
assign_label_to_node(machine, 'building',
machine, manager=leader)
def check_dir_on_machine(dirpath, machine):
"""Checks weather a dir exists on a machine
:dirpath: Directory to check
:machine: Machine to check
:returns: True when dir exists false otherwise
"""
check_command = f"[ -d {dirpath} ]"
check_result = run(['docker-machine', 'ssh', machine, check_command])
return check_result.returncode == 0
def check_file_on_machine(filepath, machine):
"""Checks weather a file exists on a machine
:filepath: File to check
:machine: Machine to check
:returns: True when file exists false otherwise
"""
check_command = f"[ -f {filepath} ]"
check_result = run(['docker-machine', 'ssh', machine, check_command])
return check_result.returncode == 0
def copy_files_to_machine(filepath, machine):
"""Copyies a directory and its content or a file to a machine
:filepath: Direcotry or file to copy
:machine: Machine to copy to
"""
run(['docker-machine', 'scp', '-r', filepath, f'{machine}:'])
def execute_command_on_machine(command, machine):
"""Executes a command on a docker machine
:command: Command to execute
:machine: Machine to execute command
"""
run([f'docker-machine ssh {machine} {command}'], shell=True)
# >>>
# ******************************
# Docker client commands <<<
# ******************************
def resolve_service_nodes(service):
"""Returnes nodes running on a specified service
:service: name or id of a service
:returns: list of nodes running the service
"""
node_result = run(['docker', 'service', 'ps', service,
'--format', '{{.Node}}',
'-f', 'desired-state=running'],
universal_newlines=True,
stdout=PIPE)
return node_result.stdout.splitlines()
def get_container_list(manager=None):
"""Return a list of containers running on a machine
:manager: Docker machine to use for command, otherwise local
:returns: list of containers
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
"""
client = get_docker_client(manager)
return [c.name for c in client.containers.list()]
def get_service_list(manager=None):
"""Return a list of services managed by a machine
:manager: Docker machine to use for command, otherwise local
:returns: list of services
"""
client = get_docker_client(manager)
return [s.name for s in client.services.list()]
def assign_label_to_node(nodeid, label, value, manager=None):
"""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
:manager: Docker machine to use for command, otherwise local
"""
client = get_docker_client(manager)
node = client.nodes.get(nodeid)
spec = node.attrs['Spec']
spec['Labels'][label] = value
node.update(spec)
logging.info(f'Assign label {label} with value {value} to {nodeid}')
client.close()
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)
"""
client = get_docker_client(building)
# 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):
print(f'Found multiple containers matching service name {service}, '
'ensure service is unambigous')
elif (len(containers) < 1):
print(f'Found no matching container for service name {service}')
else:
service_container = containers[0]
print(f'Executing {command} in container {service_container.name}'
f'({service_container.id}) on building {building}\n')
command_exec = service_container.exec_run(command)
print(command_exec.output.decode())
client.close()
def get_docker_client(manager=None):
"""Returns docker client instance
:manager: Optional machine to use, local otherwise
:returns: Docker client instance
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
"""
if manager:
machine_env = get_machine_env(manager)
client = docker.from_env(environment=machine_env)
else:
client = docker.from_env()
return client
# >>>
# ******************************
# CLI base commands <<<
# ******************************
def init_config_dirs_command(args):
"""Initialize config directories
:args: parsed commandline arguments
"""
base_dir = args.base_dir
if base_dir is None:
base_dir = os.getcwd()
# generate basic config folder
generate_config_folders(base_dir)
def assign_building_command(args):
"""Assigns the role of a building to a node
:args: parsed commandline arguments
"""
node = args.node
building = args.building
print(f'Assign role of building {building} to node {node}')
assign_label_to_node(node, 'building', building)
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
"""
building = args.building
target = args.target
if not check_machine_exists(target):
print(f'Machine with name {target} not found')
return
print(f'Restoring building {building} on machine {target}')
get_machine_env(target)
def interactive_command(args):
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
"""Top level function to start the interactive mode
:args: parsed command line arguments
"""
main_menu(args)
# >>>
# ******************************
# Interactive menu entries <<<
# ******************************
def main_menu(args):
""" Display main menu
"""
# Base directory for configs
base_dir = args.base_dir
if base_dir is None:
base_dir = os.getcwd()
# Main menu prompts selection contains function
choice = qust.select('Public Building Manager - Main Menu',
choices=load_main_entires(base_dir), style=st).ask()
# Call funtion of menu entry
choice(args)
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({'name': 'Create initial structure',
'value': init_menu})
else:
entries.append({'name': 'Manage Services',
'value': service_menu})
entries.append({'name': 'Manage Users',
'value': user_menu})
entries.append({'name': 'Manage Devices',
'value': device_menu})
entries.append({'name': 'Execute a command in a service container',
'value': exec_menu})
entries.append({'name': 'Exit', 'value': sys.exit})
return entries
def exit_menu(args):
"""Exits the programm
"""
sys.exit()
# *** Init Menu Entries ***
def init_menu(args):
"""Menu entry for initial setup and file generation
:args: Passed commandline arguments
"""
# Base directory for configs
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
base_dir = args.base_dir
if base_dir is None:
base_dir = os.getcwd()
# Prompts
stack_name = qust.text('Choose a name for your setup', style=st).ask()
hosts = qust.checkbox('What docker machines will be used?',
choices=generate_cb_choices(
get_machine_list()), style=st).ask()
# Ensure passwords match
password_match = False
while not password_match:
password = qust.password(
'Choose a password for the ohadmin user:', style=st).ask()
confirm = qust.password(
'Repeat password for the ohadmin user:', style=st).ask()
if password == confirm:
password_match = True
else:
print("Passwords did not match, try again")
# Initialize custom configuration dirs and templates
generate_config_folders(base_dir)
generate_initial_compose(base_dir)
# Generate config files based on input
username = ADMIN_USER
generate_sftp_file(base_dir, username, password)
generate_postgres_files(base_dir, username, password)
generate_mosquitto_file(base_dir, username, password)
generate_traefik_file(base_dir, username, password)
generate_volumerize_file(base_dir, hosts)
generate_filebrowser_file(base_dir, username, password)
generate_id_rsa_files(base_dir)
generate_host_key_files(base_dir, hosts)
frames = []
for i, host in enumerate(hosts):
building, services = init_machine_menu(base_dir, host, i)
frames.append({'host': host,
'building': building, 'services': services})
# When frames is not empty generate frame config
if frames:
generate_pb_framr_file(base_dir, frames)
# print(answers)
print(f"Configuration files for {stack_name} generated in {base_dir}")
# Check if changes shall be applied to docker environment
generate = qust.confirm(
'Apply changes to docker environment?', default=True, style=st).ask()
if generate:
generate_swarm(hosts)
def init_machine_menu(base_dir, host, increment):
"""Prompts to select server services
:base_dir: Directory of config files
:host: docker-machine host
:increment: incrementing number to ensure ports are unique
:return: choosen building name and services
"""
# Prompt for services
building = qust.text(f'Choose a name for building on server {host}',
default=f'{host}', style=st).ask()
services = qust.checkbox(f'What services shall {host} provide?',
choices=generate_cb_service_choices(checked=True),
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
style=st).ask()
if Service.SFTP in services:
add_sftp_service(base_dir, host, increment)
if Service.OPENHAB in services:
add_openhab_service(base_dir, host)
if Service.NODERED in services:
add_nodered_service(base_dir, host)
if Service.MQTT in services:
add_mqtt_service(base_dir, host, increment)
if Service.POSTGRES in services:
add_postgres_service(base_dir, host)
if Service.FILES in services:
add_file_service(base_dir, host)
return building, services
# *** Exec Menu Entries ***
def exec_menu(args):
"""Menu entry for executing commands in services
:args: Passed commandline arguments
"""
machine = docker_client_prompt(" to execute command at")
service_name = qust.select(
'Which service container shall execute the command?',
choices=get_container_list(machine), style=st).ask()
command = qust.text('What command should be executed?', style=st).ask()
run_command_in_service(service_name, command, machine)
# *** User Menu Entries ***
def user_menu(args):
"""Menu entry for user managment
:args: Passed commandline arguments
"""
# Base directory for configs
base_dir = args.base_dir
if base_dir is None:
base_dir = os.getcwd()
# Ask for action
choice = qust.select("What do you want to do?", choices=[
'Add a new user', 'Modify existing user', 'Exit'],
style=st).ask()
if "Add" in choice:
new_user_menu(base_dir)
elif "Modify" in choice:
modify_user_menu(base_dir)
def new_user_menu(base_dir):
"""Menu entry for new users
:base_dir: Directory of config files
"""
current_users = get_users_from_files(base_dir)
new_user = False
while not new_user:
username = qust.text("Choose a new username:", style=st).ask()
if username not in current_users:
new_user = True
else:
print(f"User with name {username} already exists, try again")
# Ensure passwords match
password_match = False
while not password_match:
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
password = qust.password(
f'Choose a password for the user {username}:', style=st).ask()
confirm = qust.password(
f'Repeat password for the user {username}:', style=st).ask()
if password == confirm:
password_match = True
else:
print("Passwords did not match, try again")
add_user_to_traefik_file(base_dir, username, password)
def modify_user_menu(base_dir):
"""Menu entry to remove users or change passwords
:base_dir: Directory of config files
"""
current_users = get_users_from_files(base_dir)
user = qust.select("Choose user to modify:",
choices=current_users, style=st).ask()
if user == 'ohadmin':
choices = [{'name': 'Delete user',
'disabled': 'Disabled: cannot delete admin user'},
'Change password', 'Exit']
else:
choices = ['Delete user', 'Change password', 'Exit']
action = qust.select(
f"What should we do with {user}?", choices=choices, style=st).ask()
if 'Delete' in action:
is_sure = qust.confirm(
f"Are you sure you want to delete user {user}?", style=st).ask()
if is_sure:
remove_user_from_traefik_file(base_dir, user)
elif 'Change' in action:
password_match = False
while not password_match:
password = qust.password(
f'Choose a password for the user {user}:', style=st).ask()
confirm = qust.password(
f'Repeat password for the user {user}:', style=st).ask()
if password == confirm:
password_match = True
else:
print("Passwords did not match, try again")
add_user_to_traefik_file(base_dir, user, password)
# *** Service Menu Entries ***
def service_menu(args):
"""Menu entry for service managment
:args: Passed commandline arguments
"""
# Base directory for configs
base_dir = args.base_dir
if base_dir is None:
base_dir = os.getcwd()
# Ask for action
choice = qust.select("What do you want to do?", choices=[
'Modify existing services', 'Add additional service',
'Exit'], style=st).ask()
if "Add" in choice:
service_add_menu(base_dir)
elif "Modify" in choice:
service_modify_menu(base_dir)
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
def service_add_menu(base_dir):
"""Menu to add additional services
:base_dir: Directory of config files
"""
services = [s for s in Service if s.additional]
service = qust.select(
'What service do you want to add?', style=st,
choices=generate_cb_service_choices(service_list=services)).ask()
host = qust.select('Where should the service be located?',
choices=generate_cb_choices(
get_machine_list()), style=st).ask()
identifier = qust.text(
'Input an all lower case identifier:', style=st).ask()
if service and host and identifier:
if service == Service.POSTGRES:
add_postgres_service(base_dir, host, postfix=identifier)
def service_modify_menu(base_dir):
"""Menu to modify services
:base_dir: Directory of config files
"""
services = get_current_services(base_dir)
service = qust.select(
'What service do you want to modify?', choices=services).ask()
if service in ['proxy', 'landing']:
choices = [{'name': 'Remove service',
'disabled': 'Disabled: cannot remove framework services'},
'Exit']
else:
choices = ['Remove service', 'Exit']
action = qust.select(
f"What should we do with {service}?", choices=choices, style=st).ask()
if 'Remove' in action:
delete_service(base_dir, service)
# *** Device Menu Functions ***
def device_menu(args):
"""Menu to manage devices
:args: Arguments form commandline
"""
print("Adding device")
# Base directory for configs
base_dir = args.base_dir
if base_dir is None:
base_dir = os.getcwd()
# Check if device scripts are installed
bin_path = '/usr/bin/enable-swarm-device'
choices = ['Install device scripts']
if os.path.exists(bin_path):
choices.append('Link device to service')
choices.append('Exit')
# Ask for action
choice = qust.select("What do you want to do? (root required)",
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
choices=choices, style=st).ask()
if "Install" in choice:
print("Installing device scripts (needs root)")
device_install_menu(base_dir)
elif "Link" in choice:
device_link_menu(base_dir)
def device_install_menu(base_dir):
"""Install scripts to link devices
:base_dir: Base directory of configuration files
"""
machine = docker_client_prompt(" to install usb support")
# Name of base dir on machines
external_base_dir = os.path.basename(base_dir)
# Check if files are available on targeted machine
machine_dir = f"{external_base_dir}/install-usb-support.sh"
print(machine_dir)
if not check_file_on_machine(machine_dir, machine):
print("Scripts missing on machine, will be copied")
copy_files_to_machine(base_dir, machine)
else:
print("Scripts available on machine")
execute_command_on_machine(f'sudo {machine_dir}', machine)
def device_link_menu(base_dir):
"""Link device to a service
:base_dir: Base directory of configuration files
"""
machine = docker_client_prompt(" to link device on")
device = qust.select("What device should be linked?",
choices=USB_DEVICES, style=st).ask()
# Start systemd service that ensures link (escapes of backslash needed)
link_cmd = f"sudo systemctl status swarm-device@" + \
f"{device}\\\\\\\\x20openhab.service"
# Needs enable to keep after reboot
execute_command_on_machine(link_cmd, machine)
print(f"Linked device {device} to openHAB service on machine {machine}")
# *** Menu Helper Functions ***
def generate_cb_choices(list, checked=False):
"""Generates checkbox entries for lists of strings
:list: pyhton list that shall be converted
:checked: if true, selections will be checked by default
:returns: A list of dicts with name keys
"""
return [{'name': m, 'checked': checked} for m in list]
def generate_cb_service_choices(checked=False, service_list=None):
"""Generates checkbox entries for the sevice enum
:checked: if true, selections will be checked by default
:service_list: optional list of services, use all if empty
:returns: A list of dicts with name keys
"""
services = service_list if service_list is not None else Service
return [
{'name': s.fullname, 'value': s, 'checked': checked} for s in services
]
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
def docker_client_prompt(message_details=''):
"""Show list of docker machines and return selection
:manager: Optional machine to use, prompt otherwise
:returns: Docker client instance
"""
machine = qust.select(f'Choose manager machine{message_details}',
choices=get_machine_list(), style=st).ask()
return machine
# >>>
# ******************************
# Script main (entry) <<<
# ******************************
if __name__ == '__main__':
import argparse
parser = argparse.ArgumentParser(
prog='building_manager',
description='Generate and manage multi'
'building configurations of openHAB with docker swarm')
parser.add_argument(
'--base_dir',
'-d',
help='Directory to creat config folders in, default is current dir')
subparsers = parser.add_subparsers()
# Interactive mode
parser_interactive = subparsers.add_parser(
'interactive',
help='Starts the interactive mode of the building manager')
parser_interactive.set_defaults(func=interactive_command)
# Restore command
parser_restore = subparsers.add_parser('restore', help='Restore backups')
parser_restore.add_argument(
'building', help='Name (label) of the building that shall be restored')
parser_restore.add_argument(
'target', help='Name of the machine to restore to')
parser_restore.set_defaults(func=restore_command)
# 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)
# 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)
# 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)
# Parse arguments into args dict
args = parser.parse_args()
# when no subcommand is defined show interactive menu
try:
args.func(args)
except AttributeError:
interactive_command(args)
# >>>
# --- vim settings ---
# vim:foldmethod=marker:foldlevel=0:foldmarker=<<<,>>>