Project

Profile

Help

Pulp Container Roadmap » History » Sprint/Milestone 28

ipanova@redhat.com, 08/26/2019 02:26 PM

1 1 ipanova@redhat.com
# Pulp Docker Roadmap
2 2 ipanova@redhat.com
3
~~~
4
This is a living document that is moving towards a long term plan to develop Docker plugin for Pulp 3.0 and beyond.
5
~~~
6 1 ipanova@redhat.com
7 18 ipanova@redhat.com
~~~
8
With Pulp as a docker registry you can:
9
10
- Mirror container image repositories hosted on Docker-hub, Google Container Registry, Quay.io, etc
11
- Reduce disk use space by mirroring container image repositories using the "on demand" policy. An image is only downloaded once it has been requested by a client.
12
- Use local filesystem or an object storage store such as S3 to host all the container images.
13
- Curate container images by whitelisting what is mirrored from an external repository.
14
- Curate container images by creating repository versions with a specific set of images.
15
- Create versioned repositories that can be promoted or rolled back with a single operation.
16
17
Pulp also has:
18
- tasking system that can be used to perform a variety of specialized work such as analysis of content. e.g. integration with clair-scanner
19
- a large community of users
20
- a commuity of plugin developers
21
~~~
22
23 22 ipanova@redhat.com
<span style="color: #458b74;">green</span>
24 1 ipanova@redhat.com
25
### MVP
26
27 22 ipanova@redhat.com
## Supported Content Types
28
29 16 ipanova@redhat.com
  - <span style="color: #458b74;">Image manifest schema2 and schema1</span>
30
  - {color: #458b74} Manifest list
31
  - {color: #458b74} Blob
32
  - {color: #458b74} Tag
33 2 ipanova@redhat.com
34 1 ipanova@redhat.com
## Pulp Docker Plugin Use Cases
35
36
### MVP
37
38 2 ipanova@redhat.com
##### Sync
39 8 ipanova@redhat.com
40 16 ipanova@redhat.com
  - <span style="color: #458b74;">As a user I can sync docker repo from docker registry</span>
41 1 ipanova@redhat.com
42
<!-- end list -->
43 8 ipanova@redhat.com
44 16 ipanova@redhat.com
  - {color: #458b74} assumes registry is compliant v2 api specs
45
  - {color: #458b74} with token based auth
46 21 ipanova@redhat.com
  - {color: #458b74} with basic auth
47 16 ipanova@redhat.com
  - {color: #458b74} specify \`feed\` and \`upstream_name\`
48 8 ipanova@redhat.com
49
<!-- end list -->
50 1 ipanova@redhat.com
51 19 ipanova@redhat.com
  - {color: #458b74} As a user I can sync a registry by whitelisting tags ( Filtered Sync)
52
  - {color: #458b74} As a user i can lazily fetch docker repo by specifying the download policy
53 23 ipanova@redhat.com
  - {color: #458b74} As a user I can sync a private docker repo from docker registry
54
  - {color: #458b74} As a user I can sync from a docker repo published by Pulp ( pulp2pulp3 and pulp3pulp3 sync)
55 17 ipanova@redhat.com
  - {color: #458b74} As a user, I can mirror the content of a remote repository with an additive behaviour, so content is never removed locally.
56 19 ipanova@redhat.com
  - As a user I can validate the size and the checksum of downloaded content against metadata ( #2625 #2624)
57 1 ipanova@redhat.com
58
**NOTE**: dropping enable_v1, enable_v2, mask_id options
59
60 8 ipanova@redhat.com
##### Publish
61
62 16 ipanova@redhat.com
  - {color: #458b74} As a user I can distribute docker content
63
  - {color: #458b74} As a user, I can specify publish_directory( i.e base_path) from which the content will be served( provided by pulp_core)
64 28 ipanova@redhat.com
  - As a user, I can specify base_path that will be used in the docker registry
65 13 ipanova@redhat.com
  - As a user i can specify redirect-url which will lead to the location the content is stored
66 1 ipanova@redhat.com
  - As a user I can specify whether i want to convert docker image schema2 to schema1( aka schema convertor, for older clients support)
67 25 ipanova@redhat.com
  - As a user I cam pull from docker registry that has auth mechanish  
68 28 ipanova@redhat.com
    \*token auth
69 8 ipanova@redhat.com
70 1 ipanova@redhat.com
As a result the above section should enable clients to perform \`docker/podman pull\`
71
72 21 ipanova@redhat.com
**NOTE** dropping protected option
73 1 ipanova@redhat.com
74 21 ipanova@redhat.com
##### Filtering
75
76 22 ipanova@redhat.com
  - {color: #458b74} As a user I can filter tags and images by digest, media_type, tag_name
77 21 ipanova@redhat.com
78 1 ipanova@redhat.com
##### Addition of the content to the repo with deps
79
80 25 ipanova@redhat.com
  - <span style="color: #458b74;">As a user I can add Manifest and all Blobs it references to the destination repo</span>
81
  - <span style="color: #458b74;">As a user I can add Manifest List and all Manifests and Blobs it references to the destination repo</span>
82
  - <span style="color: #458b74;">As a user I can add Tag and all its' associated content it references to the destination repo</span>
83 1 ipanova@redhat.com
84 21 ipanova@redhat.com
##### Removal of the content from the repo with deps
85 1 ipanova@redhat.com
86 21 ipanova@redhat.com
  - As a user I can remove Manifest and all Blobs it references from the repo
87
  - As a user I can remove Manifest List and all Manifests and Blobs it references from the repo
88
  - As a user I can remove Tag and all its' associated content it references from the repo
89
90
**NOTE** units that are referenced by other units are not removed, unless force flag is specified
91
92
##### Force removal of the content from the repo with deps
93
94
  - As a user I can remove Manifest and all Blobs it references from the repo
95
  - As a user I can remove Manifest List and all Manifests and Blobs it references from the repo
96
  - As a user I can remove Tag and all its' associated content it references from the repo
97
98
##### Copy of the content form source repo to the dest repo with deps
99
100 27 ipanova@redhat.com
  - {color: #458b74} As a user I can copy by digest, media_type Manifest and all Blobs it references from the source repo to the destination repo
101
  - {color: #458b74} As a user I can copy by digest , media_type Manifest List and all Manifests and Blobs it references from the source repo to the destination repo
102
  - {color: #458b74} As a user I can copy Tag by name and all its' associated content it references from the source repo to the destination repo
103 21 ipanova@redhat.com
104
##### Adding/removing Tag via pulp api
105
106 25 ipanova@redhat.com
  - <span style="color: #458b74;">As a user I can Tag an imagine in a repo</span>
107
  - <span style="color: #458b74;">As a user I can Untag an imagine in a repo</span>
108
  - <span style="color: #458b74;">As a user I can point existing Tag to a different image in a repo</span>
109 21 ipanova@redhat.com
110 1 ipanova@redhat.com
### Post-MVP 4.1+
111
112
##### Sync
113
114
  - As a user, I can sync from a repository with Forein Layers and save them in pulp for disconnected env.
115
  - As a user, I can exactly mirror the content of a remote repository( mirror on sync)
116 28 ipanova@redhat.com
117
##### Publish
118
119
  - As a user I cam pull from docker registry that has auth mechanish  
120
    \*basic auth
121 21 ipanova@redhat.com
122 26 ipanova@redhat.com
##### Export
123 21 ipanova@redhat.com
124 1 ipanova@redhat.com
  - As a user I can distribute docker content using a remote server ( rsync exporter)
125
126 25 ipanova@redhat.com
##### Docker push
127 16 ipanova@redhat.com
128 25 ipanova@redhat.com
  - As a user, I can 'docker push' to a Pulp repository
129
  - As a user I can 'docker tag' to a Pulp repository
130
131
##### Skopeo copy
132
133
  - As a user I can use skopeo pulp transport to push images to Pulp container registry
134 16 ipanova@redhat.com
135 1 ipanova@redhat.com
##### Enable v2/catalog endpoint
136 10 ipanova@redhat.com
137 13 ipanova@redhat.com
##### Custom Live API (4.1+))
138 11 ipanova@redhat.com
139 7 ipanova@redhat.com
  - some dedicated storage for the metadata files ( remove the need of in-memory database)
140 13 ipanova@redhat.com
  - enable docker push functionality or provide this as a separate plugin/package
141 8 ipanova@redhat.com
142 3 ipanova@redhat.com
## What will be dropped in Pulp3
143 1 ipanova@redhat.com
144 2 ipanova@redhat.com
  - v1 API support. In Pulp3 we'll have just v2 api registry and corresponding v2 content types
145
  - v1/search. There is no v2/search so \`docker search\` for v2 content will not work. If upstream docker will add support for v2 docker content search by the time we deliver docker plugin for pulp3 we will reconsider and include the endpoint.
146 1 ipanova@redhat.com
  - content protection. In Pulp3 docker repos will not support entitlement cert protection. ( option \`protected\` is dropped)
147 7 ipanova@redhat.com
  - export content into a tar file. It was possible to do so for v1 content.
148 13 ipanova@redhat.com
  - Crane is not longer used as a registry API. Pulp 3's ability to serve custom live APIs has made it possible for Crane's feature set to be incorporated into the pulp_docker plugin