Variables d'environnement injectées automatiquement
Lorsque vous déployez une application ou une fonction, ou lorsque vous exécutez un travail, Code Engine injecte automatiquement certaines variables d'environnement dans l'application, la fonction ou le travail.
Injection automatique de variables d'environnement pour les applications
Lorsque vous déployez une application, Code Engine injecte automatiquement certaines variables d'environnement dans l'application. Le tableau suivant répertorie les variables d'environnement injectées automatiquement dans chaque instance de
l'application déployée. Les exemples suivants de variables d'environnement injectées automatiquement sont basés sur une application nommée myapp, qui fait référence à l'image d'exemple Code Engine, icr.io/codeengine/codeengine.
Les variables d'environnement, CE_APP, CE_DOMAIN, et CE_SUBDOMAIN sont utilisées pour construire le URL d'une application, https://CE_APP.CE_SUBDOMAIN.CE_DOMAIN. Par exemple, si CE_APP=myapp,
CE_SUBDOMAIN=01234567-abcd et CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud, l'URL externe de votre application est https://myapp.01234567-abcd.us-south.codeengine.dev.appdomain.cloud. L'URL privée
de votre application est appName.CE_SUBDOMAIN ou myapp.01234567-abcd.
| Variable d'environnement | Description | Exemple |
|---|---|---|
CE_API_BASE_URL |
Le site privé Code Engine API URL qui est basé sur la région du projet. Utilisez cette adresse URL pour les appels de point de terminaison API vers le point de terminaison de tous les composants (y compris les applications) situés dans la même région de votre projet Code Engine. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_APP |
Nom de l'application. | CE_APP=myapp |
CE_DOMAIN |
Partie nom de domaine de l'URL de l'application (et du projet). | CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud |
CE_REGION |
La région où réside l'application. | CE_REGION=us-south |
CE_PROJECT_ID |
ID de votre projet. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_SUBDOMAIN |
Partie sous-domaine de l'URL associée à l'application (et au projet). Pour les utilisateurs qui maîtrisent Kubernetes : CE_SUBDOMAIN est mappé à l'espace de nom Kubernetes associé à votre projet. | CE_SUBDOMAIN=01234567-abcd |
HOME |
Votre répertoire personnel dans lequel l'application est exécutée. | HOME=/root |
HOSTNAME |
Le nom de l'instance sur laquelle votre application est déployée. | HOSTNAME=myapp-00001-deployment-65684cffd-xng7z |
K_CONFIGURATION |
Nom de votre application. | K_CONFIGURATION=myapp |
K_REVISION |
Le nom de la révision actuelle de l'application déployée. | K_REVISION=myapp-00001 |
K_SERVICE |
Nom de votre application. | K_SERVICE=myapp |
PATH |
Liste des répertoires dans lesquels le système recherche des exécutables. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PORT |
Le port que votre application écoute pour recevoir les requêtes HTTP. | PORT=8080 |
PWD |
Répertoire de travail en cours | PWD=/ |
Notez que vous pouvez remplacer la variable PORT en déployant votre application à partir de la console et en spécifiant la valeur du port d'écoute ou en utilisant le CLI et en définissant l'option --port.
Injection automatique de variables d'environnement pour les fonctions
Lorsque vous déployez une fonction, Code Engine injecte automatiquement certaines variables d'environnement dans la fonction. Le tableau suivant répertorie les variables d'environnement injectées automatiquement dans chaque instance de la fonction déployée.
Les variables d'environnement CE_FUNCTION, CE_DOMAIN, et CE_SUBDOMAIN sont utilisées pour construire le URL d'une fonction, https://CE_FUNCTION.CE_SUBDOMAIN.CE_DOMAIN. Par exemple, si CE_FUNCTION=myfunc,
CE_SUBDOMAIN=01234567-abcd et CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud, votre fonction externe URL est https://myfunc.01234567-abcd.us-south.codeengine.dev.appdomain.cloud. L'URL privée de votre
application est CE_FUNCTION.CE_SUBDOMAIN.private.CE_DOMAIN ou myfunc.01234567-abcd.private.us-south.codeengine.appdomain.cloud.
| Variable d'environnement | Description | Exemple |
|---|---|---|
CE_API_BASE_URL |
Le site privé Code Engine API URL qui est basé sur la région du projet. Utilisez cette adresse URL pour les appels de point d'extrémité API vers le point d'extrémité de tous les composants (y compris les fonctions) situés dans la même région de votre projet Code Engine. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_ALLOW_CONCURRENT |
Ce paramètre booléen interne est utilisé par le contrôleur de fonction Code Engine pour indiquer si l'environnement d'exécution prend en charge les appels simultanés de la même instance de fonction et peut être ignoré. | CE_ALLOW_CONCURRENT=true |
CE_DOMAIN |
La partie du nom de domaine du site URL de la fonction (et du projet). | CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud |
CE_REGION |
Région dans laquelle réside la fonction. | CE_REGION=us-south |
CE_PROJECT_ID |
ID de votre projet. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_EXECUTION_ENV |
Type d'environnement d'exécution géré et sa version d'édition. | CE_EXECUTION_ENV=ibm/action-python-v3.11 Cet exemple spécifie l'utilisation de Python v3.11. |
CE_FUNCTION |
Nom de la fonction. | CE_FUNCTION=myfunc |
CE_SUBDOMAIN |
La partie du sous-domaine du site URL associée à la fonction (et au projet). Si vous connaissez Kubernetes, CE_SUBDOMAIN correspond à l'espace de noms Kubernetes associé à votre projet. |
CE_SUBDOMAIN=01234567-abcd |
HOME |
Répertoire de base du conteneur d'exécution de la fonction. | HOME=/root |
LC_CTYPE |
Environnement local utilisé par l'API du système d'exploitation ctype et multibyte. Disponible uniquement avec les environnements d'exécution Python. |
LC_CTYPE=C.UTF-8 |
PATH |
Paramètre en cours de la variable PATH, qui répertorie les répertoires dans lesquels le système recherche les exécutables. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PYTHONIOENCODING |
Codage standard utilisé par les flux d'entrée standard, de sortie standard et d'erreur standard. Cette variable s'applique uniquement à un environnement d'exécution Python. | PYTHONIOENCODING=UTF-8 |
PWD |
Répertoire de travail en cours | PWD=/ |
Variables d'environnement injectées automatiquement pour les travaux
Lorsque vous exécutez un travail, Code Engine injecte automatiquement certaines variables d'environnement dans l'instance d'exécution du travail.
Le tableau ci-après répertorie les variables d'environnement injectées automatiquement dans chaque instance de votre travail en cours d'exécution. Les exemples suivants de variables d'environnement injectées automatiquement sont basés sur un
travail nommé myjob, qui référence l'exemple d'image Code Engine , icr.io/codeengine/codeengine.
| Variable d'environnement | Description | Exemple |
|---|---|---|
CE_API_BASE_URL |
Le site privé Code Engine API URL qui est basé sur la région du projet. Utilisez cette adresse URL pour les appels de point de terminaison API vers le point de terminaison de tous les composants (y compris les travaux) situés dans la même région de votre projet Code Engine. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_DOMAIN |
Nom de domaine du projet. | CE_DOMAIN=us-south.codeengine.appdomain.cloud |
CE_REGION |
Région dans laquelle réside l'exécution du travail. | CE_REGION=us-south |
CE_PROJECT_ID |
ID de votre projet. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_JOB |
Nom de la configuration de travail définie qui a été utilisée pour l'exécution de travail. | CE_JOB=myjobdef |
CE_JOBRUN |
Nom de l'exécution de travail. | CE_JOBRUN=myjob-jobrun-f5kxz |
CE_SUBDOMAIN |
Sous-domaine associé au projet dans lequel votre travail est en cours d'exécution. Pour les utilisateurs qui maîtrisent Kubernetes : CE_SUBDOMAIN est mappé à l'espace de nom Kubernetes qui est associé à votre projet. |
CE_SUBDOMAIN=01234567-abcd |
HOME |
Votre répertoire de base qui exécute le travail. | HOME=/root |
HOSTNAME |
Le nom de l'instance sur laquelle votre application est déployée. | HOSTNAME=myjob-jobrun-6bgmg-0-0 |
JOB_ARRAY_SIZE |
Nombre d'instances de travail à exécuter en parallèle. La valeur est spécifiée directement en tant que taille du tableau d'exécution du travail, ou calculée en comptant les index spécifiés. | JOB_ARRAY_SIZE=10 |
JOB_INDEX |
Index d'une instance d'exécution de travail spécifique. | JOB_INDEX=1 |
JOB_INDEX_RETRY_COUNT |
Nombre de nouvelles tentatives en cours de l'instance de travail. | JOB_INDEX_RETRY_COUNT=0 |
JOB_MODE |
Mode d'exécution d'un travail. En mode task, les travaux sont exécutés pendant une durée maximale et les instances ayant échoué sont relancées en fonction du nombre maximal de relances de travail. En mode daemon,
les travaux s'exécutent sans durée maximale et les instances défaillantes sont redémarrées indéfiniment. |
JOB_MODE=task |
JOB_RETRY_LIMIT |
Nombre maximal de nouvelles tentatives configuré pour l'exécution de travail. | JOB_RETRY_LIMIT=3 |
PATH |
Liste des répertoires dans lesquels le système recherche des exécutables. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PWD |
Répertoire de travail en cours | PWD=/ |
Notez que chaque instance d'exécution d'un travail obtient son propre index à partir du tableau d'index spécifié lors de la création du travail. Code Engine attribue automatiquement des index allant de 0 à (taille du tableau - 1). La variable
d'environnement JOB_INDEX contient la valeur d'index.
Bien que le travail lui-même n'ait pas d'adresse URL associée, les valeurs CE_DOMAIN et CE_SUBDOMAIN peuvent être utiles si vous avez besoin de faire référence à une application qui s'exécute dans le même projet. L'URL
externe complète de cette application est appName.CE_SUBDOMAIN.CE_DOMAIN. Pour référencer l'URL privée d'une application, utilisez appName.CE_SUBDOMAIN.