Project

Profile

Help

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

bmbouter, 06/26/2017 10:47 PM
Make the CLI section red since it's not yet discussed

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