Project

Profile

Help

Story #4244

Convert manifest to schema1 when older clients are pulling by tag

Added by amacdona@redhat.com 12 months ago. Updated 13 days ago.

Status:
MODIFIED
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
% Done:

100%

Platform Release:
Blocks Release:
Target Release - Docker:
Backwards Incompatible:
No
Groomed:
No
Sprint Candidate:
No
Tags:
Pulp 3 docker blocker
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 61

Description

Problem:

When pulling newer format manifest by tag old clients are not supported.

Solution:

Rewrite available manifest to schema1 to support old clients.

Workflow:

Fetch the available manifest from the storage backend, if it exists. Parse incoming accept headers from client (client indicates support for certain manifest formats) and if necessary rewrite manifest when it is being fetched by tag. If it is being fetched by digest, conversion is not possible.

  • If available manifest is a manifest list - within the manifest list find the image manifest corresponding to the default platform and arch (amd64 platform and linux OS). If no suitable manifest is found in the manifest list, return a 404 error.
    If necessary( based on incoming accept headers), convert the image manifest to schema1. Invoke Schema1ManifestBuilder to create skeleton of schema1 format. Populate the builder with the data incoming from parsed image manifest schema2 json.
    Sign schema1 manifest with the provided signing key (in config). If no signing key is provided generate an ephemeral rsa key to be used for signing converted manifests.
  • If available manifest is a manifest schema2 , if necessary( based on incoming accept headers), convert the image manifest to schema1.
  • If available manifest is a manifest schema1, return as is.

Signed Manifest Field Description

Signed manifests include an image manifest and a list of signatures. A signature consists of the following fields:

header JOSE
A JSON Web Signature
signature string
A signature for the image manifest, signed by a private key
protected string
The signed protected header

Optional conversion

The conversion will be optional. There will be a boolean flag called for example 'schema_conversion` added as a parameter to the docker distribution [0] where its default value would be set to False.
Conversion would happen only if enabled.

[0] https://github.com/pulp/pulp_docker/blob/master/pulp_docker/app/models.py#L297
https://docs.docker.com/registry/spec/manifest-v2-2/#backward-

Opened questions:

Do we convert manifest schema2 if it had foreign layers?


Subtasks

Story #5635: Implement Schema 2 to Schema 1 converterMODIFIEDmihai.ibanescu@gmail.com

Actions

Related issues

Duplicates Docker Support - Issue #5146: Docker sync missing schema version 1 manifests CLOSED - DUPLICATE Actions

Associated revisions

Revision 42183b9c View on GitHub
Added by Lubos Mjachky 15 days ago

Execute implemented schema conversion from the registry

closes #4244
https://pulp.plan.io/issues/4244

Revision 42183b9c View on GitHub
Added by Lubos Mjachky 15 days ago

Execute implemented schema conversion from the registry

closes #4244
https://pulp.plan.io/issues/4244

History

#1 Updated by amacdona@redhat.com 12 months ago

  • Description updated (diff)

#2 Updated by amacdona@redhat.com 12 months ago

I think this affects the Tag view and the Manifest/ManifestList views.

#3 Updated by CodeHeeler 11 months ago

  • Triaged changed from No to Yes

#4 Updated by ipanova@redhat.com 7 months ago

  • Tags Pulp 3 added

#5 Updated by ipanova@redhat.com 7 months ago

  • Tracker changed from Issue to Story
  • Subject changed from Support old (v2s2) clients that do not support manifest lists to Support old clients that do not support v2s2
  • Description updated (diff)
  • % Done set to 0

#6 Updated by ipanova@redhat.com 7 months ago

  • Description updated (diff)

#7 Updated by ipanova@redhat.com 7 months ago

  • Description updated (diff)

#8 Updated by ipanova@redhat.com 7 months ago

  • Subject changed from Support old clients that do not support v2s2 to Support old clients that do not support v2s2 when pulling by tag
  • Description updated (diff)

#9 Updated by bmbouter 7 months ago

  • Tags deleted (Pulp 3)

#10 Updated by ipanova@redhat.com 7 months ago

  • Description updated (diff)

#11 Updated by ipanova@redhat.com 7 months ago

Shall we make this conversion optional? we could introduce a flag to the docker distribution where its default value would be set to False.
Conversion would happen only if enabled.

#12 Updated by ipanova@redhat.com 7 months ago

  • Description updated (diff)

#13 Updated by ipanova@redhat.com 7 months ago

  • Description updated (diff)

#14 Updated by ipanova@redhat.com 7 months ago

  • Description updated (diff)

#15 Updated by ipanova@redhat.com 4 months ago

  • Duplicates Issue #5146: Docker sync missing schema version 1 manifests added

#16 Updated by ipanova@redhat.com 4 months ago

  • Description updated (diff)

#17 Updated by ipanova@redhat.com 4 months ago

  • Subject changed from Support old clients that do not support v2s2 when pulling by tag to Convert manifest to schema1 when older clients are pulling by tag

#18 Updated by ipanova@redhat.com 4 months ago

  • Description updated (diff)

#19 Updated by ipanova@redhat.com 4 months ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to ipanova@redhat.com

#20 Updated by ipanova@redhat.com 4 months ago

  • Sprint set to Sprint 56

#21 Updated by rchan 4 months ago

  • Sprint changed from Sprint 56 to Sprint 57

#22 Updated by ipanova@redhat.com 3 months ago

  • Status changed from ASSIGNED to NEW

#23 Updated by rchan 3 months ago

  • Sprint changed from Sprint 57 to Sprint 58

#24 Updated by ipanova@redhat.com 3 months ago

  • Sprint deleted (Sprint 58)

#25 Updated by ipanova@redhat.com about 2 months ago

  • Tags Pulp 3 docker blocker added

#26 Updated by ipanova@redhat.com about 2 months ago

  • Assignee deleted (ipanova@redhat.com)

#27 Updated by ipanova@redhat.com 26 days ago

  • Sprint set to Sprint 61

#29 Updated by lmjachky 15 days ago

  • Status changed from NEW to POST
  • Assignee set to lmjachky

#30 Updated by Anonymous 13 days ago

  • Status changed from POST to MODIFIED

Please register to edit this issue

Also available in: Atom PDF