docs: clarify difference between stackable-base and stackable-devel

dervoeti · dervoeti · commit e0f6f6dbaa89 · 2025-06-11T16:17:37.000+02:00
diff --git a/stackable-base/Dockerfile b/stackable-base/Dockerfile
@@ -1,6 +1,12 @@
 # syntax=docker/dockerfile:1.16.0@sha256:e2dd261f92e4b763d789984f6eab84be66ab4f5f08052316d8eb8f173593acf7
 # check=error=true
 
+#
+# Base image for final stages
+# Should not contain any components that are not needed (or helpful) at runtime
+# Build time dependencies that are used in multiple images can be added to `stackable-devel` (or a derivative like `java-devel`) instead
+#
+
 FROM stackable/image/stackable-devel AS config-utils
 
 # Find the latest version here: https://github.com/stackabletech/config-utils/tags
diff --git a/stackable-devel/Dockerfile b/stackable-devel/Dockerfile
@@ -3,6 +3,9 @@
 
 #
 # Base image for builder stages
+# It is intended to be used as an intermediate "workbench" layer to build components
+# It should not be the base for a final image to avoid shipping build time dependencies like `patchable` or `gcc`
+# Use `stackable-base` as a base for the final image stage instead
 #
 
 # Find the latest version at https://catalog.redhat.com/software/containers/ubi9/ubi-minimal/615bd9b4075b022acc111bf5?container-tabs=gti

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,9 @@`
`3`	`3`
`4`	`4`	`#`
`5`	`5`	`# Base image for builder stages`
	`6`	`+# It is intended to be used as an intermediate "workbench" layer to build components`
	`7`	+# It should not be the base for a final image to avoid shipping build time dependencies like `patchable` or `gcc`
	`8`	+# Use `stackable-base` as a base for the final image stage instead
`6`	`9`	`#`
`7`	`10`
`8`	`11`	`# Find the latest version at https://catalog.redhat.com/software/containers/ubi9/ubi-minimal/615bd9b4075b022acc111bf5?container-tabs=gti`