| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung |
| client:container [2021/10/05 09:51 CEST] – [Konfiguration des Containers] chr | client:container [2021/12/27 16:35 CET] (aktuell) – bißchen Kosmetik chr |
|---|
| ==== Auswahl des Imagetyps ==== | ==== Auswahl des Imagetyps ==== |
| |
| [{{ :bwsuite:container:bwlp_suite_new_image.png?400|bwLehrpool-Suite: Auswahl zwischen VM und Container}}]Den Wizard zur Erstellung eines Docker-Abbildes erreichen Sie nach Auswahl per Schaltfläche „Neues Docker-Image“ (siehe Abb. rechts). | [{{ :bwsuite:container:211118_bwlp_suite_new_image.png?320|bwLehrpool-Suite: Auswahl zwischen VM und Container}}]Den Wizard zur Erstellung eines Docker-Abbildes erreichen Sie nach Auswahl der Schaltfläche „Neues Docker-Image“ (siehe Abb. rechts). |
| |
| <note important>Bitte beachten Sie eventuelle Warnungen unter „Hinweis“. Überprüfen Sie gegebenenfalls wie [[https://www.bwlehrpool.de/wiki/doku.php/client/bwlehrpool-suite#menueleiste|hier beschrieben]], ob eine neue Version der bwLehrpool-Suite zur Verfügung steht.</note> | <note important>Bitte beachten Sie eventuelle Warnungen unter „Hinweis“. Überprüfen Sie gegebenenfalls wie [[https://www.bwlehrpool.de/wiki/doku.php/client/bwlehrpool-suite#menueleiste|hier beschrieben]], ob eine neue Version der bwLehrpool-Suite zur Verfügung steht.</note> |
| {clear} | {clear} |
| |
| ==== Anlegen des Container-Image ==== | ==== Anlegen des Container-Images ==== |
| |
| [{{ :bwsuite:container:bwlp_suite_new_image_container.png?400|bwLehrpool-Suite: Container-Image erstellen}}] | [{{ :bwsuite:container:211118_bwlp_suite_new_image_container.png?320|bwLehrpool-Suite: Container-Image erstellen}}] |
| Für die Erstellung eines Container-Images stehen Ihnen verschiedene Möglichkeiten zur Auswahl. Sie können dabei das Image aus einem Dockerfile oder einem Git-Repository bauen lassen, oder auf bestehende Abbilder aus einem Image-Repositorium, beispielsweise [[https://hub.docker.com/|Docker Hub]]), zurückgreifen. | Zur Erstellung eines Container-Images stehen Ihnen zwei Möglichkeiten zur Auswahl. Sie können Ihr selbstgebautes Image als Docker-Archive exportieren und hochladen, oder auf bestehende Abbilder aus einem Image-Repositorium, beispielsweise [[https://hub.docker.com/|Docker Hub]]), zurückgreifen. |
| | |
| | <html><!-- Vielleicht gibt es später die entsprechenden Funktionen um Containr Images mit Dockerfiles zu bauen... |
| |
| - Falls ein eigenes Images gebaut werden soll: Verwenden Sie die Eingabeoptionen „Dockerfile“ oder „Git Repository“. | - Falls ein eigenes Images gebaut werden soll: Verwenden Sie die Eingabeoptionen „Dockerfile“ oder „Git Repository“. |
| * Dockerfile: Zum Erstellen eines eigenen Dockerfiles: Anleitung [[https://docs.docker.com/engine/reference/builder/|Docker-Referenz]]. | * Dockerfile: Zum Erstellen eines eigenen Dockerfiles: Anleitung [[https://docs.docker.com/engine/reference/builder/|Docker-Referenz]]. |
| * Git-Repository: Für komplexere Images können Sie auch entsprechend der [[https://docs.docker.com/engine/reference/commandline/build/|Docker-Build-Anleitung]] einen Link auf ein Git-Repository angeben. Hierdurch ist es beispielsweise möglich, dem endgültigen Image weitere Dateien wie Konfigurationen oder Skripte hinzuzufügen. | * Git-Repository: Für komplexere Images können Sie auch entsprechend der [[https://docs.docker.com/engine/reference/commandline/build/|Docker-Build-Anleitung]] einen Link auf ein Git-Repository angeben. Hierdurch ist es beispielsweise möglich, dem endgültigen Image weitere Dateien wie Konfigurationen oder Skripte hinzuzufügen. |
| | --></html> |
| | |
| | - Docker-Archive ist die bevorzugte Methode, um in bwLehrpool Container-Images anzulegen. Exportieren Sie Ihr erstelltes Image mit [[https://docs.docker.com/engine/reference/commandline/save/|docker save]] und fügen Sie es dem Upload hinzu. |
| - Soll ein bestehendes Image von Docker Hub verwendet werden, geben Sie lediglich den Repository-Namen an (z.b. python:3.7, tensorflow/tensorflow:nightly-gpu-jupyter, etc.). | - Soll ein bestehendes Image von Docker Hub verwendet werden, geben Sie lediglich den Repository-Namen an (z.b. python:3.7, tensorflow/tensorflow:nightly-gpu-jupyter, etc.). |
| - Geben Sie Ihrem Container-Images einen sprechenden Namen. | - Geben Sie Ihrem Container-Image einen sprechenden Namen. |
| |
| <note important>Der Bau von Container-Images findet derzeit noch auf Clients statt. Sollte dies zu viel Zeit in Anspruch nehmen, können Sie dem Upload auch ein vorgebautes Container-Image hinzufügen ([[https://docs.docker.com/engine/reference/commandline/save/|docker save]]). Das Bauen eines Images soll in einem späteren Schritt im bwLehrpool-System erfolgen </note> | |
| | <note tip>Docker-Archive profitieren aktuell von [[satellite:dnbd3_lokales_caching|lokalem Caching]].</note> |
| | |
| | <note important>Die Dateiendung für Docker-Archive muss für die bwLehrpool-Suite **.tar** lauten, ansonsten werden die Dateien in der Auswahl nicht angezeigt.\\ \\ Prüfen Sie nach dem Exportieren eines Containers-Images ("//docker save ...//"), ob das erstellte Docker-Archive passende Dateiberechtigungen besitzt. Eventuell besitzt die Datei Root-Rechte und kann daher nicht in der Suite ausgewählt werden.</note> |
| |
| |
| ==== Metadaten, Container-Typ ==== | ==== Metadaten, Container-Typ ==== |
| |
| [{{ :bwsuite:container:bwlp_suite_new_image_container_meta.png?direct&400|}}] Geben Sie im letzen Schritt dem Container-Image eine Beschreibung und legen den Typ des Container-Image fest. | [{{ :bwsuite:container:bwlp_suite_new_image_container_meta.png?direct&320|}}] Geben Sie im letzten Schritt dem Container-Image eine Beschreibung und legen den Typ des Container-Image fest. |
| |
| === Beschreibung === | === Beschreibung === |
| === Container-Image-Typ === | === Container-Image-Typ === |
| |
| Der Typ eines Container-Images legt fest, wie dieser in Veranstaltungen oder in anderen Systemen genutzt wwird. Derzeit werden zwei Arten unterstützt: | Der Typ eines Container-Images legt fest, wie dieser in Veranstaltungen oder in anderen Systemen genutzt wird. Derzeit werden zwei Arten unterstützt: |
| |
| * Pool (Default): Ein einfaches Container-Image, das rein zur Verwendung auf bwLehrpool-Clientrechnern erstellt wurde. | * Pool (Default): Ein einfaches Container-Image, das rein zur Verwendung auf bwLehrpool-Clients erstellt wurde. |
| * Daten: Ein spezielles Container-Image, das nur Daten enthält. Beispielsweise können so Daten-Container mit Trainingsdaten für Machine-Learning (Mnist, ImageNet, CIFAR, ...) bereitgestellt werden. | * Daten: Ein spezielles Container-Image, das nur Daten enthält. Beispielsweise können so Daten-Container mit Trainingsdaten für Machine-Learning (Mnist, ImageNet, CIFAR, ...) separat bereitgestellt werden. |
| * Pool/Batch: Ein modifiziertes Container-Image, das sowohl für Lehrveranstaltungen auf bwLehrpool-Clientrechnern als auch für das neue bwLehrpool-Cluster-System verwendet werden kann. (**todo:** bwlp-cluster side and link) | <note important>Daten für einen Daten-Container müssen derzeit unter **/data/** abgelegt werden! Verwenden Sie zur Erstellung von Daten-Containern kleine Basis-Images wie [[https://hub.docker.com/_/alpine|Alpine]] oder [[https://hub.docker.com/_/busybox|BusyBox]]</note> |
| | |
| | <html><!-- Batch-System bezieht seine Container von eigener Container-Registry |
| | * Pool/Batch: Ein modifiziertes Container-Image, das sowohl für Lehrveranstaltungen auf bwLehrpool-Clients als auch für das neue bwLehrpool-Cluster-System verwendet werden kann. (**todo:** bwlp-cluster side and link) |
| | --></html> |
| |
| Nach Angabe der Beschreibung und des gewünschten Imagetyps können Sie wie gewohnt mittels „Weiter“ die Zugriffsberechtigungen Ihres Containers festlegen oder direkt per „Fertigstellen“ die Konfiguration abschließen. | Nach Angabe der Beschreibung und des gewünschten Imagetyps können Sie wie gewohnt mittels „Weiter“ die Zugriffsberechtigungen Ihres Containers festlegen oder direkt per „Fertigstellen“ die Konfiguration abschließen. |
| | |
| ===== Veranstaltungen mit Docker-Container ===== | ===== Veranstaltungen mit Docker-Container ===== |
| |
| ==== Konfiguration des Containers ==== | ==== Konfiguration des Containers ==== |
| |
| [{{ :bwsuite:container:bwlp_suite_lecture_container_details.png?direct&400|Veranstaltungsdetails Containerkonfiguration}}] | [{{ :bwsuite:container:bwlp_suite_lecture_container_details.png?direct&320|Veranstaltungsdetails Containerkonfiguration}}] |
| |
| Nachdem eine auf ein Container-Image verlinkende Veranstaltung angelegt wurde, muss das Startverhalten des Containers festgelegt werden. Hierzu befindet sich in der Detailansicht der neu erstellten Veranstaltung im Untermenü „Container“ eine Eingabemaske. Dort kann das Verhalten des Containers durch die Menüpunkte „Container-Startoptionen“, „Container-Startbefehl“ sowie eine Mount-Konfiguration angepasst werden. | Nachdem eine auf ein Container-Image verlinkende Veranstaltung angelegt wurde, muss das Startverhalten des Containers festgelegt werden. Hierzu befindet sich in der Detailansicht der neu erstellten Veranstaltung im Untermenü „Container“ eine Eingabemaske. Dort kann das Verhalten des Containers durch die Menüpunkte „Container-Startoptionen“, „Container-Startbefehl“ sowie eine Mount-Konfiguration angepasst werden. |
| * **Container-Startbefehl**: Bei der Erstellung eines Containers wird durch die im Dockerfile enthaltenen Angaben ENTRYPOINT bzw. CMD festgelegt, welche und wie die Containeranwendung gestartet wird. Durch Überschreiben dieser Angaben können Sie das Verhalten der genutzten Anwendung Ihren Wünschen entsprechend anpassen (siehe [[https://docs.docker.com/engine/reference/builder/|Dockerreferenz]]). | * **Container-Startbefehl**: Bei der Erstellung eines Containers wird durch die im Dockerfile enthaltenen Angaben ENTRYPOINT bzw. CMD festgelegt, welche und wie die Containeranwendung gestartet wird. Durch Überschreiben dieser Angaben können Sie das Verhalten der genutzten Anwendung Ihren Wünschen entsprechend anpassen (siehe [[https://docs.docker.com/engine/reference/builder/|Dockerreferenz]]). |
| |
| * **Bind Mount-Konfiguration**: Geben Sie hier die Verzeichnisse an, die in den Container hineingemountet werden sollen. Unter „SOURCE“ finden Sie vordefinierte Labels für Quellen. „USER_HOME“ stellt das Home Verzeichnis des angemeldeten Users dar, „USER_TMP“ einen Bereich in /tmp. Die Buchstaben sind als Laufwerkbuchstaben zu betrachten und referenzieren ein Netzlaufwerk, das in den Veranstaltungsdetails festgelegt werden kann. „TARGET“ stellt das Zielverzeichnis innerhalb des Containers dar, in das die Quelle gemountet wird. Weitere Informationen zur Anwendung von Bind Mounts finden Sie in der Docker-Dokumentation. | * **Bind Mount-Konfiguration**: Durch Anlegen von Bind Mounts wird festgelegt, welche Verzeichnisse aus dem Host-System und/oder interne Docker-Speicherbereiche (Volumes) im Container unter einem festgelegten Dateipfad eingehängt werden. Dabei sind eine Quelle (Source) und ein Ziel (Target) zwingend erforderlich, optional können zusätzliche Optionen das Verhalten im Container beeinflussen (z.b. READ_ONLY). Weitere Informationen zu Bind Mounts finden Sie in der [[https://docs.docker.com/storage/bind-mounts/|Docker-Dokumentation]]. Derzeit können Sie nur vordefinierte Labels als Quelle auswählen, diese sind wie folgt definiert: |
| | * //USER_HOME// stellt das Home Verzeichnis des angemeldeten Users dar. |
| | * //USER_TMP// stellt dem User ein temporäres Verzeichnis zum Austausch unter ///tmp/docker/<USERNAME>/// bereit. |
| | * //Buchstaben// referenzieren den Laufwerksbuchstaben eines Netzlaufwerks, das in den Veranstaltungsdetails festgelegt werden kann. |
| | * //Daten-Container// referenziert ein zuvor hochgeladenes Container-Image, das als Type Daten-Container markiert wurde. |
| |
| ==== Zusätzliche Einstellungen ==== | ==== Zusätzliche Einstellungen ==== |
| ==== Container-Veranstaltungen auf bwLehrpool-Client ==== | ==== Container-Veranstaltungen auf bwLehrpool-Client ==== |
| |
| [{{ :bwsuite:container:bwlp_client_example_lecture.png?direct&400|Start der Containeranwendung auf einem bwLehrpool-Client}}] | [{{ :bwsuite:container:bwlp_client_example_lecture.png?direct&320|Start der Containeranwendung auf einem bwLehrpool-Client}}] |
| |
| Nach dem Start einer Container-Veranstaltung wird der Desktop des nativen Linux gestartet und der Container mit den Veranstaltungsdetails initialisiert. Im aktuellen Entwicklungsstand öffnet sich nach Start der Desktopoberfläche ein Terminal, in dem der aktuelle Fortschritt der Initialisierung angezeigt wird. | Nach dem Start einer Container-Veranstaltung wird der Desktop des nativen Linux gestartet und der Container mit den Veranstaltungsdetails initialisiert. Im aktuellen Entwicklungsstand öffnet sich nach Start der Desktopoberfläche ein Terminal, in dem der aktuelle Fortschritt der Initialisierung angezeigt wird. |
