Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Try to clarify sha256 explanation #490

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Docs: Try to clarify sha256 explanation #490

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
28689b9
Docs: Try to clarify sha256 explanation
ewels May 7, 2024
ce6b10f
Whilst -> While
ewels Nov 22, 2024
ce2ff55
Apply suggestions from code review
ewels Nov 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ 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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
the augmentation process to extend container images.
the augmentation process to extend container images.
This is because Wave augmentation affects the image sha256, because the image contents change.


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 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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This will force the creation of a new container image, using the container you have specified as base image.
This will force the creation of a new container image, using the container you have specified as base image
and push it to a 3rd party container registry.


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
Expand All @@ -73,6 +73,12 @@ wave.strategy = ['dockerfile']
wave.build.repository = 'docker.io/<user>/<repository>'
```

This would build a new image, push it to docker.io and return a URI with the following structure:

```
docker.io/<user>/<repository>:<image>--<hash>
```
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```
The image `tag` here is composed of a Human-readable `<image>` name and a `<hash>` based on the build instructions.


## Tutorials

### Authenticate private repositories
Expand Down