Questa pagina è stata tradotta dall'API Cloud Translation.

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 attività di Google Cloud .

gcloud CLI include una serie di strumenti come il filtro, la formattazione e il flag --quiet, che ti consentono di gestire in modo efficace l'output e automatizzare le attività.

Nozioni di base sulla creazione di script con gcloud CLI

Per una guida passo passo alla creazione di script di base con gcloud CLI, consulta questo post del blog: Scripting con gcloud: una guida per principianti all'automazione delle attività Google Cloud .

Autorizzazione

Quando crei script con l'interfaccia a riga di comando gcloud, devi prendere in considerazione i metodi di autorizzazione. L'interfaccia a riga di comando gcloud offre due opzioni:

Autorizzazione dell'account utente
Autorizzazione tramite account di servizio

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 comuni di configurazione di gcloud CLI:

gcloud init

L'autorizzazione del service account è 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 comandi gcloud CLI su un'istanza di macchina virtuale Compute Engine in cui tutti gli utenti hanno accesso a root.

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

Vai alla pagina Service account

Per creare e scaricare la chiave privata associata come file di chiavi in formato JSON, scegli Gestisci chiavi dal menu delle 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 accedere alla tua istanza VM tramite SSH 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 gcloud CLI, consulta Autorizzazione di gcloud CLI.

Disattivare le richieste

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

Nella maggior parte dei casi, questo non è auspicabile quando si eseguono comandi in uno script o in un'altra automazione. Puoi disattivare le richieste dei comandi gcloud CLI impostando la proprietà disable_prompts 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 le richieste sono disattivate, vengono utilizzati questi valori predefiniti.

Ad esempio:

gcloud debug targets list --quiet

Filtrare e formattare l'output

Per creare 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 rispetti le specifiche di formato (ad esempio json, yaml, csv e testo) e filtro (nomi VM con il 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 pulsante seguente:

Gli esempi seguenti mostrano gli utilizzi comuni della formattazione e del filtraggio 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 data e 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'"

Tieni presente che 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 non strutturato 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 filtraggio 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:

Dipende 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 fare affidamento sui messaggi stampati nell'errore standard.

Il testo di questi messaggi potrebbe cambiare nelle versioni future della gcloud CLId e interrompere l'automazione.
Non fare affidamento sull'output non elaborato dei messaggi stampati nell'output standard.

L'output predefinito di qualsiasi comando potrebbe cambiare in una release futura. Puoi ridurre al minimo l'impatto di queste modifiche utilizzando il flag --format 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 da --format utilizzando projections. Per una maggiore granularità, utilizza il flag --filter per restituire un sottoinsieme dei valori in base a un'espressione. Puoi quindi creare script in base ai valori restituiti.

Esempi di formattazione e filtraggio 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 in base a:

Iterazione sui progetti
Per ogni progetto, recuperare i service account associati
Per ogni account di servizio, recuperare le 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"
      }
  }
}

Analizzare 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 dell'account di servizio in un array e separa i valori nel campo serviceAccounts.scope() formattato 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