Variabili di ambiente inserite automaticamente

Quando si distribuisce un'applicazione o una funzione, o quando si esegue un lavoro, Code Engine inietta automaticamente alcune variabili d'ambiente nell'applicazione, nella funzione o nel lavoro.

Variabili d'ambiente iniettate automaticamente per le applicazioni

Quando si distribuisce un'applicazione, Code Engine inietta automaticamente alcune variabili d'ambiente nell'applicazione. La tabella seguente elenca le variabili d'ambiente iniettate automaticamente in ogni istanza dell'applicazione distribuita. I seguenti esempi di variabili d'ambiente iniettate automaticamente si basano su un'applicazione denominata myapp, che fa riferimento all'immagine campione Code Engine, icr.io/codeengine/codeengine.

Le variabili d'ambiente CE_APP, CE_DOMAIN e CE_SUBDOMAIN sono utilizzate per costruire la URL di un'applicazione, https://CE_APP.CE_SUBDOMAIN.CE_DOMAIN. Ad esempio, se CE_APP=myapp, CE_SUBDOMAIN=01234567-abcd e CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud, l'applicazione esterna URL è https://myapp.01234567-abcd.us-south.codeengine.dev.appdomain.cloud. L'indirizzo URL privato dell'applicazione è appName.CE_SUBDOMAIN, o myapp.01234567-abcd.

Inserisce automaticamente le variabili di ambiente durante la distribuzione delle Code Engine
Variabile di ambiente Descrizione Esempio
CE_API_BASE_URL L'API privata Code Engine URL che si basa sulla regione del progetto. Usare questo URL per le chiamate all'endpoint API per tutti i componenti (comprese le applicazioni) che si trovano nella stessa regione del progetto Code Engine. CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com
CE_APP Il nome dell'applicazione. CE_APP=myapp
CE_DOMAIN La parte del nome di dominio di URL dell'applicazione (e del progetto). CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud
CE_REGION La regione in cui risiede l'applicazione. CE_REGION=us-south
CE_PROJECT_ID L'ID progetto del progetto. CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
CE_SUBDOMAIN La porzione di sottodominio di URL associata all'applicazione (e al progetto). Se si ha familiarità con Kubernetes, CE_SUBDOMAIN corrisponde allo spazio dei nomi Kubernetes associato al progetto. CE_SUBDOMAIN=01234567-abcd
HOME La vostra home directory in cui è in esecuzione l'applicazione. HOME=/root
HOSTNAME Il nome dell'istanza su cui viene distribuita l'applicazione. HOSTNAME=myapp-00001-deployment-65684cffd-xng7z
K_CONFIGURATION Il nome della tua applicazione. K_CONFIGURATION=myapp
K_REVISION Il nome della revisione corrente dell'applicazione distribuita. K_REVISION=myapp-00001
K_SERVICE Il nome della tua applicazione. K_SERVICE=myapp
PATH L'elenco di directory in cui il sistema ricerca gli eseguibili. PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
PORT La porta su cui l'applicazione si mette in ascolto per ricevere le richieste di HTTP. PORT=8080
PWD La directory di lavoro corrente. PWD=/

Si noti che è possibile sovrascrivere la variabile PORT distribuendo l'applicazione dalla console e specificando il valore della porta di ascolto o utilizzando la CLI e impostando l'opzione --port.

Variabili di ambiente inserite automaticamente per le funzioni

Quando distribuisci una funzione, Code Engine inserisce automaticamente alcune variabili di ambiente nella funzione. La seguente tabella elenca le variabili di ambiente inserite automaticamente in ogni istanza della funzione distribuita.

Le variabili d'ambiente CE_FUNCTION, CE_DOMAIN e CE_SUBDOMAIN sono utilizzate per costruire il URL di una funzione, https://CE_FUNCTION.CE_SUBDOMAIN.CE_DOMAIN. Ad esempio, se CE_FUNCTION=myfunc, CE_SUBDOMAIN=01234567-abcd e CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud, la funzione esterna URL è https://myfunc.01234567-abcd.us-south.codeengine.dev.appdomain.cloud. L'indirizzo URL privato dell'applicazione è CE_FUNCTION.CE_SUBDOMAIN.private.CE_DOMAIN, o myfunc.01234567-abcd.private.us-south.codeengine.appdomain.cloud.

Le variabili di ambiente inserite automaticamente durante la distribuzione delle Code Engine
Variabile di ambiente Descrizione Esempio
CE_API_BASE_URL L'API privata Code Engine URL che si basa sulla regione del progetto. Usare questo URL per le chiamate all'endpoint API per tutti i componenti (comprese le funzioni) che si trovano nella stessa regione del progetto Code Engine. CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com
CE_ALLOW_CONCURRENT Questa impostazione booleana interna viene utilizzata dal controller della funzione Code Engine per indicare se il runtime supporta richiami simultanei della stessa istanza della funzione e può essere ignorata. CE_ALLOW_CONCURRENT=true
CE_DOMAIN La parte del nome di dominio del sito URL della funzione (e del progetto). CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud
CE_REGION La regione in cui risiede la funzione. CE_REGION=us-south
CE_PROJECT_ID L'ID progetto del progetto. CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
CE_EXECUTION_ENV Il tipo di runtime gestito e la relativa versione di release. CE_EXECUTION_ENV=ibm/action-python-v3.11 Questo esempio specifica di utilizzare Python v3.11.
CE_FUNCTION Il nome della funzione. CE_FUNCTION=myfunc
CE_SUBDOMAIN La porzione di sottodominio di URL associata alla funzione (e al progetto). Se si ha familiarità con Kubernetes, CE_SUBDOMAIN si riferisce allo spazio dei nomi Kubernetes associato al progetto. CE_SUBDOMAIN=01234567-abcd
HOME La directory home del contenitore di runtime per la funzione. HOME=/root
LC_CTYPE La locale utilizzata dall'API del sistema operativo ctype e multibyte. Disponibile solo con runtime Python. LC_CTYPE=C.UTF-8
PATH L'impostazione corrente della variabile PATH, che elenca le directory in cui il sistema cerca gli eseguibili. PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
PYTHONIOENCODING La codifica standard utilizzata dai flussi di input, output standard e errore standard. Questa variabile si applica solo a un runtime Python. PYTHONIOENCODING=UTF-8
PWD La directory di lavoro corrente. PWD=/

Variabili di ambiente inserite automaticamente per i lavori

Quando esegui un lavoro, Code Engine inserisce automaticamente alcune variabili di ambiente nell'istanza di esecuzione del lavoro.

La seguente tabella elenca le variabili di ambiente inserite automaticamente in ciascuna istanza del job in esecuzione. I seguenti esempi di variabili di ambiente inserite automaticamente si basano su un job denominato myjob, che fa riferimento all'immagine di esempio Code Engine, icr.io/codeengine/codeengine.

Le variabili di ambiente inserite automaticamente durante la distribuzione dei lavori Code Engine
Variabile di ambiente Descrizione Esempio
CE_API_BASE_URL L'API privata Code Engine URL che si basa sulla regione del progetto. Usare questo URL per le chiamate all'endpoint API per tutti i componenti (compresi i lavori) che si trovano nella stessa regione del progetto Code Engine. CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com
CE_DOMAIN Il nome del dominio del progetto. CE_DOMAIN=us-south.codeengine.appdomain.cloud
CE_REGION La regione in cui risiede l'esecuzione del lavoro. CE_REGION=us-south
CE_PROJECT_ID L'ID progetto del progetto. CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
CE_JOB Il nome della configurazione del lavoro definito utilizzato per l'esecuzione del lavoro. CE_JOB=myjobdef
CE_JOBRUN Il nome dell'esecuzione del lavoro. CE_JOBRUN=myjob-jobrun-f5kxz
CE_SUBDOMAIN Il sottodominio associato al progetto in cui è in esecuzione il job. Se hai dimestichezza con Kubernetes, CE_SUBDOMAIN viene associato allo spazio dei nomi Kubernetes associato al tuo progetto. CE_SUBDOMAIN=01234567-abcd
HOME La directory home che sta eseguendo il lavoro. HOME=/root
HOSTNAME Il nome dell'istanza su cui viene distribuita l'applicazione. HOSTNAME=myjob-jobrun-6bgmg-0-0
JOB_ARRAY_SIZE Il numero di istanze del job da eseguire in parallelo. Il valore viene specificato direttamente come dimensione dell'array di esecuzione del lavoro o calcolato contando gli indici specificati. JOB_ARRAY_SIZE=10
JOB_INDEX L'indice di una specifica istanza di esecuzione lavoro. JOB_INDEX=1
JOB_INDEX_RETRY_COUNT Il conteggio dei tentativi correnti dell'istanza del lavoro. JOB_INDEX_RETRY_COUNT=0
JOB_MODE La modalità di esecuzione di un lavoro. In modalità task, i lavori vengono eseguiti per un periodo di tempo massimo e le istanze non riuscite vengono ritentate per il limite di tentativi del lavoro. In modalità daemon, i lavori vengono eseguiti senza un tempo massimo e le istanze fallite vengono riavviate indefinitamente. JOB_MODE=task
JOB_RETRY_LIMIT Il limite di tentativi configurato dell'esecuzione lavoro. JOB_RETRY_LIMIT=3
PATH L'elenco di directory in cui il sistema ricerca gli eseguibili. PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
PWD La directory di lavoro corrente. PWD=/

Si noti che ogni istanza di esecuzione del lavoro ottiene il proprio indice dall'array di indici specificato al momento della creazione del lavoro. Code Engine assegna automaticamente gli indici a partire da 0 fino a (dimensione dell'array - 1). La variabile di ambiente JOB_INDEX contiene il valore di indice.

Mentre il lavoro in sé non ha un URL associato, i valori CE_DOMAIN e CE_SUBDOMAIN possono essere utili se si deve fare riferimento a un'applicazione in esecuzione nello stesso progetto. Il sito esterno completo URL di questa applicazione è appName.CE_SUBDOMAIN.CE_DOMAIN. Per fare riferimento al sito URL privato di un'applicazione, utilizzare appName.CE_SUBDOMAIN.