ansible-role-keyboard's Introduction

Ansible Role: Keyboard

Role to configure the keyboard layout etc.

Requirements

Ansible >= 2.9
Linux Distribution
- Debian Family
  - Debian
    - Stretch (9)
    - Buster (10)
    - Bullseye (11)
  - Ubuntu
    - Bionic (18.04)
    - Focal (20.04)

Role Variables

The following variables will change the behavior of this role (default values are shown below):

# The XKB keyboard model name.
keyboard_model: pc104

# The XKB keyboard layout name.
keyboard_layout: us

# The XKB keyboard variant components.
keyboard_variant: ''

# The XKB keyboard option components.
keyboard_options: ''

# The behavior of <BackSpace> and <Delete> keys.
keyboard_backspace: guess

See man keyboard for configuration options.

Example Playbook

- hosts: servers
  roles:
    - role: gantsign.keyboard
      # European keyboard model (pc105 is widely used outside Europe as well)
      keyboard_model: pc105
      # Layout for Great Britain / United Kingdom
      keyboard_layout: gb

More Roles From GantSign

You can find more roles from GantSign on Ansible Galaxy.

Development & Testing

This project uses Molecule to aid in the development and testing; the role is unit tested using Testinfra and pytest.

To develop or test you'll need to have installed the following:

Linux (e.g. Ubuntu)
Docker
Python (including python-pip)
Ansible
Molecule

Because the above can be tricky to install, this project includes Molecule Wrapper. Molecule Wrapper is a shell script that installs Molecule and it's dependencies (apart from Linux) and then executes Molecule with the command you pass it.

To test this role using Molecule Wrapper run the following command from the project root: