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.

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

go-fips image page should add more info #1421

Open
xnox opened this issue Mar 6, 2024 · 2 comments
Open

go-fips image page should add more info #1421

xnox opened this issue Mar 6, 2024 · 2 comments

Comments

@xnox
Copy link

xnox commented Mar 6, 2024

Is your feature request related to a problem? Please describe.
go-fips image description does not clarify what one has to do to ensure binaries produced by that toolchain are in FIPS mode.

Describe the solution you'd like
@xnox should improve the docs based on internal spec they wrote

Describe alternatives you've considered
Information on how to build and verify go binaries are operating in FIPS mode should all be public

Additional context
As mentioned on slack

@ltagliaferri
Copy link
Collaborator

The images readmes are in the images directory and syndicated in Academy: https://github.com/chainguard-images/images so if you would like to update the readme, I would open a PR there. Alternately, if the FIPS images have a general and generic guide, it can be added to https://edu.chainguard.dev/chainguard/chainguard-images/fips-images/ or if it's a longer doc, it can be its own "migration guide" (https://edu.chainguard.dev/chainguard/migration-guides/)

@mamccorm
Copy link

Adding some historical context - Previously we'd no way of rendering private image documentation in our image catalogue (assume same for Academy). We've also no monopod implementation today for our private-images repo.

I believe in the absence of above, the public facing docs would instead render the public image docs for fips variants. However now we have the ability to add private docs and have them rendered in the image catalogue / academy :)

I'm not sure this ticket makes sense for edu? this seems more like an engineering quality issue? i.e go back and create some private docs that are missing for go-fips

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants