Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gantsign/ansible-role-keyboard

Ansible role for configuring keyboard layout etc.
https://github.com/gantsign/ansible-role-keyboard

ansible ansible-role

Last synced: 2 months ago
JSON representation

Ansible role for configuring keyboard layout etc.

Awesome Lists containing this project

README

        

Ansible Role: Keyboard
======================

[![Tests](https://github.com/gantsign/ansible-role-keyboard/workflows/Tests/badge.svg)](https://github.com/gantsign/ansible-role-keyboard/actions?query=workflow%3ATests)
[![Ansible Galaxy](https://img.shields.io/badge/ansible--galaxy-gantsign.keyboard-blue.svg)](https://galaxy.ansible.com/gantsign/keyboard)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/gantsign/ansible-role-keyboard/master/LICENSE)

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):

```yaml
# 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 and keys.
keyboard_backspace: guess
```

See `man keyboard` for configuration options.

Example Playbook
----------------

```yaml
- 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](https://galaxy.ansible.com/gantsign).

Development & Testing
---------------------

This project uses [Molecule](http://molecule.readthedocs.io/) to aid in the
development and testing; the role is unit tested using
[Testinfra](http://testinfra.readthedocs.io/) and
[pytest](http://docs.pytest.org/).

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

* Linux (e.g. [Ubuntu](http://www.ubuntu.com/))
* [Docker](https://www.docker.com/)
* [Python](https://www.python.org/) (including python-pip)
* [Ansible](https://www.ansible.com/)
* [Molecule](http://molecule.readthedocs.io/)

Because the above can be tricky to install, this project includes
[Molecule Wrapper](https://github.com/gantsign/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:

```bash
./moleculew test
```

Note: some of the dependencies need `sudo` permission to install.

License
-------

MIT

Author Information
------------------

John Freeman

GantSign Ltd.
Company No. 06109112 (registered in England)