Variáveis de ambiente injetadas automaticamente
Quando você implanta um aplicativo ou uma função, ou quando executa um trabalho, o site Code Engine injeta automaticamente determinadas variáveis de ambiente no aplicativo, na função ou no trabalho.
Variáveis de ambiente injetadas automaticamente para aplicativos
Quando você implanta um aplicativo, o Code Engine injeta automaticamente determinadas variáveis de ambiente no aplicativo. A tabela a seguir lista as variáveis de ambiente injetadas automaticamente em cada instância do aplicativo implantado.
Os exemplos a seguir de variáveis de ambiente injetadas automaticamente baseiam-se em um aplicativo chamado myapp, que faz referência à imagem de amostra Code Engine, icr.io/codeengine/codeengine.
As variáveis de ambiente, CE_APP, CE_DOMAIN e CE_SUBDOMAIN são usadas para construir o URL de um aplicativo, https://CE_APP.CE_SUBDOMAIN.CE_DOMAIN. Por exemplo, se CE_APP=myapp,
CE_SUBDOMAIN=01234567-abcd e CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud, a sua URL externa de aplicativo é https://myapp.01234567-abcd.us-south.codeengine.dev.appdomain.cloud. A URL privada de
seu aplicativo é appName.CE_SUBDOMAIN ou myapp.01234567-abcd.
| Variável do ambiente | Descrição | Exemplo |
|---|---|---|
CE_API_BASE_URL |
A API privada Code Engine URL que é baseada na região do projeto. Use este URL para chamadas de ponto de extremidade de API para o ponto de extremidade de todos os componentes (incluindo aplicativos) que estão localizados na mesma região do seu projeto Code Engine. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_APP |
O nome do aplicativo. | CE_APP=myapp |
CE_DOMAIN |
A parte do nome de domínio da URL do aplicativo (e do projeto). | CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud |
CE_REGION |
A região onde o aplicativo reside. | CE_REGION=us-south |
CE_PROJECT_ID |
O ID do projeto de seu projeto. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_SUBDOMAIN |
A parte do subdomínio da URL associada ao aplicativo (e projeto). Se você estiver familiarizado com o Kubernetes, CE_SUBDOMAIN mapeará para o namespace do Kubernetes associado ao seu projeto. | CE_SUBDOMAIN=01234567-abcd |
HOME |
Seu diretório pessoal que está executando o aplicativo. | HOME=/root |
HOSTNAME |
O nome da instância em que seu aplicativo está implementado. | HOSTNAME=myapp-00001-deployment-65684cffd-xng7z |
K_CONFIGURATION |
O nome do aplicativo. | K_CONFIGURATION=myapp |
K_REVISION |
O nome da revisão atual do seu aplicativo implantado. | K_REVISION=myapp-00001 |
K_SERVICE |
O nome do aplicativo. | K_SERVICE=myapp |
PATH |
A lista de diretórios na qual o sistema procura executáveis. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PORT |
A porta que seu aplicativo escuta para receber solicitações de HTTP. | PORT=8080 |
PWD |
O diretório atualmente em funcionamento. | PWD=/ |
Observe que é possível substituir a variável PORT implantando o aplicativo a partir do console e especificando o valor da porta Listening ou usando a CLI e definindo a opção --port.
Variáveis de ambiente injetadas automaticamente para funções
Quando você implanta uma função, o site Code Engine injeta automaticamente determinadas variáveis de ambiente na função. A tabela a seguir lista as variáveis de ambiente injetadas automaticamente em cada instância de sua função implantada.
As variáveis de ambiente, CE_FUNCTION, CE_DOMAIN e CE_SUBDOMAIN são usadas para construir o URL de uma função, https://CE_FUNCTION.CE_SUBDOMAIN.CE_DOMAIN. Por exemplo, se CE_FUNCTION=myfunc,
CE_SUBDOMAIN=01234567-abcd e CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud, sua função externa URL é https://myfunc.01234567-abcd.us-south.codeengine.dev.appdomain.cloud. A URL privada de seu aplicativo
é CE_FUNCTION.CE_SUBDOMAIN.private.CE_DOMAIN ou myfunc.01234567-abcd.private.us-south.codeengine.appdomain.cloud.
| Variável do ambiente | Descrição | Exemplo |
|---|---|---|
CE_API_BASE_URL |
A API privada Code Engine URL que é baseada na região do projeto. Use este URL para chamadas de ponto de extremidade de API para o ponto de extremidade de todos os componentes (incluindo funções) que estão localizados na mesma região do seu projeto Code Engine. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_ALLOW_CONCURRENT |
Essa configuração booleana interna é usada pelo controlador da função Code Engine para indicar se o tempo de execução suporta chamadas simultâneas da mesma instância de função e pode ser ignorado. | CE_ALLOW_CONCURRENT=true |
CE_DOMAIN |
A parte do nome de domínio do site URL da função (e do projeto). | CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud |
CE_REGION |
A região na qual a função reside. | CE_REGION=us-south |
CE_PROJECT_ID |
O ID do projeto de seu projeto. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_EXECUTION_ENV |
O tipo de tempo de execução gerenciado e sua versão de liberação.. | CE_EXECUTION_ENV=ibm/action-python-v3.11 Este exemplo especifica o uso do Python v3.11 |
CE_FUNCTION |
O nome da função. | CE_FUNCTION=myfunc |
CE_SUBDOMAIN |
A parte do subdomínio do site URL associada à função (e ao projeto). Se você estiver familiarizado com Kubernetes, CE_SUBDOMAIN mapeia para o espaço de nome Kubernetes associado ao seu projeto. |
CE_SUBDOMAIN=01234567-abcd |
HOME |
O diretório inicial do contêiner de tempo de execução para a função | HOME=/root |
LC_CTYPE |
O código de idioma que é usado pela API do sistema operacional ctype e multibyte.. Disponível apenas com tempos de execução do Python |
LC_CTYPE=C.UTF-8 |
PATH |
A configuração atual da variável PATH, que lista os diretórios em que o sistema procura executáveis. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PYTHONIOENCODING |
A codificação padrão que é usada pela entrada padrão, saída padrão e fluxos de erro padrão. Essa variável se aplica apenas a um tempo de execução do Python. | PYTHONIOENCODING=UTF-8 |
PWD |
O diretório atualmente em funcionamento. | PWD=/ |
Variáveis de ambiente injetadas automaticamente para tarefas
Quando você executa uma tarefa, o Code Engine injeta automaticamente determinadas variáveis de ambiente na instância de execução da tarefa.
A tabela a seguir lista variáveis de ambiente injetadas automaticamente em cada instância de sua tarefa em execução. Os exemplos a seguir de variáveis de ambiente injetadas automaticamente são baseados em uma tarefa que é denominada myjob,
que referencia a imagem de amostra do Code Engine, icr.io/codeengine/codeengine.
| Variável do ambiente | Descrição | Exemplo |
|---|---|---|
CE_API_BASE_URL |
A API privada Code Engine URL que é baseada na região do projeto. Use este URL para chamadas de ponto de extremidade de API para o ponto de extremidade de todos os componentes (incluindo trabalhos) que estão localizados na mesma região do seu projeto Code Engine. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_DOMAIN |
O nome de domínio do projeto. | CE_DOMAIN=us-south.codeengine.appdomain.cloud |
CE_REGION |
A região na qual a execução da tarefa reside | CE_REGION=us-south |
CE_PROJECT_ID |
O ID do projeto de seu projeto. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_JOB |
O nome da configuração de tarefa definida que foi usada para a execução da tarefa. | CE_JOB=myjobdef |
CE_JOBRUN |
O nome da execução da tarefa. | CE_JOBRUN=myjob-jobrun-f5kxz |
CE_SUBDOMAIN |
O subdomínio associado ao projeto no qual a sua tarefa está em execução. Se você estiver familiarizado com o Kubernetes, CE_SUBDOMAIN mapeará para o namespace do Kubernetes que está associado ao seu projeto. |
CE_SUBDOMAIN=01234567-abcd |
HOME |
O seu diretório inicial que está executando a tarefa. | HOME=/root |
HOSTNAME |
O nome da instância em que seu aplicativo está implementado. | HOSTNAME=myjob-jobrun-6bgmg-0-0 |
JOB_ARRAY_SIZE |
O número de instâncias da tarefa a serem executadas em paralelo O valor é especificado diretamente como o tamanho da matriz de execução do trabalho ou calculado pela contagem dos índices especificados. | JOB_ARRAY_SIZE=10 |
JOB_INDEX |
O índice de uma instância de execução da tarefa específica. | JOB_INDEX=1 |
JOB_INDEX_RETRY_COUNT |
A contagem de retentos atuais da instância de emprego. | JOB_INDEX_RETRY_COUNT=0 |
JOB_MODE |
O modo de execução de um trabalho. No modo task, as tarefas executadas por um tempo máximo e instâncias falidas são rejulgadas por limite de retentativas de tarefa. No modo daemon, os trabalhos são executados
sem um tempo máximo e as instâncias com falha são reiniciadas indefinidamente. |
JOB_MODE=task |
JOB_RETRY_LIMIT |
O limite de retry configurado do jobrun. | JOB_RETRY_LIMIT=3 |
PATH |
A lista de diretórios na qual o sistema procura executáveis. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PWD |
O diretório atualmente em funcionamento. | PWD=/ |
Observe que cada instância de execução de trabalho obtém seu próprio índice da matriz de índices que foi especificada quando o trabalho foi criado. Code Engine atribui automaticamente índices a partir de 0 até (tamanho da matriz - 1). A variável
de ambiente JOB_INDEX contém o valor de índice.
Enquanto a tarefa em si não tem uma URL associada a ele, os valores CE_DOMAIN e CE_SUBDOMAIN podem ser úteis se você precisar fazer referência a um aplicativo que está em execução no mesmo projeto. A URL externa completa
deste aplicativo é appName.CE_SUBDOMAIN.CE_DOMAIN. Para referenciar a URL privada de um aplicativo, use appName.CE_SUBDOMAIN.