Container: T7473: Fix show/monitor container log failure and allow log-driver to be configured per container

Author: opswill

data/templates/container/containers.conf.j2

@@ -172,11 +172,7 @@ default_sysctls = [
 
 # Logging driver for the container. Available options: k8s-file and journald.
 #
-{% if log_driver is vyos_defined %}
-log_driver = "{{ log_driver }}"
-{% else %}
 #log_driver = "k8s-file"
-{% endif %}
 
 # Maximum size allowed for the container log file. Negative numbers indicate
 # that no size limit is imposed. If positive, it must be >= 8192 to match or

interface-definitions/container.xml.in

@@ -532,6 +532,30 @@
               </leafNode>
             </children>
           </tagNode>
+          <leafNode name="log-driver">
+            <properties>
+              <help>Configure container log driver</help>
+              <completionHelp>
+                <list>k8s-file journald none</list> <!-- Added none -->
+              </completionHelp>
+              <valueHelp>
+                <format>k8s-file</format>
+                <description>Logs to plain-text file</description>
+              </valueHelp>
+              <valueHelp>
+                <format>journald</format>
+                <description>Logs to systemd's journal</description>
+              </valueHelp>
+                <valueHelp>
+                <format>none</format>
+                <description>Disable logging for the container</description>
+              </valueHelp>
+              <constraint>
+                <regex>(k8s-file|journald|none)</regex>
+              </constraint>
+            </properties>
+             <defaultValue>k8s-file</defaultValue>
+          </leafNode>
         </children>
       </tagNode>
       <tagNode name="network">
@@ -627,25 +651,6 @@
           </node>
         </children>
       </tagNode>
-      <leafNode name="log-driver">
-        <properties>
-          <help>Configure container log driver</help>
-          <completionHelp>
-            <list>k8s-file journald</list>
-          </completionHelp>
-          <valueHelp>
-            <format>k8s-file</format>
-            <description>Logs to plain-text json file</description>
-          </valueHelp>
-          <valueHelp>
-            <format>journald</format>
-            <description>Logs to systemd's journal</description>
-          </valueHelp>
-          <constraint>
-            <regex>(k8s-file|journald)</regex>
-          </constraint>
-        </properties>
-      </leafNode>
     </children>
   </node>
 </interfaceDefinition>

op-mode-definitions/container.xml.in

@@ -89,7 +89,7 @@
                 <path>container name</path>
               </completionHelp>
             </properties>
-            <command>sudo podman logs --follow --names "$4"</command>
+            <command>sudo ${vyos_op_scripts_dir}/container.py show_log --follow --name "$4"</command>
           </tagNode>
         </children>
       </node>
@@ -133,7 +133,7 @@
               </completionHelp>
             </properties>
             <!-- no admin check -->
-            <command>sudo podman logs --names "$4"</command>
+            <command>sudo ${vyos_op_scripts_dir}/container.py show_log --name "$4"</command>
           </tagNode>
           <node name="network">
             <properties>
@@ -162,7 +162,7 @@
                 <path>container name</path>
               </completionHelp>
             </properties>
-            <command>sudo podman logs --names "$4"</command>
+            <command>sudo ${vyos_op_scripts_dir}/container.py show_log --name "$4"</command>
           </tagNode>
         </children>
       </node>

smoketest/scripts/cli/test_container.py

@@ -95,7 +95,7 @@ def test_basic(self):
                 '4096',
             ]
         )
-
+        self.cli_set(base_path + ['name', cont_name, 'log-driver', 'journald'])
         # commit changes
         self.cli_commit()
 
@@ -110,14 +110,10 @@ def test_basic(self):
         tmp = cmd(f'sudo podman exec -it {cont_name} sysctl kernel.msgmax')
         self.assertEqual(tmp, 'kernel.msgmax = 4096')
 
-    def test_log_driver(self):
-        self.cli_set(base_path + ['log-driver', 'journald'])
-
-        self.cli_commit()
-
-        tmp = cmd('podman info --format "{{ .Host.LogDriver }}"')
+        tmp = cmd(f'podman container inspect {cont_name} --format "{{{{ .HostConfig.LogConfig.Type }}}}""')
         self.assertEqual(tmp, 'journald')
 
+
     def test_name_server(self):
         cont_name = 'dns-test'
         net_name = 'net-test'

src/conf_mode/container.py

@@ -310,6 +310,7 @@ def generate_run_arguments(name, container_config):
     memory = container_config['memory']
     shared_memory = container_config['shared_memory']
     restart = container_config['restart']
+    log_driver = container_config['log_driver']
 
     # Add sysctl options
     sysctl_opt = ''
@@ -408,7 +409,7 @@ def generate_run_arguments(name, container_config):
             name_server += f'--dns {ns}'
 
     container_base_cmd = f'--detach --interactive --tty --replace {capabilities} {privileged} --cpus {cpu_quota} {sysctl_opt} ' \
-                         f'--memory {memory}m --shm-size {shared_memory}m --memory-swap 0 --restart {restart} ' \
+                         f'--memory {memory}m --shm-size {shared_memory}m --memory-swap 0 --restart {restart} --log-driver={log_driver} ' \
                          f'--name {name} {hostname} {device} {port} {name_server} {volume} {tmpfs} {env_opt} {label} {uid} {host_pid}'
 
     entrypoint = ''

src/op_mode/container.py

@@ -16,6 +16,7 @@
 
 import json
 import sys
+import subprocess
 
 from vyos.utils.process import cmd
 from vyos.utils.process import rc_cmd
@@ -109,6 +110,45 @@ def restart(name: str):
     print(f'Container "{name}" restarted!')
     return output
 
+def show_log(name: str, follow: bool = False, raw: bool = False):
+    """
+    Show or monitor logs for a specific container.
+    Use --follow to continuously stream logs.
+    """
+    from vyos.configquery import ConfigTreeQuery
+    conf = ConfigTreeQuery()
+    container = conf.get_config_dict(['container', 'name', name],  get_first_key=True, with_recursive_defaults=True)
+    log_type = container.get('log-driver')
+    if log_type == 'k8s-file':
+        if follow:
+            log_command_list = ['sudo', 'podman', 'logs', '--follow', '--names', name]
+        else:
+            log_command_list = ['sudo', 'podman', 'logs', '--names', name]
+    if log_type == 'journald':
+        if follow:
+            log_command_list = ['journalctl', '--follow', '--unit', f'vyos-container-{name}.service']
+        else:
+            log_command_list = ['journalctl', '-e', '--no-pager', '--unit', f'vyos-container-{name}.service']
+    if log_type == 'none':
+        print(f'Container "{name}" has disabled logs.')
+        return None
+
+    process = None
+    try:
+        process = subprocess.Popen(log_command_list,
+                                   stdout=sys.stdout,
+                                   stderr=sys.stderr)
+        process.wait()
+    except KeyboardInterrupt:
+        if process:
+            process.terminate()
+            process.wait()
+        return None
+    except Exception as e:
+        raise vyos.opmode.InternalError(f"Error starting logging command: {e} ")
+    return None
+
+
 if __name__ == '__main__':
     try:
         res = vyos.opmode.run(sys.modules[__name__])