.. _section-role-geoip:

Rôle geoip

• Page Ansible Galaxy <https://galaxy.ansible.com/honzamach/geoip>__
• Dépôt GitHub <https://github.com/honzamach/ansible-role-geoip>__
• Page Travis CI <https://travis-ci.org/honzamach/ansible-role-geoip>__

Rôle Ansible pour l'installation pratique des bases de données de géolocalisation IP gratuites GeoLite2 <https://dev.maxmind.com/geoip/geoip2/geolite2/#Download_Access>__ fournies par MaxMind <https://www.maxmind.com/en/home>__.

Table des matières :

• :ref:section-role-geoip-installation
• :ref:section-role-geoip-dependencies
• :ref:section-role-geoip-usage
• :ref:section-role-geoip-variables
• :ref:section-role-geoip-files
• :ref:section-role-geoip-author

Ce rôle fait partie du package MSMS <https://github.com/honzamach/msms>__. Certaines fonctionnalités communes sont documentées dans son :ref:manuel <section-manual>.

.. _section-role-geoip-installation:

Installation

Pour installer le rôle honzamach.geoip <https://galaxy.ansible.com/honzamach/geoip>__ depuis Ansible Galaxy <https://galaxy.ansible.com/>__, veuillez utiliser une variante de la commande suivante ::

ansible-galaxy install honzamach.geoip

Pour installer le rôle directement depuis GitHub <https://github.com>__ en clonant le dépôt ansible-role-geoip <https://github.com/honzamach/ansible-role-geoip>__, veuillez utiliser une variante de la commande suivante ::

git clone https://github.com/honzamach/ansible-role-geoip.git honzamach.geoip

Actuellement, l'avantage d'utiliser le clonage Git direct est de pouvoir facilement mettre à jour le rôle lorsque de nouvelles versions sortent.

.. _section-role-geoip-dependencies:

Dépendances

Ce rôle n'a de dépendance envers aucun autre rôle.

Les rôles suivants dépendent de ce rôle :

• :ref:mentat <section-role-mentat>
• :ref:mentat_dev <section-role-mentat-dev>

.. _section-role-geoip-usage:

Utilisation

Exemple de contenu du fichier d'inventaire inventory ::

[serveurs_geoip]
votre-serveur

Exemple de contenu du fichier playbook de rôle role_playbook.yml ::

- hosts: serveurs_geoip
  remote_user: root
  roles:
    - role: honzamach.geoip
  tags:
    - role-geoip

Exemple d'utilisation ::

# Exécuter tout :
ansible-playbook --ask-vault-pass --inventory inventory role_playbook.yml

Il est recommandé de suivre ces principes de configuration :

• Créez/modifiez le fichier inventory/group_vars/all/vars.yml et définissez y quelques paramètres par défaut sensés pour tous vos serveurs gérés. Exemple ::

    hm_geoip__account_id: "{{ vault_hm_geoip__account_id }}"
    hm_geoip__license_key: "{{ vault_hm_geoip__license_key }}"
  

• Créez/modifiez le fichier :ref:vault <section-overview-vault> chiffré inventory/group_vars/all/vault.yml et y enregistrez votre mot de passe de chiffrement de sauvegarde ::

    vault_hm_geoip__account_id: 123456
    vault_hm_geoip__license_key: quelque-chose-de-si-secret-personne-ne-va-le-deviner
  

• Utilisez les fichiers inventory/host_vars/[votre-serveur]/vars.yml pour personnaliser les paramètres pour des serveurs spécifiques. Veuillez consulter la section :ref:section-role-geoip-variables pour toutes les options disponibles.

.. _section-role-geoip-variables:

Variables de configuration

Variables internes du rôle

.. envvar:: hm_geoip__package_url

    URL par défaut du package depuis lequel installer l'utilitaire geoipupdate.

    * *Type de données :* ``string``
    * *Par défaut :* ``https://github.com/maxmind/geoipupdate/releases/download/v4.1.5/geoipupdate_4.1.5_linux_amd64.deb``

.. envvar:: hm_geoip__account_id

    Votre identifiant unique de compte MaxMind (numérique).

    * *Type de données :* ``integer``
    * *Par défaut :* ``null``

.. envvar:: hm_geoip__license_key

    Votre clé de licence de compte MaxMind. Assurez-vous d'avoir activé l'option *Mise à jour* lors de la création de la clé.

    * *Type de données :* ``string``
    * *Par défaut :* ``null``

.. envvar:: hm_geoip__edition_ids

    Liste des bases de données de géolocalisation IP demandées à installer sur l'hôte cible.

    * *Type de données :* ``liste de chaînes``
    * *Par défaut :* ``["GeoLite2-ASN", "GeoLite2-City", "GeoLite2-Country"]``

.. envvar:: hm_geoip__database_directory

    Le répertoire pour stocker les fichiers de la base de données.

    * *Type de données :* ``string``
    * *Par défaut :* ``/usr/share/GeoIP``


Variables Ansible intégrées

.. envvar:: ansible_lsb['codename']

Le nom de code de distribution Debian est utilisé pour la fonction :ref:`personnalisation des modèles <section-overview-role-customize-templates>`.

.. _section-role-geoip-files:

Fichiers gérés

.. note::

Ce rôle prend en charge la fonction :ref:`personnalisation des modèles <section-overview-role-customize-templates>`.

Ce rôle gère le contenu des fichiers suivants sur le système cible :

• /etc/cron.d/geoipupdate [MODÈLE]
• /etc/GeoIP.conf [MODÈLE]

.. _section-role-geoip-author:

Auteur et licence

| Droit d'auteur : (C) depuis 2019 Honza Mach honza.mach.ml@gmail.com | Auteur : Honza Mach honza.mach.ml@gmail.com | L'utilisation de ce rôle est régie par la licence MIT, voir le fichier LICENSE. |