Ansible Role: `locales`

This Ansible role allows you to install and configure the locales of the targeted host.

More precisely, it will:

Generate /etc.locale.conf or /etc/default/locale (depending on the host OS)
Generate /etc/locale.gen
Generate the locales depending on the previous file.

Some distributions (such as Arch Linux) don't need any additional package. In this case, just leave locales_package_name empty (or remove it).

Also, please note that we are completely replacing the content of the /etc/locale.gen file, so you have to triple-check the values you provide.

Requirements

None

Dependencies

None

Role variables

Variables and properties in bold are mandatory. Others are optional.

Variable name	Description	Default value
`locales_package_name`	Name of the package to install.
`locales_configuration_file`	Path to the locale configuration file of the system.	`/etc/locale.conf`
`locales_locales`	A list of locales.	See locale properties default values.
`locales_lang`	Value to use as the `LANG` environment variable.	`locale` value of the first locale in `locales_locales`.
`locales_language`	Value to use as the `LANGUAGE` environment variable.	`locales_lang`
`locales_lc`	A locales_lc dict.	`{}`

📗 Documentation:

More about locales and environment variables

locale properties

Property name	Description	Default value
`locale`	Locale name.	`en_US.UTF-8`
`charset`	Locale charset.	`UTF-8`

locales_lc properties

👉 These are only set if a value different from locales_lang is provided.

Property name	Description	Default value
`address`	Value to use as the `LC_ADDRESS` environment variable.	`locales_lang`
`all`	Value to use as the `LC_ALL` environment variable.	`locales_lang`
`collate`	Value to use as the `LC_COLLATE` environment variable.	`locales_lang`
`ctype`	Value to use as the `LC_CTYPE` environment variable.	`locales_lang`
`identification`	Value to use as the `LC_IDENTIFICATION` environment variable.	`locales_lang`
`measurement`	Value to use as the `LC_MEASUREMENT` environment variable.	`locales_lang`
`messages`	Value to use as the `LC_MESSAGES` environment variable.	`locales_lang`
`monetary`	Value to use as the `LC_MONETARY` environment variable.	`locales_lang`
`name`	Value to use as the `LC_NAME` environment variable.	`locales_lang`
`numeric`	Value to use as the `LC_NUMERIC` environment variable.	`locales_lang`
`paper`	Value to use as the `LC_PAPER` environment variable.	`locales_lang`
`response`	Value to use as the `LC_RESPONSE` environment variable.	`locales_lang`
`telephone`	Value to use as the `LC_TELEPHONE` environment variable.	`locales_lang`
`time`	Value to use as the `LC_TIME` environment variable.	`locales_lang`

Playbook example

IMPORTANT: DO NOT use this example as it is.

---
- hosts: all
  become: true
  roles:
    - role: frzk.locales
      locales_locales:
        - locale: en_US.UTF-8
          charset: UTF-8
        - locale: fr_BE.UTF-8
          charset: UTF-8

      locales_lc:
        collate: "fr_FR.UTF-8"
...

Testing

Testing is done by leveraging Molecule and Ansible (see verify.yml), through GitHub Actions and Docker containers.

Tests successfully pass under the following distributions:

Arch Linux
Debian 11
Debian 10
Debian 9
Ubuntu 20.04
Ubuntu 18.04

Contributing

Code reviews, patches, comments, bug reports and feature requests are welcome. Please read the Contributing Guide for further details.

Frzk/ansible-role-locales

Ansible Role: locales