Make console logging optional

Logging the console to a file prevents a serial PTY from also being
available, which is not ideal. Add a toggle to enable console logging
which defaults to false, meaning the old PTY behaviour is maintained by
default.

Author: Will Miller

README.md

@@ -60,6 +60,11 @@ Role Variables
       Each network interface is defined with the following dict:
         - `network`: Name of the network to which an interface should be attached.
 
+    - `console_log_enabled`: if `true`, log console output to a file at the
+      path specified by `console_log_path`, **instead of** to a PTY. If
+      `false`, direct terminal output to a PTY at serial port 0. Default is
+      `false`.
+
     - `console_log_path`: Path to console log file. Default is
       `{{ libvirt_vm_default_console_log_dir }}/{{ name }}-console.log`.
 

tasks/main.yml

@@ -13,6 +13,7 @@
 
 - include_tasks: vm.yml
   vars:
+    console_log_enabled: "{{ vm.console_log_enabled | default(false) }}"
     console_log_path: "{{ vm.console_log_path | default(libvirt_vm_default_console_log_dir + '/' +  vm.name + '-console.log', true) }}"
     machine_default: "{{ none if libvirt_vm_engine == 'kvm' else 'pc-1.0' }}"
     machine: "{{ vm.machine | default(machine_default, true) }}"

tasks/vm.yml

@@ -7,6 +7,7 @@
     group: qemu
     recurse: true
     mode: 0770
+  when: console_log_enabled | bool
   become: true
 
 - name: Ensure the VM is defined

templates/vm.xml.j2

@@ -31,13 +31,22 @@
       <model type='virtio'/>
     </interface>
 {% endfor %}
-     <serial type='file'>
-       <source path='{{ console_log_path }}'/>
-     </serial>
-     <serial type='pty'/>
-     <console type='file'>
-       <source path='{{ console_log_path }}'/>
-       <target type='serial'/>
-     </console>
+{% if console_log_enabled | bool %}
+    <serial type='file'>
+      <source path='{{ console_log_path }}'/>
+    </serial>
+    <serial type='pty'/>
+    <console type='file'>
+      <source path='{{ console_log_path }}'/>
+      <target type='serial'/>
+    </console>
+{% else %}
+    <serial type='pty'>
+      <target port='0'/>
+    </serial>
+    <console type='pty'>
+      <target type='serial' port='0'/>
+    </console>
+{% endif %}
   </devices>
 </domain>