Utilizza i criteri degli agenti (GA)

Puoi creare e gestire i criteri degli agenti utilizzando il gruppo di comandi gcloud compute instances ops-agents policies in Google Cloud CLI. I comandi in questo gruppo utilizzano la suite di strumenti VM Manager di Compute Engine per gestire i criteri del sistema operativo, che possono automatizzare il deployment e la manutenzione di configurazioni software come Ops Agent. Questi criteri non possono essere applicati all'agente Monitoring legacy o all'agente Logging legacy.

Il gruppo di comandi gcloud compute instances ops-agents policies utilizza le risorse di assegnazione dei criteri del sistema operativo nell'API OS Config. Anche se esiste un gruppo di comandi gcloud CLI generale per la gestione delle assegnazioni dei criteri del sistema operativo, gcloud compute os-config os-policy-assignments, il gruppo di comandi gcloud compute instances ops-agents policies è progettato specificamente per i criteri dell'agente descritti in questo documento.

Prima di iniziare

Prima di utilizzare Google Cloud CLI per creare criteri degli agenti, completa questi passaggi:

  1. Se non lo hai già fatto, installa Google Cloud CLI.

  2. Scarica ed esegui lo script prepare-for-ops-agents-policies.sh per abilitare le API richieste e impostare le autorizzazioni appropriate per l'utilizzo di Google Cloud CLI.

    Per informazioni sullo script, consulta Lo script prepare-for-ops-agents-policies.sh.

Disinstalla l'agente Monitoring e l'agente Logging legacy

Se stai creando un criterio per Ops Agent, assicurati che nelle VM non sia installato l'agente Logging o l'agente Monitoring legacy. L'esecuzione di Ops Agent e degli agenti legacy sulla stessa VM può causare l'importazione di log duplicati o un conflitto nell'importazione delle metriche. Se necessario, disinstalla l'agente Monitoring e disinstalla l'agente Logging prima di creare un criterio per installare Ops Agent.

Verifica che l'agente OS Config sia installato

Potresti dover installare e configurare manualmente l'agente OS Config sulle VM precedenti a OS Config. Per informazioni sull'installazione e sulla verifica manuale dell'agente OS Config, consulta l'elenco di controllo per la verifica di VM Manager.

Crea un criterio dell'agente per gestire Ops Agent

Per creare un criterio dell'agente, utilizza il comando gcloud compute instances ops-agents policies create. Questo comando ha la seguente struttura:

gcloud compute instances ops-agents policies create POLICY_ID \
  --zone ZONE \
  --file path/to/policy-description-file.yaml \
  --project PROJECT_ID

Quando utilizzi questo comando, sostituisci le variabili come segue:

  • POLICY_ID è un nome per il criterio.
  • ZONE è una zona Compute Engine. I criteri dell'agente vengono applicati solo alle VM nella zona specificata; per applicare un criterio in più zone, devi creare più criteri.
  • path/to/policy-description-file.yaml è il percorso di un file YAML che descrive il criterio. Per informazioni sulla struttura di questo file, consulta Descrivere i criteri dell'agente.
  • PROJECT_ID è l'ID del tuo progetto Google Cloud.

Per informazioni sugli altri comandi nel gruppo di comandi e sulle opzioni disponibili, consulta la documentazione di gcloud compute instances ops-agents policies.

Descrivi i criteri degli agenti

Per fornire informazioni sul criterio all'elemento gcloud compute instances ops-agents policies create, crea un file YAML che descriva il criterio e passa questo file al comando come valore dell'opzione --file.

Questa sezione descrive la struttura del file di descrizione dei criteri. Per ulteriori informazioni, consulta Esempi di file di descrizione dei criteri.

Formato del file YAML policy-description

Il file di descrizione per un criterio di agente deve includere due gruppi di campi:

  • agentsRule, che indica al criterio dell'agente se installare o rimuovere l'Ops Agent e specifica la versione di Ops Agent su cui operare.

  • instanceFilter, che descrive le VM su cui viene applicato il criterio.

Struttura del gruppo di campi agentsRule

Il gruppo di campi agentsRule ha la seguente struttura:

agentsRule:
  packageState: installed|removed
  version: latest|2.*.*|2.x.y
  • Il campo packageState indica al criterio lo stato previsto dell'Ops Agent. I valori validi sono installed e removed.

  • Il campo version indica la versione di Ops Agent da installare o rimuovere. Puoi specificare i seguenti valori:

    • latest è la versione più recente di Ops Agent.
    • 2.*.* è la release più recente della versione principale 2 di Ops Agent.
    • 2.x.y indica una release specifica della versione principale 2.

    Per informazioni sulle versioni disponibili di Ops Agent, consulta il repository GitHub dell'agente.

Struttura del gruppo di campi instanceFilter

Il gruppo di campi instanceFilter indica le VM in una zona a cui si applica il filtro. Questo gruppo di campi è una rappresentazione YAML della struttura InstanceFilter utilizzata dalla risorsa OSPolicyAssignment nell'API OS Config.

Il gruppo di campi instanceFilter ha una delle seguenti strutture:

  • Per applicare il criterio dell'agente a tutte le VM in una zona, utilizza quanto segue:

    instanceFilter:
  all: True

    Se utilizzi il filtro all: True, non puoi specificare altri criteri.

  • Per applicare il criterio dell'agente a un insieme specifico di VM in una zona, descrivi le VM utilizzando una combinazione dei seguenti elementi:

    • Etichette sulla VM, per inclusione o esclusione:
      • inclusionLabels:
      • exclusionLabels:
    • Sistema operativo: inventories:

    Ad esempio, il seguente filtro applica il criterio dell'agente alle VM con i sistemi operativi specificati che hanno l'etichetta "env=prod" e non hanno l'etichetta "app=web":

    instanceFilter:
  inclusionLabels:
  - labels:
      env: prod
  exclusionLabels:
  - labels:
      app: web
  inventories:
  - osShortName: rhel
    osVersion: '7.*'
  - osShortName: debian
    osVersion: '11'

    Per trovare i valori per i campi osShortName e osVersion di una VM, utilizza i seguenti comandi:

    gcloud compute instances os-inventory describe INSTANCE_NAME \
--zone ZONE | grep "^ShortName: "

    gcloud compute instances os-inventory describe INSTANCE_NAME \
--zone ZONE | grep "^Version: "

    Questi comandi richiedono l'installazione dell'agente OS Config sulla VM.

Verifica lo stato dei criteri dell'agente

Questa sezione descrive come controllare lo stato dei criteri creati e l'installazione di Ops Agent. Queste informazioni possono anche aiutarti a risolvere i problemi relativi ai criteri degli agenti.

Pagina dei criteri del sistema operativo di Compute Engine

La pagina Criteri del sistema operativo di Compute Engine fornisce informazioni sui criteri degli agenti che gestiscono Ops Agent e sulle VM nella scheda Istanze VM. Ad esempio:

  • La colonna Stato indica se un criterio è stato installato correttamente ("Conforme"), in corso ("In sospeso"), potenzialmente non riuscito ("Sconosciuto") o se mancante ("Nessun criterio").
  • La colonna VM monitorata indica se Ops Agent è gestito da OS Config ("Monitorata") o meno ("Non monitorato").

    Se un criterio è "Conforme", ma la VM mostra "Non monitorata", potrebbe esserci un problema durante l'installazione di Ops Agent. Ad esempio, potresti avere un agente legacy già installato.

Nella console Google Cloud, vai alla pagina Criteri del sistema operativo:

Vai a Criteri del sistema operativo

Se usi la barra di ricerca per trovare questa pagina, seleziona il risultato con sottotitolo Compute Engine.

La sezione Istanze VM nella scheda Criteri del sistema operativo di Compute Engine mostra le informazioni sugli agenti gestiti da tutti i criteri del sistema operativo nel tuo progetto Google Cloud. Questi criteri sono etichettati come goog-ops-agent-policy.

  • L'indicatore goog-ops-agent-policy include diversi tipi di criteri:

    Per distinguere i criteri, utilizza la scheda Assegnazioni criteri del sistema operativo nella pagina per visualizzare gli ID criterio per tutte le assegnazioni dei criteri nel tuo progetto Google Cloud.

  • Questa colonna VM monitorata non riflette l'installazione di Ops Agent con altri mezzi, come l'installazione manuale o tramite i criteri degli agenti beta.

Pagina Istanze VM di Cloud Monitoring

La pagina Istanze VM in Cloud Monitoring include una colonna Agent che elenca l'agente installato su ogni VM e, per l'Ops Agent, un indicatore relativo agli agenti installati precedenti alla versione più recente.

Nella console Google Cloud, vai alla pagina della dashboard delle istanze VM:

Vai alla dashboard delle istanze VM

Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

Esempi di file di descrizione dei criteri

Questa sezione fornisce alcuni esempi di file YAML di descrizione dei criteri per diversi scenari. Gli esempi presuppongono che tu abbia inserito lo YAML in un file denominato agent-policy-description.yaml e che crei il criterio nella zona us-central1-a utilizzando un comando come il seguente:

gcloud compute instances ops-agents policies create POLICY_ID \
  --zone us-central1-a \
  --file agent-policy-description.yaml \
  --project PROJECT_ID

Installa su tutte le VM

Per installare la versione più recente di Ops Agent su tutte le VM nella zona us-central1-a, utilizza la seguente descrizione dei criteri:

agentsRule:
  packageState: installed
  version: latest
instanceFilter:
  all: True

Rimuovi da tutte le VM

Per rimuovere la versione più recente di Ops Agent su tutte le VM nella zona us-central1-a, utilizza la seguente descrizione del criterio:

agentsRule:
  packageState: removed
  version: latest
instanceFilter:
  all: True

Installazione su VM in base alle etichette

Per installare la versione più recente di Ops Agent su tutte le VM nella zona us-central1-a con l'etichetta "env=prod" o "app=web", utilizza la seguente descrizione dei criteri:

agentsRule:
  packageState: installed
  version: latest
instanceFilter:
  inclusionLabels:
  - labels:
      env: prod
  - labels:
      app: web

Quando specifichi più voci labels: per l'inclusione o l'esclusione, una VM trova una corrispondenza se è presente una qualsiasi delle etichette; in altre parole, gli insiemi di etichette per l'inclusione o l'esclusione vengono abbinati come operazione OR logica, non come operazione AND logica.

Installa su VM in base ad altre etichette

Per installare la versione più recente di Ops Agent su tutte le VM nella zona us-central1-a che esegue Debian 11, ad eccezione di quelle con le etichette "env=prod" e "app=web6", utilizza la seguente descrizione dei criteri:

agentsRule:
  packageState: installed
  version: latest
instanceFilter:
  exclusionLabels:
  - labels:
      env: prod
      app: web6
  inventories:
  - osShortName: debian
    osVersion: '11'

Quando specifichi più coppie chiave-valore in una singola voce labels: per l'inclusione o l'esclusione, una VM corrisponde se sono presenti tutte le etichette; in altre parole, le etichette vengono abbinate come operazione AND logica, non come operazione OR logica.

Installa su VM in base al sistema operativo

Per installare l'ultima versione 2 di Ops Agent su tutte le VM che eseguono Debian 11 o RHEL 7.* nella zona us-central1-a, utilizza la seguente descrizione del criterio:

agentsRule:
  packageState: installed
  version: 2.*.*
instanceFilter:
  inventories:
  - osShortName: rhel
    osVersion: '7.*'
  - osShortName: debian
    osVersion: '11'

Risolvere i problemi relativi ai criteri degli agenti GA

Questa sezione fornisce informazioni utili per risolvere i problemi relativi ai criteri dell'agente GA per Ops Agent. Anche le informazioni descritte in Verificare lo stato dei criteri dell'agente potrebbero essere utili.

I comandi ops-agents policy hanno esito negativo

In caso di errore di un comando gcloud compute instances ops-agents policies, la risposta mostra un errore di convalida. Correggi gli errori correggendo gli argomenti e i flag dei comandi come suggerito dal messaggio di errore.

Oltre agli errori di convalida, potresti notare errori che indicano le seguenti condizioni:

Nelle sezioni seguenti vengono descritte queste condizioni in modo più dettagliato.

Autorizzazione IAM insufficiente

Se un comando gcloud compute instances ops-agents policies non va a buon fine e restituisce un errore di autorizzazione, assicurati di aver eseguito lo script prepare-for-ops-agents-policies.sh come descritto in Prima di iniziare per configurare i ruoli dei criteri di OS Config:

Per ulteriori informazioni sullo script prepare-for-ops-agents-policies.sh, consulta Lo script prepare-for-ops-agents-policies.sh.

L'API OS Config non è abilitata

Un errore di esempio ha il seguente aspetto:

API [osconfig.googleapis.com] not enabled on project PROJECT_ID.
Would you like to enable and retry (this will take a few minutes)?
(y/N)?

Puoi inserire y per abilitare l'API oppure eseguire lo script prepare-for-ops-agents-policies.sh, descritto in Prima di iniziare, per concedere tutte le autorizzazioni necessarie. Se inserisci y nella richiesta del messaggio di errore, devi comunque eseguire lo script prepare-for-ops-agents-policies.sh per impostare le autorizzazioni necessarie.

Per verificare che l'API OS Config sia abilitata per il progetto, esegui questi comandi:

gcloud services list --project PROJECT_ID | grep osconfig.googleapis.com

Di seguito è riportato l'output previsto:

osconfig.googleapis.com    Cloud OS Config API

Il criterio non esiste

Un errore di esempio ha il seguente aspetto:

NOT_FOUND: Requested entity was not found

Questo errore potrebbe significare che il criterio non è mai stato creato, che è stato eliminato o che l'ID criterio specificato non è corretto. Assicurati che il valore POLICY_ID utilizzato in un comando gcloud compute instances ops-agents policies describe, update o delete corrisponda a un criterio esistente. Per ottenere un elenco dei criteri degli agenti, usa il comando gcloud compute instances ops-agents policies list.

Il criterio è stato creato, ma sembra non produrre alcun effetto

Per gestire i pacchetti per gli agenti Logging e Monitoring, viene eseguito il deployment degli agenti OS Config in ogni istanza Compute Engine. Il criterio potrebbe non avere alcun effetto se l'agente OS Config sottostante non è installato.

Linux

Per verificare che l'agente OS Config sia installato, esegui questo comando:

gcloud compute ssh instance-id \
    --project project-id \
    -- sudo systemctl status google-osconfig-agent

Un output di esempio è:

    google-osconfig-agent.service - Google OSConfig Agent
    Loaded: loaded (/lib/systemd/system/google-osconfig-agent.service; enabled; vendor preset:
    Active: active (running) since Wed 2020-01-15 00:14:22 UTC; 6min ago
    Main PID: 369 (google_osconfig)
     Tasks: 8 (limit: 4374)
    Memory: 102.7M
    CGroup: /system.slice/google-osconfig-agent.service
            └─369 /usr/bin/google_osconfig_agent

Windows

Per verificare che l'agente OS Config sia installato:

  1. Connettiti all'istanza utilizzando RDP o uno strumento simile e accedi a Windows.

  2. Apri un terminale PowerShell, quindi esegui il seguente comando PowerShell. Non hai bisogno di privilegi amministrativi.

    Get-Service google_osconfig_agent

Un output di esempio è:

    Status   Name               DisplayName
    ------   ----               -----------
    Running  google_osconfig_a… Google OSConfig Agent

Se l'agente OS Config non è installato, è possibile che tu stia utilizzando un sistema operativo che non supporta VM Manager. Il documento Dettagli del sistema operativo di Compute Engine indica le funzionalità di VM Manager supportate per ciascun sistema operativo Compute Engine.

Se il sistema operativo supporta VM Manager, puoi installare l'agente OS Config manualmente.

L'agente OS Config è installato, ma non installa Ops Agent

Per verificare se sono presenti errori quando l'agente OS Config applica i criteri, puoi controllare il log dell'agente OS Config. Per farlo, utilizza Esplora log oppure utilizza SSH o RDP per controllare le singole istanze di Compute Engine.

Per visualizzare i log dell'agente OS Config in Esplora log, utilizza il seguente filtro:

resource.type="gce_instance"
logId(OSConfigAgent)

Per visualizzare i log degli agenti OS Config, segui questi passaggi:

CentOS, RHEL,
SLES, SUSE

Esegui questo comando: 

gcloud compute ssh INSTANCE_ID \
    --project PROJECT_ID \
    -- sudo cat /var/log/messages \
       | grep "OSConfigAgent\|google-fluentd\|stackdriver-agent"

Debian, Ubuntu

Esegui questo comando: 

gcloud compute ssh INSTANCE_ID \
    --project PROJECT_ID \
    -- sudo cat /var/log/syslog \
       | grep "OSConfigAgent\|google-fluentd\|stackdriver-agent"

Windows

  1. Connettiti all'istanza utilizzando RDP o uno strumento simile e accedi a Windows.

  2. Apri l'app Visualizzatore eventi, quindi seleziona Log di Windows > Applicazione e cerca i log con Source uguale a OSConfigAgent.

Se si verifica un errore durante la connessione al servizio OS Config, assicurati di eseguire lo script prepare-for-ops-agents-policies.sh come descritto in Prima di iniziare a configurare i metadati di OS Config.

Per verificare che i metadati OS Config siano abilitati, puoi eseguire questo comando:

gcloud compute project-info describe \
    --project PROJECT_ID \
    | grep "enable-osconfig\|enable-guest-attributes" -A 1

Di seguito è riportato l'output previsto:

- key: enable-guest-attributes
  value: 'TRUE'
- key: enable-osconfig
  value: 'TRUE'

Ops Agent è installato, ma non funziona correttamente

Per ulteriori informazioni sul debug dei problemi di Ops Agent, consulta Risolvere i problemi di Ops Agent.

Abilita i log a livello di debug per l'agente OS Config

Può essere utile abilitare il logging a livello di debug nell'agente OS Config durante la segnalazione di un problema.

Puoi impostare i metadati osconfig-log-level: debug per abilitare il logging a livello di debug per l'agente OS Config. I log raccolti contengono ulteriori informazioni per facilitare l'indagine.

Per abilitare il logging a livello di debug per l'intero progetto, esegui questo comando:

gcloud compute project-info add-metadata \
    --project PROJECT_ID \
    --metadata osconfig-log-level=debug

Per abilitare il logging a livello di debug per una VM, esegui questo comando:

gcloud compute instances add-metadata INSTANCE_ID \
    --project PROJECT_ID \
    --metadata osconfig-log-level=debug

Script di supporto

Questa sezione fornisce informazioni aggiuntive sugli script di supporto descritti in questo documento:

Lo script prepare-for-ops-agents-policies.sh

Dopo aver scaricato lo script prepare-for-ops-agents-policies.sh, puoi utilizzare lo script per eseguire le seguenti azioni, in base agli argomenti forniti:

Gli esempi seguenti mostrano alcune chiamate comuni allo script. Per ulteriori informazioni, vedi i commenti nello script stesso.

Per abilitare le API, concedi i ruoli necessari all'account di servizio predefinito e abilita i metadati OS Config per un progetto, esegui lo script come segue:

bash prepare-for-ops-agents-policies.sh --project=PROJECT_ID

Per concedere inoltre uno dei ruoli OS Config a un utente che non dispone del ruolo Proprietario (roles/owner) nel progetto, esegui lo script come segue:

bash prepare-for-ops-agents-policies.sh --project=PROJECT_ID \
  --iam-user=USER_EMAIL \
  --iam-policy-access=[admin|editor|viewer]

Per concedere inoltre uno dei ruoli OS Config a un account di servizio non predefinito, esegui lo script come segue:

bash prepare-for-ops-agents-policies.sh --project=PROJECT_ID \
  --iam-service-account=SERVICE_ACCT_EMAIL \
  --iam-policy-access=[admin|editor|viewer]

Lo script diagnose_policies.sh

Dati un ID progetto, un ID istanza Compute Engine, una zona Compute Engine e l'ID criterio dell'agente, lo script diagnose_policies.sh raccoglie automaticamente le informazioni necessarie per diagnosticare i problemi relativi al criterio:

  • La versione dell'agente OS Config
  • L'assegnazione dei criteri del sistema operativo sottostante
  • Le assegnazioni dei criteri del sistema operativo applicabili a questa istanza Compute Engine
  • Una descrizione di questa istanza Compute Engine

Per richiamare lo script, esegui questo comando:

bash diagnose_policies.sh --project-id=PROJECT_ID \ 
  --gce-instance-id=INSTANCE_ID \
  --policy-id=POLICY_ID \
  --zone=ZONE

Prezzi

I comandi gcloud compute instances ops-agents policies vengono implementati utilizzando le risorse di assegnazione dei criteri del sistema operativo di VM Manager. Lo script prepare-for-ops-agents-policies.sh, descritto in Prima di iniziare, configura VM Manager in modalità a funzionalità limitate (OSCONFIG_B), che è sufficiente per creare e gestire i criteri degli agenti. Non sono previsti costi per l'utilizzo di VM Manager in modalità limitata.

Se hai configurato VM Manager in modalità completa (OSCONFIG_C), potrebbero esserti addebitati dei costi.