From 52ce659509022807c4a38fcb791abd325f3e8b00 Mon Sep 17 00:00:00 2001
From: sarthurdev <965089+sarthurdev@users.noreply.github.com>
Date: Wed, 6 Jul 2022 19:35:11 +0200
Subject: syslog: T4500: Remove max-size from rsyslog leaving rotation to
logrotate
After discussion with @zsdc this was decided the better long term fix
* Removes hourly logrotate cron in favour of systemd timer override
---
data/templates/syslog/rsyslog.conf.j2 | 4 ++
debian/vyos-1x.install | 1 -
.../include/version/system-version.xml.i | 2 +-
interface-definitions/system-syslog.xml.in | 25 -----------
smoketest/configs/basic-vyos | 4 ++
src/conf_mode/system-syslog.py | 2 -
src/etc/cron.hourly/vyos-logrotate-hourly | 4 --
src/etc/logrotate.d/vyos-rsyslog | 2 +-
.../system/logrotate.timer.d/10-override.conf | 2 +
src/migration-scripts/system/24-to-25 | 52 ++++++++++++++++++++++
10 files changed, 64 insertions(+), 34 deletions(-)
delete mode 100755 src/etc/cron.hourly/vyos-logrotate-hourly
create mode 100644 src/etc/systemd/system/logrotate.timer.d/10-override.conf
create mode 100755 src/migration-scripts/system/24-to-25
diff --git a/data/templates/syslog/rsyslog.conf.j2 b/data/templates/syslog/rsyslog.conf.j2
index 4445d568b..abe880283 100644
--- a/data/templates/syslog/rsyslog.conf.j2
+++ b/data/templates/syslog/rsyslog.conf.j2
@@ -10,7 +10,11 @@ $MarkMessagePeriod {{ files['global']['marker-interval'] }}
$PreserveFQDN on
{% endif %}
{% for file, file_options in files.items() %}
+{% if file_options['max-size'] is vyos_defined %}
$outchannel {{ file }},{{ file_options['log-file'] }},{{ file_options['max-size'] }},{{ file_options['action-on-max-size'] }}
+{% else %}
+$outchannel {{ file }},{{ file_options['log-file'] }}
+{% endif %}
{{ file_options['selectors'] }} :omfile:${{ file }}
{% endfor %}
{% if console is defined and console is not none %}
diff --git a/debian/vyos-1x.install b/debian/vyos-1x.install
index 493c896eb..edd090993 100644
--- a/debian/vyos-1x.install
+++ b/debian/vyos-1x.install
@@ -1,4 +1,3 @@
-etc/cron.hourly
etc/dhcp
etc/ipsec.d
etc/logrotate.d
diff --git a/interface-definitions/include/version/system-version.xml.i b/interface-definitions/include/version/system-version.xml.i
index 3cf92001c..b7650c782 100644
--- a/interface-definitions/include/version/system-version.xml.i
+++ b/interface-definitions/include/version/system-version.xml.i
@@ -1,3 +1,3 @@
-
+
diff --git a/interface-definitions/system-syslog.xml.in b/interface-definitions/system-syslog.xml.in
index 480cb1ca6..90c3de5c1 100644
--- a/interface-definitions/system-syslog.xml.in
+++ b/interface-definitions/system-syslog.xml.in
@@ -390,31 +390,6 @@
Logging to system standard location
-
-
- Log file size and rotation characteristics
-
-
-
-
- Number of saved files (default is 5)
-
- [0-9]+
-
- illegal characters in number of files
-
-
-
-
- Size of log files (in kbytes, default is 256)
-
- [0-9]+
-
- illegal characters in size
-
-
-
-
Facility for logging
diff --git a/smoketest/configs/basic-vyos b/smoketest/configs/basic-vyos
index e6f89954f..23186b9b8 100644
--- a/smoketest/configs/basic-vyos
+++ b/smoketest/configs/basic-vyos
@@ -128,6 +128,10 @@ system {
name-server 192.168.0.1
syslog {
global {
+ archive {
+ file 5
+ size 512
+ }
facility all {
level info
}
diff --git a/src/conf_mode/system-syslog.py b/src/conf_mode/system-syslog.py
index a9d3bbe31..20132456c 100755
--- a/src/conf_mode/system-syslog.py
+++ b/src/conf_mode/system-syslog.py
@@ -52,8 +52,6 @@ def get_config(config=None):
{
'global': {
'log-file': '/var/log/messages',
- 'max-size': 262144,
- 'action-on-max-size': '/usr/sbin/logrotate /etc/logrotate.d/vyos-rsyslog',
'selectors': '*.notice;local7.debug',
'max-files': '5',
'preserver_fqdn': False
diff --git a/src/etc/cron.hourly/vyos-logrotate-hourly b/src/etc/cron.hourly/vyos-logrotate-hourly
deleted file mode 100755
index f4f56a9c2..000000000
--- a/src/etc/cron.hourly/vyos-logrotate-hourly
+++ /dev/null
@@ -1,4 +0,0 @@
-#!/bin/sh
-
-test -x /usr/sbin/logrotate || exit 0
-/usr/sbin/logrotate /etc/logrotate.conf
diff --git a/src/etc/logrotate.d/vyos-rsyslog b/src/etc/logrotate.d/vyos-rsyslog
index 28ea088e2..3c087b94e 100644
--- a/src/etc/logrotate.d/vyos-rsyslog
+++ b/src/etc/logrotate.d/vyos-rsyslog
@@ -4,7 +4,7 @@
nomail
notifempty
rotate 10
- size 262144
+ size 1M
postrotate
# inform rsyslog service about rotation
/usr/lib/rsyslog/rsyslog-rotate
diff --git a/src/etc/systemd/system/logrotate.timer.d/10-override.conf b/src/etc/systemd/system/logrotate.timer.d/10-override.conf
new file mode 100644
index 000000000..f50c2b082
--- /dev/null
+++ b/src/etc/systemd/system/logrotate.timer.d/10-override.conf
@@ -0,0 +1,2 @@
+[Timer]
+OnCalendar=hourly
diff --git a/src/migration-scripts/system/24-to-25 b/src/migration-scripts/system/24-to-25
new file mode 100755
index 000000000..c2f70689d
--- /dev/null
+++ b/src/migration-scripts/system/24-to-25
@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2022 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 .
+#
+# Migrate system syslog global archive to system logs logrotate messages
+
+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', 'syslog', 'global', 'archive']
+config = ConfigTree(config_file)
+
+if not config.exists(base):
+ exit(0)
+
+if config.exists(base + ['file']):
+ tmp = config.return_value(base + ['file'])
+ config.set(['system', 'logs', 'logrotate', 'messages', 'rotate'], value=tmp)
+
+if config.exists(base + ['size']):
+ tmp = config.return_value(base + ['size'])
+ tmp = max(round(int(tmp) / 1024), 1) # kb -> mb
+ config.set(['system', 'logs', 'logrotate', 'messages', 'max-size'], value=tmp)
+
+config.delete(base)
+
+try:
+ with open(file_name, 'w') as f:
+ f.write(config.to_string())
+except OSError as e:
+ print(f'Failed to save the modified config: {e}')
+ exit(1)
--
cgit v1.2.3