Google uses AI technology to translate content into your preferred language. AI translations can contain errors.

Creazione di script dei comandi dell'interfaccia a riga di comando gcloud

Oltre a eseguire i comandi di Google Cloud CLI dalla riga di comando, puoi eseguirli da script o altre automazioni, ad esempio quando utilizzi Jenkins per gestire l'automazione delle Google Cloud attività.

Google Cloud SDK include una serie di strumenti come filtri, formattazione e il flag --quiet, che ti consentono di gestire in modo efficace l'output e automatizzare le attività.

Nozioni di base per la creazione di script con Google Cloud SDK

Per una guida passo passo alla creazione di script di base con la gcloud CLI, consulta questo post del blog: Scripting with gcloud: a beginner’s guide to automating Google Cloud tasks.

Autorizzazione

Quando scrivi script con Google Cloud SDK, devi prendere in considerazione i metodi di autorizzazione. Google Cloud SDK offre due opzioni:

Autorizzazione dell'account utente
Autorizzazione tramite service account

L'autorizzazione dell'account utente è consigliata se esegui uno script o un'altra automazione su una singola macchina.

Per autorizzare l'accesso ed eseguire altri passaggi di configurazione comuni di Google Cloud SDK:

gcloud init

L'autorizzazione tramite account di servizio è consigliata se esegui il deployment di uno script o di un'altra automazione su più macchine in un ambiente di produzione. È anche il metodo di autorizzazione consigliato se esegui i comandi gcloud CLI su un'istanza di macchina virtuale Compute Engine in cui tutti gli utenti hanno accesso a root.

Per utilizzare l'autorizzazione tramite account di servizio, utilizza un account di servizio esistente o creane uno nuovo nella pagina Account di servizio:

Vai alla pagina Account di servizio

Per creare e scaricare la chiave privata associata come file di chiavi in formato JSON, scegli Gestisci chiavi dal menu Azioni per il account di servizio.

Per eseguire l'autorizzazione, esegui gcloud auth activate-service-account:

gcloud auth activate-service-account --key-file [KEY_FILE]

Puoi connetterti tramite SSH all'istanza VM utilizzando gcloud compute ssh, che si occupa dell'autenticazione. I file di configurazione SSH possono essere configurati utilizzando gcloud compute config-ssh.

Per istruzioni dettagliate sull'autorizzazione degli strumenti di Google Cloud SDK, consulta Autenticati per gcloud CLI.

Disattivazione dei prompt

Alcuni comandi gcloud CLI sono interattivi e richiedono agli utenti di confermare un'operazione o di inserire input aggiuntivi per un comando inserito.

Nella maggior parte dei casi, questa operazione non è consigliabile quando si eseguono comandi in uno script o in un'altra automazione. Puoi disattivare i prompt dai comandi gcloud CLI impostando la disable_prompts proprietà nella configurazione su True o utilizzando il flag globale --quiet o -q. La maggior parte dei comandi interattivi ha valori predefiniti quando sono richieste ulteriori conferme o input. Se i prompt sono disattivati, vengono utilizzati questi valori predefiniti.

Ad esempio:

gcloud debug targets list --quiet

Filtro e formattazione dell'output

Per scrivere script con gcloud CLI, è importante avere un output prevedibile; è qui che i flag --filter e --format sono utili. Garantiscono che, quando esegui un comando utilizzando gcloud CLI, l'output prodotto sia conforme alle specifiche di formato (ad esempio json, yaml, csv e testo) e filtro (nomi VM con prefisso "test", anno di creazione successivo al 2015 e così via).

Se preferisci seguire un tutorial interattivo sull'utilizzo dei flag di filtro e formato, avvialo utilizzando il seguente pulsante:

I seguenti esempi mostrano gli utilizzi comuni della formattazione e del filtro con i comandi gcloud CLI:

Elenca le istanze create nella zona us-central1-a:

gcloud compute instances list --filter="zone:us-central1-a"

Elenca in formato JSON i progetti in cui le etichette corrispondono a valori specifici (ad es. label.env è "test" e label.version è alpha):

gcloud projects list --format="json" \
  --filter="labels.env=test AND labels.version=alpha"

Elenca i progetti con la data e l'ora di creazione specificate nel fuso orario locale:

gcloud projects list \
  --format="table(name, project_id, createTime.date(tz=LOCAL))"

Elenca i progetti creati dopo una data specifica in formato tabella:

gcloud projects list \
  --format="table(projectNumber,projectId,createTime)" \
  --filter="createTime.date('%Y-%m-%d', Z)='2016-05-11'"

Nell'ultimo esempio è stata utilizzata una proiezione sulla chiave. Il filtro viene applicato alla chiave createTime dopo aver impostato la formattazione della data.

Elenca una tabella nidificata delle quote di una regione:

gcloud compute regions describe us-central1 \
  --format="table(quotas:format='table(metric,limit,usage)')"

Stampa un elenco appiattito delle quote globali in formato CSV:

gcloud compute project-info describe --flatten='quotas[]' \
  --format='csv(quotas.metric,quotas.limit,quotas.usage)'

Elenca le risorse delle istanze di Compute con decorazioni e titoli delle caselle, ordinate per nome, in formato tabella:

gcloud compute instances list \
  --format='table[box,title=Instances](name:sort=1,zone:label=zone,status)'

Elenca l'indirizzo email dell'utente autenticato del progetto:

gcloud info --format='value(config.account)'

Per esempi più complessi delle funzionalità di configurazione dell'output integrate nei flag filters, formats e projections di gcloud CLI, consulta questo post del blog su filtri e formattazione.

Best practice

Se vuoi che uno script o un'altra automazione esegua azioni in modo condizionale in base all'output di un comando gcloud CLI, tieni presente quanto segue:

Dipendi dallo stato di uscita del comando.

Se lo stato di uscita non è zero, si è verificato un errore e l'output potrebbe essere incompleto, a meno che la documentazione del comando non indichi diversamente. Ad esempio, un comando che crea più risorse potrebbe crearne solo alcune, elencarle nell'output standard e poi uscire con uno stato diverso da zero. In alternativa, puoi utilizzare la proprietà show_structured_logs per analizzare i log degli errori. Esegui gcloud config per maggiori dettagli.
Non dipendere dai messaggi stampati sull'errore standard.

La formulazione di questi messaggi potrebbe cambiare nelle versioni future di gcloud CLI e interrompere l'automazione.
Non dipendere dall'output non elaborato dei messaggi stampati sull'output standard.

L'output predefinito per qualsiasi comando potrebbe cambiare in una release futura. Puoi ridurre al minimo l'impatto di queste modifiche utilizzando il --format flag per formattare l' output con uno dei seguenti: --format=json|yaml|csv|text|list per specificare i valori da restituire. Esegui gcloud topic formats per altre opzioni.

Puoi modificare l'output predefinito di --format utilizzando projections. Per una maggiore granularità, utilizza il --filter flag per restituire un sottoinsieme dei valori in base a un'espressione. Puoi quindi scrivere script in base a questi valori restituiti.

Esempi di formattazione e filtro dell'output sono disponibili nella sezione seguente.

Script di esempio

Utilizzando la funzionalità di formato e filtro, puoi combinare i comandi gcloud CLI in uno script per estrarre facilmente le informazioni incorporate.

Elenca le chiavi per tutti i service account dei tuoi progetti

I seguenti script di esempio elencano le chiavi associate a tutti i service account dei tuoi progetti:

Iterazione sui progetti
Per ogni progetto, recupero dei service account associati
Per ogni account di servizio, recupero delle chiavi associate

Bash

#!/bin/bash
for project in  $(gcloud projects list --format="value(projectId)")
do
  echo "ProjectId:  $project"
  for robot in $(gcloud iam service-accounts list --project $project --format="value(email)")
   do
     echo "    -> Robot $robot"
     for key in $(gcloud iam service-accounts keys list --iam-account $robot --project $project --format="value(name.basename())")
        do
          echo "        $key"
     done
   done
done

Windows PowerShell

Oppure come Windows PowerShell:

foreach ($project in gcloud projects list --format="value(projectId)")
{
  Write-Host "ProjectId: $project"
  foreach ($robot in  gcloud iam service-accounts list --project $project --format="value(email)")
  {
      Write-Host "    -> Robot $robot"
      foreach ($key in gcloud iam service-accounts keys list --iam-account $robot --project $project --format="value(name.basename())")
      {
        Write-Host "        $key"
      }
  }
}

Analizza l'output per l'elaborazione

Il seguente esempio mostra l'analisi dell'output per l'elaborazione. In particolare, lo script di esempio scrive le informazioni del account di servizio in un array e separa i valori nel campo serviceAccounts.scope() in formato CSV con più valori:

#!/bin/bash
for scopesInfo in $(
    gcloud compute instances list --filter=name:instance-1 \
        --format="csv[no-heading](name,id,serviceAccounts[].email.list(),
                      serviceAccounts[].scopes[].map().list(separator=;))")
do
      IFS=',' read -r -a scopesInfoArray<<< "$scopesInfo"
      NAME="${scopesInfoArray[0]}"
      ID="${scopesInfoArray[1]}"
      EMAIL="${scopesInfoArray[2]}"
      SCOPES_LIST="${scopesInfoArray[3]}"

      echo "NAME: $NAME, ID: $ID, EMAIL: $EMAIL"
      echo ""
      IFS=';' read -r -a scopeListArray<<< "$SCOPES_LIST"
      for SCOPE in  "${scopeListArray[@]}"
      do
        echo "  SCOPE: $SCOPE"
      done
done