Variables de entorno inyectadas automáticamente
Cuando despliega una aplicación o una función, o cuando ejecuta un trabajo, Code Engine inyecta automáticamente determinadas variables de entorno en la aplicación, función o trabajo.
Variables de entorno inyectadas automáticamente para las aplicaciones
Al desplegar una aplicación, Code Engine inyecta automáticamente determinadas variables de entorno en la aplicación. La siguiente tabla enumera las variables de entorno inyectadas automáticamente en cada instancia de su aplicación desplegada.
Los siguientes ejemplos de variables de entorno inyectadas automáticamente se basan en una aplicación denominada myapp, que hace referencia a la imagen de muestra Code Engine, icr.io/codeengine/codeengine.
Las variables de entorno, CE_APP, CE_DOMAIN, y CE_SUBDOMAIN se utilizan para construir el URL de una aplicación, https://CE_APP.CE_SUBDOMAIN.CE_DOMAIN. Por ejemplo, si CE_APP=myapp,
CE_SUBDOMAIN=01234567-abcd y CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud, el URL externo de la aplicación es https://myapp.01234567-abcd.us-south.codeengine.dev.appdomain.cloud. El URL privado de
la aplicación es appName.CE_SUBDOMAIN o myapp.01234567-abcd.
| Variable de entorno | Descripción | Ejemplo |
|---|---|---|
CE_API_BASE_URL |
La API privada Code Engine URL que se basa en la región del proyecto. Utilice esta dirección URL para las llamadas al punto final de la API de todos los componentes (incluidas las aplicaciones) que se encuentren en la misma región de su proyecto Code Engine. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_APP |
El nombre de la aplicación. | CE_APP=myapp |
CE_DOMAIN |
La parte de nombre de dominio del URL de la aplicación (y proyecto). | CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud |
CE_REGION |
La región donde reside la aplicación. | CE_REGION=us-south |
CE_PROJECT_ID |
El ID de proyecto del proyecto. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_SUBDOMAIN |
La parte de subdominio del URL asociada a la aplicación (y el proyecto). Si está familiarizado con Kubernetes, CE_SUBDOMAIN se correlaciona con el espacio de nombres de Kubernetes asociado al proyecto. | CE_SUBDOMAIN=01234567-abcd |
HOME |
Tu directorio personal en el que se ejecuta la aplicación. | HOME=/root |
HOSTNAME |
El nombre de la instancia en la que se despliega su aplicación. | HOSTNAME=myapp-00001-deployment-65684cffd-xng7z |
K_CONFIGURATION |
El nombre de la aplicación. | K_CONFIGURATION=myapp |
K_REVISION |
El nombre de la revisión actual de su aplicación desplegada. | K_REVISION=myapp-00001 |
K_SERVICE |
El nombre de la aplicación. | K_SERVICE=myapp |
PATH |
La lista de directorios en los que el sistema busca los ejecutables. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PORT |
El puerto en el que su aplicación escucha, para recibir peticiones HTTP. | PORT=8080 |
PWD |
El directorio de trabajo actual. | PWD=/ |
Tenga en cuenta que puede anular la variable PORT desplegando su aplicación desde la consola y especificando el valor del puerto de escucha o utilizando la CLI y configurando la opción --port.
Variables de entorno inyectadas automáticamente para las funciones
Al desplegar una función, Code Engine inyecta automáticamente determinadas variables de entorno en la función. La siguiente tabla enumera las variables de entorno inyectadas automáticamente en cada instancia de su función desplegada.
Las variables de entorno, CE_FUNCTION, CE_DOMAIN, y CE_SUBDOMAIN se utilizan para construir el URL de una función, https://CE_FUNCTION.CE_SUBDOMAIN.CE_DOMAIN. Por ejemplo, si CE_FUNCTION=myfunc,
CE_SUBDOMAIN=01234567-abcd y CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud, su función externa URL es https://myfunc.01234567-abcd.us-south.codeengine.dev.appdomain.cloud. El URL privado de la aplicación
es CE_FUNCTION.CE_SUBDOMAIN.private.CE_DOMAIN o myfunc.01234567-abcd.private.us-south.codeengine.appdomain.cloud.
| Variable de entorno | Descripción | Ejemplo |
|---|---|---|
CE_API_BASE_URL |
La API privada Code Engine URL que se basa en la región del proyecto. Utilice este URL para las llamadas al punto final de la API de todos los componentes (incluidas las funciones) que se encuentran en la misma región de su proyecto Code Engine. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_ALLOW_CONCURRENT |
Este valor booleano interno lo utiliza el controlador de función Code Engine para indicar si el tiempo de ejecución soporta invocaciones simultáneas de la misma instancia de función y se puede ignorar. | CE_ALLOW_CONCURRENT=true |
CE_DOMAIN |
La parte del nombre de dominio de URL de la función (y del proyecto). | CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud |
CE_REGION |
La región donde reside la función. | CE_REGION=us-south |
CE_PROJECT_ID |
El ID de proyecto del proyecto. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_EXECUTION_ENV |
El tipo de tiempo de ejecución gestionado y su versión de release. | CE_EXECUTION_ENV=ibm/action-python-v3.11 Este ejemplo especifica que se utilice Python v3.11. |
CE_FUNCTION |
Nombre de la función. | CE_FUNCTION=myfunc |
CE_SUBDOMAIN |
La parte del subdominio de URL asociada a la función (y al proyecto). Si está familiarizado con Kubernetes, CE_SUBDOMAIN se asigna al espacio de nombres Kubernetes asociado a su proyecto. |
CE_SUBDOMAIN=01234567-abcd |
HOME |
El directorio de inicio del contenedor de tiempo de ejecución para la función. | HOME=/root |
LC_CTYPE |
El entorno local utilizado por la API del sistema operativo ctype y multibyte. Sólo está disponible con tiempos de ejecución Python. |
LC_CTYPE=C.UTF-8 |
PATH |
El valor actual de la variable PATH, que lista los directorios en los que el sistema busca ejecutables. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PYTHONIOENCODING |
La codificación estándar que utilizan las corrientes de entrada estándar, salida estándar y error estándar. Esta variable sólo se aplica a un tiempo de ejecución de Python. | PYTHONIOENCODING=UTF-8 |
PWD |
El directorio de trabajo actual. | PWD=/ |
Variables de entorno inyectadas automáticamente para trabajos
Al ejecutar un trabajo, Code Engine inyecta automáticamente determinadas variables de entorno en la instancia de ejecución del trabajo.
En la tabla siguiente se muestran automáticamente las variables de entorno inyectadas en cada instancia del trabajo en ejecución. Los siguientes ejemplos de variables de entorno inyectadas automáticamente se basan en un trabajo denominado myjob,
que hace referencia a la imagen de ejemplo de Code Engine, icr.io/codeengine/codeengine.
| Variable de entorno | Descripción | Ejemplo |
|---|---|---|
CE_API_BASE_URL |
La API privada Code Engine URL que se basa en la región del proyecto. Utilice este URL para las llamadas al punto final de la API para todos los componentes (incluidos los trabajos) que se encuentran en la misma región de su proyecto Code Engine. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_DOMAIN |
El nombre de dominio del proyecto. | CE_DOMAIN=us-south.codeengine.appdomain.cloud |
CE_REGION |
La región donde reside la ejecución del trabajo. | CE_REGION=us-south |
CE_PROJECT_ID |
El ID de proyecto del proyecto. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_JOB |
Nombre de la configuración de trabajo definida que se ha utilizado en la ejecución del trabajo. | CE_JOB=myjobdef |
CE_JOBRUN |
El nombre de la ejecución del trabajo. | CE_JOBRUN=myjob-jobrun-f5kxz |
CE_SUBDOMAIN |
El subdominio asociado al proyecto en el que se ejecuta el trabajo. Si está familiarizado con Kubernetes, CE_SUBDOMAIN se correlaciona con el espacio de nombres de Kubernetes que está asociado al proyecto. |
CE_SUBDOMAIN=01234567-abcd |
HOME |
El directorio de inicio que ejecuta el trabajo. | HOME=/root |
HOSTNAME |
El nombre de la instancia en la que se despliega su aplicación. | HOSTNAME=myjob-jobrun-6bgmg-0-0 |
JOB_ARRAY_SIZE |
Número de instancias de trabajo que se van a ejecutar en paralelo. El valor se especifica directamente como el tamaño de la matriz de ejecución del trabajo, o se calcula contando los índices especificados. | JOB_ARRAY_SIZE=10 |
JOB_INDEX |
El índice de una instancia de ejecución de trabajo específica. | JOB_INDEX=1 |
JOB_INDEX_RETRY_COUNT |
Recuento actual de reintentos de la instancia de trabajo. | JOB_INDEX_RETRY_COUNT=0 |
JOB_MODE |
El modo de ejecución de un trabajo. En la modalidad task, los trabajos se ejecutan durante un tiempo máximo y las instancias anómalas se reintentan según el límite de reintentos de trabajo. En el modo daemon,
los trabajos se ejecutan sin un tiempo máximo y las instancias fallidas se reinician indefinidamente. |
JOB_MODE=task |
JOB_RETRY_LIMIT |
El límite de reintentos configurado del jobrun. | JOB_RETRY_LIMIT=3 |
PATH |
La lista de directorios en los que el sistema busca los ejecutables. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PWD |
El directorio de trabajo actual. | PWD=/ |
Tenga en cuenta que cada instancia de ejecución de trabajo obtiene su propio índice de la matriz de índices que se especificó al crear el trabajo. Code Engine asigna automáticamente los índices empezando por 0 hasta (tamaño de la matriz - 1).
La variable de entorno JOB_INDEX contiene el valor de índice.
Aunque el trabajo en sí no tiene un URL asociado, los valores CE_DOMAIN y CE_SUBDOMAIN pueden ser útiles si necesita hacer referencia a una aplicación que se ejecuta en el mismo proyecto. El URL externo completo de
esta aplicación es appName.CE_SUBDOMAIN.CE_DOMAIN. Para referenciar el URL privado de una aplicación, utilice appName.CE_SUBDOMAIN.