Skip to content

Commit

Permalink
Merge pull request #481 from dtantsur/checksum-type-fix
Browse files Browse the repository at this point in the history
User guide: fix missing checksumType in samples
  • Loading branch information
metal3-io-bot authored Oct 22, 2024
2 parents 4c30299 + 5fee192 commit f037629
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/user-guide/src/bmo/instance_customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ spec:
image:
checksum: http://192.168.0.150/SHA256SUMS
url: http://192.168.0.150/jammy-server-cloudimg-amd64.img
checksumType: auto
networkData:
name: host-0-networkdata
```
Expand Down
15 changes: 15 additions & 0 deletions docs/user-guide/src/bmo/provisioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ spec:
image:
checksum: http://192.168.0.150/SHA256SUMS
url: http://192.168.0.150/jammy-server-cloudimg-amd64.img
checksumType: auto
```
In most real cases, you will also want to provide
Expand All @@ -66,6 +67,7 @@ spec:
image:
checksum: http://192.168.0.150/SHA256SUMS
url: http://192.168.0.150/jammy-server-cloudimg-amd64.img
checksumType: auto
format: raw
rootDeviceHints:
wwn: "0x55cd2e415652abcd"
Expand Down Expand Up @@ -104,6 +106,19 @@ large raw images with a lot of empty space.
**NOTE:** the special format value `live-iso` triggers a [live ISO
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.

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,
but it provides a weaker defense against man-in-the-middle attacks.

## Deprovisioning

To remove an instance from the host and make it available for new deployments,
Expand Down

0 comments on commit f037629

Please sign in to comment.