From 28689b9c052c6ff8c8491f71e33df5ed64a4fd67 Mon Sep 17 00:00:00 2001 From: Phil Ewels Date: Tue, 7 May 2024 14:16:54 +0200 Subject: [PATCH] Docs: Try to clarify sha256 explanation Follow on from https://github.com/seqeralabs/wave/pull/448 Try to add a little more detail / explanation about exactly what this section is proposing. --- docs/guide.mdx | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/guide.mdx b/docs/guide.mdx index 59fd11644..73d4d9a7b 100644 --- a/docs/guide.mdx +++ b/docs/guide.mdx @@ -61,10 +61,12 @@ If an access token isn't provided, the following rate limits apply: 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. +Whilst using a digest directly isn't possible, Wave can generate image names which include a sha256 digest +of the `Dockerfile` used to build the image within the tag. +In order to reference a container via this sha256 digest tag, you will need to use the _freeze_ image mode. +This 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: +For example, in your pipeline configuration you could specify the following settings: ```groovy wave.enabled = true @@ -73,6 +75,12 @@ wave.strategy = ['dockerfile'] wave.build.repository = 'docker.io//' ``` +This would build a new image, push it to docker.io and return a URI with the following structure: + +``` +docker.io//:-- +``` + ## Tutorials ### Authenticate private repositories