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

Modifying notes on checksum to reflect recent updates regarding empty checksumType field #497

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Modifying notes on checksum to reflect recent updates regarding empty checksumType field #497

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 3 additions & 6 deletions docs/user-guide/src/bmo/provisioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,9 @@ provisioning](./live-iso.md) that works differently from a normal one.

### Notes on checksums

Unlike Ironic itself, Metal3 currently assumes the checksum algorithm to be MD5
when no `checksumType` value is provided. Since more secure algorithms, such as
SHA256 or SHA512, are popular nowadays, care must be taken to provide the
correct `checksumType`. The value of `auto` will make Ironic detect the
checksum type from its length and will become the default in the next version
of the BareMetalHost API.
Starting from BMO v0.10.0, leaving `checksumType` empty prompts Ironic to
automatically detect the checksum type based on its length. In earlier versions,
this behavior can be achieved by setting `checksumType` to `auto`.

The `checksum` value can be provided either as a URL or as the hash value
directly. Providing a URL is more convenient in case of public cloud images,
Expand Down