Project

Profile

Help

Pulp 3 Minimum Viable Product » History » Sprint/Milestone 29

bmbouter, 05/02/2017 06:46 PM
Posting results of the "Upload & Copy" MVP call

1 1 bmbouter
# Pulp 3.0.0 Minimum Viable Product (MVP)
2
3 21 bmbouter
<span style="color:red;">Lines highlighted in red need more attention.</span>
4 20 bmbouter
5 1 bmbouter
## Authentication
6
7 17 semyers
As an authenticated user I can manage user(s).
8
9
  - Add a user
10
  - View user(s)
11
  - Update any user detail
12
  - Delete a user
13
14
As an API user, I can have documentation to generate a JSON Web Token (JWT) without the server being online.
15
16
A user authenticated with HTTP/HTTPS "Basic" auth can acquire a non-expiring JWT to access the API.
17
18
  - The JWT shall have a created timestamp which can be used to invalidate
19
  - The JWT shall have a user identifier (its primary key)
20
21
I can authenticate to any API call using HTTP/HTTPS "Basic" auth with a username and password that Pulp stores.
22
23
  - The password is stored as a hash (for security).
24
25
As an API user, I can authenticate any API call with a JWT.
26
27
As an API user, I can invalidate all JWT tokens for a given user issued earlier than now.
28
29
As an authenticated user, when deleting a user 'foo', all of user 'foo's JWTs are invalidated.
30 1 bmbouter
31
## Repositories
32
33 18 dkliban@redhat.com
As an authenticated user, I can list all repos.
34
35
  - All fields are included
36
  - Pagination is supported
37 22 bmbouter
  - <span style="color:red;">Filtering support</span>
38 18 dkliban@redhat.com
39
As an authenticated user, I can CRUD a repository
40
41
  - Create a repo
42
  - Read a repo
43
  - Update all mutable repo fields
44 21 bmbouter
  - Delete a repo (asynchronous)
45 18 dkliban@redhat.com
46
As an authenticated user, I can list a repository's associated importers and publishers
47
48
  - All fields are included
49
  - Pagination is supported
50 22 bmbouter
  - <span style="color:red;">Filtering support</span>
51 18 dkliban@redhat.com
52
As an authenticated user, I can list content in a repository
53
54
  - All fields are included
55
  - Pagination is supported
56 22 bmbouter
  - <span style="color:red;">Filtering support</span>
57 1 bmbouter
58 20 bmbouter
<span style="color:red;">As an authenticated user, I can summarize content in a repo (including counts)</span>
59 18 dkliban@redhat.com
60
As an authenticated user, I can CRUD an importer
61
62
  - Create an importer
63
  - Read an importer
64
  - Update all mutable importer fields
65 21 bmbouter
  - Delete an importer (asynchronous)
66 18 dkliban@redhat.com
67
As an authenticated user, I can CRUD a publisher
68
69
  - Create a publisher
70
  - Read a publisher
71
  - Update all mutable publisher fields
72 21 bmbouter
  - Delete a publisher (asynchronous)
73 1 bmbouter
74
## Content Manipulation
75
76 19 bmbouter
As an authenticated user, I can trigger an importer to sync.
77
78
  - I can follow the progress of all syncs. (Syncs are asynchronous.)
79
  - I cannot pass "sync" options.
80
  - Auto-publish is not included as an importer property.
81
82
As an authenticated user, I can trigger a publisher to publish.
83
84
  - I can follow the progress of all publishes. (Publishes are asynchronous.)
85
  - I cannot pass "publish" options.
86
87 25 bmbouter
## Upload & Copy
88
89 29 bmbouter
<span style="color:red;">As an authenticated user, I can upload a file and track it with a file UUID I provide.</span>
90 19 bmbouter
91 29 bmbouter
<span style="color:red;">As an authenticated user, I can upload a file in parallel by providing the file UUID, a chunk size, and offset.</span>
92 19 bmbouter
93 29 bmbouter
<span style="color:red;">During our meeting, we talked about deduplication. We don't have time to discuss this, but I want to point out that modern filesystems like BTRFS and ZFS can perform deduplication for you. -Jeremy</span>
94 1 bmbouter
95 29 bmbouter
<span style="color:red;">As an authenticated user, I can rely on Pulp to auto-delete uploaded files after 6 hours.</span>{color:red}%{color:red}As a user, I can delete an uploaded file by file UUID%
96 1 bmbouter
97 29 bmbouter
<span style="color:red;">As an authenticated user, I can upload a file used to create an artifact associated with the content unit created as part of an upload transaction.</span>  
98
<span style="color:red;">As an authenticated user, I can discard an upload transaction.</span>  
99
<span style="color:red;">As an authenticated user, I can commit an upload transaction.</span>  
100
<span style="color:red;">As an authenticated user, I can associate a content unit created using an upload transaction with a repository.</span>
101
102
%{color:red}As an authenticated user, I can create a unit based on uploaded files by specifying the unit type, metadata, and 0, 1, or more uploaded files by file UUID%{color:red}
103
104
<span style="color:red;">As an authenticated user, I can associate a unit with a repo.</span>
105
106
<span style="color:red;">As an authenticated user, I can copy a unit(s) from one repo to another</span>  
107
<span style="color:red;">\* Filtering support for specifying the unit(s)</span>  
108
<span style="color:red;">\* I can follow the progress of all copies. (Copies are asynchronous.)</span>
109 25 bmbouter
110
## Orphans
111 1 bmbouter
112 20 bmbouter
<span style="color:red;">As an authenticated user, I can clean up orphans</span>  
113
<span style="color:red;">\* I can follow the progress of all cleanups. (Cleanups are asynchronous.)</span>
114 1 bmbouter
115
## Filter
116
117
I can filter all nouns *(What is the meaning of "filter?" What is a noun?)*
118
119
## Task Management
120
121 22 bmbouter
As an authenticated user, I can list all tasks
122
123
  - Filtering support on \['state', 'id', 'group'\]
124
  - This does not include associated progress reports
125
126
As an authenticated user, I can see a detail view for a specific task
127
128
  - all attributes of a task
129
  - all associated progress reports
130
131
As an authenticated user, I can cancel a task
132
133
  - don't dare to use the DELETE verb!
134 1 bmbouter
135
## Task Group
136
137
I can view a summary of the status of all tasks in a group
138
139
## Event Listener Notifier
140
141
I can receive serialized task info via AMQP on each task save
142
143 12 Ichimonji10
*Can this be restated in more pedantic terms? Does this mean that an arbitrary host can attach itself to Pulp's AMQP message bus and get updates on the progress of tasks?*
144
145 1 bmbouter
## Status
146
147
I can view the status of all pulp components  
148
I can view an overall health attribute  
149
I can view information about unapplied migrations
150
151
## Plugin API
152
153 28 bmbouter
As a plugin writer, I have a plugin API that is semantically versioned at 0.x separate from the REST API
154 1 bmbouter
155 28 bmbouter
As a plugin writer, I can report progress with a message and state
156 1 bmbouter
157 28 bmbouter
As a plugin writer, I can report progress with an optional suffix
158
159
As a plugin writer, I can report progress with a total count of things to do an the current count of things done
160
161
As a plugin writer, non-fatal exceptions a on the Task and are included in the Task detail. non_fatal exceptions do not cause the Task to be marked as failed, but may be interpreted by the user as not fully successful.
162
163
As a plugin writer, the working directory is set before Task work is done and cleaned up afterwards. I should not need to interact with the file system outside of the working dir.
164
165
As a plugin writer, I can provide a subclassed Importer. The importer's responsibility is to synchronize the content of a Pulp repository with the content of a remote repository.
166
167
As a plugin writer, I can provide a subclassed Publisher. The publisher's responsibility is to publish content.
168
169
As a plugin writer, I can define unit types by subclassing Content models to provide concrete content unit types to be manged by the platform.
170
171
As a plugin writer, I can interact with and create Artifacts
172
173
As a plugin writer, my app will be discovered by Pulp's app via an entry point provided by the plugin writer
174
175
As a plugin writer, I can use the plugin API to query content units/artifacts associated with a repository.
176
177
As a plugin writer, I can assocate/disassociate content units with a repository.
178 6 Ichimonji10
179 1 bmbouter
## CLI
180
181 8 Ichimonji10
We will port what is there with as little effort as possible *(Does this mean that porting will be easy for developers, or that switching from the Pulp 2-3 CLI will be easy for users? If the former, isn't this an implementation detail that doesn't belong in an MVP document? If the latter, does this mean that we're going to carry forward the issues with pulp-admin, like a lack of status codes?)*
182
183 1 bmbouter
repo CRUD  
184
CRUD for importers  
185
CRUD for publishers  
186
trigger syncs  
187
trigger publish  
188
list content in a repo  
189
upload  
190
server status  
191
list and cancel tasks  
192 8 Ichimonji10
authn via basic auth  
193
*(Should the supported set of operations be stated in terms of "The capabilities listed in the 'Authenctication,' 'Repositories,' and 'Filter' sections will be supported by the CLI."?)*
194 1 bmbouter
195 24 bmbouter
## Download API
196 1 bmbouter
197 26 bmbouter
As a plugin writer, I can download files via
198
199
  - http://
200
  - https://
201
  - file://
202
203
As a plugin writer, I can configure a downloader with:
204
205
  - Basic Auth
206 27 bmbouter
  - SSL Cert Client Auth
207
  - Custom CAs will be configured via a "trust store" either on the system or similar. Pulp will not do anything to read/load/manage CAs directly.
208 26 bmbouter
209
As a plugin writer, I can provide arbitrary behaviors for customized downloaders
210
211
  - For example token authentication in the docker plugin
212
213
As a plugin writer, I can have connection pooling/reuse
214
215
As a plugin writer, I have proxy settings
216
217
  - proxy url (containing basic auth info)
218
219
As a plugin writer, I can have great logs
220
221
As a user, I have documentation about how to use something for bandwidth limiting
222
223
As a plugin writer, I can configure the validation mechanisms used at download time
224
225
  - checksum validation - minimum (md5, sha1, sha256, sha512)
226
  - size validation
227
228
<span style="color:red;">As a plugin writer, I expect units that are missing from the remote repository to not be created in Pulp when using the immediate download policy.</span>
229
230
<span style="color:red;">As a plugin writer, I expect units that are missing from the remote repository to be created in Pulp when using background or on_demand download policies.</span>
231
232
As a plugin writer I can configure mirror lists and rotate between the mirrors
233
234
  - round robin
235
  - nearest mirror support
236
237
As a plugin writer, the plugin API provides tooling whereby I can provide the content to be added and removed from the repository. This tooling supports both immediate and deferred downloading.
238
239
As a plugin writer I can manage the catalog by using ChangeSets
240
241 1 bmbouter
As a plugin writer, the plugin can participate in adding content for cases where the decision to add additional content is based content that has been downloaded.
242 26 bmbouter
243 27 bmbouter
As a plugin writer, I can fetch content myself (but I am not encouraged to do so) with code I write
244 26 bmbouter
245
As a plugin writer, I can CRUD content units
246
247
## Alternate Content Source Support
248
249
<span class="Etc? Python? RPM? this? support will importers of types which things, importer-related an is this Assuming else? Something locations? of list prioritized a from content download to attempt may importer single a that mean it Does file://? and HTTPS HTTP, than other protocol a via downloaded be can content that mean this Does means. this what clarify Please" style="color:red;"></span>
250
251
  - Streamer parity with 2.y
252 1 bmbouter
253
## Consumer Applicability
254
255
Using consumer profiles and repo bindings I can compute applicability with 2.y parity  
256
Performance needs to be awesome
257
258 11 Ichimonji10
*(Is the Pulp Consumer going away in Pulp 3? If so, is this section still appropriate?)*
259
260 1 bmbouter
## Plugin compatibility
261
262
rpm will work with platform  
263
puppet will work with platform  
264
ostree will work with platform  
265
python will work with platform  
266
file_plugin will work with platform  
267
docker will work with platform
268
269
## Migrations
270
271
users can run an executable similar to pulp-manage-db that is not named pulp-manage-db *(Why the change in name?)*
272 20 bmbouter
273
<span style="color:red;">What about migrating fields that we don't use in 3.0 but will use in 3.1+. For example the auto-publish feature?</span>