Docker/Image/best-practice
Mehrstufige Builds
Mit mehrstufigen Builds können Sie die Größe Ihres endgültigen Images reduzieren, indem Sie eine klarere Trennung zwischen dem Erstellen Ihres Images und der endgültigen Ausgabe schaffen. Teilen Sie die Anweisungen in Ihrer Dockerfile-Datei in einzelne Phasen auf, um sicherzustellen, dass die resultierende Ausgabe nur die Dateien enthält, die für die Ausführung der Anwendung erforderlich sind.
Durch die Verwendung mehrerer Stufen können Sie zudem effizienter bauen, indem Sie die Bauschritte parallel ausführen.
Weitere Informationen finden Sie unter Mehrstufige Builds.
Wiederverwendbare Phasen
Wenn Sie mehrere Images haben, die viele Gemeinsamkeiten aufweisen, sollten Sie in Erwägung ziehen, eine wiederverwendbare Stage zu erstellen, die die gemeinsamen Komponenten enthält, und Ihre individuellen Stages darauf aufzubauen. Docker muss die gemeinsame Stage nur einmal erstellen. Das bedeutet, dass Ihre abgeleiteten Images den Arbeitsspeicher auf dem Docker-Host effizienter nutzen und schneller geladen werden.
Außerdem ist es einfacher, eine gemeinsame Basisebene zu pflegen („Don’t repeat yourself“), als mehrere verschiedene Ebenen zu haben, die ähnliche Aufgaben erfüllen.
Um Dateien auszuschließen, die für den Build nicht relevant sind, ohne Ihr Quell-Repository umzustrukturieren, verwenden Sie eine .dockerignore-Datei. Diese Datei unterstützt Ausschlussmuster, die denen von .gitignore-Dateien ähneln.
Um beispielsweise alle Dateien mit der Erweiterung .md auszuschließen:
*.md
Informationen zum Erstellen einer solchen Datei finden Sie unter Dockerignore-Datei.
Das in Ihrer Dockerfile definierte Image sollte Container erzeugen, die so kurzlebig wie möglich sind. Kurzlebig bedeutet, dass der Container angehalten und gelöscht, anschließend neu erstellt und mit einem absoluten Minimum an Einrichtung und Konfiguration ersetzt werden kann.
Lesen Sie den Abschnitt Prozesse unter der Methodik „The Twelve-Factor App“, um ein Gefühl dafür zu bekommen, warum Container auf diese zustandslose Weise ausgeführt werden.
Vermeiden Sie es, zusätzliche oder unnötige Pakete zu installieren, nur weil sie vielleicht ganz praktisch sein könnten. So brauchen Sie beispielsweise in einem Datenbank-Image keinen Texteditor einzubinden.
Wenn Sie die Installation zusätzlicher oder unnötiger Pakete vermeiden, weisen Ihre Images eine geringere Komplexität, weniger Abhängigkeiten, kleinere Dateigrößen und kürzere Erstellungszeiten auf.
Jeder Container sollte nur eine Aufgabe erfüllen. Die Entkopplung von Anwendungen in mehrere Container erleichtert die horizontale Skalierung und die Wiederverwendung von Containern. Beispielsweise könnte ein Webanwendungs-Stack aus drei separaten Containern bestehen, von denen jeder über ein eigenes Image verfügt, um die Webanwendung, die Datenbank und einen In-Memory-Cache entkoppelt zu verwalten.
Jeden Container auf einen Prozess zu beschränken, ist eine gute Faustregel, aber keine unumstößliche Regel. Beispielsweise können Container nicht nur mit einem Init-Prozess gestartet werden, sondern manche Programme können auch eigenständig zusätzliche Prozesse starten. So kann beispielsweise Celery mehrere Worker-Prozesse starten, und Apache kann pro Anfrage einen Prozess erstellen.
Entscheiden Sie nach bestem Ermessen, die Container so sauber und modular wie möglich zu halten. Wenn Container voneinander abhängig sind, können Sie Docker-Containernetzwerke nutzen, um sicherzustellen, dass diese Container miteinander kommunizieren können.
Sortieren Sie mehrzeilige Argumente nach Möglichkeit alphanumerisch, um die Pflege zu vereinfachen. Dadurch lassen sich Doppelungen bei den Paketen vermeiden und die Liste lässt sich viel einfacher aktualisieren. Außerdem werden PRs dadurch wesentlich lesbarer und leichter zu prüfen. Es ist ebenfalls hilfreich, vor einem Backslash ein Leerzeichen einzufügen (\).
Hier ist ein Beispiel aus dem buildpack-deps-Image:
RUN apt-get update && apt-get install -y --no-install-recommends \
bzr \ cvs \ git \ mercurial \ subversion \ && rm -rf /var/lib/apt/lists/*
Beim Erstellen eines Images arbeitet Docker die Anweisungen in Ihrer Dockerfile der Reihe nach ab und führt sie in der angegebenen Reihenfolge aus. Bei jeder Anweisung prüft Docker, ob er die Anweisung aus dem Build-Cache wiederverwenden kann.
Um schnellere Builds zu gewährleisten, ist es entscheidend, die Funktionsweise des Build-Caches und den Ablauf der Cache-Invalidierung zu verstehen. Weitere Informationen zum Docker-Build-Cache und zur Optimierung Ihrer Builds finden Sie unter Docker-Build-Cache.
Bild-Tags sind veränderbar, das heißt, ein Herausgeber kann ein Tag aktualisieren, sodass es auf ein neues Bild verweist. Dies ist nützlich, da Herausgeber dadurch Tags so anpassen können, dass sie auf neuere Versionen eines Bildes verweisen. Für Sie als Nutzer des Bildes bedeutet dies, dass Sie automatisch die neue Version erhalten, wenn Sie Ihr Bild neu erstellen.
Wenn Sie beispielsweise in Ihrer Dockerfile-Datei FROM alpine:3.21 angeben, wird 3.21 als die aktuellste Patch-Version für 3.21 interpretiert.
# syntax=docker/dockerfile:1 FROM alpine:3.21
Zu einem bestimmten Zeitpunkt könnte das Tag 3.21 auf die Version 3.21.1 des Images verweisen. Wenn Sie das Image drei Monate später neu erstellen, könnte dasselbe Tag auf eine andere Version verweisen, beispielsweise 3.21.4. Dieser Veröffentlichungsworkflow entspricht den Best Practices, und die meisten Herausgeber wenden diese Tagging-Strategie an, sie ist jedoch nicht zwingend vorgeschrieben.
Der Nachteil dabei ist, dass nicht garantiert ist, dass Sie bei jedem Build dasselbe erhalten. Dies könnte zu kompatibilitätsbrechenden Änderungen führen, und es bedeutet außerdem, dass Sie keinen Nachweis über die genauen Image-Versionen haben, die Sie verwenden.
Um die Integrität Ihrer Lieferkette vollständig zu gewährleisten, können Sie die Image-Version an einen bestimmten Digest binden. Indem Sie Ihre Images an einen Digest binden, stellen Sie sicher, dass immer dieselbe Image-Version verwendet wird, selbst wenn ein Herausgeber das Tag durch ein neues Image ersetzt. Das folgende Dockerfile bindet beispielsweise das Alpine-Image an dasselbe Tag wie zuvor, 3.21, diesmal jedoch zusätzlich mit einem Digest-Verweis.
# syntax=docker/dockerfile:1 FROM alpine:3.21@sha256:a8560b36e8b8210634f77d9f7f9efd7ffa463e380b75e2e74aff4511df3ef88c
Mit diesem Dockerfile würden Ihre Builds auch dann, wenn der Herausgeber das Tag 3.21 aktualisiert, weiterhin die festgelegte Image-Version verwenden: a8560b36e8b8210634f77d9f7f9efd7ffa463e380b75e2e74aff4511df3ef88c.
Das hilft Ihnen zwar, unerwartete Änderungen zu vermeiden, ist aber auch mühsamer, da Sie jedes Mal, wenn Sie das Basis-Image aktualisieren möchten, den Image-Digest für die jeweiligen Versionen manuell nachschlagen und einfügen müssen. Außerdem verzichten Sie damit auf automatische Sicherheitsupdates, die Sie wahrscheinlich gerne erhalten möchten.
Die Standardrichtlinie Keine veralteten Basis-Images von Docker Scout prüft, ob die von Ihnen verwendete Basis-Image-Version tatsächlich die aktuellste ist. Diese Richtlinie prüft außerdem, ob die in Ihrem Dockerfile festgelegten Digests der richtigen Version entsprechen. Wenn ein Herausgeber ein Image aktualisiert, das Sie fixiert haben, gibt die Richtlinienauswertung den Status „nicht konform“ zurück, was darauf hinweist, dass Sie Ihr Image aktualisieren sollten.
Um Ihre Basis-Images automatisch auf dem neuesten Stand zu halten, verwenden Sie GitHub Dependabot mit package-ecosystem: „docker“. Dependabot erstellt Pull-Anfragen, um die Tags und Digests Ihrer Basis-Images nach einem festgelegten Zeitplan zu aktualisieren. Dies ist besser als die Verwendung eines Tags, das die Version automatisch ändert, da Sie die Kontrolle behalten und über einen Prüfpfad verfügen, aus dem hervorgeht, wann und wie die Änderung erfolgte.
Sie können die verfügbaren Updates für Basis-Images auch über die Befehlszeile mit docker scout recommendations einsehen.
Wenn Sie eine Änderung in die Versionsverwaltung einchecken oder einen Pull-Request erstellen, verwenden Sie GitHub Actions oder eine andere CI/CD-Pipeline, um ein Docker-Image automatisch zu erstellen, mit einem Tag zu versehen und zu testen.