Quelltext der Seite Cloudcomputing Kurzanleitung - Jupyter Notebook

{{article
|type=Anleitung
|service=Service:Cloudcomputing
|targetgroup=Angestellte,Studierende,Gäste
|hasdisambig=Nein
}}
{{template caller‏‎
|marker=Stub
}}
In dieser Anleitung erfahren Sie, wie Sie ein Jupiter Notebook auf einer Instanz des Cloudcomputing-Dienstes der Universität erstellen. 
<bootstrap_alert color=info>Dieser Artikel erfordert grundlegende Erfahrung im Umgang mit Linux.
</bootstrap_alert>

== Was ist zu tun? ==
* eine Ubuntu Instanz erstellen
* JupiterLab installieren
* Server starten und anmelden

== Erstellen einer Ubuntu Instanz ==
Zunächst benötigen Sie eine Instanz, auf welcher Sie die JupyterLab Umgebung bereitstellen können - für dieses Tutorial verwenden wir Ubuntu 20.04.
An dieser Stelle werden wir nur eine sehr kurze Anleitung zur Erstellung einer Instanz geben - eine ausführlichere Anleitung finden Sie im Bereich [https://hilfe.uni-paderborn.de/Cloudcomputing_Quick-Start QuickStartGuide].

'''Vorraussetzung ist ein vorhandnes Schlüsselpaar!''' Falls Sie noch kein Schlüsselpaar angelegt haben, finden Sie [https://hilfe.uni-paderborn.de/Cloudcomputing_Quick-Start#Schl.C3.BCsselpaare hier] eine Anleitung, wie Sie ein Schlüsselpaar erstellen.

1. Erstellen Sie einen Datenträger unter ''Datenträger/Datenträger'' mit den folgenden Einstellungen:

[[Datei:Screenshot_OpenStack_Datentraeger_erstellen.png |mini|200px|none| Datenträger erstellen]] 

2. Legen Sie unter ''Netzwerk/Sicherheitsgruppen'' eine neue Sicherheitsgruppe an mit dem Namen ''JupyterLab'' an. 
Erstellen Sie zunächst eine neue Sicherheitsregel für den Port des SSH-Dienstes - hier bietet OpenStack bereits eine Standardregel.

Der Dienst der JupyterLab Umgebung wird standardmäßig auf dem Port 8888 bereitgestellt.  Erstellen Sie innerhalb der Sicherheitsgruppe eine neue Regel mit den folgenden Einstellungen:

[[Datei:Screenshot_OpenStack_Sicherheitsregel_JupiterLab.png |mini|200px|none| Sicherheitsregel erstellen]] 

Soll der Dienst auch über IPv6 erreichbar sein, erstellen Sie eine weitere Regel mit den selben Parameter - ausser ''CIDR'', dort geben Sie <code>::/0</code> an.

3. Erstellen Sie eine neue Instanz unter ''Compute/Instanzen'' über den Button ''Instanz starten''. Vergeben Sie den Namen <code>Ubuntu-20.04-JupyterLab</code>.
Als Quelle wählen Sie den zuvor erstellen Datenträger aus. Die Wahl der ''Variante'' hängt von Ihren Anforderungen ab - für dieses Tutorial wählen wir <code>medium</code> aus.
Falls Sie bereits ein Netzwerk angelegt haben, können Sie die Instanz diesem zuordnen. Unter ''Sicherheitsgruppen'' ordnen Sie die zuvor erstellte Sicherheitsgruppe der Instanz zu.
Ihr Schlüsselpaar sollte automatisch zur Instanz hinzugefügt worden sein. Klicken Sie anschließend auf ''Instanz starten''.

4. Im Kontextmenü der Instanz können Sie dieser eine Floating IP zuweisen, damit diese von Aussen erreichbar ist. 

== Installieren von JupiterLab ==

Loggen Sie sich auf der erstellten Instanz per SSH ein.

Um JupyterLab zu installieren benötigen Sie zunächst den PIP-Packetmanager (ein populärer Paketmanager der Python Umgebung).
Führen Sie folgenden Befehl aus: 

<source>sudo apt update && sudo apt upgrade -y && sudo apt install python3-pip -y</source>

Hier wird zunächst das System auf Updates geprüft, eventuelle Updates installiert und danach wird PIP hinzugefügt.

Mithilfe des PIP Packetmanagers können wir nun JupytherLab installieren:
<source>pip install jupyterlab</source>

Damit der Server der JupyterLab-Instanz ausgeführt werden kann, müssen Sie noch eine Umgebungsvariable angeben, dazu führen Sie folgenden Befehl aus: 
<source>export PATH="$HOME/.local/bin:$PATH"</source>

== Ausführen von JupiterLab / Jupyter Notebook ==
Um JupyterLab auszuführen, geben Sie folgenden Befehlt in die Konsole ein:
<source>jupyter-lab --no-browser --ip="0.0.0.0" --allow-root</source>

Beim Start des JupyterLabs wird Ihnen ein Token angezeigt. Speichern Sie den Token ab, da Sie ihn später noch zur Anmeldung am Server benötigen.

<source>
ubuntu@jupiterlab:~$ jupyter-lab --no-browser --ip="0.0.0.0" --allow-root
[I 2021-06-18 08:32:18.396 ServerApp] jupyterlab | extension was successfully linked.
[I 2021-06-18 08:32:18.411 ServerApp] Writing notebook server cookie secret to /home/ubuntu/.local/share/jupyter/runtime/jupyter_cookie_secret
[I 2021-06-18 08:32:18.420 LabApp] JupyterLab extension loaded from /home/ubuntu/.local/lib/python3.8/site-packages/jupyterlab
[I 2021-06-18 08:32:18.420 LabApp] JupyterLab application directory is /home/ubuntu/.local/share/jupyter/lab
[I 2021-06-18 08:32:18.423 ServerApp] jupyterlab | extension was successfully loaded.
[I 2021-06-18 08:32:18.426 ServerApp] Serving notebooks from local directory: /home/ubuntu
[I 2021-06-18 08:32:18.426 ServerApp] Jupyter Server 1.8.0 is running at:
[I 2021-06-18 08:32:18.426 ServerApp] http://jupiterlab:8888/lab?token=2805c442eee7908eb4062befb545cb2c21f04e860b03a111
[I 2021-06-18 08:32:18.426 ServerApp] http://127.0.0.1:8888/lab?token=2805c442eee7908eb4062befb545cb2c21f04e860b03a111
[I 2021-06-18 08:32:18.426 ServerApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
[C 2021-06-18 08:32:18.428 ServerApp]

    To access the server, open this file in a browser:
        file:///home/ubuntu/.local/share/jupyter/runtime/jpserver-23274-open.html
    Or copy and paste one of these URLs:
        http://jupiterlab:8888/lab?token=2805c442eee7908eb4062befb545cb2c21f04e860b03a111
        http://127.0.0.1:8888/lab?token=2805c442eee7908eb4062befb545cb2c21f04e860b03a111
</source>

Rufen Sie die Floating IP-Adresse der Instanz auf dem Port 8888 in Ihrem Browser auf: <code>http://[Floating-IP]:8888/lab</code>.
Hier werden Sie aufgefordert den Token des Server einzugeben, um sich anzumelden. Fügen Sie den Token in das Feld ein und melden Sie sich an.

Weiterführende Informationen zur Benutzung der JupiterLab und Jupyter Notebook Umgebung finden Sie unter folgenden Links:<br>
[https://jupyterlab.readthedocs.io/en/stable/user/interface.html https://jupyterlab.readthedocs.io/en/stable/user/interface.html]<br>
[https://jupyter-notebook.readthedocs.io/en/stable/notebook.html https://jupyter-notebook.readthedocs.io/en/stable/notebook.html]