Add docs and tests for Transfer Service #2084
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AkihiroSuda
reviewed
Jul 16, 2025
docs/transfer.md
Outdated
|
|
||
| To use Stargz Snapshotter on containerd with enabling Transfer Service, additional configurations is needed. | ||
|
|
||
| ## When is Transfer Service enabled? |
There was a problem hiding this comment.
"When" sounds awkward here
Suggested change
| ## When is Transfer Service enabled? | |
| ## Availability of Transfer Service |
Anyway you can assume that the service is always available as containerd v1.6 will reach EOL soon
Signed-off-by: Kohei Tokunaga <[email protected]>
Signed-off-by: Kohei Tokunaga <[email protected]>
Signed-off-by: Kohei Tokunaga <[email protected]>
AkihiroSuda
approved these changes
Jul 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Transfer Service is enabled in CRI by default since containerd v2.1. However, when the CRI plugin finds
disable_snapshot_annotations = falsein containerd's config.toml, it doesn't enable Transfer Service and falls back to the traditional client-library-based pulling. (c.f. docs). So if user preservedisable_snapshot_annotations = falsein the config, the user can expect the traditional (non-Transfer-Service) behaviour without breaking lazy pulling behaviour.If the user wants to enable Transfer Service, additional configuration is needed and this commit adds a doc about it.
Tests are also added for continuously checking if stargz snapshotter works with enabling Transfer Service.