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 Google Cloud CLI dalla riga di comando, puoi eseguire 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 filtri, 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à di Google Cloud.

Autorizzazione

Quando scrivi 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 stai eseguendo 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 dell'account di servizio è consigliata se esegui il deployment di uno script o di un'altra automazione su macchine in un ambiente di produzione. È anche il metodo di autorizzazione consigliato se esegui comandi dell'interfaccia a riga di comando gcloud CLI su un'istanza della macchina virtuale Compute Engine a cui tutti gli utenti hanno accesso a root.

Per utilizzare l'autorizzazione dell'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 di azioni dell'account di servizio.

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

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

Puoi accedere con 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 gcloud CLI, consulta Autorizzazione dell'interfaccia a riga di comando gcloud.

Disattivare i prompt

Alcuni comandi dellgcloud CLI sono interattivi e richiedono agli utenti di confermare un'operazione o di fornire 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 i prompt dei comandi dell'interfaccia a riga di comando gcloud impostando la proprietà disable_prompts nella configurazione su True o utilizzando il flag --quiet o -q globale. La maggior parte dei comandi interattivi ha valori predefiniti quando è richiesta un'ulteriore conferma o un input. Se le richieste sono disattivate, vengono utilizzati questi valori predefiniti.

Ad esempio:

gcloud debug targets list --quiet

Filtrare e formattare l'output

Per scrivere script con la gcloud CLI, è importante avere un output prevedibile. È qui che entrano in gioco i flag --filter e --format. Garantiscono che quando esegui un comando utilizzando la gcloud CLI, l'output sia conforme alle specifiche del formato (ad esempio JSON, YAML, CSV e testo) e dei filtri (nomi VM con prefisso "test", anno di creazione successivo al 2015 e così via).

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

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

Tieni presente che nell'ultimo esempio è stata utilizzata una proiezione sulla chiave. Il filtro viene applicato alla chiave createTime dopo l'impostazione della 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 calcolo con decorazioni delle caselle e titoli, 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 dell'interfaccia a riga di comando gcloud CLI, consulta questo post del blog sulla filtrazione e la formattazione.

Best practice

Se vuoi che uno script o un'altra automazione esegua azioni in base alle condizioni dell'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 ed uscire con uno stato diverso da zero. In alternativa, puoi utilizzare la proprietà show_structured_logs per analizzare i log di errore. Esegui gcloud config per ulteriori dettagli.
Non fare affidamento sui messaggi stampati nell'errore standard.

Il testo di questi messaggi potrebbe cambiare nelle versioni future dell'interfaccia alla gcloud CLI 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 il risultato con uno dei seguenti: --format=json|yaml|csv|text|list per specificare i valori da restituire. Esegui gcloud topic formats per visualizzare altre opzioni.

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

Nella sezione riportata di seguito puoi trovare esempi di output di formattazione e filtri.

Script di esempio

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

Elenca le chiavi per tutti gli account di servizio dei tuoi progetti

I seguenti script di esempio elencano le chiavi associate a tutti gli account di servizio dei tuoi progetti in base a:

Eseguire l'iterazione sui progetti
Per ogni progetto, ottieni gli account di servizio associati
Per ogni account di servizio, ottieni 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

In alternativa, 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

L'esempio seguente 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 segrega 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