Installation des HSA-KITS läuft aus einem dockerisierten Containermaschine auf einem Server, vollumfänglich innerhalb des internen Netzwerks.
Für weitere Installationsoptionen siehe HSA KIT Deployment.
VM Requirements
- Docker Version 20.10.5 oder später.
- amd64 Architektur
Installation
- Laden Sie die folgenden Dateien herunter und/oder erstellen Sie sie auf der Zielmaschine, die Docker ausführt:
- Die Beispiel-docker-compose.yml Konfigurationsdatei.
- Die env.list Datei mit Umgebungsvariablen für den Container, insbesondere dem Lizenzschlüssel.
- Laden Sie das HSA-KIT-Image entweder
- Von einer lokalen Datei mit dem Befehl
docker image load -i <IMAGE.TAR>ODER - Vom AWS Elastic Container Registry (ECR). Vorheriger Zugriff muss von uns gewährt werden.
- Von einer lokalen Datei mit dem Befehl
- Bereiten Sie alle Verzeichnisse wie in der docker-compose.yml-Datei sowie im folgenden Abschnitt Ressourcenverzeichnisse beschrieben vor.
- Nach der Vorbereitung der Dateistruktur ändern Sie die docker-compose.yml-Datei, um Ihre Ordnerzuweisungen anzupassen.
- Bearbeiten Sie den “source” Wert der Datenbank, Daten, Logs, logs_python, Projekte und Folienbindungsverzeichnis entsprechend.
- Relative Pfade sind möglich.
- Falls Sie eine bestimmte Version (=Tag) des HSA-KITS verwenden möchten, stellen Sie sicher, dass der richtige Tag durch die Imagequelle ausgewählt ist:
hsa-kit:<TAG>- Um immer die zuletzt geladene Version zu verwenden, setzen Sie das Tag auf
hsa-kit:latest
- Um immer die zuletzt geladene Version zu verwenden, setzen Sie das Tag auf
- Stellen Sie sicher, dass der Pfad zur env.list Datei noch korrekt ist. Wenn Sie es im selben Ordner wie Ihre docker-compose.yml Datei haben, ist der Pfad korrekt.
Die env.list Datei muss jedoch noch konfiguriert werden, um einen Schlüssel zu erhalten, müssen wir zuerst das HSA-KIT starten und darauf zugreifen.
- Öffnen Sie die env.list Datei in einem Texteditor Ihrer Wahl.
- Geben Sie den Lizenzschlüssel ein, der aus Ihrer Hardware-ID auf der Lizenzierungsseite berechnet wurde, unter dem Schlüssel “HSA_LICENSE_KEY”.
- Falls Sie den Zugriff nur von bestimmten URLs erlauben möchten, konfigurieren Sie die Umgebungsvariable HSA_ALLOWED_ORIGINS als ein Array zulässiger Ursprünge. Die Ursprünge sollten nur durch Kommata getrennt werden, ohne Leerzeichen oder Klammern.
- Speichern und beenden Sie die env.list Datei.
- Starten Sie das dockerisierte HSA-KIT neu.
Running HSA KIT
Nach erfolgreicher Einrichtung des dockerisierten HSA-KITS kann es wie folgt ausgeführt werden:
- Navigieren Sie zu dem Ordner mit allen erforderlichen Dateien, wie zuvor eingerichtet.
- Führen Sie den Befehl docker-compose up -d aus
- Für erweiterte Optionen siehe auch die offizielle docker-compose Dokumentation zum Ausführen von Containern.
- Sobald der Start abgeschlossen ist (die Befehlszeile ist wieder verfügbar), können Sie auf die Website unter <http://<your> servers address> zugreifen.
Update HSA KIT
Sie müssen Zugriff auf die Befehlszeile für Docker sowie die Ordner haben, in denen das HSA-KIT gespeichert ist.
Das neue hsa-kit.tar Docker-Image muss vorhanden und auf dem Server zugänglich sein, wie oben beschrieben, ODER das neueste Image vom ECR abrufen.
Navigieren Sie zu dem Ordner mit allen erforderlichen Dateien, wie zuvor eingerichtet.
- Laden Sie das neue Docker-Image.
- Stoppen Sie den Docker-Container wie zuvor beschrieben.
- Wenn ein neuer Tag verwendet werden soll, aktualisieren Sie das Tag in der docker-compose.yml.
- Starten Sie den Docker-Container wie zuvor beschrieben.
- Alle anderen Einstellungen werden auf die neue Version übertragen.
- Optional: Bereinigen Sie das ältere Image, indem Sie den Befehl “docker image prune” ausführen und bestätigen.