Configura le variabili di ambiente

Puoi eseguire il deployment di coppie chiave/valore arbitrarie insieme a una Cloud Function. Queste coppie vengono rese disponibili per la funzione come variabili di ambiente letterali, accessibili dal codice in fase di runtime, o come informazioni di configurazione per i buildpack di Google Cloud.

Le variabili di ambiente sono associate a una singola funzione e non sono visibili ad altre funzioni nel progetto Google Cloud. Ogni variabile è archiviata nel backend di Cloud Functions ed esiste all'interno dello stesso ciclo di vita della funzione a cui è associata.

Puoi aggiungere o rimuovere variabili di ambiente di runtime utilizzando Google Cloud CLI o la console Google Cloud.

Impostazione delle variabili di ambiente di runtime

Utilizza questi metodi per definire nuove variabili o sostituire completamente quelle esistenti. Per apportare modifiche aggiuntive, utilizza la procedura di aggiornamento descritta nella sezione successiva.

gcloud

Per impostare una variabile di ambiente di runtime utilizzando Google Cloud CLI, utilizza il flag --set-env-vars al momento del deployment:

gcloud functions deploy FUNCTION_NAME --set-env-vars FOO=bar FLAGS ...

Puoi anche impostare più variabili di ambiente di runtime utilizzando un elenco separato da virgole:

gcloud functions deploy FUNCTION_NAME --set-env-vars FOO=bar,BAZ=boo FLAGS...

Se vuoi archiviare la configurazione in un file (ad esempio, sotto il controllo del codice sorgente), puoi utilizzare un file YAML insieme al flag --env-vars-file:

gcloud functions deploy FUNCTION_NAME --env-vars-file .env.yaml FLAGS...

in cui i contenuti del file .env.yaml sono:

 FOO: bar
 BAZ: boo

Negli esempi precedenti, FLAGS... si riferisce ad altre opzioni trasferite durante il deployment della funzione. Per un riferimento completo per il comando deploy, consulta gcloud functions deploy.

UI di Google Cloud Console

Puoi impostare le variabili di ambiente di runtime durante la creazione della funzione nella console Google Cloud:

1. Apri la pagina Panoramica delle funzioni nella console Google Cloud:

   Vai alla pagina Panoramica di Cloud Functions.

2. Fai clic su Crea funzione.

3. Compila i campi obbligatori per la funzione.

4. Apri la sezione Impostazioni runtime, build e connessioni.

5. Seleziona la scheda Runtime.

6. Nella sezione Variabili di ambiente di runtime, fai clic su Aggiungi variabile e aggiungi il nome e il valore.

   Per istruzioni su come aggiungere variabili di ambiente a una funzione esistente, consulta Aggiornamento delle variabili di ambiente di runtime.

Aggiornamento delle variabili di ambiente di runtime

Puoi anche aggiornare le variabili di ambiente di runtime per le funzioni esistenti. Si tratta di un approccio non distruttivo che modifica o aggiunge variabili di ambiente di runtime, ma non elimina.

gcloud

Per aggiornare una variabile utilizzando Google Cloud CLI, utilizza il flag --update-env-vars al momento del deployment:

gcloud functions deploy FUNCTION_NAME --update-env-vars FOO=bar

Puoi anche aggiornare più variabili di ambiente di runtime utilizzando un elenco separato da virgole:

gcloud functions deploy FUNCTION_NAME --update-env-vars FOO=bar,BAZ=boo

UI di Google Cloud Console

Per aggiornare le variabili di ambiente di runtime utilizzando la console Google Cloud:

1. Apri la pagina Panoramica delle funzioni nella console Google Cloud:

   Vai alla pagina Panoramica di Cloud Functions.

2. Fai clic su una funzione esistente per passare alla relativa pagina dei dettagli.

3. Fai clic su Modifica.

4. Apri la sezione Impostazioni runtime, build e connessioni.

5. Seleziona la scheda Runtime.

6. Apporta le modifiche nella sezione Variabili di ambiente di runtime.

Eliminazione delle variabili di ambiente di runtime

gcloud

Se vuoi rimuovere selettivamente le variabili di ambiente di runtime, puoi utilizzare il flag --remove-env-vars al momento del deployment:

gcloud functions deploy FUNCTION_NAME --remove-env-vars FOO,BAZ

In alternativa, puoi cancellare tutte le variabili di ambiente di runtime impostate in precedenza con il flag --clear-env-vars:

gcloud functions deploy FUNCTION_NAME --clear-env-vars

UI di Google Cloud Console

Per eliminare le variabili di ambiente di runtime utilizzando la console Google Cloud:

1. Apri la pagina Panoramica delle funzioni nella console Google Cloud:

   Vai alla pagina Panoramica di Cloud Functions.

2. Fai clic su una funzione esistente per passare alla relativa pagina dei dettagli.

3. Fai clic su Modifica.

4. Apri la sezione Impostazioni runtime, build e connessioni.

5. Seleziona la scheda Runtime.

6. Nella sezione Variabili di ambiente di runtime, fai clic sull'icona di garbage accanto alla coppia chiave-valore per eliminarla.

Variabili di ambiente di runtime impostate automaticamente

In questa sezione sono elencate le variabili di ambiente di runtime che vengono impostate automaticamente.

Chiave	Descrizione
FUNCTION_TARGET	Riservato: la funzione da eseguire.
FUNCTION_SIGNATURE_TYPE	Riservato: il tipo di funzione: http per le funzioni HTTP e event per le funzioni basate su eventi.
K_SERVICE	Riservato: il nome della risorsa della funzione.
K_REVISION	Riservato: l'identificatore di versione della funzione.
PORT	Riservato: la porta su cui viene richiamata la funzione.

Nota: se la tua funzione richiede una delle variabili di ambiente di un runtime precedente, puoi impostare la variabile quando esegui il deployment della funzione. Ad esempio:

gcloud functions deploy envVarMemory \
--runtime nodejs10 \
--set-env-vars FUNCTION_MEMORY_MB=2Gi \
--memory 2Gi \
--trigger-http

Esempio di impostazione e recupero delle variabili di ambiente di runtime

Imposta la variabile di ambiente di runtime:

Node.js

gcloud functions deploy envVar \
--runtime nodejs20 \
--set-env-vars FOO=bar \
--trigger-http

Utilizza il flag --runtime per specificare l'ID runtime di una versione Node.js supportata per eseguire la funzione.

Python

gcloud functions deploy env_vars \
--runtime python312 \
--set-env-vars FOO=bar \
--trigger-http

Utilizza il flag --runtime per specificare l'ID runtime di una versione Python supportata per eseguire la funzione.

Go

gcloud functions deploy EnvVar \
--runtime go121 \
--set-env-vars FOO=bar \
--trigger-http

Utilizza il flag --runtime per specificare l'ID runtime di una versione Go supportata per eseguire la funzione.

Java

gcloud functions deploy java-envVar-function \
--entry-point functions.EnvVars \
--runtime java17 \
--memory 512MB \
--set-env-vars FOO=bar \
--trigger-http

Utilizza il flag --runtime per specificare l'ID runtime di una versione Java supportata per eseguire la funzione.

C#

gcloud functions deploy csharp-envVar-function \
--entry-point EnvironmentVariables.Function \
--runtime dotnet6 \
--set-env-vars FOO=bar \
--trigger-http

Utilizza il flag --runtime per specificare l'ID runtime di una versione .NET supportata per eseguire la funzione.

Ruby

gcloud functions deploy env_vars --runtime ruby32 \
--set-env-vars FOO=bar \
--trigger-http

Utilizza il flag --runtime per specificare l'ID runtime di una versione Ruby supportata per eseguire la funzione.

PHP

 gcloud functions deploy envVar --runtime php82 \
--set-env-vars FOO=bar \
--trigger-http

Utilizza il flag --runtime per specificare l'ID runtime di una versione PHP supportata per eseguire la funzione.

In fase di runtime, accedi alle variabili in modo programmatico:

Node.js

In Node.js utilizza la proprietà process.env per accedere alle variabili di ambiente di runtime:

exports.envVar = (req, res) => {
  // Sends 'bar' as response
  res.send(process.env.FOO);
};

Python

In Python, utilizza os.environ per accedere alle variabili di ambiente di runtime:

import os


def env_vars(request):
    return os.environ.get("FOO", "Specified environment variable is not set.")

Go

In Go, utilizza os.Getenv() per accedere alle variabili di ambiente di runtime:

// Package tips contains tips for writing Cloud Functions in Go.
package tips

import (
	"fmt"
	"net/http"
	"os"
)

// EnvVar is an example of getting an environment variable in a Go function.
func EnvVar(w http.ResponseWriter, r *http.Request) {
	fmt.Fprintf(w, "FOO: %q", os.Getenv("FOO"))
}

Java

In Java, utilizza System.getenv per accedere alle variabili di ambiente di runtime:

import com.google.cloud.functions.HttpFunction;
import com.google.cloud.functions.HttpRequest;
import com.google.cloud.functions.HttpResponse;
import java.io.BufferedWriter;
import java.io.IOException;

public class EnvVars implements HttpFunction {

  // Returns the environment variable "foo" set during function deployment.
  @Override
  public void service(HttpRequest request, HttpResponse response)
      throws IOException {
    BufferedWriter writer = response.getWriter();
    String foo = System.getenv("FOO");
    if (foo == null) {
      foo = "Specified environment variable is not set.";
    }
    writer.write(foo);
  }
}

C#

In fase di runtime, le variabili di ambiente sono accessibili utilizzando Environment.GetEnvironmentVariable in C#:

using Google.Cloud.Functions.Framework;
using Microsoft.AspNetCore.Http;
using System;
using System.Threading.Tasks;

namespace EnvironmentVariables;

public class Function : IHttpFunction
{
    public async Task HandleAsync(HttpContext context)
    {
        string foo = Environment.GetEnvironmentVariable("FOO")
            ?? "Specified environment variable is not set.";
        await context.Response.WriteAsync(foo, context.RequestAborted);
    }
}

Ruby

In fase di runtime, le variabili di ambiente sono accessibili utilizzando ENV in Ruby:

require "functions_framework"

FunctionsFramework.http "env_vars" do |_request|
  ENV["FOO"] || "Specified environment variable is not set."
end

PHP

In fase di runtime, le variabili di ambiente sono accessibili utilizzando la funzione getenv di PHP:

use Psr\Http\Message\ServerRequestInterface;

function envVar(ServerRequestInterface $request): string
{
    return getenv('FOO') . PHP_EOL;
}

Utilizzo delle variabili di ambiente di build

Puoi anche impostare le variabili di ambiente di build per i runtime che supportano i buildpack.

Le variabili di ambiente di build sono coppie chiave/valore distribuite insieme a una funzione che consentono di passare le informazioni di configurazione ai buildpack. Ad esempio, potresti voler personalizzare le opzioni del compilatore. Puoi aggiungere o rimuovere queste variabili di ambiente di build utilizzando Google Cloud CLI o l'interfaccia utente della console Google Cloud.

Nota: le chiavi devono iniziare con una lettera ASCII maiuscola e contenere lettere ASCII maiuscole, numeri e trattini bassi. Evita di creare chiavi variabili con un prefisso GOOGLE_*. Visualizza tutte le variabili di ambiente buildpacks supportate.

Impostazione delle variabili di ambiente di build

Utilizza questi metodi per definire nuove variabili o sostituire completamente quelle esistenti. Per apportare modifiche aggiuntive, utilizza la procedura di aggiornamento (il flag --update-build-env-vars in gcloud) descritta nella sezione successiva.

gcloud

Per impostare una variabile utilizzando Google Cloud CLI, utilizza il flag --set-build-env-vars al momento del deployment:

gcloud beta functions deploy FUNCTION_NAME --set-build-env-vars FOO=bar FLAGS...

Puoi anche impostare più variabili di ambiente di build utilizzando un elenco separato da virgole:

gcloud functions deploy FUNCTION_NAME --set-build-env-vars FOO=bar,BAZ=boo FLAGS...

Se vuoi archiviare la configurazione in un file (ad es. sotto il controllo del codice sorgente), puoi utilizzare un file YAML insieme al flag --build-env-vars-file:

gcloud functions deploy FUNCTION_NAME --build-env-vars-file FILE_NAME.yaml FLAGS...

in cui i contenuti del file *.yaml sono:

 FOO: bar
 BAZ: boo

Negli esempi precedenti, FLAGS... si riferisce ad altre opzioni passate durante il deployment della funzione. Per un riferimento completo per il comando deploy, consulta gcloud beta functions deploy.

UI di Google Cloud Console

Puoi anche impostare le variabili di ambiente di build durante la creazione della funzione nella console Google Cloud:

1. Apri la pagina Panoramica delle funzioni nella console Google Cloud:

   Vai alla pagina Panoramica di Cloud Functions.

2. Fai clic su Crea funzione.

3. Compila i campi obbligatori per la funzione.

4. Apri la sezione Impostazioni runtime, build e connessioni.

5. Seleziona la scheda Crea.

6. Nella sezione Crea variabili di ambiente, fai clic su Aggiungi variabile e aggiungi il nome e il valore.

Aggiornamento delle variabili di ambiente di build

Puoi anche aggiornare le variabili di ambiente di build per le funzioni esistenti. Si tratta di un approccio non distruttivo che modifica o aggiunge variabili di ambiente di build, ma non elimina.

gcloud

Per impostare una variabile utilizzando Google Cloud CLI, utilizza il flag --update-build-env-vars al momento del deployment:

gcloud functions deploy FUNCTION_NAME --update-build-env-vars FOO=bar

Puoi anche aggiornare più variabili di ambiente di build utilizzando un elenco separato da virgole:

gcloud functions deploy FUNCTION_NAME --update-build-env-vars FOO=bar,BAZ=boo

UI di Google Cloud Console

Per aggiornare le variabili di ambiente di build utilizzando la console Google Cloud:

1. Apri la pagina Panoramica delle funzioni nella console Google Cloud:

   Vai alla pagina Panoramica di Cloud Functions.

2. Fai clic su una funzione esistente per passare alla relativa pagina dei dettagli.

3. Fai clic su Modifica.

4. Apri la sezione Impostazioni runtime, build e connessioni.

5. Seleziona la scheda Crea.

6. Apporta le modifiche nella sezione Crea variabili di ambiente.

Eliminazione delle variabili di ambiente di build

gcloud

Se vuoi rimuovere selettivamente le variabili di ambiente di build, puoi utilizzare il flag --remove-build-env-vars al momento del deployment:

gcloud functions deploy FUNCTION_NAME --remove-build-env-vars FOO,BAZ

In alternativa, puoi cancellare tutte le variabili di ambiente di build impostate in precedenza con il flag --clear-build-env-vars:

gcloud functions deploy FUNCTION_NAME --clear-build-env-vars

UI di Google Cloud Console

Per eliminare le variabili di ambiente di build utilizzando la console Google Cloud:

1. Apri la pagina Panoramica delle funzioni nella console Google Cloud:

   Vai alla pagina Panoramica di Cloud Functions.

2. Fai clic su una funzione esistente per passare alla relativa pagina dei dettagli.

3. Fai clic su Modifica.

4. Apri la sezione Impostazioni runtime, build e connessioni.

5. Seleziona la scheda Crea.

6. Nella sezione Crea variabili di ambiente, fai clic sull'icona di garbage accanto alla coppia chiave-valore per eliminarla.

Ciclo di vita variabile

Tutte le variabili di ambiente sono associate al deployment di una Cloud Function e possono essere impostate o modificate solo con un deployment. Se un deployment non riesce per qualsiasi motivo, le modifiche alle variabili di ambiente non verranno applicate. Le modifiche alle variabili di ambiente richiedono un deployment riuscito.

Best practice e variabili di ambiente riservate

Alcune variabili di ambiente aggiuntive vengono impostate automaticamente a seconda del runtime utilizzato dalla funzione. Si basano sul sistema operativo del runtime (ad esempio DEBIAN_FRONTEND, SHLVL o PATH) e sul runtime del linguaggio (ad esempio NODE_ENV, VIRTUAL_ENV o GOPATH).

Le variabili di ambiente fornite dall'ambiente (tranne quelle elencate in Variabili di ambiente impostate automaticamente) potrebbero cambiare nelle versioni future del runtime. Come best practice, ti consigliamo di non dipendere da o modificare eventuali variabili di ambiente che non hai impostato in modo esplicito.

La modifica delle variabili di ambiente fornite dall'ambiente potrebbe portare a risultati imprevedibili. I tentativi di modificare queste variabili di ambiente potrebbero essere bloccati o, peggio ancora, portare a conseguenze indesiderate come funzioni che non possono essere avviate. Come best practice, ti consigliamo di anteporre a tutte le variabili di ambiente una chiave univoca per evitare conflitti.

Infine, non puoi utilizzare le seguenti variabili di ambiente:

Chiave	Descrizione
Vuoto ('')	Le chiavi non possono essere una stringa vuota.
=	Le chiavi non possono contenere il carattere '='.
X_GOOGLE_	Le chiavi non possono contenere il prefisso X_GOOGLE_.

Nota: le variabili di ambiente visualizzate nell'ambiente di esecuzione, ma non documentate nella tabella riportata sopra, devono essere considerate deprecate e potrebbero scomparire in qualsiasi momento senza preavviso.

Limiti di dimensioni

Il numero totale di byte utilizzati dai nomi e dai valori delle variabile di ambiente di runtime per una singola funzione è limitato a 32 KiB. Non ci sono limiti specifici per i singoli valori o chiavi all'interno di questa capacità complessiva.

Per le variabili di ambiente di build, è possibile definire fino a 100 variabili, con la stringa di definizione foo=bar limitata a 64 KiB.

Gestione dei secret

Le variabili di ambiente possono essere utilizzate per la configurazione delle funzioni, ma non sono consigliate come metodo per archiviare secret come le credenziali di database o le chiavi API. Questi valori più sensibili devono essere archiviati sia all'esterno del codice sorgente sia alle variabili di ambiente esterne. Alcuni ambienti di esecuzione o l'utilizzo di alcuni framework possono comportare l'invio dei contenuti delle variabili di ambiente ai log e non è consigliabile l'archiviazione di credenziali sensibili in file YAML, script di deployment o sotto controllo del codice sorgente.

Per archiviare i secret, ti consigliamo di utilizzare Secret Manager. Per configurare Cloud Functions per accedere ai secret archiviati in Secret Manager, consulta Configurare i secret. Tieni presente che non esiste un'integrazione specifica di Cloud Functions con Cloud KMS.

Portabilità

È possibile che le variabili di ambiente che attualmente funzionano con la Cloud Function non funzionino con un ambiente di runtime diverso, ad esempio in un linguaggio diverso o con determinati strumenti o librerie. È anche possibile che non siano accettati da un'altra piattaforma.

Per evitare questi problemi, segui lo standard POSIX per le variabili di ambiente. Se utilizzi la console Google Cloud per modificare le variabili, la console Google Cloud ti avvisa ogni volta che definisci una variabile che potrebbe avere problemi di portabilità (ma non impedirà il deployment). Come regola generale, consigliamo che le chiavi variabile di ambiente siano costituite esclusivamente da lettere maiuscole, cifre e <underscore> (_), come definito nel Set di caratteri portatili e che non inizino con un numero.