Utilizzare le variabili di ambiente

Puoi definire variabili di ambiente per Workflows al momento del deployment. Ad esempio, puoi creare un flusso di lavoro configurato dinamicamente in base all'ambiente in cui viene eseguito il deployment. In alternativa, puoi creare un flusso di lavoro che può essere riutilizzato come modello e configurato in base a variabili di ambiente gestite separatamente.

Le variabili di ambiente sono impostate come coppie di stringhe chiave e valore arbitrarie che sono accessibili dal tuo flusso di lavoro in fase di runtime. Sono archiviati nel backend di Workflows, hanno come ambito l'esecuzione del flusso di lavoro e sono immutabili durante l'esecuzione di un flusso di lavoro.

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'implementazione riuscita. Se un deployment non va a buon fine per qualsiasi motivo, le eventuali 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 predefinite definite per Workflows sono riservate e non possono essere impostate.

Tieni presente che non puoi utilizzare quanto segue per definire le variabili di ambiente per Workflows:

Imposta le variabili di ambiente

Puoi definire nuove variabili o sostituire quelle esistenti durante il deployment di un flusso di lavoro. Per apportare modifiche additive, consulta Aggiornare le variabili di ambiente in questo documento.

gcloud workflows deploy WORKFLOW_NAME \
    --set-env-vars KEY1=VALUE1

Impostare 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 di escape per le virgole

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, in un controllo dei file 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, effettua una chiamata alla 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 di flusso di lavoro denominata keyValue e poi lo restituisce:

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 le variabili di ambiente, ma non le elimina.

gcloud workflows deploy WORKFLOW_NAME \
    --update-env-vars KEY1=VALUE1

gcloud workflows deploy WORKFLOW_NAME \
    --update-env-vars KEY1=VALUE1,KEY2=VALUE2

Eliminare le variabili di ambiente

Puoi eliminare le variabili di ambiente definite dall'utente per i flussi di lavoro esistenti.

gcloud workflows deploy WORKFLOW_NAME \
    --remove-env-vars KEY1,KEY2

gcloud workflows deploy WORKFLOW_NAME \
    --clear-env-vars

Best practice

Come best practice, ti consigliamo di non fare affidamento su o modificare le variabili di ambiente che non hai impostato esplicitamente. Se modifichi le variabili di ambiente diverse da quelle impostate esplicitamente, potresti provocare 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 di 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 consultare le best practice per la gestione dei secret e di seguire le istruzioni per utilizzare Secret Manager con i flussi di lavoro.

Convenzioni di denominazione

Come regola generale, consigliamo che le chiavi variabile di ambiente siano costituite esclusivamente da lettere maiuscole, numeri e trattini bassi (_) e che non inizino con un numero. Valuta la possibilità di anteporre alle variabili di ambiente definite dall'utente un prefisso con una chiave univoca per evitare conflitti con altre variabili.

Limiti di dimensioni

È possibile definire un massimo di 20 variabili di ambiente definite dall'utente. Ogni stringa di definizione (KEY=value) è limitata a 4 KiB.

Passaggi successivi

• Esegui un flusso di lavoro.
• Passa gli argomenti di runtime in una richiesta di esecuzione.