Merge "Introduce nova virtlogd wrapper"

deployment/nova/nova-libvirt-container-puppet.yaml

@@ -281,6 +281,22 @@ parameters:
     default: "/var/lib/tripleo-config/ceph"
     description: |
       The path where the Ceph Cluster config files are stored on the host.
+  NovaEnableVirtlogdContainerWrapper:
+    description: Generate a virtlogd wrapper script so that virtlogd launches
+                 in a separate container and won't get restarted e.g. on minor
+                 updates.
+    type: boolean
+    default: true
+  VirtlogdWrapperDebug:
+    type: boolean
+    default: false
+    description: Controls debugging for the wrapper scripts.
+  DeployIdentifier:
+    default: ''
+    type: string
+    description: >
+      Setting this to a unique value will re-run any deployment tasks which
+      perform configuration on a Heat stack-update.
 
 conditions:
 
@@ -362,6 +378,9 @@ conditions:
   key_size_qemu_client_override_unset: {equals: [{get_param: QemuClientCertificateKeySize}, '']}
   key_size_qemu_server_override_unset: {equals: [{get_param: QemuServerCertificateKeySize}, '']}
 
+  virtlogd_wrapper_enabled: {equals: [{get_param: NovaEnableVirtlogdContainerWrapper}, true]}
+  service_debug_unset: {equals : [{get_param: VirtlogdWrapperDebug}, false]}
+
 resources:
   RoleParametersValue:
     type: OS::Heat::Value
@@ -415,6 +434,15 @@ outputs:
           - get_attr: [NovaLibvirtLogging, config_settings]
           # we include ::nova::compute::libvirt::services in nova/libvirt profile
           - nova::compute::libvirt::manage_libvirt_services: false
+            tripleo::profile::base::nova::virtlogd_wrapper::enable_wrapper: {get_param: NovaEnableVirtlogdContainerWrapper}
+            # don't think this is a good place as /var/lib/nova can also be shared storage
+            tripleo::profile::base::nova::virtlogd_wrapper::virtlogd_process_wrapper: '/var/lib/container-config-scripts/virtlogd_wrapper'
+            tripleo::profile::base::nova::virtlogd_wrapper::virtlogd_image: {get_param: ContainerNovaLibvirtImage}
+            tripleo::profile::base::nova::virtlogd_wrapper::debug:
+              if:
+                - service_debug_unset
+                - {get_attr: [NovaBase, role_data, config_settings, 'nova::logging::debug']}
+                - {get_param: VirtlogdWrapperDebug}
           # we manage migration in nova common puppet profile
             nova::compute::libvirt::migration_support: false
             nova::compute::rbd::libvirt_images_rbd_ceph_conf:
@@ -543,7 +571,13 @@ outputs:
                           default_user: {get_param: CephClientUserName}
                           multiconfig: {get_param: CinderRbdMultiConfig}
         /var/lib/kolla/config_files/nova_virtlogd.json:
-          command: /usr/sbin/virtlogd --config /etc/libvirt/virtlogd.conf
+          # IF virtlogd_wrapper_enabled run the wrapper script
+          # if not use current command
+          command:
+            if:
+              - virtlogd_wrapper_enabled
+              - /usr/local/bin/virtlogd_wrapper
+              - /usr/sbin/virtlogd --config /etc/libvirt/virtlogd.conf
           config_files:
             - source: "/var/lib/kolla/config_files/src/*"
               dest: "/"
@@ -571,8 +605,35 @@ outputs:
           mode: "0755"
           content: { get_file: ../../container_config_scripts/nova_libvirt_init_secret.sh }
       docker_config:
+        step_2:
+          create_virtlogd_wrapper:
+            start_order: 1
+            detach: false
+            net: host
+            pid: host
+            user: root
+            command: # '/container_puppet_apply.sh "STEP" "TAGS" "CONFIG" "DEBUG"'
+              list_concat:
+                -
+                  - '/container_puppet_apply.sh'
+                  - '4'
+                  - 'file'
+                  - 'include ::tripleo::profile::base::nova::virtlogd_wrapper'
+            image: {get_param: ContainerNovaLibvirtImage}
+            volumes:
+              list_concat:
+                - {get_attr: [ContainersCommon, container_puppet_apply_volumes]}
+                -
+                  - /var/lib/container-config-scripts:/var/lib/container-config-scripts:shared,z
+            environment:
+              # NOTE: this should force this container to re-run on each
+              # update (scale-out, etc.)
+              TRIPLEO_DEPLOY_IDENTIFIER: {get_param: DeployIdentifier}
         step_3:
-          nova_virtlogd:
+          map_merge:
+            - if:
+                - virtlogd_wrapper_enabled
+                - nova_virtlogd_wrapper: &virtlog_container_config
                     start_order: 0
                     image: {get_param: ContainerNovaLibvirtImage}
                     ulimit: {get_param: ContainerNovaLibvirtUlimit}
@@ -599,9 +660,16 @@ outputs:
                           - /etc/libvirt/qemu:/etc/libvirt/qemu:ro
                           - /var/log/libvirt/qemu:/var/log/libvirt/qemu
                           - /var/lib/nova:/var/lib/nova:shared
+                        -
+                          if:
+                            - virtlogd_wrapper_enabled
+                            -
+                              - /var/lib/container-config-scripts/virtlogd_wrapper:/usr/local/bin/virtlogd_wrapper:ro
+                            - null
                     environment:
                       KOLLA_CONFIG_STRATEGY: COPY_ALWAYS
-          nova_libvirt:
+                - nova_virtlogd: *virtlog_container_config
+            - nova_libvirt:
                 start_order: 1
                 image: {get_param: ContainerNovaLibvirtImage}
                 ulimit: {get_param: ContainerNovaLibvirtUlimit}
@@ -615,6 +683,10 @@ outputs:
                   - label=filetype:container_share_t
                 restart: always
                 depends_on:
+                  -
+                    if:
+                      - virtlogd_wrapper_enabled
+                      - tripleo_nova_virtlogd_wrapper.service
                       - tripleo_nova_virtlogd.service
                 healthcheck:
                   test: '/openstack/healthcheck libvirtd'

releasenotes/notes/nova_virtlogd_wrapper-120fcfcfa0787b2b.yaml

@@ -0,0 +1,17 @@
+---
+features:
+  - |
+    When nova_virtlogd container gets restarted the instance console auth files
+    will not be reopened again by virtlogd. As a result either instances need
+    to be restarted or live migrated to a different compute node to get new
+    console logs messages logged again.
+    Usually on receipt of SIGUSR1, virtlogd will re-exec() its binary, while
+    maintaining all current logs and clients. This allows for live upgrades of
+    the virtlogd service on non containerized environments where updates just
+    by doing an RPM update.
+    To reduce the likelihood in a containerized environment virtlogd should
+    only be restarted on manual request, or on compute node reboot. It should
+    not be restarted on a minor update without migration off instances.
+    This introduces a nova_virtlogd_wrapper container and virtlogd wrapper
+    script, to only restart virtlogd on either manual or compute node restart.
+