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.

Sign up for GitHub

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

Jump to bottom

Document manifest size limit recommendation #293

Merged
merged 1 commit into from
Feb 17, 2022
Merged

Document manifest size limit recommendation #293

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,10 @@ The `<location>` is a pullable manifest URL.

An attempt to pull a nonexistent repository MUST return response code `404 Not Found`

A registry SHOULD enforce some limit on the maximum manifest size that it can accept.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is recommended for public registries, I can see a case for private registries not wanting to implement this.

Suggested change
A registry SHOULD enforce some limit on the maximum manifest size that it can accept.
A registry MAY enforce limits on the maximum manifest size that it can accept.

A registry that enforces this limit SHOULD respond to a request to push a manifest over this limit with a response code `413 Payload Too Large`.
Client and registry implementations SHOULD expect to be able to support manifest pushes of at least 4 megabytes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest splitting this into two lines, one for clients, and one for registries:

Suggested change
Client and registry implementations SHOULD expect to be able to support manifest pushes of at least 4 megabytes.
A registry that implementations this SHOULD support manifest pushes of at least 4 megabytes.
A client SHOULD avoiding pushing a manifest larger than 4 megabytes and SHOULD support pulling a manifest of at least 4 megabytes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe something like:

Registries SHOULD NOT impose a limit less than 4 megabytes on the size of a manifest.
Clients SHOULD support handling manifest sizes of at least 4 megabytes.
Clients concerned with portability SHOULD NOT generate manifests larger than 4 megabytes.

FWIW, if quay has a 1MB limit, I would lean toward 1MB as the recommendation.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The wording from @jonjohnsonjr is more clear.


#### Content Discovery

Currently, the only functionality provided by this workflow is the ability to discover tags.
Expand Down