Comment 17 for bug 1682020

Reviewed: https://review.openstack.org/483994
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=cab8139498c7ea6b05cfdc8b4997276051b943fc
Submitter: Zuul
Branch: master

commit cab8139498c7ea6b05cfdc8b4997276051b943fc
Author: Stephen Finucane <email address hidden>
Date: Fri Jul 14 17:00:27 2017 +0100

    conf: Deprecate 'keymap' options

    Defining the 'keymap' option in libvirt results in the '-k' option being
    passed through to QEMU [1][2]. This QEMU option has some uses, primarily
    for users interacting with QEMU via stdin on the text console. However,
    for users interacting with QEMU via VNC or Spice, like nova users do, it
    is strongly recommended to never add the "-k" option. Doing so will
    force QEMU to do keymap conversions which are known to be lossy. This
    disproportionately affects users with non-US keyboard layouts, who would
    be better served by relying on the guest OS to manage this. Users should
    instead rely on their clients and guests to correctly configure this.

    This is the second part of the three part deprecation cycle for these
    options. At this point, they are retained but deprecated them and their
    defaults modified to be unset. This allows us to warn users with libvirt
    hypervisors that have configured the options about the pitfalls of the
    option and give them time to prepare migration strategies, if necessary.
    A replacement option is added to the VMWare group to allow us to retain
    this functionality for that hypervisor. Combined with the above, this
    will allow us to remove the options in a future release.

    [1] https://github.com/libvirt/libvirt/blob/v1.2.9-maint/src/qemu/qemu_command.c#L6985-L6986
    [2] https://github.com/libvirt/libvirt/blob/v1.2.9-maint/src/qemu/qemu_command.c#L7215-L7216

    Change-Id: I9a50a111ff4911f4364a1b24d646095c72af3d2c
    Closes-Bug: #1682020