From 193323ba5d2f0318ceb81b3969c0181ba3125cf2 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Sat, 21 Nov 2020 00:34:25 +0100 Subject: system: T3078: rename "system options" -> "system option" By design a CLI node should not be named by its plural but rather describe it as singular. --- interface-definitions/system-option.xml.in | 120 ++++++++++++++++++++++++ interface-definitions/system-options.xml.in | 120 ------------------------ src/conf_mode/system-option.py | 136 +++++++++++++++++++++++++++ src/conf_mode/system-options.py | 137 ---------------------------- src/migration-scripts/system/19-to-20 | 64 +++++++++++++ 5 files changed, 320 insertions(+), 257 deletions(-) create mode 100644 interface-definitions/system-option.xml.in delete mode 100644 interface-definitions/system-options.xml.in create mode 100755 src/conf_mode/system-option.py delete mode 100755 src/conf_mode/system-options.py create mode 100755 src/migration-scripts/system/19-to-20 diff --git a/interface-definitions/system-option.xml.in b/interface-definitions/system-option.xml.in new file mode 100644 index 000000000..26b78c8a4 --- /dev/null +++ b/interface-definitions/system-option.xml.in @@ -0,0 +1,120 @@ + + + + + + + System Options + 9999 + + + + + System action on Ctrl-Alt-Delete keystroke + + ignore reboot poweroff + + + ignore + Ignore key sequence + + + reboot + Reboot system + + + poweroff + Poweroff system + + + ^(ignore|reboot|poweroff)$ + + Must be ignore, reboot, or poweroff + + + + + System keyboard layout, type ISO2 + + us fr de fi no dk + + + us + United States of America + + + fr + France + + + de + Germany + + + fi + Finland + + + no + Norway + + + dk + Denmark + + + us + + + + Tune system performance + + throughput latency + + + throughput + Tune for maximum network throughput + + + latency + Tune for low network latency + + + ^(throughput|latency)$ + + + + + + Global options used for HTTP client + + + #include + #include + + + + + Reboot system on kernel panic + + + + + + Global options used for SSH client + + + #include + + + + + plays sound via system speaker when you can login + + + + + + + + diff --git a/interface-definitions/system-options.xml.in b/interface-definitions/system-options.xml.in deleted file mode 100644 index 12e4044af..000000000 --- a/interface-definitions/system-options.xml.in +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - - System Options - 9999 - - - - - plays sound via system speaker when you can login - - - - - - Ctrl-Alt-Delete action - - ignore reboot poweroff - - - ignore - Ignore Ctrl-Alt-Delete - - - reboot - Reboot VyOS - - - poweroff - Poweroff VyOS - - - ^(ignore|reboot|poweroff)$ - - Must be ignore, reboot, or poweroff - - - - - Tune system performance - - throughput latency - - - throughput - Tune for maximum network throughput - - - latency - Tune for low network latency - - - ^(throughput|latency)$ - - - - - - Global options used for HTTP client - - - #include - #include - - - - - Reboot system on kernel panic - - - - - - Global options used for SSH client - - - #include - - - - - System keyboard layout, type ISO2 - - us fr de fi no dk - - - us - United States of America - - - fr - France - - - de - Germany - - - fi - Finland - - - no - Norway - - - dk - Denmark - - - us - - - - - - diff --git a/src/conf_mode/system-option.py b/src/conf_mode/system-option.py new file mode 100755 index 000000000..2376e5d44 --- /dev/null +++ b/src/conf_mode/system-option.py @@ -0,0 +1,136 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2019-2020 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +import os + +from netifaces import interfaces +from sys import exit +from time import sleep + +from vyos.config import Config +from vyos.configdict import dict_merge +from vyos.template import render +from vyos.util import cmd +from vyos.validate import is_addr_assigned +from vyos.xml import defaults +from vyos import ConfigError +from vyos import airbag +airbag.enable() + +curlrc_config = r'/etc/curlrc' +ssh_config = r'/etc/ssh/ssh_config' +systemd_action_file = '/lib/systemd/system/ctrl-alt-del.target' + +def get_config(config=None): + if config: + conf = config + else: + conf = Config() + base = ['system', 'option'] + options = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=True) + + # We have gathered the dict representation of the CLI, but there are default + # options which we need to update into the dictionary retrived. + default_values = defaults(base) + options = dict_merge(default_values, options) + + return options + +def verify(options): + if 'http_client' in options: + config = options['http_client'] + if 'source_interface' in config: + if not config['source_interface'] in interfaces(): + raise ConfigError(f'Source interface {source_interface} does not ' + f'exist'.format(**config)) + + if {'source_address', 'source_interface'} <= set(config): + raise ConfigError('Can not define both HTTP source-interface and source-address') + + if 'source_address' in config: + if not is_addr_assigned(config['source_address']): + raise ConfigError('No interface with give address specified!') + + if 'ssh_client' in options: + config = options['ssh_client'] + if 'source_address' in config: + if not is_addr_assigned(config['source_address']): + raise ConfigError('No interface with give address specified!') + + return None + +def generate(options): + render(curlrc_config, 'system/curlrc.tmpl', options, trim_blocks=True) + render(ssh_config, 'system/ssh_config.tmpl', options, trim_blocks=True) + return None + +def apply(options): + # System bootup beep + if 'startup_beep' in options: + cmd('systemctl enable vyos-beep.service') + else: + cmd('systemctl disable vyos-beep.service') + + # Ctrl-Alt-Delete action + if os.path.exists(systemd_action_file): + os.unlink(systemd_action_file) + if 'ctrl_alt_del' in options: + if options['ctrl_alt_del'] == 'reboot': + os.symlink('/lib/systemd/system/reboot.target', systemd_action_file) + elif options['ctrl_alt_del'] == 'poweroff': + os.symlink('/lib/systemd/system/poweroff.target', systemd_action_file) + + # Configure HTTP client + if 'http_client' not in options: + if os.path.exists(curlrc_config): + os.unlink(curlrc_config) + + # Configure SSH client + if 'ssh_client' not in options: + if os.path.exists(ssh_config): + os.unlink(ssh_config) + + # Reboot system on kernel panic + with open('/proc/sys/kernel/panic', 'w') as f: + if 'reboot_on_panic' in options: + f.write('60') + else: + f.write('0') + + # tuned - performance tuning + if 'performance' in options: + cmd('systemctl restart tuned.service') + # wait until daemon has started before sending configuration + while (int(os.system('systemctl is-active --quiet tuned.service')) != 0): + sleep(0.250) + cmd('tuned-adm profile network-{performance}'.format(**options)) + else: + cmd('systemctl stop tuned.service') + + # Keyboard layout - there will be always the default key inside the dict + # but we check for key existence anyway + if 'keyboard_layout' in options: + cmd('loadkeys -C /dev/console {keyboard_layout}'.format(**options)) + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) diff --git a/src/conf_mode/system-options.py b/src/conf_mode/system-options.py deleted file mode 100755 index 1061b90ac..000000000 --- a/src/conf_mode/system-options.py +++ /dev/null @@ -1,137 +0,0 @@ -#!/usr/bin/env python3 -# -# Copyright (C) 2019-2020 VyOS maintainers and contributors -# -# This program is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License version 2 or later as -# published by the Free Software Foundation. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . - -import os - -from netifaces import interfaces -from sys import exit -from time import sleep - -from vyos.config import Config -from vyos.configdict import dict_merge -from vyos.template import render -from vyos.util import cmd -from vyos.validate import is_addr_assigned -from vyos.xml import defaults -from vyos import ConfigError -from vyos import airbag -airbag.enable() - -curlrc_config = r'/etc/curlrc' -ssh_config = r'/etc/ssh/ssh_config' -systemd_action_file = '/lib/systemd/system/ctrl-alt-del.target' - -def get_config(config=None): - if config: - conf = config - else: - conf = Config() - base = ['system', 'options'] - options = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=True) - - # We have gathered the dict representation of the CLI, but there are default - # options which we need to update into the dictionary retrived. - default_values = defaults(base) - options = dict_merge(default_values, options) - - return options - -def verify(options): - if 'http_client' in options: - config = options['http_client'] - if 'source_interface' in config: - if not config['source_interface'] in interfaces(): - raise ConfigError(f'Source interface {source_interface} does not ' - f'exist'.format(**config)) - - if {'source_address', 'source_interface'} <= set(config): - raise ConfigError('Can not define both HTTP source-interface and source-address') - - if 'source_address' in config: - if not is_addr_assigned(config['source_address']): - raise ConfigError('No interface with give address specified!') - - if 'ssh_client' in options: - config = options['ssh_client'] - if 'source_address' in config: - if not is_addr_assigned(config['source_address']): - raise ConfigError('No interface with give address specified!') - - return None - -def generate(options): - render(curlrc_config, 'system/curlrc.tmpl', options, trim_blocks=True) - render(ssh_config, 'system/ssh_config.tmpl', options, trim_blocks=True) - return None - -def apply(options): - # System bootup beep - if 'beep_if_fully_booted' in options: - cmd('systemctl enable vyos-beep.service') - else: - cmd('systemctl disable vyos-beep.service') - - # Ctrl-Alt-Delete action - if os.path.exists(systemd_action_file): - os.unlink(systemd_action_file) - if 'ctrl_alt_del_action' in options: - if options['ctrl_alt_del_action'] == 'reboot': - os.symlink('/lib/systemd/system/reboot.target', systemd_action_file) - elif options['ctrl_alt_del_action'] == 'poweroff': - os.symlink('/lib/systemd/system/poweroff.target', systemd_action_file) - - # Configure HTTP client - if 'http_client' not in options: - if os.path.exists(curlrc_config): - os.unlink(curlrc_config) - - # Configure SSH client - if 'ssh_client' not in options: - if os.path.exists(ssh_config): - os.unlink(ssh_config) - - # Reboot system on kernel panic - with open('/proc/sys/kernel/panic', 'w') as f: - if 'reboot_on_panic' in options: - f.write('60') - else: - f.write('0') - - # tuned - performance tuning - if 'performance' in options: - cmd('systemctl restart tuned.service') - # wait until daemon has started before sending configuration - while (int(os.system('systemctl is-active --quiet tuned.service')) != 0): - sleep(0.250) - cmd('tuned-adm profile network-{performance}'.format(**options)) - else: - cmd('systemctl stop tuned.service') - - # Keyboard layout - there will be always the default key inside the dict - # but we check for key existence anyway - if 'keyboard_layout' in options: - cmd('loadkeys -C /dev/console {keyboard_layout}'.format(**options)) - -if __name__ == '__main__': - try: - c = get_config() - verify(c) - generate(c) - apply(c) - except ConfigError as e: - print(e) - exit(1) - diff --git a/src/migration-scripts/system/19-to-20 b/src/migration-scripts/system/19-to-20 new file mode 100755 index 000000000..eb20fd8db --- /dev/null +++ b/src/migration-scripts/system/19-to-20 @@ -0,0 +1,64 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2020 VyOS maintainers and contributors +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 or later as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +# T3048: remove smp-affinity node from ethernet and use tuned instead + +import os + +from sys import exit, argv +from vyos.configtree import ConfigTree + +if (len(argv) < 1): + print("Must specify file name!") + exit(1) + +file_name = argv[1] +with open(file_name, 'r') as f: + config_file = f.read() + +base = ['system', 'options'] +base_new = ['system', 'option'] +config = ConfigTree(config_file) + +if not config.exists(base): + # Nothing to do + exit(0) + +if config.exists(base_new): + for node in config.list_nodes(base): + config.copy(base + [node], base_new + [node]) +else: + config.copy(base, base_new) + +config.delete(base) + +# Rename "system option beep-if-fully-booted" -> "system option startup-beep" +base_beep = base_new + ['beep-if-fully-booted'] +if config.exists(base_beep): + config.rename(base_beep, 'startup-beep') + +# Rename "system option ctrl-alt-del-action" -> "system option ctrl-alt-delete" +base_ctrl_alt_del = base_new + ['ctrl-alt-del-action'] +if config.exists(base_ctrl_alt_del): + config.rename(base_ctrl_alt_del, 'ctrl-alt-delete') + + +try: + with open(file_name, 'w') as f: + f.write(config.to_string()) +except OSError as e: + print("Failed to save the modified config: {}".format(e)) + exit(1) -- cgit v1.2.3