Laufzeitkonfiguration verwenden

Wenn Sie eine Notizbuchsession erstellen, können Sie benutzerdefinierte Umgebungsvariablenschlüssel und Git-Repository-URLs hinzufügen, die in Notizbuchsessions verwendet werden sollen.

Hinweis

Benennen Sie keine Umgebungsvariablenschlüssel mit den vom Service verwalteten Umgebungsnamen in der folgenden Tabelle, da die Schlüssel bestimmte Werte erwarten, oder der Data Science-Service gibt den Wert automatisch zurück.

Vom Service verwaltete Umgebungsvariablen

Variablenname

Beschreibung

Angegeben von

TENANCY_OCID

OCID des Mandanten, zu dem das Notizbuch gehört

Wird automatisch von Data Science aufgefüllt.

PROJECT_OCID

Die OCID des Projekts, das mit der aktuellen Notizbuchsession verknüpft ist.

Wird automatisch von Data Science aufgefüllt.

PROJECT_COMPARTMENT_OCID

OCID des Compartments des Projekts, mit dem das Notizbuch verknüpft ist

Wird automatisch von Data Science aufgefüllt.

USER_OCID

Benutzer-OCID.

Wird automatisch von Data Science aufgefüllt.

NB_SESSION_OCID

Die OCID der aktuellen Notizbuchsession.

Wird automatisch von Data Science aufgefüllt.

NB_SESSION_COMPARTMENT_OCID

Die Compartment-OCID der aktuellen Notizbuchsession.

Wird automatisch von Data Science aufgefüllt.

OCI_RESOURCE_PRINCIPAL_RPT_PATH

Pfad zum OCI-Resource-Principal-Token

Wird automatisch von Data Science aufgefüllt.

OCI_RESOURCE_PRINCIPAL_RPT_ID

ID des OCI-Resource-Principal-Tokens

Wird automatisch von Data Science aufgefüllt.

NB_ONCREATE_SCRIPT_URL

URL des Lebenszyklusskripts für Notizbuchsessions, die beim Erstellen ausgeführt werden soll.

Vom Benutzer angegeben.

NB_ONACTIVATE_SCRIPT_URL

URL des Lebenszyklusskripts für Notizbuchsessions, die beim Aktivieren ausgeführt werden soll.

Vom Benutzer angegeben.

NB_ONDEACTIVATE_SCRIPT_URL

URL des Lebenszyklusskripts für Notizbuchsessions, die beim Deaktivieren ausgeführt werden soll.

Vom Benutzer angegeben.

NB_ONDELETE_SCRIPT_URL

URL des Lebenszyklusskripts für Notizbuchsessions, die beim Löschen ausgeführt werden soll.

Vom Benutzer angegeben.

NB_SCRIPT_OUTPUT_LOG_NAMESPACE

Object Storage-Namespace für Ausgabelogs von Notizbuchlebenszyklusskripten.

Vom Benutzer angegeben.

NB_SCRIPT_OUTPUT_LOG_BUCKET

Objektspeicher-Bucket für Ausgabelogs von Notizbuchlebenszyklusskripten.

Vom Benutzer angegeben.

SECURE_DATA_SESSION

Deaktivieren Sie den Dateidownload vom JupyterLab-Client und der JupyterLab-Download-API, und setzen Sie den Wert auf "True", um die Downloadfunktion zu deaktivieren.

Vom Benutzer angegeben.

SHM_SIZE Geben Sie die Speichergröße gefolgt von den Einheiten ein: g für GB, m für MB und b für Byte. Beispiel: Geben Sie 128g für 128 GB Shared Memory ein. Vom Benutzer angegeben.

Benutzerdefinierte Umgebungsvariablenschlüssel

Zusätzlich zu den vom System bereitgestellten Variablen können Sie Notizbuchsessions benutzerdefinierte Umgebungsvariablenschlüssel hinzufügen. Wenn Sie eine Notebook-Session erstellen, fügen Sie im Abschnitt Laufzeitkonfiguration benutzerdefinierte Variablen als Schlüssel/Wert-Paare hinzu.

Constraints zu Schlüssel/Wert-Paaren
  • Bei Schlüsseln und Werten wird zwischen Groß- und Kleinschreibung unterschieden.

  • Schlüssel müssen mit einem Buchstaben oder Unterstrich beginnen und dürfen nur alphanumerische Zeichen und Unterstriche enthalten.

  • Die Schlüssellänge muss zwischen 2 und 32 Zeichen liegen.

  • Der Wert muss zwischen 1 und 256 Zeichen lang sein.

  • Schlüssel dürfen nicht mit dem für den Service reservierten Namespace oci_internal_ beginnen.

  • Schlüssel können nicht von Services verwaltete Variablen sein.

Deaktivieren Sie vorhandene Notizbuchsessions. Wenn Sie dann das Notizbuch aktivieren, fügen Sie die Schlüssel/Wert-Paare im Abschnitt Laufzeitkonfiguration hinzu.

Lebenszyklusskripte für Notizbuchsessions mit benutzerdefinierten Umgebungsvariablenschlüsseln verwalten

Mit den Lebenszyklusskripten für Notizbuchsessions können Sie wie folgt ein benutzerdefiniertes Skript mit unterschiedlichen Lebenszyklusstatus für Notizbuchsessions ausführen:

  • erstellen

  • Aktivieren

  • Deaktivieren

  • Löschen

Um ein Notizbuchlebenszyklusskript auszuführen, übergeben Sie einen vom Service verwalteten Schlüssel im Abschnitt Laufzeitkonfiguration, der den Lebenszyklusstatus angibt, in dem das Skript ausgeführt werden soll. Geben Sie im entsprechenden Wertfeld die OCI Object Storage-Datei-URI an, in die das Lebenszyklusskript hochgeladen wurde.

Der Notizbuchstatus ändert sich erst, wenn das Skript zum Löschen und Deaktivieren von Lebenszyklusstatus abgeschlossen wurde. Erstellen und aktivieren Sie Lebenszyklusskripte, die parallel zur Notizbuchsession ausgeführt werden, damit keine Startverzögerungen auftreten.

Wir haben mehrere Beispielskripte für den Lebenszyklus von Notizbüchern bereitgestellt, die an verschiedene Anwendungsfälle angepasst werden können.

Um Notizbuchlebenszyklusskripte zu verwenden, muss eine Notizbuchsession dynamische Gruppe und Policy zur Verwendung eines Resource Principals erstellt werden. Leseberechtigungen müssen der dynamischen Notizbuchgruppe für den Objektspeicher-Bucket mit den Lebenszyklusskripten erteilt werden.

Folgende Variablenschlüssel für Lebenszyklusskriptumgebungen für Notizbuchsessions sind verfügbar:

NB_ONCREATE_SCRIPT_URL
NB_ONACTIVATE_SCRIPT_URL
NB_ONDEACTIVATE_SCRIPT_URL
NB_ONDELETE_SCRIPT_URL

Für diese Schlüssel muss die folgende IAM-Policy hinzugefügt werden, damit Data Science Objekte aus dem Skript-Bucket lesen kann, wie im folgenden Beispiel dargestellt:


allow dynamic-group <notebook_dyn_group> to manage objects in tenancy
 where all {target.bucket.name='<scripts_bucket>',
            any {request.permission='OBJECT_INSPECT',
                 request.permission='OBJECT_READ'}}

Bei vom Service verwalteten Schlüsseln, die den vorherigen Notizbuchlebenszyklusskriptschlüsseln entsprechen, muss der Wert eine OCI Object Storage-Datei-URI für die hochgeladenen Skripte sein. Das URI-Format lautet https://objectstorage.region.oraclecloud.com/n/object-storage-namespace/b/bucket/o/filename. Die Datei-URI finden Sie im Abschnitt Objektdetails.

Die Variablenschlüssel für das Ausgabeskript der Notizbuchsession-Lebenszyklusumgebung sind:

NB_SCRIPT_OUTPUT_LOG_NAMESPACE
NB_SCRIPT_OUTPUT_LOG_BUCKET

Für diese Schlüssel muss die folgende IAM-Policy hinzugefügt sein, damit Data Science Ausgabelogs wie im folgenden Beispiel in den Log-Bucket erstellen und hochladen kann:


allow dynamic-group <notebook_dyn_group> to manage objects in tenancy
 where all {target.bucket.name='<logs_bucket>',
            any {request.permission='OBJECT_CREATE'}}

Erstellungs- und Aktivierungsskriptlogs sind in der Notizbuchsession in demselben Pfad wie die Laufzeitkonfiguration im Verzeichnis /opt/log/odsc.log verfügbar.

Der Logupload erfolgt mit einem Vorgang zum Deaktivieren oder Löschen von Notizbuchsessions. Dadurch können Sie den Status der Skriptverarbeitung prüfen, weil Sie den Zugriff auf die Notizbuchsession verlieren. Dies wird für das Erstellen und Aktivieren von Skripten nicht unterstützt.

Git-Repository mit einer Laufzeitkonfiguration klonen

Git-Repositorys können mithilfe einer Laufzeitkonfiguration in Notizbuchsessions geklont werden. Mit diesem Ansatz können nur öffentliche Git-Repositorys geklont werden. Um Private Git-Repositorys zu klonen, verwenden Sie SSH-Schlüssel zur Authentifizierung.

Sie können das Git-Repository in einem lokalen Verzeichnis einer Notizbuchsession klonen und dann Git verwenden.

Git-Constraints
  • Das Notizbuch muss Internetzugriff haben, damit das Git-Repository geklont werden kann.

  • Nur öffentliche Git-Repositorys werden unterstützt.

  • Maximal drei Git-Repositorys-URLs sind zulässig.

  • Die maximale Länge einer URL beträgt 256 Zeichen.

Git-bezogene Verzeichnisse in den Notizbuchsessions
  • Suchen Sie die Klone von Git-Repositorys im Verzeichnis /home/datascience/repos einer Notizbuchsession.
  • Um den Klonstatus ("success", "failure" oder "in-progress") abzurufen, gehen Sie zu /opt/log/odsc.log.
  • Für Verbose-Logs gehen Sie zu /var/log/jupyterlab/runtime_config.log.

Auf die Logs von einem Terminal in einer Notizbuchsession zugreifen.

Deaktivieren Sie vorhandene Notebook-Sitzungen. Wenn Sie dann das Notizbuch aktivieren, fügen Sie die Git-Repository-URL im Abschnitt Laufzeitkonfiguration hinzu.

Wenn Sie eine Notebook-Session mit neuen Git-Repository-URLs aktivieren, werden alle aufgelisteten URLs im Abschnitt Runtime-Konfiguration, einschließlich früherer URLs aus den deaktivierten Notebook-Sessions, ebenfalls in das Verzeichnis /home/datascience/repos des Notizbuchs geklont.

Um ein geklontes Repository aus einer Notizbuchsession zu entfernen, können Sie es aus dem Verzeichnis /home/datascience/repos der Notizbuchsession löschen.

Um einen alten Klon aus einem deaktivierten Notizbuch durch einen neuen zu ersetzen, löschen Sie die unerwünschte Git-Repository-URL im Abschnitt Laufzeitkonfiguration, fügen Sie die neue URL hinzu, und aktivieren Sie dann die Notebook-Session.