Questa guida ti aiuta a comprendere ed eseguire il deployment della soluzione Knowledge base dell'IA generativa. Questa soluzione dimostra come creare una pipeline di question-answering (EQA) per produrre contenuti per una conoscenza interna base.
Una pipeline EQA elabora i documenti, ne estrae le coppie di domande e risposte e fornisce informazioni strutturate per perfezionare un modello linguistico di grandi dimensioni (LLM). Ad esempio, potresti caricare un documento contenente molte domande frequenti (FAQ), ottimizzare un LLM utilizzando queste domande frequenti e poi utilizzare il modello addestrato per aiutare gli addetti all'assistenza clienti a trovare informazioni durante la risoluzione delle richieste.
Questo documento è rivolto agli sviluppatori che hanno una certa esperienza con gli LLM. it presuppone la conoscenza di concetti cloud di base.
Obiettivi
Questa guida alle soluzioni ti consente di:
- Esegui il deployment di un'applicazione che estrae coppie di domanda e risposta dal tuo documenti.
- Esegui il deployment di una pipeline che attiva la tua applicazione quando viene caricato un documento.
- Addestra un modello di AI basato su prompt utilizzando l'output del tuo un'applicazione.
Architettura
Questa soluzione esegue il deployment di un'applicazione Knowledge base dell'IA generativa. Il seguente diagramma mostra l'architettura dell'infrastruttura dell'applicazione:
Flusso delle richieste
I passaggi seguenti descrivono in dettaglio il flusso di elaborazione delle richieste dell'applicazione. I passaggi del flusso sono numerati come mostrato nel diagramma di architettura precedente.
Per avviare l'applicazione della knowledge base dell'IA generativa di un documento direttamente in un bucket Cloud Storage, mediante la console Google Cloud o gcloud CLI.
Quando il documento viene caricato, attiva una funzione Cloud Run. Questa funzione esegue il processo di risposta alle domande estrattive.
La funzione utilizza l'OCR di Document AI per estrarre tutto il testo del documento.
La funzione indicizza il documento in Vector Search. L'indice di ricerca vettoriale fornisce il contesto per consentire all'LLM di estrarre coppie di domande e risposte in base solo ai contenuti estratti direttamente dai documenti caricati.
La funzione utilizza Vertex AI per estrarre e generare domande e risposte dal documento.
La funzione archivia le coppie di domande e risposte estratte in Firestore.
Un set di dati di ottimizzazione JSONL viene generato dal database Firestore e archiviato in Cloud Storage.
Dopo aver verificato manualmente che il set di dati è soddisfacente, puoi avviare un job di ottimizzazione fine su Vertex AI.
Al termine del job di ottimizzazione, il modello ottimizzato viene implementato in un endpoint. Dopo il deployment in un endpoint, puoi inviare query al modello ottimizzato in un blocco note di Colab, per poi confrontarlo con il modello di base.
Prodotti utilizzati
Questa sezione descrive i prodotti utilizzati dalla soluzione.
Se hai dimestichezza con il linguaggio di configurazione Terraform, puoi modificare alcune delle impostazioni dei servizi.
Componente | Descrizione prodotto | Scopo in questa soluzione |
---|---|---|
Cloud Storage | Un servizio di livello enterprise che fornisce archiviazione di oggetti a basso costo e senza limiti per diversi tipi di dati. | Archivia i documenti PDF, il testo estratto, il set di dati di ottimizzazione e il modello ottimizzato. |
Eventarc | Un servizio che gestisce il flusso delle modifiche dello stato (eventi) tra microservizi disaccoppiati, instradando gli eventi a varie destinazioni e gestendo al contempo la distribuzione, la sicurezza, l'autorizzazione, l'osservabilità e la gestione degli errori. | Cerca nuovi documenti nel bucket Cloud Storage e attiva un evento nelle funzioni Cloud Run. |
Funzioni Cloud Run | Un servizio di serverless computing leggero che ti consente di creare funzioni autonome a uso specifico in grado di rispondere agli eventi Google Cloud senza la necessità di gestire un ambiente server o di runtime. | Orchestra le fasi di elaborazione dei documenti. |
Document AI | Una piattaforma di comprensione dei documenti che prende i dati non strutturati dai documenti e li trasforma in dati strutturati. Puoi automatizzare attività noiose, migliorare l'estrazione dei dati e ottenere insight più approfonditi dai dati. | Estrae il testo dai documenti. |
Vertex AI | Una piattaforma di machine learning che consente di addestrare, testare, ottimizzare ed eseguire il deployment di LLM e applicazioni di AI generativa. | Genera domande e risposte dai documenti. |
Ricerca vettoriale | Un servizio che ti consente di utilizzare la stessa infrastruttura che fornisce la base per prodotti Google come Ricerca Google, YouTube e Play. | Ti consente di cercare negli incorporamenti per trovare entità semanticamente simili o correlate. |
Firestore | Un file system a bassa latenza e completamente gestito per VM e cluster che offre alta disponibilità e velocità effettiva. | Archivia le domande e le risposte generate. |
Costo
Per una stima del costo delle risorse Google Cloud utilizzate dalla soluzione della knowledge base di IA generativa, consulta la stima precalcolata nel Calcolatore prezzi di Google Cloud.
Utilizza questa stima come punto di partenza per calcolare il costo del deployment. Puoi modificare la stima per riflettere eventuali modifiche alla configurazione che prevedi per le risorse utilizzate nella soluzione.
La stima precalcolata si basa su ipotesi per determinati fattori, tra cui:
- Le località Google Cloud in cui vengono implementate le risorse.
La quantità di tempo di utilizzo delle risorse.
La quantità di dati archiviati in Cloud Storage.
Il numero di volte in cui viene invocata l'applicazione della knowledge base.
Le risorse di calcolo utilizzate per l'ottimizzazione del modello.
Prima di iniziare
Per eseguire il deployment di questa soluzione, devi prima disporre di un progetto Google Cloud e di alcune autorizzazioni IAM.
Crea o scegli un progetto Google Cloud
Quando esegui il deployment della soluzione, scegli il progetto Google Cloud in cui vengono implementate le risorse. Puoi creare un nuovo progetto o utilizzare progetto esistente per il deployment.
Se vuoi creare un nuovo progetto, fallo prima di iniziare il deployment. L'utilizzo di un nuovo progetto può contribuire a evitare conflitti con le risorse di cui è stato eseguito il provisioning in precedenza, ad esempio quelle utilizzate per i carichi di lavoro di produzione.
Per creare un progetto, completa i seguenti passaggi:
-
In the Google Cloud console, go to the project selector page.
-
Click Create project.
-
Name your project. Make a note of your generated project ID.
-
Edit the other fields as needed.
-
Click Create.
Ottieni le autorizzazioni IAM richieste
Per avviare la procedura di deployment, devi disporre delle autorizzazioni di Identity and Access Management (IAM) elencate nella tabella seguente.
Se hai creato un nuovo progetto per questa soluzione, hai roles/owner
ruolo di base
nel progetto e disporre di tutte le autorizzazioni necessarie. Se non disponi del ruolo roles/owner
, chiedi all'amministratore di concederti queste autorizzazioni (o i ruoli che le includono).
Autorizzazione IAM richiesta | Ruolo predefinito che include le autorizzazioni richieste |
---|---|
|
Amministratore Service Usage ( roles/serviceusage.serviceUsageAdmin ) |
|
Amministratore account di servizio ( roles/iam.serviceAccountAdmin ) |
|
Amministratore IAM progetto ( roles/resourcemanager.projectIamAdmin ) |
config.deployments.create config.deployments.list |
Amministratore Cloud Infrastructure Manager ( roles/config.admin ) |
iam.serviceAccount.actAs |
Utente account di servizio ( roles/iam.serviceAccountUser ) |
Informazioni sulle autorizzazioni temporanee degli account di servizio
Se avvii la procedura di implementazione tramite la console, Google crea un account di servizio per eseguire il deployment della soluzione per tuo conto (e per eliminare il deployment in un secondo momento, se lo desideri). A questo account di servizio sono assegnate determinate autorizzazioni IAM temporarily; cioè le autorizzazioni vengono revocate automaticamente le operazioni di deployment ed eliminazione della soluzione. Google consiglia di eliminare l'account di servizio dopo aver eliminato il deployment, come descritto più avanti in questa guida.
Visualizza i ruoli assegnati al servizio account
Questi ruoli sono elencati qui nel caso in cui un amministratore del tuo progetto o della tua organizzazione Google Cloud abbia bisogno di queste informazioni.
roles/aiplatform.user
roles/artifactregistry.admin
roles/documentai.editor
roles/firebase.admin
roles/iam.serviceAccountUser
roles/serviceusage.serviceUsageAdmin
roles/iam.serviceAccountAdmin
roles/resourcemanager.projectIamAdmin
roles/config.agent
Esegui il deployment della soluzione
Per aiutarti a eseguire il deployment di questa soluzione con il minimo sforzo, su GitHub è disponibile una configurazione Terraform. La configurazione di Terraform definisce Le risorse Google Cloud necessarie per la soluzione.
Puoi eseguire il deployment della soluzione utilizzando uno dei seguenti metodi:
Tramite la console: utilizza questo metodo se vuoi per provare la soluzione con la configurazione predefinita e vedere come funziona. Cloud Build esegue il deployment di tutte le risorse necessarie per la soluzione. Quando non hai più bisogno della soluzione di cui è stato eseguito il deployment, puoi eliminarla tramite la console. Qualsiasi risorsa creata dopo potrebbe essere necessario eliminare separatamente la soluzione.
Per utilizzare questo metodo di deployment, segui le istruzioni riportate in Eseguire il deployment tramite la console.
Utilizzo della CLI Terraform: utilizza questo metodo se vuoi personalizzare la soluzione o se vuoi automatizzare il provisioning e la gestione delle risorse utilizzando l'approccio Infrastructure as Code (IaC). Scarica la configurazione Terraform da GitHub, personalizza facoltativamente il codice in base alle necessità, quindi esegui il deployment della soluzione utilizzando Terraform CLI. Dopo il giorno esegui il deployment della soluzione, puoi continuare a usare Terraform per gestire soluzione.
Per utilizzare questo metodo di deployment, segui le istruzioni in Esegui il deployment utilizzando l'interfaccia a riga di comando di Terraform.
Esegui il deployment tramite la console
Completa i seguenti passaggi per eseguire il deployment della soluzione preconfigurata.
Nel catalogo delle soluzioni già pronte di Google Cloud, vai alla soluzione Knowledge base con l'IA generativa.
Controlla le informazioni fornite nella pagina, ad esempio la stima costo della soluzione e il tempo di deployment stimato.
Quando è tutto pronto per iniziare a eseguire il deployment della soluzione, fai clic su Esegui il deployment.
Viene visualizzato un riquadro di configurazione passo passo.
Completa i passaggi nel riquadro di configurazione.
Prendi nota del nome inserito per il deployment. Questo nome è obbligatorio in un secondo momento, quando elimini il deployment.
Quando fai clic su Esegui il deployment, viene visualizzata la pagina Deployment di soluzioni. Il campo Stato in questa pagina mostra Deployment in corso.
Attendi il deployment della soluzione.
Se il deployment non va a buon fine, il campo Stato mostra Non riuscito. Puoi utilizzare il log di Cloud Build per diagnosticare gli errori. Per ulteriori informazioni, consulta Errori durante il deployment tramite la console.
Al termine del deployment, il campo Stato diventa Deployment eseguito.
Per visualizzare le risorse Google Cloud di cui è stato eseguito il deployment e la relativa configurazione, fai un tour interattivo nella console.
Per i passaggi successivi, vedi Utilizzare la soluzione.
Quando la soluzione non ti serve più, puoi eliminare il deployment per evitare e la fatturazione continua per le risorse Google Cloud. Per ulteriori informazioni, vedi Elimina il deployment.
Esegui il deployment utilizzando l'interfaccia a riga di comando Terraform
Questa sezione descrive come personalizzare la soluzione o automatizzare il provisioning e la gestione della soluzione utilizzando l'interfaccia a riga di comando Terraform. Le soluzioni di cui esegui il deployment utilizzando Terraform CLI non vengono visualizzate nella pagina Deployment delle soluzioni della console Google Cloud.
Configura il client Terraform
Puoi eseguire Terraform in Cloud Shell o sul tuo host locale. Questo descrive come eseguire Terraform in Cloud Shell, Terraform è preinstallato e configurato per l'autenticazione con Google Cloud.
Il codice Terraform per questa soluzione è disponibile in un repository GitHub.
Clona il repository GitHub in Cloud Shell.
Viene visualizzato un messaggio per confermare il download del repository GitHub in Cloud Shell.
Fai clic su Conferma.
Cloud Shell viene avviato in una scheda separata del browser Il codice Terraform viene scaricato nella directory
$HOME/cloudshell_open
di dell'ambiente Cloud Shell.In Cloud Shell, controlla se la directory di lavoro attuale è
$HOME/cloudshell_open/terraform-genai-knowledge-base/
. Questo è il contenente i file di configurazione Terraform per la soluzione. Se devi passare a questa directory, esegui questo comando:cd $HOME/cloudshell_open/terraform-genai-knowledge-base/
Inizializza Terraform eseguendo il seguente comando:
terraform init
Attendi finché non viene visualizzato il seguente messaggio:
Terraform has been successfully initialized!
Configura le variabili Terraform
Il codice Terraform scaricato include variabili che puoi utilizzare per personalizzare il deployment in base ai tuoi requisiti. Ad esempio, puoi specificare il progetto Google Cloud e la regione in cui vuoi eseguire il deployment della soluzione.
Assicurati che la directory di lavoro attuale sia
$HOME/cloudshell_open/terraform-genai-knowledge-base/
. Se non lo è, vai a quella directory.Nella stessa directory, crea un file di testo denominato
terraform.tfvars
.Nel file
terraform.tfvars
, copia il seguente snippet di codice e imposta i valori per le variabili richieste.- Segui le istruzioni fornite come commenti nello snippet di codice.
- Questo snippet di codice include solo le variabili per le quali devi impostare i valori. La configurazione di Terraform include altre variabili con valori predefiniti. Per esaminare tutte le variabili e i valori predefiniti, consulta il file
variables.tf
disponibile nella directory$HOME/cloudshell_open/terraform-genai-knowledge-base/
. - Assicurati che ogni valore impostato nel file
terraform.tfvars
sia corrispondente al tipo di variabile dichiarato nel filevariables.tf
. Ad esempio, se il tipo definita per una variabile nel filevariables.tf
èbool
, allora deve specificaretrue
ofalse
come valore di quella variabile nellaterraform.tfvars
.
# This is an example of the terraform.tfvars file. # The values in this file must match the variable types declared in variables.tf. # The values in this file override any defaults in variables.tf. # ID of the project in which you want to deploy the solution project_id = "PROJECT_ID"
Convalida e rivedi la configurazione di Terraform
Assicurati che la directory di lavoro corrente sia
$HOME/cloudshell_open/terraform-genai-knowledge-base/
. Se non lo è, vai a quella directory.Verifica che la configurazione Terraform non contenga errori:
terraform validate
Se il comando restituisce degli errori, apporta le correzioni necessarie nella configurazione ed esegui di nuovo il comando
terraform validate
. Ripeti questo passaggio finché il comando non restituisce il seguente messaggio:Success! The configuration is valid.
Esamina le risorse definite nella configurazione:
terraform plan
Se non hai creato il file
terraform.tfvars
come описано sopra, Terraform ti chiede di inserire i valori per le variabili che non hanno valori predefiniti. Inserisci i valori richiesti.L'output del comando
terraform plan
è un elenco delle risorse che Terraform esegue il provisioning quando applichi la configurazione.Se vuoi apportare modifiche, modifica la configurazione ed esegui di nuovo
terraform validate
eterraform plan
.
Esegui il provisioning delle risorse
Quando non sono necessarie ulteriori modifiche alla configurazione Terraform, esegui il deployment le risorse.
Assicurati che la directory di lavoro attuale sia
$HOME/cloudshell_open/terraform-genai-knowledge-base/
. Se non lo è, vai a quella directory.Applica la configurazione Terraform:
terraform apply
Se non hai creato il file
terraform.tfvars
come descritto in precedenza, Terraform richiede di inserire i valori per le variabili privi di valori predefiniti. Inserisci i valori richiesti.Terraform mostra un elenco delle risorse che verranno create.
Quando ti viene chiesto di eseguire le azioni, inserisci
yes
.Terraform mostra messaggi che indicano l'avanzamento del deployment.
Se il deployment non può essere completato, Terraform mostra gli errori che hanno causato il fallimento. Esamina i messaggi di errore e aggiorna la configurazione per correggere gli errori. Quindi esegui di nuovo il comando
terraform apply
. Per assistenza con la risoluzione degli errori di Terraform, consulta Errori durante il deployment della soluzione utilizzando l'interfaccia a riga di comando Terraform.Al termine della creazione di tutte le risorse, Terraform visualizza quanto segue messaggio:
Apply complete!
Per visualizzare le risorse Google Cloud di cui è stato eseguito il deployment e la relativa configurazione, fai un tour interattivo nella console.
Successivamente, potrai utilizzare la soluzione e vedere come funziona.
Quando la soluzione non ti serve più, puoi eliminare il deployment per evitare e la fatturazione continua per le risorse Google Cloud. Per ulteriori informazioni, consulta la sezione Elimina il deployment.
Utilizzare la soluzione
Una volta implementata la soluzione, puoi caricare un documento per indicizzarlo e porvi domande. Inoltre, viene creato anche un file di set di dati di ottimizzazione delle linee JSON (JSONL) che puoi usare per ottimizzare un LLM.
Carica un documento e esegui query sul modello
Inizia a utilizzare questa soluzione caricando un documento, poi chiedi all'LLM preaddestrato domande sul documento.
Per seguire indicazioni dettagliate per questa attività direttamente nella console Google Cloud, fai clic su Procedura guidata.
Il completamento di questa operazione richiede circa 10 minuti.Ottimizza l'LLM
Dopo aver caricato i documenti per la soluzione, puoi utilizzare Vertex AI per perfezionare un LLM con le coppie di domande e risposte. L'ottimizzazione dell'LLM non è processo automatizzato. Prima di ottimizzare l'LLM, controlla i dati e assicurati che siano validi e accurati. Una volta ottenuti dati soddisfacenti, puoi avviare manualmente un job di ottimizzazione e avviare l'LLM dal Registry dei modelli.
Il file di ottimizzazione JSONL contiene contenuti estratti dalle tue domande e risposte
in coppia. Ogni riga del file è una voce JSON con campi input_text
e output_text
. Il campo input_text
include i contenuti di ogni domanda e il
output_text
include i contenuti di ciascuna risposta corrispondente.
Ad esempio, il seguente file JSONL contiene la domanda "Quante persone vivi a Pechino" e la rispettiva risposta:
{"input_text": "CONTEXT: With over 21 million residents, Beijing is the
world's most populous national capital city and is China's second largest
city after Shanghai. QUESTION: How many people live in Beijing?,
"output_text": "21 million people"}
Per seguire indicazioni dettagliate per l'ottimizzazione del tuo modello direttamente nella console Google Cloud, fai clic su Procedura guidata.
Questa procedura dettagliata richiede circa 10 minuti, ma l'ottimizzazione del modello può richiedere un'ora o più per terminare l'elaborazione.Elimina il deployment
Quando la soluzione non è più necessaria, elimina il deployment. Quando elimini il deployment, non ti vengono più addebitate le risorse che hai creato.
Prima dell'eliminazione
Prima di eliminare questa soluzione, elimina il deployment dell'indice Vector Search:
Vai alla pagina Ricerca vettoriale.
Fai clic su
knowledge-base-index
.In Indici di cui è stato eseguito il deployment, fai clic su more_vert Altro.
Fai clic su Annulla il deployment.
Non devi attendere il completamento del processo di eliminazione dell'indice.
Elimina tramite la console
Utilizza questa procedura se hai eseguito il deployment della soluzione tramite la console.
Nella console Google Cloud, vai alla pagina Deployment della soluzione.
Vai a Deployment di soluzioni
Seleziona il progetto che contiene il deployment da eliminare.
Individua il deployment che vuoi eliminare.
Nella riga relativa al deployment, fai clic su
Azioni e seleziona Elimina.Potresti dover scorrere per visualizzare Azioni nella riga.
Inserisci il nome del deployment e fai clic su Conferma.
Il campo Stato mostra la dicitura Eliminazione.
Se l'eliminazione non riesce, consulta le indicazioni per la risoluzione dei problemi in Errore durante l'eliminazione di un deployment.
Quando non hai più bisogno del progetto Google Cloud che hai utilizzato per la soluzione, possono eliminare il progetto. Per ulteriori informazioni, consulta la sezione Facoltativo: elimina il progetto.
Elimina utilizzando l'interfaccia a riga di comando di Terraform
Utilizza questa procedura se hai eseguito il deployment della soluzione mediante l'interfaccia a riga di comando di Terraform.
In Cloud Shell, assicurati che la directory di lavoro corrente sia
$HOME/cloudshell_open/terraform-genai-knowledge-base/
. Se non lo è, vai a quella directory.Rimuovi le risorse di cui è stato eseguito il provisioning da Terraform:
terraform destroy
Terraform visualizza un elenco delle risorse che verranno eliminate.
Quando ti viene chiesto di eseguire le azioni, inserisci
yes
.Terraform mostra messaggi che indicano l'avanzamento. Dopo che tutte le risorse sono state eliminate, Terraform mostra il seguente messaggio:
Destroy complete!
Se l'eliminazione non riesce, consulta le indicazioni per la risoluzione dei problemi in Errore durante l'eliminazione di un deployment.
Quando non hai più bisogno del progetto Google Cloud che hai utilizzato per la soluzione, possono eliminare il progetto. Per ulteriori informazioni, consulta la sezione Facoltativo: elimina il progetto.
Elimina il modello ottimizzato
Devi eliminare manualmente il modello ottimizzato.
Per eliminare la modalità ottimizzata, consulta Eliminare un modello da Vertex AI Model Registry.
(Facoltativo) Elimina il progetto
Se hai eseguito il deployment della soluzione in un nuovo progetto Google Cloud e non ne hai più bisogno, eliminalo completando i seguenti passaggi:
- Nella console Google Cloud, vai alla pagina Gestisci risorse.
- Nell'elenco dei progetti, seleziona il progetto che vuoi eliminare, quindi fai clic su Elimina.
- Al prompt, digita l'ID progetto e fai clic su Chiudi.
Se decidi di conservare il progetto, elimina l'account di servizio che era creato per questa soluzione, come descritto nella sezione successiva.
(Facoltativo) Elimina l'account di servizio
Se hai eliminato il progetto che hai utilizzato per la soluzione, salta questo passaggio .
Come accennato in precedenza in questa guida, quando hai implementato la soluzione è stato creato un account di servizio per tuo conto. All'account di servizio sono state assegnate determinate autorizzazioni IAM temporaneamente, ovvero le autorizzazioni sono state revocate automaticamente al termine delle operazioni di deployment ed eliminazione della soluzione, ma l'account di servizio non è stato eliminato. Google consiglia di eliminare questo account di servizio.
Se hai eseguito il deployment della soluzione tramite la console Google Cloud, vai alla pagina Deployment di soluzioni. Se sei già su questa pagina, aggiorna il browser. Un processo è attivata in background per eliminare l'account di servizio. Non sono necessari ulteriori interventi.
Se hai eseguito il deployment della soluzione utilizzando l'interfaccia a riga di comando di Terraform, completa i seguenti passaggi:
Nella console Google Cloud, vai alla pagina Account di servizio.
Seleziona il progetto utilizzato per la soluzione.
Seleziona l'account di servizio che vuoi eliminare.
L'ID email dell'account di servizio creato per la soluzione è nel seguente formato:
goog-sc-DEPLOYMENT_NAME-NNN@PROJECT_ID.iam.gserviceaccount.com
L'ID email contiene i seguenti valori:
- DEPLOYMENT_NAME: il nome del deployment.
- NNN: un numero di 3 cifre casuali.
- PROJECT_ID: l'ID del progetto in cui di cui è stato eseguito il deployment della soluzione.
Fai clic su Elimina.
Risolvere gli errori
Le azioni che puoi intraprendere per diagnosticare e risolvere gli errori dipendono il metodo di deployment e la complessità dell'errore.
Errori durante il deployment tramite la console
Se il deployment non va a buon fine quando utilizzi la console, segui questi passaggi:
Vai alla pagina Deployment di soluzioni.
Se il deployment non è riuscito, il campo Stato mostra Non riuscito.
Visualizza i dettagli degli errori che hanno causato l'errore:
Nella riga relativa al deployment, fai clic su
Azioni.Potresti dover scorrere per visualizzare Azioni nella riga.
Seleziona Visualizza i log di Cloud Build.
Esamina il log di Cloud Build e intervieni di conseguenza per risolvere il problema che ha causato l'errore.
Errori durante il deployment utilizzando l'interfaccia a riga di comando Terraform
Se il deployment non riesce quando utilizzi Terraform, l'output del comando terraform
apply
include messaggi di errore che puoi esaminare per diagnosticare il problema.
Gli esempi nelle sezioni seguenti mostrano errori di deployment che potresti incontrato nell'uso di Terraform.
Errore relativo all'API non abilitata
Se crei un progetto e poi provi immediatamente a eseguire il deployment della soluzione nel nuovo progetto, il deployment potrebbe non riuscire con un errore simile al seguente:
Error: Error creating Network: googleapi: Error 403: Compute Engine API has not
been used in project PROJECT_ID before or it is disabled. Enable it by visiting
https://console.developers.google.com/apis/api/compute.googleapis.com/overview?project=PROJECT_ID
then retry. If you enabled this API recently, wait a few minutes for the action
to propagate to our systems and retry.
Se si verifica questo errore, attendi qualche minuto ed esegui terraform apply
il comando precedente.
Errore durante l'assegnazione dell'indirizzo richiesto
Quando esegui il comando terraform apply
, viene eseguita un'operazione cannot assign requested address
potrebbe verificarsi un errore, con un messaggio simile al seguente:
Error: Error creating service account:
Post "https://iam.googleapis.com/v1/projects/PROJECT_ID/serviceAccounts:
dial tcp [2001:db8:ffff:ffff::5f]:443:
connect: cannot assign requested address
Se si verifica questo errore, esegui di nuovo il comando terraform apply
.
Errore di configurazione
Se modifichi gli argomenti della risorsa nel file main.tf
utilizzando valori non supportati, si verifica un errore come il seguente:
Error: Error creating Instance: googleapi: Error 400: Provided Redis version is
not supported: REDIS_5_X
│ com.google.apps.framework.request.StatusException:
<eye3 title='INVALID_ARGUMENT'/>
generic::INVALID_ARGUMENT: Provided Redis version is not supported: REDIS_5_X
Details:
│ [>
│ {
│ "@type": "type.googleapis.com/google.rpc.BadRequest",
│ "fieldViolations": [
│ {
│ "description": "Invalid value: REDIS_5_X",
│ "field": "instance.redis_version"
│ }
│ ]
│ }
│ ]
│
│ with google_redis_instance.main,
│ on main.tf line 96, in resource "google_redis_instance" "main":
│ 96: resource "google_redis_instance" "main" {
In questo caso, l'intento era utilizzare Redis versione 5, ma il valore specificato per
l'argomento instance.redis_version
(REDIS_5_X
) nel file main.tf
non è
valido.
Il valore corretto è REDIS_5_0
, come enumerato nel
Documentazione relativa all'API REST Memorystore.
Errore durante l'eliminazione di un deployment
In alcuni casi, i tentativi di eliminazione di un deployment potrebbero non riuscire:
- Dopo aver eseguito il deployment di una soluzione tramite la console, modificare qualsiasi risorsa di cui la soluzione ha eseguito il provisioning, e se poi provi per eliminare il deployment, l'eliminazione potrebbe non riuscire. Il campo Status (Stato) nella Nella pagina Deployment della soluzione viene visualizzato lo stato Non riuscito e Il log di Cloud Build mostra la causa dell'errore.
- Dopo aver eseguito il deployment di una soluzione utilizzando Terraform CLI, se modifichi una risorsa utilizzando un'interfaccia non Terraform (ad esempio la console) e poi provi a eliminare il deployment, l'eliminazione potrebbe non riuscire. I messaggi nell'output dell'
terraform destroy
per visualizzare la causa dell'errore.
Esamina i log e i messaggi degli errori, identifica ed elimina le risorse che ha causato l'errore, poi riprova a eliminare il deployment.
Se un deployment basato su console non viene eliminato e se non puoi diagnosticare l'errore utilizzando il log di Cloud Build, quindi eliminare il deployment utilizzando l'interfaccia a riga di comando Terraform, come descritto nella sezione successiva.
Eliminare un deployment basato sulla console utilizzando la CLI Terraform
Questa sezione descrive come eliminare un deployment basato su console se si verificano quando provi a eliminarlo tramite la console. Con questo approccio, scarichi la configurazione di Terraform per il deployment che vuoi eliminare e poi utilizzi Terraform CLI per eliminare il deployment.
Identifica la regione in cui sono archiviati il codice Terraform, i log e altri dati del deployment. che potrebbe essere diversa da quella in cui selezionato durante il deployment della soluzione.
Nella console Google Cloud, vai alla pagina Deployment delle soluzioni.
Vai a Deployment di soluzioni
Seleziona il progetto che contiene il deployment da eliminare.
Nell'elenco dei deployment, identifica la riga del deployment che da eliminare.
Fai clic su
Visualizza tutte le righe contenuti multimediali.Nella colonna Località, controlla la seconda posizione, come evidenziata nel seguente esempio:
In the Google Cloud console, activate Cloud Shell.
At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
Crea variabili di ambiente per l'ID progetto, la regione e il nome del deployment che vuoi eliminare:
export REGION="REGION" export PROJECT_ID="PROJECT_ID" export DEPLOYMENT_NAME="DEPLOYMENT_NAME"
In questi comandi, sostituisci quanto segue:
- REGION: la località che hai annotato in precedenza in questa procedura.
- PROJECT_ID: l'ID del progetto in cui hai eseguito il deployment della soluzione.
- DEPLOYMENT_NAME: il nome del deployment da eliminare.
Recupera l'ID dell'ultima revisione del deployment che vuoi eliminare:
export REVISION_ID=$(curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}" \ | jq .latestRevision -r) echo $REVISION_ID
L'output è simile al seguente:
projects/PROJECT_ID/locations/REGION/deployments/DEPLOYMENT_NAME/revisions/r-0
Ottieni la posizione di Cloud Storage della configurazione Terraform per il deployment:
export CONTENT_PATH=$(curl \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://config.googleapis.com/v1alpha2/${REVISION_ID}" \ | jq .applyResults.content -r) echo $CONTENT_PATH
Di seguito è riportato un esempio dell'output di questo comando:
gs://PROJECT_ID-REGION-blueprint-config/DEPLOYMENT_NAME/r-0/apply_results/content
Scarica la configurazione Terraform da Cloud Storage in Cloud Shell:
gcloud storage cp $CONTENT_PATH $HOME --recursive cd $HOME/content/
Attendi che venga visualizzato il messaggio
Operation completed
, come mostrato nell'esempio seguente:Operation completed over 45 objects/268.5 KiB
Inizializza Terraform:
terraform init
Attendi finché non viene visualizzato il seguente messaggio:
Terraform has been successfully initialized!
Rimuovi le risorse di cui hai eseguito il deployment:
terraform destroy
Terraform mostra un elenco delle risorse che verranno eliminate.
Se vengono visualizzati avvisi relativi a variabili non dichiarate, ignora il comando avvisi.
Quando ti viene chiesto di eseguire le azioni, inserisci
yes
.In Terraform vengono visualizzati dei messaggi che mostrano l'avanzamento. Dopo tutte le vengono eliminate, Terraform visualizza il seguente messaggio:
Destroy complete!
Elimina l'elemento del deployment:
curl -X DELETE \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}?force=true&delete_policy=abandon"
Attendi qualche secondo, quindi verifica che l'artefatto del deployment sia stato eliminati:
curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://config.googleapis.com/v1alpha2/projects/${PROJECT_ID}/locations/${REGION}/deployments/${DEPLOYMENT_NAME}" \ | jq .error.message
Se l'output mostra
null
, attendi qualche secondo ed esegui di nuovo il comando.Dopo l'eliminazione dell'artefatto di deployment, verrà visualizzato un messaggio come mostrato che viene visualizzato l'esempio seguente:
Resource 'projects/PROJECT_ID/locations/REGION/deployments/DEPLOYMENT_NAME' was not found
Invia feedback
Le soluzioni Jump Start sono solo informative e non sono prodotti supportati ufficialmente. Google può modificare o rimuovere le soluzioni senza preavviso.
Per risolvere i problemi relativi agli errori, esamina i log di Cloud Build e l'output di Terraform.
Per inviare un feedback:
- Per la documentazione, i tutorial nella console o la soluzione, usa sul pulsante Invia feedback nella pagina.
- Per il codice Terraform non modificato, crea i problemi nel repository GitHub. I problemi di GitHub vengono esaminati secondo il criterio del "best effort" e non sono destinati a domande sull'utilizzo generale.
- Per problemi relativi ai prodotti utilizzati nella soluzione, contatta l'assistenza clienti Google Cloud.
Passaggi successivi
- Scopri di più sull'IA generativa su Vertex AI.