Rôle Winlogbeat

Résumé

Ce rôle :

• installe winlogbeat sur Windows
• copie le fichier de configuration préparé (chemin des logs, connexion à Elasticsearch, etc.)

Tâches du rôle

• [Optionnel] Créer un ou plusieurs dossiers pour des chemins personnalisés
• Installer winlogbeat
• Copier le fichier de configuration

Exigences

• Version minimale d'Ansible requise pour l'installation : 2.8
• Systèmes d'exploitation pris en charge :
  • Windows
    • 2016
    • 2019

Variables du rôle

Vous pouvez remplacer n'importe quelle variable ci-dessous en définissant "variable : valeur" dans le playbook.

• winlogbeat_version Utilisé pour sélectionner la branche principale de Winlogbeat à installer. La valeur par défaut est 7.
• winlogbeat_last_version Utilisé pour sélectionner une version spécifique de Winlogbeat à installer. La valeur par défaut est 7.4.2
• winlogbeat_node_name Nom du nœud Winlogbeat. La valeur par défaut est {{ inventory_hostname }}. Si cette option n'est pas définie, le nom d'hôte est utilisé.
• winlogbeat_ssl_enabled Active/désactive la connexion SSL entre Winlogbeat et Logstash/Elasticsearch. Les options SSL doivent être définies par les champs de dictionnaire correspondants comme montré ci-dessous :

  ssl:
    key: 'c:\tls\private\server.key'
    certificate: 'c:\tls\certs\server.pem'
    certificate_authorities: 'c:\CA\ca-root.pem'

La section path des options de configuration définit où Winlogbeat cherche ses fichiers. Par exemple, Winlogbeat recherche le fichier de modèle Elasticsearch dans le chemin de configuration et écrit les fichiers de log dans le chemin des logs. Winlogbeat recherche ses fichiers de registre dans le chemin de données. Les valeurs par défaut pour un hôte Windows sont configurées comme suit :

path:
  home: 'c:\program files\winlogbeat'
  config: 'c:\program files\winlogbeat'
  data: 'c:\programdata\winlogbeat'
  logs: 'c:\programdata\winlogbeat\logs'

• win_download_path Répertoire temporaire pour Windows afin de télécharger et décompresser le paquet Winlogbeat. La valeur par défaut est '{{ ansible_env.TEMP }}/winlogbeat' (la valeur ansible_env.TEMP résout le problème d'idempotence).

Personnalisation de la sortie :

• winlogbeat_output Utilisé pour configurer quelle sortie utiliser lors de l'envoi de données (elasticsearch ou logstash). La valeur par défaut est elasticsearch.

• elasticsearch.host Tableau des hôtes auxquels se connecter. La valeur par défaut est localhost.

• elasticsearch.port Valeur pour définir un port personnalisé. La valeur par défaut est 9200.

• logstash.host Tableau des hôtes auxquels se connecter. La valeur par défaut est localhost.

• logstash.port Valeur pour définir un port personnalisé. La valeur par défaut est 5044.

Paramètres de configuration avancés :

La section winlogbeat(systemd)\initd des options de configuration définit quel script d'initialisation sera utilisé pour gérer le service Winlogbeat en fonction du système d'exploitation *nix. Les chemins personnalisés seront pris en compte (s'ils sont configurés).

• winlogbeat_service_name Nom du script nssm\init qui gère le service Winlogbeat.

• winlogbeat_bulk_max_size Nombre maximum d'événements à regrouper dans une seule requête Logstash. La valeur par défaut est 500.

• winlogbeat_worker Nombre de travailleurs par hôte Elasticsearch. La valeur par défaut est 1.

• winlogbeat_logging_to_syslog Envoie toutes les sorties de journalisation à syslog. La valeur par défaut est false.

• winlogbeat_logging_to_files Envoie toutes les sorties de journalisation vers des fichiers rotatifs. La valeur par défaut est true.

• winlogbeat_rotateeverybytes Définit la taille limite des fichiers journaux. La valeur par défaut est 104857600 = 100MB.

• winlogbeat_keepfiles Nombre de fichiers journaux à conserver. La valeur par défaut est 30.

• winlogbeat_ignore_older Valeur (toutes les chaînes temporelles comme 2h, 5m peuvent être utilisées) au-dessus de laquelle les journaux seront ignorés. La valeur par défaut est 0 (désactivé).

• winlogbeat_logname Nom des fichiers de log. La valeur par défaut est "winlogbeat.log".

Dépendances

ca-cert (seulement pour l'installation avec SSL)

Exemple de Playbook

Installer la version 7.x de Winlogbeat :

- name: Installer winlogbeat
  hosts: all
  roles:
    - role: lean_delivery.winlogbeat

Licence

Apache

Informations sur l'auteur

auteurs:

• Équipe Lean Delivery team@lean-delivery.com