Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
soledad
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
leap
soledad
Commits
e6731dea
Verified
Commit
e6731dea
authored
7 years ago
by
Victor
Committed by
drebs
7 years ago
Browse files
Options
Downloads
Patches
Plain Diff
[doc] add stream format to docs
- Relates:
#9003
parent
e5ce16c7
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/reference/blobs/sync.rst
+43
-0
43 additions, 0 deletions
docs/reference/blobs/sync.rst
with
43 additions
and
0 deletions
docs/reference/blobs/sync.rst
+
43
−
0
View file @
e6731dea
...
...
@@ -78,3 +78,46 @@ increasing time interval to minimize competition for resources used by other
concurrent transfer attempts. The interaval starts at 10 seconds and increases
to 20, 30, 40, 50, and finally 60 seconds. All further retries will be
separated by a 60 seconds time interval.
Streaming
=========
Streaming is a method of synchronization optimized for small payloads, it
transfers multiple small blobs in a single stream of data. This method improves
resource usage, specially in scenarios which blobs are so small that opening
one connection for each would generate a noticeable overhead.
Downstream
----------
During download, client provides a list of blobs by POSTing a JSON formatted
list of Blob identifiers. Then the server starts producing a stream of data in
which each of the requested Blobs is written using the following format:
* Blob Size in hex (padded to 8 bytes)
* base64 encoded AES-GCM 16 byte tag
* Space (separator)
* Blob content
Upstream
--------
During upload, the client will produce a stream of Blobs in the following
format:
* First line: JSON encoded list of tuples with each Blob identifier and size.
Note that the size is the encrypted Blob size, which matches exactly what the
client is sending on the stream.
* Encrypted Blob content, for each Blob in the upstream list.
Server endpoint specification
-----------------------------
Endpoint: /stream/{user-uuid}/
Method: POST
Query parameters:
* namespace: Each stream can only stream for/from a single namespace, specified
on this POST query parameter.
* direction: 'upload' for upstream, 'download' for downstream.
This diff is collapsed.
Click to expand it.
drebs
@drebs
mentioned in merge request
!179 (closed)
·
7 years ago
mentioned in merge request
!179 (closed)
mentioned in merge request !179
Toggle commit list
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment