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

[FEATURE] Add authorization documentation #736

Closed
Tracked by #926
Kern-- opened this issue Jul 21, 2023 · 1 comment
Closed
Tracked by #926

[FEATURE] Add authorization documentation #736

Kern-- opened this issue Jul 21, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation feature New feature or request

Comments

@Kern--
Copy link
Contributor

Kern-- commented Jul 21, 2023

Description

The SOCI snapshotter's authorization setup is not immediately obvious. It doesn't share authorization with the containerd client that normally performs a pull and instead relies on either docker credentials or kubernetes credentials. Both require additional setup when using SOCI with private images.

The only documentation we have is to do sudo docker login in our getting started doc which is not realistic in a production environment. Additionally, since SOCI tries hard not to fail an image pull, if it doesn't have credentials it will fall back to pulling with the client which will likely succeed. This leads to confusion about SOCI's performance being on-par or worse than without because it's doing work and then doing a normal image pull anyway.

Describe the solution you'd like

[ ] A doc outlining the authorization options and their configuration
[ ] Update to debug.md to include looking for authorization errors when the SOCI performs worse than ahead-of-time pulls

Describe any alternative solutions/features you've considered

N/A

Any additional context or information about the feature request

#642 (reply in thread)

@Kern--
Copy link
Contributor Author

Kern-- commented Aug 28, 2024

This is done via #1237

@Kern-- Kern-- closed this as completed Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or request
Projects
Status: Done
Development

No branches or pull requests

1 participant