Automatisch injizierte Umgebungsvariablen
Wenn Sie eine Anwendung oder eine Funktion bereitstellen oder einen Auftrag ausführen, fügt Code Engine automatisch bestimmte Umgebungsvariablen in die Anwendung, Funktion oder den Auftrag ein.
Automatisch eingefügte Umgebungsvariablen für Anwendungen
Wenn Sie eine Anwendung bereitstellen, fügt Code Engine automatisch bestimmte Umgebungsvariablen in die Anwendung ein. In der folgenden Tabelle sind die Umgebungsvariablen aufgeführt, die automatisch in jede Instanz Ihrer bereitgestellten Anwendung
injiziert werden. Die folgenden Beispiele für automatisch eingefügte Umgebungsvariablen basieren auf einer Anwendung mit dem Namen myapp, die auf das Beispielbild Code Engine, icr.io/codeengine/codeengine, verweist.
Die Umgebungsvariablen CE_APP, CE_DOMAIN und CE_SUBDOMAIN werden verwendet, um die URL einer Anwendung, https://CE_APP.CE_SUBDOMAIN.CE_DOMAIN, zu erstellen. Wenn beispielsweise CE_APP=myapp,
CE_SUBDOMAIN=01234567-abcd und CE_DOMAIN=us-south.codeengine.dev.appdomain.cloudangegeben ist, lautet die externe URL Ihrer Anwendung https://myapp.01234567-abcd.us-south.codeengine.dev.appdomain.cloud.
Die private URL Ihrer Anwendung ist appName.CE_SUBDOMAINoder myapp.01234567-abcd.
| Umgebungsvariable | Beschreibung | Beispiel |
|---|---|---|
CE_API_BASE_URL |
Die private Code Engine API URL, die sich auf die Region des Projekts bezieht. Verwenden Sie diese URL für API-Endpunktaufrufe an den Endpunkt für alle Komponenten (einschließlich Anwendungen), die sich in der gleichen Region Ihres Code Engine Projekts befinden. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_APP |
Der Name der Anwendung. | CE_APP=myapp |
CE_DOMAIN |
Der Domänennamensabschnitt der URL der Anwendung (und des Projekts). | CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud |
CE_REGION |
Die Region, in der sich die Anwendung befindet. | CE_REGION=us-south |
CE_PROJECT_ID |
Die Projekt-ID Ihres Projekts. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_SUBDOMAIN |
Der Teil der Unterdomäne der URL, die der Anwendung zugeordnet ist (und Projekt). Wenn Sie mit Kubernetes vertraut sind, ordnet die CE_SUBDOMAIN-Zuordnung dem Kubernetes-Namespace, der Ihrem Projekt zugeordnet ist, zu. | CE_SUBDOMAIN=01234567-abcd |
HOME |
Ihr Heimatverzeichnis, in dem die Anwendung ausgeführt wird. | HOME=/root |
HOSTNAME |
Der Name der Instanz, in der Ihre Anwendung bereitgestellt wird. | HOSTNAME=myapp-00001-deployment-65684cffd-xng7z |
K_CONFIGURATION |
Der Name Ihrer Anwendung. | K_CONFIGURATION=myapp |
K_REVISION |
Der Name der aktuellen Revision Ihrer bereitgestellten Anwendung. | K_REVISION=myapp-00001 |
K_SERVICE |
Der Name Ihrer Anwendung. | K_SERVICE=myapp |
PATH |
Die Liste der Verzeichnisse, in denen das System nach ausführbaren Dateien sucht. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PORT |
Der Port, den Ihre Anwendung abhört, um HTTP Anfragen zu empfangen. | PORT=8080 |
PWD |
Das aktuelle Arbeitsverzeichnis. | PWD=/ |
Beachten Sie, dass Sie die Variable PORT außer Kraft setzen können, indem Sie Ihre Anwendung von der Konsole aus bereitstellen und den Wert Listening port angeben oder indem Sie die CLI verwenden und die Option
--port setzen.
Automatisch eingefügte Umgebungsvariablen für Funktionen
Wenn Sie eine Funktion bereitstellen, fügt Code Engine automatisch bestimmte Umgebungsvariablen in die Funktion ein. In der folgenden Tabelle sind die automatisch in jede Instanz der von Ihnen bereitgestellten Funktion injizierten Umgebungsvariablen aufgeführt.
Die Umgebungsvariablen CE_FUNCTION, CE_DOMAIN und CE_SUBDOMAIN werden verwendet, um die URL einer Funktion, https://CE_FUNCTION.CE_SUBDOMAIN.CE_DOMAIN, zu erstellen. Zum Beispiel, wenn CE_FUNCTION=myfunc,
CE_SUBDOMAIN=01234567-abcd und CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud, Ihre Funktion extern URL ist https://myfunc.01234567-abcd.us-south.codeengine.dev.appdomain.cloud. Die private URL Ihrer
Anwendung ist CE_FUNCTION.CE_SUBDOMAIN.private.CE_DOMAINoder myfunc.01234567-abcd.private.us-south.codeengine.appdomain.cloud.
| Umgebungsvariable | Beschreibung | Beispiel |
|---|---|---|
CE_API_BASE_URL |
Die private Code Engine API URL, die sich auf die Region des Projekts bezieht. Verwenden Sie diese URL für API-Endpunktaufrufe an den Endpunkt für alle Komponenten (einschließlich Funktionen), die sich in der gleichen Region Ihres Code Engine Projekts befinden. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_ALLOW_CONCURRENT |
Diese interne boolesche Einstellung wird vom Funktionscontroller Code Engine verwendet, um anzuzeigen, ob die Laufzeit gleichzeitige Aufrufe derselben Funktionsinstanz unterstützt, und kann ignoriert werden. | CE_ALLOW_CONCURRENT=true |
CE_DOMAIN |
Der Teil des Domänennamens der URL der Funktion (und des Projekts). | CE_DOMAIN=us-south.codeengine.dev.appdomain.cloud |
CE_REGION |
Die Region, in der sich die Funktion befindet | CE_REGION=us-south |
CE_PROJECT_ID |
Die Projekt-ID Ihres Projekts. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_EXECUTION_ENV |
Der Typ der verwalteten Laufzeit und ihre Releaseversion. | CE_EXECUTION_ENV=ibm/action-python-v3.11 In diesem Beispiel wird die Verwendung von Python v3.11angegeben. |
CE_FUNCTION |
Der Name der Funktion. | CE_FUNCTION=myfunc |
CE_SUBDOMAIN |
Der Teil der Subdomäne von URL, der mit der Funktion (und dem Projekt) verbunden ist. Wenn Sie mit Kubernetes vertraut sind, entspricht CE_SUBDOMAIN dem mit Ihrem Projekt verbundenen Namensraum Kubernetes. |
CE_SUBDOMAIN=01234567-abcd |
HOME |
Das Ausgangsverzeichnis des Laufzeitcontainers für die Funktion. | HOME=/root |
LC_CTYPE |
Die Ländereinstellung, die von der API des Betriebssystems ctype und multibyte verwendet wird. Nur mit Python-Laufzeiten verfügbar. |
LC_CTYPE=C.UTF-8 |
PATH |
Die aktuelle Einstellung der Variablen PATH, die die Verzeichnisse auflistet, in denen das System nach ausführbaren Dateien sucht. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PYTHONIOENCODING |
Die Standardcodierung, die von Standardeingabe-, Standardausgabe-und Standardfehlerdatenströmen verwendet wird. Diese Variable gilt nur für eine Python-Laufzeit. | PYTHONIOENCODING=UTF-8 |
PWD |
Das aktuelle Arbeitsverzeichnis. | PWD=/ |
Automatisch injizierte Umgebungsvariablen für Jobs
Wenn Sie einen Job ausführen, fügt Code Engine automatisch bestimmte Umgebungsvariablen in die Jobausführungsinstanz ein.
In der folgenden Tabelle werden die Umgebungsvariablen aufgelistet, die automatisch in jede Instanz Ihres ausgeführten Jobs eingefügt werden. Die folgenden Beispiele für automatisch eingefügte Umgebungsvariablen basieren auf dem Job myjob,
der auf das Code Engine-Beispielimage icr.io/codeengine/codeengine verweist.
| Umgebungsvariable | Beschreibung | Beispiel |
|---|---|---|
CE_API_BASE_URL |
Die private Code Engine API URL, die sich auf die Region des Projekts bezieht. Verwenden Sie diese URL für API-Endpunktaufrufe an den Endpunkt für alle Komponenten (einschließlich Jobs), die sich in der gleichen Region Ihres Code Engine Projekts befinden. | CE_API_BASE_URL=https://api.private.us-south.codeengine.cloud.ibm.com |
CE_DOMAIN |
Der Domänenname des Projekts. | CE_DOMAIN=us-south.codeengine.appdomain.cloud |
CE_REGION |
Die Region, in der sich die Jobausführung befindet | CE_REGION=us-south |
CE_PROJECT_ID |
Die Projekt-ID Ihres Projekts. | CE_PROJECT_ID=abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f |
CE_JOB |
Der Name der definierten Jobkonfiguration, die für die Jobausführung verwendet wurde. | CE_JOB=myjobdef |
CE_JOBRUN |
Der Name der Jobausführung. | CE_JOBRUN=myjob-jobrun-f5kxz |
CE_SUBDOMAIN |
Die Unterdomäne, die dem Projekt zugeordnet ist, in dem Ihr Job ausgeführt wird. Wenn Sie mit Kubernetes vertraut sind, ordnet CE_SUBDOMAIN dem Kubernetes-Namespace zu, der Ihrem Projekt zugeordnet ist. |
CE_SUBDOMAIN=01234567-abcd |
HOME |
Ihr Ausgangsverzeichnis, in dem der Job ausgeführt wird. | HOME=/root |
HOSTNAME |
Der Name der Instanz, in der Ihre Anwendung bereitgestellt wird. | HOSTNAME=myjob-jobrun-6bgmg-0-0 |
JOB_ARRAY_SIZE |
Die Anzahl der Jobinstanzen, die parallel ausgeführt werden sollen Der Wert wird direkt als Größe des Arrays für den Auftragslauf angegeben oder durch Zählen der angegebenen Indizes berechnet. | JOB_ARRAY_SIZE=10 |
JOB_INDEX |
Der Index einer bestimmten Jobausführungsinstanz. | JOB_INDEX=1 |
JOB_INDEX_RETRY_COUNT |
Der aktuelle Wiederholungszähler der Jobinstanz. | JOB_INDEX_RETRY_COUNT=0 |
JOB_MODE |
Der Modus für die Ausführung eines Auftrags. Im Modus task werden Jobs, die für eine maximale Zeit ausgeführt werden, und fehlgeschlagene Instanzen gemäß dem Grenzwert für Jobwiederholungen wiederholt. Im Modus daemon laufen die Aufträge ohne zeitliche Begrenzung und fehlgeschlagene Instanzen werden auf unbestimmte Zeit neu gestartet. |
JOB_MODE=task |
JOB_RETRY_LIMIT |
Das konfigurierte Wiederholungslimit der Jobausführung. | JOB_RETRY_LIMIT=3 |
PATH |
Die Liste der Verzeichnisse, in denen das System nach ausführbaren Dateien sucht. | PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin |
PWD |
Das aktuelle Arbeitsverzeichnis. | PWD=/ |
Beachten Sie, dass jede Job-Laufinstanz ihren eigenen Index aus dem Array von Indizes erhält, die bei der Erstellung des Jobs angegeben wurden. Code Engine vergibt automatisch Indizes von 0 bis (Arraygröße - 1). Die Umgebungsvariable JOB_INDEX enthält den Indexwert.
Obwohl dem Job selbst keine URL zugeordnet ist, können die Werte CE_DOMAIN und CE_SUBDOMAIN nützlich sein, wenn Sie eine Anwendung referenzieren müssen, die in demselben Projekt ausgeführt wird. Die vollständige externe
URL dieser Anwendung ist appName.CE_SUBDOMAIN.CE_DOMAIN. Um auf die private URL einer Anwendung zu verweisen, verwenden Sie appName.CE_SUBDOMAIN.