Bug 1441962 - Remove default option for keymap in code and config files
Summary: Remove default option for keymap in code and config files
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: openstack-nova
Version: 10.0 (Newton)
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 10.0 (Newton)
Assignee: Stephen Finucane
QA Contact: Prasanth Anbalagan
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-04-13 08:28 UTC by Pierre-Andre MOREY
Modified: 2023-03-24 13:47 UTC (History)
13 users (show)

Fixed In Version: openstack-nova-14.1.0-24.el7ost
Doc Type: Bug Fix
Doc Text:
Previously, the '[vnc] keymap' option was 'en-us' by default, and it was not possible to unset this configuration. As a result of this, non-US locales experienced ineffective key mappings. With this update, users can unset the '[vnc] keymap' value. In this case, the VNC client configures the locale and non-US users attain more effective key mappings.
Clone Of:
Environment:
Last Closed: 2018-09-17 16:50:53 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
Remove any default keymap option for kvm (deprecated). (1.08 KB, application/mbox)
2017-05-09 08:40 UTC, Pierre-Andre MOREY
no flags Details
Backport from Solly Ross for proper keymap support on NoVnc (novnc-0.6.1-1.el7ost.noarch.rpm) (15.73 KB, text/plain)
2017-05-09 08:43 UTC, Pierre-Andre MOREY
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Launchpad 1682020 0 None None None 2017-04-13 08:28:21 UTC
OpenStack gerrit 483994 0 None MERGED conf: Deprecate 'keymap' options 2020-10-30 15:14:26 UTC
OpenStack gerrit 496605 0 None MERGED conf: Allow users to unset 'keymap' options 2020-10-30 15:14:42 UTC
Red Hat Issue Tracker OSP-17227 0 None None None 2022-07-09 11:40:25 UTC
Red Hat Product Errata RHSA-2018:2714 0 None None None 2018-09-17 16:52:15 UTC

Description Pierre-Andre MOREY 2017-04-13 08:28:21 UTC
Description of problem:

By default, the instances are launched with '-k en-us' option. This enables an old code path which has drawbacks for other keyboard mappings. For example French, Belgium and Spanish (and much more) won't be able to use a combination of Alt-gr + Key on the web console.

We need to remove the default for the keymap, which is deprecated in modern qemu-kvm as I was told.

This way we can get the proper behavior (with some NoVNC patchs, that are upstream, sross made a patch set for RHOSP8).

An Upstream bug has been opened on this subject.

Regards,
Pierre-André

Comment 3 Pierre-Andre MOREY 2017-05-09 08:40:36 UTC
Created attachment 1277313 [details]
Remove any default keymap option for kvm (deprecated).

Comment 4 Pierre-Andre MOREY 2017-05-09 08:43:16 UTC
Created attachment 1277316 [details]
Backport from Solly Ross for proper keymap support on NoVnc (novnc-0.6.1-1.el7ost.noarch.rpm)

Comment 7 Stephen Finucane 2017-07-14 15:20:18 UTC
Per comments on the upstream bug, it seems this option is not deprecated. In addition, the man page for qemu-kvm specifically states:

  -k language
    Use keyboard layout language (for example "fr" for French). This option is only
    needed where it is not easy to get raw PC keycodes (e.g. on Macs, with some X11
    servers or with a VNC or curses display). You don't normally need to use it on
    PC/Linux or PC/Windows hosts.

Given that we are using VNC, this seems like the correct thing to do. Could we not simply set the correct language in 'nova.conf'?

Comment 9 Pierre-Andre MOREY 2017-07-17 07:30:36 UTC
Hi Stephen,

No, even setting the correct keymap doesn't fix the issue. We really need to unset this option.

Regards,
Pierre-André

Comment 10 Stephen Finucane 2017-07-18 14:38:21 UTC
(In reply to Pierre-Andre MOREY from comment #9)
> Hi Stephen,
> 
> No, even setting the correct keymap doesn't fix the issue. We really need to
> unset this option.

Yes, Dan Barrange's comments on the upstream bug helped clarify the issue.

I've created a patch upstream that deprecates these options and unsets their defaults, similar to what Solly Ross had done previously. I'm not sure if this is likely to land in this cycle, given the short number of days remaining, but I'll work on it. If not, it should land early next cycle and parts of it can probably be backported.

Comment 11 Stephen Finucane 2017-08-04 13:28:04 UTC
The patch for this is up, but it will have to wait until features can be merged again before getting in.

How far do you envision backporting this, Pierre-Andre?

Comment 12 Pierre-Andre MOREY 2017-08-07 15:06:06 UTC
Hi Stephen,
 Customer is planning a OSP8 to OSP10 upgrade in September, so for me having it in a OSP10 seems sufficient.

This also depends on an upstream fix for NoVnc, so both should be backported on the target release. I will check if the novnc shipped with OSP10 already includes the proper NoVnc patch.

Regards,
Pierre-André

Comment 15 Stephen Finucane 2017-08-23 10:31:06 UTC
I've split the upstream patch into two parts - one that allows users to unset the configuration option (and warns them about side effects if set), and another that'll deprecate the option and unset the default. The former is backportable while I doubt the latter is. Let's see how we progress.

Comment 20 Alex McLeod 2018-09-03 08:01:22 UTC
Hi there,

If this bug requires doc text for errata release, please set the 'Doc Type' and provide draft text according to the template in the 'Doc Text' field.

The documentation team will review, edit, and approve the text.

If this bug does not require doc text, please set the 'requires_doc_text' flag to -.

Thanks,
Alex

Comment 23 errata-xmlrpc 2018-09-17 16:50:53 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2018:2714


Note You need to log in before you can comment on or make changes to this bug.