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.
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
Docs: Fix maglev.hashSeed byte size documentation #16690
Conversation
This comment has been minimized.
This comment has been minimized.
Signed-off-by: Derek Gaffney <derekmgaffney@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for the PR!
But I don't know if the change is correct. Looking at the history, I see that commit 4d9167f explicitly changed from 16 to 12 bytes, so the 16 byte
length may apply to the base64 output and not to the initial bytes piped into base64
? /Cc @brb
In any case one of the commands is wrong (either -c12
or -c16
) and the text may need some clarification indeed, so thanks for working on this!
[Edit] You edited your PR while I was writing the review, and it looks good now I think. Asking a review from Martynas to be sure, but looks good from my side, thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The maglev hash seed is 16 bytes long. See:
$ head -c12 /dev/urandom | base64 -w0 | wc -c
16
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Scratch my previous comment.
Documentation-only change so fine to merge despite merge freeze. |
Update documentation on maglev hash seed to instruct users to generate a 12 byte seed (instead of 16 bytes), according to this error message from cilium v1.9.4 (when a 16 byte seed had been used):