Erste Notebooks-Instanz erstellen und ein Demo-Notebook ausführen

Voraussetzungen

• Sie verfügen über ein STACKIT Kundenkonto: Ein Kundenkonto erstellen
• Sie verfügen über ein STACKIT Benutzerkonto: Ein Benutzerkonto erstellen
• Sie verfügen über ein STACKIT Projekt: Ein Projekt erstellen

In dieser Anleitung erstellen Sie eine Notebooks-Instanz, verfassen ein Beispiel-Notebook und führen dieses aus.

Erstellen einer Notebooks-Instanz

Hinweis: Im STACKIT Portal steht bisher nur die Lite-Variante von STACKIT Notebooks zur Verfügung. Diese kann nur über ein Support-Ticket angefragt und gebucht werden.

Monitoring

Um beispielsweise Einblicke in den Ressourcenverbrauch, die Anzahl der (aktiven) Benutzer oder die Laufzeit Ihrer Notebooks zu erhalten, können Sie den Export von Metriken an eine bereits vorhandene STACKIT Observability-Instanz aktivieren.

Hinweis: Es wird eine Observability-Instanz mit dem Tarif “Observability-Monitoring-Basic-EU01” oder höher empfohlen. Wenn Sie diese nicht zusätzlich für die Log-Aggregation nutzen möchten, wählen Sie die Variante “Nur Monitoring”.

Ihr erstes Notebook verfassen und ausführen

Diese Anleitung führt Sie durch den gesamten Prozess: Erstellen eines einfachen Notebooks, Hinzufügen zu Ihrem Git-Repository und Ausführen des Codes.

1. Starten Sie Ihren Benutzer-Server

   1. Wählen Sie Zu Notebooks wechseln.
   2. Authentifizieren Sie sich gegenüber dem konfigurierten Identity Provider.
   3. Nach erfolgreicher Authentifizierung werden Sie nach dem Server gefragt, den Sie starten möchten. Sie können zwischen “Light” (2 vCPU und 8 GiB RAM) und “Medium” (6 vCPU und 24 GiB RAM) wählen.
   4. Wählen Sie Starten, um den Server zu starten. Dabei wird ein neuer Kubernetes-Pod mit einem persistenten Volume (PVC) erstellt, das die Daten auch bei Server-Neustarts (einschließlich des Wechselns der Servergröße) aufrechterhält. Das PVC ist unter /home/jovyan im Jupyter-Pod eingebunden. Dieses Verzeichnis ist persistent und speichert Benutzerdaten wie Notebooks und Dateien. Alle anderen Verzeichnisse im Container (z. B. tmp) sind flüchtig und werden bei einem Pod-Neustart zurückgesetzt.

2. Den Launcher kennenlernen

   Sobald der Server bereit ist, erscheint der JupyterLab “Launcher”. Er bietet eine Python-3-basierte Notebook-Bearbeitung, den VS Code Editor und weitere Optionen. Da wir uns auf Notebooks konzentrieren, wählen Sie Python 3 (ipykernel).

3. Ihr erstes Notebook bearbeiten und speichern

   Notebooks sind Dokumente, die ausführbaren Code mit erläuterndem Text (Markdown, Reines Textformat) kombinieren. Das Notebook startet leer mit einem Cursor in einer Code-Zelle. Geben Sie print("Hello World") ein und wählen Sie entweder die Schaltfläche Play (▶️) oder drücken Sie Strg + Eingabe. Das Ergebnis der Codeausführung wird direkt darunter angezeigt.

   Wählen Sie nun das Speichern-Symbol oder drücken Sie Strg+S. Nennen Sie das Notebook “Getting Started”.

4. Benutzerdefinierte Bibliotheken installieren

   Wir empfehlen die Verwendung von mamba zur Installation benutzerdefinierter Pakete, da wir dieses auch für das Basis-Image nutzen. Beachten Sie, dass installierte Pakete nach einem Neustart verloren gehen, es sei denn, sie werden mit dem Flag --user installiert. Wir raten jedoch von der Verwendung des Flags --user ab, da die Pakete dann über Neustarts hinweg bestehen bleiben, was bei Aktualisierungen der Notebook-Umgebung zu Konflikten führen kann.

5. Server herunterfahren

   Der Server wird nach einer Stunde Inaktivität automatisch heruntergefahren. Sie können den Server jedoch auch manuell herunterfahren, wenn Sie Ihre Arbeit beendet haben.

   Gehen Sie unter Datei auf Hub Control Panel und dann auf die rote Schaltfläche Stop My Server. Dadurch wird der laufende Server sofort heruntergefahren und Sie werden zur Serverauswahl weitergeleitet.

   Herzlichen Glückwunsch - Sie haben erfolgreich Ihr erstes Notebook verfasst.

Git einrichten

Es wird dringend empfohlen, Git zu nutzen, wie im Abschnitt Best Practices beschrieben.

Um Git in Ihrer JupyterLab-Umgebung zu aktivieren, gehen Sie auf das Git-Symbol in der linken Navigationsleiste von JupyterLab. Wählen Sie “Repository klonen” (vorausgesetzt, Sie haben bereits eines), und geben Sie die URL und Ihre Zugangsdaten ein. JupyterLab klont das Repository anschließend auf die angehängte Festplatte.

Sobald das Klonen abgeschlossen ist, können Sie in der Git-Ansicht Dateien committen, Branches auschecken, Änderungen stagen, pushen usw.

Zusätzliche Einblicke mit STACKIT Observability

Wenn Sie bei der Einrichtung von STACKIT Notebooks das Monitoring aktiviert haben, werden detaillierte Metriken über den Status und die Arbeitslast Ihrer Notebooks-Instanz an Ihre STACKIT Observability-Instanz übertragen. Diese enthält ein Dashboard namens STACKIT Notebooks mit Diagrammen zum Status von JupyterHub selbst sowie detaillierten Metriken zu den Notebook-Servern (zum Beispiel CPU- und Speicherverbrauch).