Project

Profile

Help

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

bmbouter, 10/09/2017 08:57 PM

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 37 bmbouter
## Overall Guarantees
6
7 57 mhrivnak
  - This is not a direct replacement for Pulp 2.
8
  - This is the minimum required for a 3.0.0 beta and GA.
9
  - All REST API calls will update the DB using transactions as necessary to ensure data integrity.
10 37 bmbouter
11 59 bmbouter
## Legend
12
13
\[done\] means merged and documented  
14
\[in-progress\] means started but not fully done  
15
If there is no label the effort has not yet been started
16
17 1 bmbouter
## Authentication
18
19 59 bmbouter
As an authenticated user I can manage user(s). \[done\]
20 17 semyers
21
  - Add a user
22
  - View user(s)
23 58 mhrivnak
  - Update any user detail
24 1 bmbouter
  - Delete a user
25
26 59 bmbouter
As an API user, I can have documentation to generate a JSON Web Token (JWT) without the server being online. \[done\]
27 1 bmbouter
28 59 bmbouter
As an administrator, I can disable JWT token expiration. This configuration is in the settings file and is system-wide. \[done\]
29 1 bmbouter
30 59 bmbouter
As an administrator, I can configure the JWT tokens to expire after a configurable amount of time. This configuration is in the settings file and is system-wide. \[done\]
31 1 bmbouter
32 59 bmbouter
The JWT shall have a username identifier \[done\]
33 1 bmbouter
34 59 bmbouter
<span style="color:red;">As an API user, I can authenticate any API call (except to request a JWT) with a JWT. (not certain if this should be the behavior) \[in progress\]</span>
35 17 semyers
36 59 bmbouter
As an API user, I can invalidate all existing JWT tokens for a given user. \[done\]
37 17 semyers
38 59 bmbouter
As an authenticated user, when deleting a user 'foo', all of user 'foo's existing JWTs are invalidated. \[done\]
39 17 semyers
40 59 bmbouter
As an autheticated user, I can invalidate a user's JWTs in the same operation as updating the password. \[done\]
41 45 bmbouter
42 59 bmbouter
As an un-authenticated user, I can obtain a JWT token by using a username and password. \[done\]
43 1 bmbouter
44
## Repositories
45
46 18 dkliban@redhat.com
As an authenticated user, I can list all repos.
47
48 60 bmbouter
  - All fields are included \[done\]
49
  - Pagination is supported \[done\]
50 22 bmbouter
  - <span style="color:red;">Filtering support</span>
51 18 dkliban@redhat.com
52
As an authenticated user, I can CRUD a repository
53
54 60 bmbouter
  - Create a repo \[done\]
55
  - Read a repo \[done\]
56
  - Update all mutable repo fields \[done\]
57
  - Delete a repo (asynchronous) \[done\]
58 18 dkliban@redhat.com
59
As an authenticated user, I can list a repository's associated importers and publishers
60
61 60 bmbouter
  - All fields are included \[done\]
62
  - Pagination is supported \[done\]
63 22 bmbouter
  - <span style="color:red;">Filtering support</span>
64 18 dkliban@redhat.com
65 60 bmbouter
As an authenticated user, I can see the number of content unit types with counts for each
66 18 dkliban@redhat.com
67 51 bmbouter
## Importers
68
69
note: Importer attributes will commonly be available on importers, but aren't guaranteed to be used by all importers.
70
71 18 dkliban@redhat.com
As an authenticated user, I can CRUD an importer
72
73
  - Create an importer
74
  - Read an importer
75
  - Update all mutable importer fields
76 21 bmbouter
  - Delete an importer (asynchronous)
77 18 dkliban@redhat.com
78 50 bmbouter
As an authenticated user I can configure the following attributes on an Importer:
79 47 bmbouter
80 48 amacdona@redhat.com
  - validate (bool) \[optional: defaults to True\]: If true, the plugin will validate imported content.
81
  - ssl_ca_certificate (str) \[optional\] String containing a PEM encoded CA certificate used to validate the server certificate presented by the external source.
82
  - ssl_client_certificate (str) \[optional\] Contains a PEM encoded client certificate used for authentication.
83
  - ssl_client_key (str) \[optional\] Contains a PEM encoded private key used for authentication.
84
  - ssl_validation (bool) \[optional: defaults to True\]: If true, SSL peer validation must be performed.
85
  - proxy_url (str) \[optional\] Contains the proxy URL. Format: scheme://user:password@host:port.
86
  - username (str) \[optional\] Contains the username to be used for authentication when syncing.
87 1 bmbouter
  - password (str) \[optional\] Contains the password to be used for authentication when syncing.
88 50 bmbouter
  - download_policy (str) \[optional\] Contains the downloading policy name. This is a choice of three options:  
89
    \- immediate (default) - Downloading occurs during sync. The sync task does not complete until downloading is done.  
90
    \- background - Downloading is started by the sync but occurs in the background. The sync task completes before downloading is complete.  
91
    \- on-demand - The sync task records everything that would be downloaded but does not download content. Downloading occurs on demand as driven by client requests for content.
92 1 bmbouter
  - feed_url (str) \[optional\] Contains the URL of an external content source. This is optional.
93 50 bmbouter
  - sync mode: (str) \[optional\]. It has two choices 'additive' and 'mirror':  
94
    \- additive (default) - all remote content is added to the local repository on sync. During sync no content is removed from the local repository.  
95
    \- mirror - the local content will mirror the remote content exactly, removing local content if not also present in the remote content.
96
  - name (str) \[required\] Contains the name.
97
  - last_updated (datetime) \[read-only\] Contains the datetime of the last importer update.
98 55 bmbouter
  - last_synced (datetime) \[read-only\] Contains the datetime of the last importer sync.
99 53 bmbouter
  - <span style="color:red;">max_count (int) - ???</span>
100 51 bmbouter
101 52 bmbouter
## Publishers
102 51 bmbouter
103
note: Publisher attributes will commonly be available on publishers, but aren't guaranteed to be used by all publishers.
104 47 bmbouter
105 18 dkliban@redhat.com
As an authenticated user, I can CRUD a publisher
106
107
  - Create a publisher
108
  - Read a publisher
109 1 bmbouter
  - Update all mutable publisher fields
110
  - Delete a publisher (asynchronous)
111 50 bmbouter
112
As an authenticated user I can configure the following attributes on a Publisher:
113
114
  - relative_path (str) \[optional\] The (relative) path component of the published url.
115
  - name - (str) \[required\] contains the name.
116
  - last_published (datetime) \[read-only\] When the last successful publish occurred.
117
  - last_updated (datetime) \[read-only\] The datetime of the last publisher update.
118 56 ttereshc
  - <span style="color:red;">auto_publish(bool) - ??? consider adding auto-publish feature to MVP</span>
119 1 bmbouter
120
## Content Manipulation
121
122 19 bmbouter
As an authenticated user, I can trigger an importer to sync.
123
124
  - I can follow the progress of all syncs. (Syncs are asynchronous.)
125
  - I cannot pass "sync" options.
126
  - Auto-publish is not included as an importer property.
127
128
As an authenticated user, I can trigger a publisher to publish.
129
130
  - I can follow the progress of all publishes. (Publishes are asynchronous.)
131
  - I cannot pass "publish" options.
132
133 25 bmbouter
## Upload & Copy
134
135 32 bmbouter
#### Getting bits from the client to Pulp
136
137 35 bmbouter
As an authenticated user, I can request a file ID from the server to upload a file with
138 19 bmbouter
139 35 bmbouter
As an authenticated user, I can upload a file with the server provided file ID, an optional chunk size, and an optional offset.
140 19 bmbouter
141 35 bmbouter
As an authenticated user, I can rely on Pulp to auto-delete uploaded files after a configurable time. (Eg: 6 hours).
142 30 bmbouter
143 35 bmbouter
As a user, I can delete an uploaded file by file ID
144 30 bmbouter
145 1 bmbouter
#### Creating Artifacts and Content Units
146 35 bmbouter
147 29 bmbouter
As a user, I can reference a file ID at Artifact creation time.
148 1 bmbouter
149 37 bmbouter
As an authenticated user, I can create a content unit by providing the content type, its Artifacts using file upload IDs for each Artifact, and the metadata supplied in the POST body. This call is atomic, either all Artifacts and the content unit are created in the database and on the filesystem or none are.
150 31 bmbouter
151 1 bmbouter
As an authenticated user, I can reuse a file ID to create multiple Artifacts without uploading the file twice.
152
153 37 bmbouter
#### Unit Management / Copy
154 29 bmbouter
155 41 jortel@redhat.com
As an authenticated user, I can add and remove one or more units to and from a destination repo.
156 1 bmbouter
157
  - <span style="color:red;">Filtering support for specifying the unit(s)</span>
158 41 jortel@redhat.com
  - I can follow the progress. (adding and removing are asynchronous).
159 1 bmbouter
160
## Versioned Repositories
161
162 40 bmbouter
As an authenticated user, I can list the content in a particular repository version
163
164
  - All fields are included
165
  - Pagination is supported
166
  - <span style="color:red;">Filtering support</span>
167
168
As an authenticated user, I can discover a URL to the latest version of a repository  
169
<span class="resource repository the on attributes or endpoint, API dedicated a through \^ Is" style="color:red;"></span>
170
171
As an authenticated user, I can run a publisher without a repository version and have it default to the latest version.
172
173
<span style="color:red;">As an authenticated user, I can delete a repository version by specifying the version</span>
174
175
<span style="color:red;">As an authenticated user, I can upload multiple content(s?) and add create a single new version that adds all of them.</span>
176 1 bmbouter
177 20 bmbouter
## Orphans
178
179 43 bmbouter
<span style="color:red;">As an authenticated user, I can clean up orphaned content units</span>  
180 1 bmbouter
<span style="color:red;">\* I can follow the progress of all cleanups. (Cleanups are asynchronous.)</span>
181 43 bmbouter
182
<span style="color:red;">As an authenticated user, I can delete a specific content unit</span>  
183
<span style="color:red;">\* If the content unit is still in at least one repository the delete fails with a listing of all repositories the unit is part of.</span>  
184
<span style="color:red;">\* Artifacts and associated files from the deleted unit are cleaned up</span>
185
186
<span style="color:red;">As an authenticated user, I can delete multiple content units with filtering</span>  
187
<span style="color:red;">\* If a content unit is still in at least one repository the delete fails with a listing of all repositories the unit is part of.</span>  
188
<span style="color:red;">\* Artifacts and associated files from deleted units are cleaned up</span>
189
190
<span style="color:red;">As an authenticated user, I see all (orphans) units that are not in any repositories</span>
191 1 bmbouter
192
## Filter
193
194 44 bmbouter
<span style="color:red;">I can filter all nouns *(What is the meaning of "filter?" What is a noun?)*</span>
195 1 bmbouter
196 22 bmbouter
## Task Management
197
198
As an authenticated user, I can list all tasks
199
200
  - Filtering support on \['state', 'id', 'group'\]
201
  - This does not include associated progress reports
202
203
As an authenticated user, I can see a detail view for a specific task
204
205
  - all attributes of a task
206
  - all associated progress reports
207
208
As an authenticated user, I can cancel a task
209 1 bmbouter
210
  - don't dare to use the DELETE verb!
211
212
## Task Group
213
214
I can view a summary of the status of all tasks in a group
215
216
## Event Listener Notifier
217
218 12 Ichimonji10
I can receive serialized task info via AMQP on each task save
219
220 1 bmbouter
*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?*
221
222
## Status
223
224 42 dkliban@redhat.com
As an unauthenticated user I can view the status of Pulp workers, resource managers, and celerybeats.
225 1 bmbouter
226 42 dkliban@redhat.com
As an unauthenticated user I can view the status of httpd's connection to the database and message broker.
227
228 46 bmbouter
<span style="color:red;">As an administrator, the WSGI app will not start if all migrations have not been applied</span>
229
230 28 bmbouter
## Plugin API
231 1 bmbouter
232 28 bmbouter
As a plugin writer, I have a plugin API that is semantically versioned at 0.x separate from the REST API
233 1 bmbouter
234 28 bmbouter
As a plugin writer, I can report progress with a message and state
235
236
As a plugin writer, I can report progress with an optional suffix
237
238
As a plugin writer, I can report progress with a total count of things to do an the current count of things done
239
240
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.
241
242
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.
243
244
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.
245
246
As a plugin writer, I can provide a subclassed Publisher. The publisher's responsibility is to publish content.
247
248
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.
249
250
As a plugin writer, I can interact with and create Artifacts
251
252
As a plugin writer, my app will be discovered by Pulp's app via an entry point provided by the plugin writer
253
254
As a plugin writer, I can use the plugin API to query content units/artifacts associated with a repository.
255 6 Ichimonji10
256 41 jortel@redhat.com
As a plugin writer, I can add and remove content units to and from a repository.
257 1 bmbouter
258 8 Ichimonji10
## CLI
259
260 54 bmbouter
<span style="color:red;">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?)*</span>
261 1 bmbouter
262 54 bmbouter
<span style="color:red;">repo CRUD</span>  
263
<span style="color:red;">CRUD for importers</span>  
264
<span style="color:red;">CRUD for publishers</span>  
265
<span style="color:red;">trigger syncs</span>  
266
<span style="color:red;">trigger publish</span>  
267
<span style="color:red;">list content in a repo</span>  
268
<span style="color:red;">upload</span>  
269
<span style="color:red;">server status</span>  
270
<span style="color:red;">list and cancel tasks</span>  
271
<span style="color:red;">authn via basic auth</span>  
272
<span style="color:red;">\_(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."?)\_</span>
273 1 bmbouter
274 26 bmbouter
## Download API
275
276
As a plugin writer, I can download files via
277
278
  - http://
279
  - https://
280
  - file://
281
282
As a plugin writer, I can configure a downloader with:
283 27 bmbouter
284
  - Basic Auth
285 26 bmbouter
  - SSL Cert Client Auth
286
  - 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.
287
288
As a plugin writer, I can provide arbitrary behaviors for customized downloaders
289
290
  - For example token authentication in the docker plugin
291
292
As a plugin writer, I can have connection pooling/reuse
293
294
As a plugin writer, I have proxy settings
295
296
  - proxy url (containing basic auth info)
297
298
As a plugin writer, I can have great logs
299
300
As a user, I have documentation about how to use something for bandwidth limiting
301
302
As a plugin writer, I can configure the validation mechanisms used at download time
303
304
  - checksum validation - minimum (md5, sha1, sha256, sha512)
305
  - size validation
306
307
<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>
308
309
<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>
310
311
As a plugin writer I can configure mirror lists and rotate between the mirrors
312
313
  - round robin
314
  - nearest mirror support
315
316
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.
317
318 1 bmbouter
As a plugin writer I can manage the catalog by using ChangeSets
319 26 bmbouter
320 27 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.
321 26 bmbouter
322
As a plugin writer, I can fetch content myself (but I am not encouraged to do so) with code I write
323 1 bmbouter
324
As a plugin writer, I can CRUD content units
325
326 56 ttereshc
## {color:red} Consumer Applicability
327 1 bmbouter
328 49 amacdona@redhat.com
<span style="color:red;">Using consumer profiles and repo bindings I can compute applicability with 2.y parity  
329
Performance needs to be awesome</span>
330 11 Ichimonji10
331 49 amacdona@redhat.com
<span style="color:red;">\_(Is the Pulp Consumer going away in Pulp 3? If so, is this section still appropriate?)\_</span>
332 1 bmbouter
333
## Plugin compatibility
334
335
rpm will work with platform  
336
puppet will work with platform  
337
ostree will work with platform  
338
python will work with platform  
339
file_plugin will work with platform  
340
docker will work with platform
341
342
## Migrations
343 20 bmbouter
344
users can run an executable similar to pulp-manage-db that is not named pulp-manage-db *(Why the change in name?)*
345 36 bmbouter
346
<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>
347 1 bmbouter
348
## Glossary
349
350 39 jortel@redhat.com
Repository - A named collection of content.
351
352
Artifact - A file associated with one content (unit). Artifacts are not shared between content (units). Create a content unit using an uploaded file ID as the source for its metadata. Create Artifacts associated with the content unit using an uploaded file ID for each; commit as a single transaction.
353
354
Content (unit) - A single piece of content manged by Pulp. Each file associated with a content (unit) is called an Artifact. Each content (unit) may have zero or many Artifacts.