Describe use of sha256 hash with Wave (#448)

Signed-off-by: Paolo Di Tommaso <[email protected]> Co-authored-by: Phil Ewels <[email protected]> Co-authored-by: Paolo Di Tommaso <[email protected]>
seqeralabs · Apr 29, 2024 · 2cd00be · 2cd00be
1 parent bf375a5
commit 2cd00be
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/docs/guide.mdx b/docs/guide.mdx
@@ -54,6 +54,25 @@ If an access token isn't provided, the following rate limits apply:
 - 25 container builds per day
 - 250 container pulls per hour
 
+## Known limitation
+
+### Use of sha256 digest in the image name
+
+The Wave does not support the use of sha256 digest in the image name, e.g. `ubuntu@sha256:3235...ce8f`, when using
+the augmentation process to extend container images.
+
+In order to reference a container via sha256 digest in the image name with Wave you will need to *freeze* image mode
+that will force the creation of a new container image using the container you have specified as base image.
+
+In your pipeline configuration, ensure that you specify the following settings:
+
+```groovy
+wave.enabled = true
+wave.freeze = true
+wave.strategy = ['dockerfile']
+wave.build.repository = 'docker.io/<user>/<repository>'
+```
+
 ## Tutorials
 
 ### Authenticate private repositories