Creare e gestire le etichette

Puoi applicare etichette utente ai cluster e ai job di Managed Service for Apache Spark per raggruppare queste risorse per il filtro e l'elenco successivi. Le etichette vengono associate alle risorse al momento della creazione della risorsa, della creazione del cluster o dell'invio del job. Una volta che una risorsa è associata a un'etichetta, l'etichetta viene propagata alle operazioni eseguite sulla risorsa (creazione, aggiornamento, applicazione di patch o eliminazione del cluster; invio, aggiornamento, annullamento o eliminazione del job), consentendoti di filtrare ed elencare cluster, job e operazioni in base all'etichetta.

Puoi anche aggiungere etichette alle risorse di Compute Engine associate alle risorse del cluster, come le istanze di macchine virtuali e i dischi.

Cosa sono le etichette?

Un'etichetta è una coppia chiave-valore che puoi assegnare ai cluster e ai job di Managed Service for Apache Spark. Ti aiutano a organizzare queste risorse e a gestire i costi su larga scala, con la granularità di cui hai bisogno. Puoi collegare un'etichetta a ogni risorsa, quindi filtrare le risorse in base alle relative etichette. Le informazioni relative alle etichette vengono inoltrate al sistema di fatturazione, che ti consente di suddividere i costi fatturati in base all'etichetta. Con i report di fatturazione integrati, puoi filtrare e raggruppare i costi in base alle etichette delle risorse. Puoi anche utilizzare le etichette per eseguire query sulle esportazioni dei dati di fatturazione.

Requisiti per le etichette

Le etichette applicate a una risorsa devono soddisfare i seguenti requisiti:

  • Ogni cluster o job può avere fino a 32 etichette.
  • Ogni etichetta deve essere una coppia chiave/valore.
  • Le chiavi hanno una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri.
  • Chiavi e valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8; sono consentiti i caratteri internazionali. Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale.
  • La parte della chiave di un'etichetta deve essere univoca all'interno di una singola risorsa. Tuttavia, puoi utilizzare la stessa chiave con più risorse.

Questi limiti si applicano alla chiave e al valore di ogni etichetta e al singolo cluster o job di Managed Service for Apache Spark che hanno etichette. Non esiste un limite al numero di etichette che puoi applicare a tutte le risorse di un progetto.

Usi comuni delle etichette

Ecco alcuni casi d'uso comuni per le etichette:

  • Etichette di team o centro di costo: aggiungi etichette basate su team o centro di costo per distinguere i cluster e i job di Managed Service for Apache Spark di proprietà di team diversi (ad esempio, team:research e team:analytics). Puoi utilizzare questo tipo di etichetta per la contabilità dei costi o la definizione del budget.

  • Etichette dei componenti: ad esempio, component:redis, component:frontend, component:ingest, e component:dashboard.

  • Etichette di ambiente o fase: ad esempio, environment:production e environment:test.

  • Etichette di stato: ad esempio, state:active, state:readytodelete e state:archive.

  • Etichette di proprietà: utilizzate per identificare i team responsabili delle operazioni, ad esempio: team:shopping-cart.

Non è consigliabile creare un numero elevato di etichette univoche, ad esempio per timestamp o valori individuali per ogni chiamata API. Il problema di questo approccio è che, quando i valori cambiano frequentemente o con chiavi che ingombrano il catalogo, è difficile filtrare e generare report sulle risorse in modo efficace.

Etichette e tag

Le etichette possono essere utilizzate come annotazioni su cui è possibile eseguire query per le risorse, ma non possono essere utilizzate per impostare condizioni sulle policy. I tag forniscono un modo per consentire o negare in modo condizionale le policy a seconda che una risorsa abbia un tag specifico, fornendo un controllo granulare sulle policy. Per saperne di più, consulta la panoramica dei tag.

Creare e utilizzare le etichette di Managed Service for Apache Spark

Console

Puoi specificare un insieme di etichette da aggiungere a un cluster o a un job al momento della creazione del cluster o dell'invio del job utilizzando la Google Cloud console.

  • Aggiungi etichette a un cluster dalla Crea cluster pagina Fai clic su Configurazione aggiuntiva per espandere la sezione, quindi modifica Personalizzazione e altro e aggiungi le etichette nella sezione Etichette.
  • Aggiungi etichette a un job dalla Invia un job pagina, nella sezione Etichette.

Una volta creato o inviato un cluster o un job, puoi aggiornare le etichette associate al cluster o al job. Per aggiornare le etichette, fai clic sulla casella di selezione di un cluster o di un job elencato, quindi fai clic su SHOW INFO PANEL. Questo è un esempio dalla pagina Managed Service for Apache Spark→Elenca cluster.

Comando gcloud

Puoi specificare una o più etichette da applicare a un cluster o a un job di Managed Service for Apache Spark al momento della creazione o dell'invio utilizzando Google Cloud CLI.

gcloud dataproc clusters create args --labels environment=production,customer=acme
gcloud dataproc jobs submit args --labels environment=production,customer=acme

Una volta creato un cluster o un job di Managed Service for Apache Spark, puoi aggiornare le etichette associate alla risorsa utilizzando Google Cloud CLI.

gcloud dataproc clusters update args --update-labels environment=production,customer=acme
gcloud dataproc jobs update args --update-labels environment=production,customer=acme

Allo stesso modo, puoi utilizzare Google Cloud CLI per filtrare le risorse di Managed Service for Apache Spark in base all'etichetta utilizzando un'espressione di filtro nel seguente formato: labels.<key=value>.

gcloud dataproc clusters list \
    --region=region \
    --filter="status.state=ACTIVE AND labels.environment=production"
gcloud dataproc jobs list \
    --region=region \
    --filter="status.state=ACTIVE AND labels.customer=acme"

Per saperne di più sulla scrittura di un'espressione di filtro, consulta la documentazione dell'API Dataproc clusters.list e jobs.list.

API REST

Le etichette possono essere collegate a cluster o job tramite l' API REST Dataproc. Le API clusters.create, jobs.submit possono essere utilizzate per collegare le etichette a un cluster o a un job al momento della creazione o dell'invio. Le API clusters.patch, jobs.patch possono essere utilizzate per modificare le etichette dopo la creazione di un cluster. Di seguito è riportato il corpo JSON di una richiesta cluster.create che include l'etichetta key1:value al cluster. 

{
  "clusterName":"cluster-1",
  "projectId":"my-project",
  "config":{
    "configBucket":"",
    "gceClusterConfig":{
      "networkUri":".../networks/default",
      "zoneUri":".../zones/us-central1-f"
    },
    "masterConfig":{
      "numInstances":1,
      "machineTypeUri":"..../machineTypes/n1-standard-4",
      "diskConfig":{
        "bootDiskSizeGb":500,
        "numLocalSsds":0
      }
    },
    "workerConfig":{
      "numInstances":2,
      "machineTypeUri":"...machineTypes/n1-standard-4",
      "diskConfig":{
        "bootDiskSizeGb":500,
        "numLocalSsds":0
      }
    }
  },
  "labels":{
    "key1":"value1"
  }
}

Le API clusters.list e jobs.list possono essere utilizzate per elencare i cluster o i job che corrispondono a un filtro specificato, utilizzando il seguente formato: labels.<key=value>.

Di seguito è riportata una richiesta GET HTTPS di esempio dell'API Dataproc clusters.list che specifica un filtro di etichette key=value. Il chiamante inserisce project, region, un filtro label-key e label-value e una api-key. Tieni presente che questa richiesta di esempio è suddivisa in due righe per una maggiore leggibilità.

GET https://dataproc.googleapis.com/v1/projects/project/regions/region/clusters?
filter=labels.label-key=label-value&key=api-key

Per saperne di più sulla scrittura di un'espressione di filtro, consulta la documentazione dell'API Dataproc clusters.list e jobs.list.

Una volta visualizzato il riquadro delle informazioni, puoi aggiornare le etichette del cluster o del job. Di seguito è riportato un esempio di aggiornamento delle etichette per un cluster di Managed Service for Apache Spark.

È anche possibile aggiornare le etichette per più elementi in un'unica operazione. In questo esempio, le etichette vengono aggiornate contemporaneamente per più job di Managed Service for Apache Spark.

Le etichette ti consentono di filtrare le risorse visualizzate nelle pagine Elenca cluster ed Elenca job. Nella parte superiore della pagina, puoi utilizzare lo schema di ricerca labels.= per filtrare le risorse in base a un'etichetta.

Etichette applicate automaticamente

Quando crei o aggiorni un cluster, Managed Service for Apache Spark applica automaticamente diverse etichette al cluster e alle risorse del cluster. Ad esempio, Managed Service for Apache Spark applica etichette a macchine virtuali, dischi permanenti e acceleratori quando viene creato un cluster. Le etichette applicate automaticamente hanno un prefisso goog-dataproc speciale.

Le seguenti etichette goog-dataproc vengono applicate automaticamente alle risorse di Managed Service for Apache Spark. I valori forniti per le etichette goog-dataproc riservate al momento della creazione del cluster sostituiranno i valori forniti automaticamente. Per questo motivo, non è consigliabile fornire valori personalizzati per queste etichette.

Etichetta Descrizione
goog-dataproc-cluster-name Nome del cluster specificato dall'utente
goog-dataproc-cluster-uuid ID cluster univoco
goog-dataproc-location Endpoint del cluster regionale di Managed Service for Apache Spark

Puoi utilizzare queste etichette applicate automaticamente in molti modi, tra cui:

Passaggi successivi