github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Add transfer docs

Browse Source 
Signed-off-by: Derek McGowan <derek@mcg.dev>
This commit is contained in:
Derek McGowan 2022-08-23 12:58:40 -07:00
parent cd67a98ec7
commit b0f519703d
No known key found for this signature in database
GPG Key ID: F58C5D0A4405ACDB
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/transfer.md Normal file
View File

@ -0,0 +1,31 @@
# Transfer Service
The transfer service is a simple flexible service which can be used to transfer artifact objects between a source and destination. The flexible API allows each implementation of the transfer interface to determines whether the transfer between the source and destination is possible. This allows new functionality to be added directly by implementations without versioning the API or requiring other implementations to handle an interface change.
The transfer service is built upon the core ideas put forth by the libchan project, that an API with binary streams and data channels as first class objects is more flexible and opens a wider variety of use cases without requiring constant protocol and API updates. To accomplish this, the transfer service makes use of the streaming service to allow binary and object streams to be accessible by transfer objects even when using grpc and ttrpc.
## Transfer Objects (Sources and Destinations)
## Transfer Operations
| Source | Destination | Description |
|-------------|-------------|-------------|
| Registry | Image Store | "pull" |
| Image Store | Registry | "push" |
| Object stream (Archive) | Image Store | "import" |
| Image Store | Object stream (Archive) | "export" |
| Object stream (Layer) | Mount/Snapshot | "unpack" |
| Mount/Snapshot | Object stream (Layer) | "diff" |
| Image Store | Image Store | "tag" |
| Registry | Registry | mirror registry image |
### Local containerd daemon support
## Streaming Protocols
### Progress
### Binary Streams
### Credential Passing