Puoi definire le variabili di ambiente per Workflows al momento del deployment. Ad esempio, puoi creare un flusso di lavoro che viene configurato dinamicamente a seconda dell'ambiente in cui viene eseguito il deployment. In alternativa, puoi creare un flusso di lavoro riutilizzabile come modello e configurabile in base a variabili di ambiente gestite separatamente.
Le variabili di ambiente sono impostate come coppie arbitrarie di stringhe chiave e valore accessibili dal tuo workflow in fase di runtime. Sono archiviate nel backend di Workflows, sono limitate all'esecuzione del workflow e sono immutabili durante l'esecuzione di un workflow.
Tutte le variabili di ambiente sono associate a un deployment di un flusso di lavoro e possono essere impostate o modificate solo con un deployment. La creazione o la modifica di una variabile di ambiente richiede un deployment riuscito. Se un deployment non va a buon fine per qualsiasi motivo, le modifiche alle variabili di ambiente non vengono applicate.
Puoi aggiungere, aggiornare o rimuovere le variabili di ambiente definite dall'utente utilizzando Google Cloud CLI.
Nomi riservati
Le variabili di ambiente integrate definite per Workflows sono riservate e non possono essere impostate.
Tieni presente che non puoi utilizzare quanto segue quando definisci le variabili di ambiente per Workflows:
| Chiave | Descrizione |
|---|---|
Vuoto ('') |
Le chiavi non possono essere una stringa vuota. |
GOOGLE_ |
Le chiavi non possono contenere il prefisso GOOGLE_. |
WORKFLOWS_ |
Le chiavi non possono contenere il prefisso WORKFLOWS_. |
Imposta le variabili di ambiente
Puoi definire nuove variabili o sostituire quelle esistenti quando implementi un flusso di lavoro. Per apportare modifiche additive, consulta Aggiornare le variabili di ambiente in questo documento.
Console
Nella console Google Cloud , vai alla pagina Workflow:
Nella pagina Flussi di lavoro, fai clic su Crea.
Nella pagina Crea flusso di lavoro, compila i campi appropriati per configurare la definizione del flusso di lavoro.
Nella sezione Variabili di ambiente (facoltativo), fai clic su Aggiungi variabile.
Nel campo Nome 1, specifica il nome della variabile.
Nel campo Valore 1, specifica il valore della variabile.
Per aggiungere un'altra variabile, fai clic su Aggiungi variabile.
Fai clic su Avanti.
Dopo aver definito il flusso di lavoro, per eseguirne il deployment, fai clic su Esegui il deployment.
gcloud
Per impostare una variabile di ambiente, utilizza il flag --set-env-vars:
gcloud workflows deploy WORKFLOW_NAME \ --set-env-vars KEY1=VALUE1
Sostituisci quanto segue:
WORKFLOW_NAME: l'ID del workflow.KEY1=VALUE1: il nome della variabile di ambiente e il relativo valore, ad esempioMONTH=January.
Terraform
Per creare un workflow, utilizza la
risorsa google_workflows_workflow
e modifica il file main.tf come mostrato nell'esempio. Per saperne di più,
consulta
Creare un flusso di lavoro utilizzando Terraform.
Utilizza l'argomento user_env_vars per associare una variabile di ambiente alla revisione del workflow.
Per scoprire come applicare o rimuovere una configurazione Terraform, consulta Comandi Terraform di base.
Imposta più variabili di ambiente
Per impostare più variabili di ambiente, utilizza un elenco separato da virgole:
gcloud workflows deploy WORKFLOW_NAME \ --set-env-vars KEY1=VALUE1,KEY2=VALUE2
Caratteri virgola di escape
Poiché il carattere virgola (,) viene utilizzato per delimitare le variabili di ambiente, se
i valori delle variabili includono virgole, devi specificare un carattere delimitatore
diverso, ad esempio @:
gcloud workflows deploy WORKFLOW_NAME \ --set-env-vars ^@^KEY1=VALUE1,VALUE2,VALUE3@KEY2=VALUE2
Memorizzare le variabili in un file
Per archiviare le variabili in un file (ad esempio nel controllo del codice sorgente), utilizza un file YAML e il flag --env-vars-file:
gcloud workflows deploy WORKFLOW_NAME \ --env-vars-file FILE_PATH
Sostituisci FILE_PATH con il percorso di un file YAML locale
che elenca le definizioni delle variabili di ambiente. Tieni presente che i nomi e i valori delle variabili devono essere stringhe. Tutte le variabili di ambiente esistenti
vengono rimosse da Workflows prima che vengano aggiunte
le nuove variabili di ambiente.
Ad esempio, i contenuti del file YAML potrebbero essere i seguenti:
KEY1: "value1" KEY2: "value2"
Per ulteriori informazioni sul comando deploy, consulta
gcloud workflows deploy.
Accedere alle variabili di ambiente
Per accedere a una variabile di ambiente, chiama la funzione
sys.get_env() in un'espressione, passando il nome della variabile di ambiente come parametro. Il
nome della variabile di ambiente deve essere passato come stringa.
Ad esempio, il seguente flusso di lavoro assegna il valore della variabile di ambiente KEY1 a una variabile del flusso di lavoro chiamata keyValue e poi restituisce questo valore:
main: steps: - init: assign: - keyValue: ${sys.get_env("KEY1")} - returnResult: return: ${keyValue}
Aggiorna le variabili di ambiente
Puoi aggiornare le variabili di ambiente definite dall'utente per i flussi di lavoro esistenti. Si tratta di un approccio non distruttivo che modifica o aggiunge variabili di ambiente, ma non le elimina.
Console
Nella Google Cloud console, vai alla pagina Workflows.
Fai clic sul nome del flusso di lavoro da aggiornare.
Viene visualizzata la pagina Dettagli workflow.
Per modificare una variabile di ambiente esistente, esegui una delle seguenti operazioni:
Fai clic sulla scheda Dettagli.
- Accanto a Variabili di ambiente, fai clic sull'icona .
- Apporta le modifiche.
- Per eseguire il deployment del workflow aggiornato, fai clic su Salva.
Fai clic su Modifica.
- Nella sezione Variabili di ambiente (facoltativo), apporta le modifiche.
- Per eseguire il deployment del workflow aggiornato, fai clic su Avanti e poi su Esegui il deployment.
gcloud
Per aggiornare una variabile, utilizza il flag --update-env-vars:
gcloud workflows deploy WORKFLOW_NAME \ --update-env-vars KEY1=VALUE1
Per aggiornare più variabili di ambiente, utilizza un elenco separato da virgole:
gcloud workflows deploy WORKFLOW_NAME \ --update-env-vars KEY1=VALUE1,KEY2=VALUE2
Elimina variabili di ambiente
Puoi eliminare le variabili di ambiente definite dall'utente per i flussi di lavoro esistenti.
Console
Nella Google Cloud console, vai alla pagina Workflows.
Fai clic sul nome del flusso di lavoro da aggiornare.
Viene visualizzata la pagina Dettagli workflow.
Per eliminare una variabile di ambiente esistente, esegui una delle seguenti operazioni:
Fai clic sulla scheda Dettagli.
- Fai clic sul appropriato.
- Accanto alla variabile di ambiente che vuoi eliminare, fai clic sull'icona .
- Per eseguire il deployment del workflow aggiornato, fai clic su Salva.
Fai clic su Modifica.
- Accanto alla variabile di ambiente che vuoi eliminare, fai clic sull'icona .
- Per eseguire il deployment del workflow aggiornato, fai clic su Avanti e poi su Esegui il deployment.
gcloud
Se vuoi rimuovere selettivamente le variabili di ambiente, utilizza il flag --remove-env-vars:
gcloud workflows deploy WORKFLOW_NAME \ --remove-env-vars KEY1,KEY2
In alternativa, puoi cancellare tutte le variabili di ambiente impostate in precedenza con il flag --clear-env-vars:
gcloud workflows deploy WORKFLOW_NAME \ --clear-env-vars
Best practice
Come best practice, ti consigliamo di non fare affidamento su variabili di ambiente che non hai impostato in modo esplicito né di modificarle. Se modifichi le variabili di ambiente diverse da quelle che hai impostato in modo esplicito, potrebbero verificarsi conseguenze impreviste.
Gestione dei secret
Le variabili di ambiente possono essere utilizzate per configurare i flussi di lavoro, ma non sono consigliate come metodo per archiviare e utilizzare secret come credenziali del database o chiavi API. Questi valori sensibili devono essere archiviati separatamente dal codice sorgente e dalle variabili di ambiente e non devono essere inviati inavvertitamente ai log.
Per l'archiviazione dei secret, ti consigliamo di esaminare le best practice per la gestione dei secret e di seguire le istruzioni per utilizzare Secret Manager con Workflows.
Convenzioni di denominazione
Come regola generale, consigliamo che le chiavi variabile di ambiente siano costituite solo da lettere maiuscole, cifre e trattini bassi (_) e che non inizino con una cifra. Valuta la possibilità di aggiungere un prefisso alle variabili di ambiente definite dall'utente con una chiave univoca per evitare conflitti con altre variabili.
Limiti delle dimensioni
È possibile definire un massimo di 20 variabili di ambiente definite dall'utente. Ogni
stringa di definizione (KEY=value) è limitata a 4 KiB.