Guida completa alla configurazione della cache dei fatti di Ansible

La capacità di Ansible di raccogliere fatti sui nodi gestiti è cruciale per l'inventario dinamico, l'esecuzione condizionale e la reportistica dettagliata. Tuttavia, l'esecuzione di gather_facts: true per ogni esecuzione di playbook può aumentare significativamente il tempo di esecuzione complessivo, specialmente in ambienti con centinaia o migliaia di host. Questo collo di bottiglia prestazionale è affrontato efficacemente tramite la Caching dei Fatti di Ansible.

La caching dei fatti consente ad Ansible di memorizzare i fatti raccolti da un'esecuzione precedente e di riutilizzarli istantaneamente per le esecuzioni successive, aggirando il dispendioso processo di connessioni SSH e raccolta dati. Questa guida illustra come configurare e sfruttare la caching dei fatti utilizzando due metodi principali: file JSON e Redis, consentendo notevoli miglioramenti delle prestazioni nei vostri flussi di lavoro di automazione.

Comprensione dei Fatti di Ansible e Impatto sulle Prestazioni

Ansible raccoglie i fatti utilizzando il modulo setup (o implicitamente tramite gather_facts: true). Questi fatti includono dettagli sul sistema operativo, interfacce di rete, pacchetti installati e altro ancora. Sebbene inestimabile, la raccolta di questi fatti tramite SSH può essere lenta, in particolare su connessioni con elevata latenza o quando si gestisce una vasta flotta di macchine.

Vantaggio Chiave per le Prestazioni: Abilitando la caching, le esecuzioni di playbook successive leggono i fatti da una cache locale (file JSON) o da un archivio in-memory veloce (Redis) invece di eseguire il modulo setup sugli host remoti.

Metodi di Configurazione per la Caching dei Fatti

Ansible supporta diversi meccanismi di caching configurati tramite il file ansible.cfg. I due metodi più comuni e affidabili sono la caching su file JSON e la caching con Redis.

1. Caching su File JSON (Archiviazione Locale)

La caching JSON è il metodo più semplice, che memorizza i dati dei fatti come file serializzati sulla macchina di controllo. Non richiede servizi esterni.

Configurazione della Caching JSON in ansible.cfg

Per abilitare la caching JSON, è necessario definire il plugin di cache e specificare la posizione in cui verranno archiviati i file.

[defaults]
# Specifica il plugin di caching da utilizzare
fact_caching = json

# Specifica la directory in cui verranno archiviati i file dei fatti
fact_caching_connection = /path/to/ansible_facts_cache

# Imposta il tempo di scadenza della cache (in secondi). 0 significa che non scade mai.
fact_caching_timeout = 600

Spiegazione dei Parametri:

• fact_caching = json: Attiva il plugin di caching JSON integrato.
• fact_caching_connection: Questa directory deve esistere ed essere scrivibile dall'utente che esegue Ansible.
• fact_caching_timeout: In questo esempio, i fatti sono considerati obsoleti e verranno nuovamente raccolti dopo 600 secondi (10 minuti).

Best Practice: Assicurarsi che la directory della cache sia posizionata su uno storage locale veloce (come un'unità NVMe) per prestazioni di lettura/scrittura ottimali.

2. Caching Redis (Archiviazione Condivisa e ad Alte Prestazioni)

Redis è un archivio di strutture dati in-memory spesso utilizzato come cache ad alte prestazioni o message broker. L'uso di Redis per la caching dei fatti è ideale per ambienti di team in cui più utenti o pipeline CI/CD devono accedere alla stessa cache in modo rapido e coerente.

Prerequisiti per la Caching Redis

1. Un server Redis in esecuzione accessibile dalla macchina di controllo Ansible.
2. La libreria Python redis deve essere installata sulla macchina di controllo: pip install redis.

Configurazione della Caching Redis in ansible.cfg

Quando si utilizza Redis, fact_caching_connection viene utilizzato per definire i parametri di connessione di Redis (host e porta).

[defaults]
# Specifica il plugin di caching da utilizzare
fact_caching = redis

# Formato della stringa di connessione: <host>[:<port>][/<db_number>]
# Se in esecuzione sulla stessa macchina sulla porta predefinita:
fact_caching_connection = 127.0.0.1:6379/0

# Imposta il tempo di scadenza della cache (in secondi). Altamente raccomandato per Redis.
fact_caching_timeout = 3600

Nota sul Database Redis: Il numero finale (es. /0) specifica l'indice del database Redis da utilizzare. Assicurarsi che questo indice sia dedicato ai fatti di Ansible per evitare conflitti se Redis è utilizzato per altri scopi.

Integrazione della Caching nei Playbook

La configurazione di ansible.cfg imposta il comportamento predefinito. Per utilizzare efficacemente la caching, è necessario assicurarsi di due cose nei playbook:

1. La cache viene popolata eseguendo un play che raccoglie i fatti.
2. I play successivi si affidano alla cache anziché raccogliere nuovamente.

Applicazione Forzata della Raccolta Fatti per la Popolazione Iniziale

Quando si esegue un playbook per la prima volta, o dopo la scadenza, Ansible eseguirà il processo di raccolta dei fatti.

- name: Play 1 - Raccogli Fatti ed Esegui Task
  hosts: webservers
  gather_facts: true  # Questo popola la cache inizialmente
  tasks:
    - name: Usa i fatti raccolti
      debug:
        msg: "La famiglia OS è {{ ansible_os_family }}"

Utilizzo della Cache nelle Esecuzioni Successive

Se fact_caching è configurato, le esecuzioni successive utilizzeranno automaticamente i dati memorizzati nella cache se gather_facts è impostato su true e i fatti sono entro il periodo di timeout.

Tuttavia, se si desidera garantire che Ansible salti completamente la raccolta dei fatti e si affidi solo alla cache (o fallisca se la cache è mancante), è possibile utilizzare gather_facts: false dopo la popolazione iniziale, a condizione che i fatti siano ancora validi.

Se si imposta esplicitamente gather_facts: false e la caching è abilitata, Ansible controllerà prima la cache. Se esistono dati validi, li utilizzerà. In caso contrario, procederà senza fatti, il che potrebbe causare problemi ai task che si basano sui fatti.

Comportamento Cruciale: Se si utilizza gather_facts: true, Ansible eseguirà la raccolta remota dei fatti solo se i fatti memorizzati nella cache sono scaduti o mancanti.

Gestione della Cache dei Fatti

A volte è necessario cancellare manualmente la cache, forzando Ansible a raccogliere dati freschi da tutti gli host.

Cancellazione della Cache JSON

Se si utilizza la caching JSON, è sufficiente eliminare il contenuto della directory specificata in fact_caching_connection.

# Esempio utilizzando il percorso definito in precedenza
rm -rf /path/to/ansible_facts_cache/*

Cancellazione della Cache Redis

Se si utilizza Redis, è possibile cancellare selettivamente le chiavi relative ad Ansible o cancellare l'intero database utilizzato da Ansible.

Per cancellare tutte le chiavi associate al prefisso predefinito di Ansible (tipicamente correlato alla sorgente dell'inventario):

# Connessione a redis-cli e svuotamento dell'intero database (DB 0 in questo esempio)
redis-cli -n 0 FLUSHDB

Attenzione: FLUSHDB o FLUSHALL in Redis devono essere utilizzati con estrema cautela, poiché eliminano tutti i dati nel database specificato o nell'intera istanza Redis, rispettivamente.

Riepilogo delle Best Practice

1. Scegliere con Cura: Utilizzare la caching JSON per configurazioni semplici e a utente singolo o quando le dipendenze esterne sono limitate. Utilizzare Redis per ambienti collaborativi o integrazione CI/CD su larga scala.
2. Impostare Timeout Realistici: Configurare fact_caching_timeout per bilanciare i guadagni di prestazioni con la freschezza dei dati. Un timeout da 1 a 24 ore è comune per ambienti in cui le configurazioni cambiano di rado.
3. Verificare la Configurazione: Eseguire sempre ansible --version o controllare l'output della prima esecuzione con cache per confermare che il plugin di cache sia attivo e funzionante.
4. Dipendenza dall'Inventario: La caching dei fatti funziona meglio con inventari statici o generati dinamicamente. Se si utilizzano script di inventario dinamico che cambiano frequentemente, il vantaggio della caching può essere annullato da dati obsoleti o errori.

Implementando correttamente la caching dei fatti, si trasforma Ansible da uno strumento di configurazione completamente iterativo a un sistema altamente ottimizzato, capace di gestire l'infrastruttura su scala massiva con latenza minima per esecuzione.