Project

Profile

Help

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

bmbouter, 12/01/2017 08:21 PM
Posting results of the "Distribution" use cases MVP call to Glossary section

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 un-authenticated user, I can obtain a JWT token by using a username and password. \[done\]
41 1 bmbouter
42 110 daviddavis
As an authenticated user, I can filter users by: \[[3142](https://pulp.plan.io/issues/3142)\]
43
44
  - username: (equality, username_in_list)
45
46 1 bmbouter
## Repositories
47
48 18 dkliban@redhat.com
As an authenticated user, I can list all repos.
49
50 60 bmbouter
  - All fields are included \[done\]
51
  - Pagination is supported \[done\]
52 1 bmbouter
53 112 bmbouter
As an authenticated user I can use filters on Repositories list: \[[3079](https://pulp.plan.io/issues/3079)\]
54 109 amacdona@redhat.com
55
  - id: (id_in_list) \# id equality is not necessary, v3/repositories/\<UUID\>/
56
  - name: (equality, name_in_list)
57
58 18 dkliban@redhat.com
As an authenticated user, I can CRUD a repository
59
60 60 bmbouter
  - Create a repo \[done\]
61
  - Read a repo \[done\]
62
  - Update all mutable repo fields \[done\]
63
  - Delete a repo (asynchronous) \[done\]
64 1 bmbouter
65 112 bmbouter
As an authenticated user, I can view content for a repository.
66
67 18 dkliban@redhat.com
As an authenticated user, I can list a repository's associated importers and publishers
68
69 60 bmbouter
  - All fields are included \[done\]
70
  - Pagination is supported \[done\]
71 1 bmbouter
72 104 bmbouter
As an authenticated user, I can see the number of content unit types with counts for each \[done\]\[[3059](https://pulp.plan.io/issues/3059)\]
73 18 dkliban@redhat.com
74 51 bmbouter
## Importers
75
76
note: Importer attributes will commonly be available on importers, but aren't guaranteed to be used by all importers.
77
78 18 dkliban@redhat.com
As an authenticated user, I can CRUD an importer
79
80
  - Create an importer
81
  - Read an importer
82
  - Update all mutable importer fields
83 21 bmbouter
  - Delete an importer (asynchronous)
84 1 bmbouter
85 113 bmbouter
As an authenticated user, I have filters on the Importer list: \[[3080](https://pulp.plan.io/issues/3080)\]
86 109 amacdona@redhat.com
87
  - id: (id_in_list) \# id equality is not necessary, objects are referenced by id
88
  - name: (equality, name_in_list)
89
90 64 mhrivnak
As an authenticated user I can configure the following attributes on an Importer: \[done\]
91 47 bmbouter
92 48 amacdona@redhat.com
  - validate (bool) \[optional: defaults to True\]: If true, the plugin will validate imported content.
93
  - ssl_ca_certificate (str) \[optional\] String containing a PEM encoded CA certificate used to validate the server certificate presented by the external source.
94
  - ssl_client_certificate (str) \[optional\] Contains a PEM encoded client certificate used for authentication.
95
  - ssl_client_key (str) \[optional\] Contains a PEM encoded private key used for authentication.
96
  - ssl_validation (bool) \[optional: defaults to True\]: If true, SSL peer validation must be performed.
97 65 mhrivnak
  - proxy_url (str) \[optional\] Contains the proxy URL. Format: scheme://user:password@host:port.
98 48 amacdona@redhat.com
  - username (str) \[optional\] Contains the username to be used for authentication when syncing.
99 1 bmbouter
  - password (str) \[optional\] Contains the password to be used for authentication when syncing.
100 63 mhrivnak
  - <span style="color:orange;">download_policy (str) \[optional\] Contains the downloading policy name. This is a choice of three options:  
101
 \- immediate (default) - Downloading occurs during sync. The sync task does not complete until downloading is done.  
102
 \- background - Downloading is started by the sync but occurs in the background. The sync task completes before downloading is complete.  
103
 \- 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.</span>
104 1 bmbouter
  - feed_url (str) \[optional\] Contains the URL of an external content source. This is optional.
105 63 mhrivnak
  - <span style="color:orange;">sync mode: (str) \[optional\]. It has two choices 'additive' and 'mirror':  
106
 \- additive (default) - all remote content is added to the local repository on sync. During sync no content is removed from the local repository.  
107
 \- mirror - the local content will mirror the remote content exactly, removing local content if not also present in the remote content.</span>
108 50 bmbouter
  - name (str) \[required\] Contains the name.
109
  - last_updated (datetime) \[read-only\] Contains the datetime of the last importer update.
110 53 bmbouter
  - last_synced (datetime) \[read-only\] Contains the datetime of the last importer sync.
111 51 bmbouter
112 52 bmbouter
## Publishers
113 51 bmbouter
114
note: Publisher attributes will commonly be available on publishers, but aren't guaranteed to be used by all publishers.
115 47 bmbouter
116 18 dkliban@redhat.com
As an authenticated user, I can CRUD a publisher
117
118
  - Create a publisher
119 1 bmbouter
  - Read a publisher
120
  - Update all mutable publisher fields
121 50 bmbouter
  - Delete a publisher (asynchronous)
122 1 bmbouter
123 113 bmbouter
As an authenticated user, I have filters on the Publisher list: \[[3081](https://pulp.plan.io/issues/3081)\]
124 109 amacdona@redhat.com
125
  - id: (id_in_list) \# id equality is not necessary, objects are referenced by id
126
  - name: (equality, name_in_list)
127
128 50 bmbouter
As an authenticated user I can configure the following attributes on a Publisher:
129
130 1 bmbouter
  - relative_path (str) \[optional\] The (relative) path component of the published url.
131 50 bmbouter
  - name - (str) \[required\] contains the name.
132 109 amacdona@redhat.com
  - last_published (datetime) \[read-only\] When the last successful publis%{color:red}h occurred.
133 50 bmbouter
  - last_updated (datetime) \[read-only\] The datetime of the last publisher update.
134 1 bmbouter
  - <span style="color:red;">auto_publish(bool) - ??? consider adding auto-publish feature to MVP</span>
135
136 123 bmbouter
## Distributions
137 1 bmbouter
138 123 bmbouter
As an authenticated user, I can CRUD Distributions:
139 1 bmbouter
140 123 bmbouter
  - Create a Distribution.
141
  - Read a Distribution
142
  - List Distributions
143
  - Update all mutable Distribution fields (synchronous)  
144
    \- base path  
145
    \- http  
146
    \- https
147
  - Delete an Distribution (synchronous)
148
149
As a user, my distribution base paths don't conflict and my create/update is rejected identifying the conflicting distributions \[[2987](https://pulp.plan.io/issues/2987)\]
150
151
As an authenticated user, I can create or update a distribution that is not associated with any publication (NULL)
152
153
As an authenticated user, I can create or update a distribution that is not associated with any publisher (NULL)
154
155
As a user, I can update a Distribution to distribute a specific Publication
156
157
As a user, I want a newly created publication to be automatically served by the content as defined by distributions.
158
159
As a user, I can see the full urls my base path is served at (one for http and one for https depending on what is on)
160
161 109 amacdona@redhat.com
As an authenticated user, I have filters on the Distribution list: \[[3082](https://pulp.plan.io/issues/3082)\]
162
163
  - name: (equality, name_in_list) 
164
  - base_path: (equality, substring, base_path_in_list)
165
166 120 bmbouter
## Publications
167 1 bmbouter
168 120 bmbouter
As an authenticated user, I can CRD Publication(s)
169 1 bmbouter
170 120 bmbouter
  - Create a publication which triggers a publish. This is asynchronous locking the repository.
171
  - Read a Publication - id, created datetime, list of distribution hrefs
172
  - List all Publications - ordered by created datetime in descending order
173
  - Delete a Publication - asyncronously with a lock on the repository.  
174
    \- prevented if associated with a distribution.  
175
    \- single object only.
176
177
As an authenticated user, I can list publications and I have enough information to choose which ones to delete.
178
179
  - choose by created (older ones or perhaps latest)
180
  - choose not associated to a distribution.
181
  - does not imply filtering
182
183
As an authenticated user, I can list publications and i have enough information to select a publication to be associated with a distribution.
184
185
  - choose by created (latest or just by publish date)  
186
    \- manual promotion. "My rawhide publication has been tested and now I want to promote it to stable".  
187
    \- rollback to an earlier publication.
188
  - does not imply filtering
189
190
As an authenticated user, I can determine if and how a publication is distributed.
191 109 amacdona@redhat.com
192 72 mhrivnak
## Sync and Publish
193 1 bmbouter
194 66 mhrivnak
As an authenticated user, I can trigger an importer to sync. \[done\]
195 19 bmbouter
196
  - I can follow the progress of all syncs. (Syncs are asynchronous.)
197
  - I cannot pass "sync" options.
198
  - Auto-publish is not included as an importer property.
199
200 66 mhrivnak
As an authenticated user, I can trigger a publisher to publish. \[done\]
201 19 bmbouter
202
  - I can follow the progress of all publishes. (Publishes are asynchronous.)
203
  - I cannot pass "publish" options.
204
205 71 mhrivnak
## Content Manipulation
206 25 bmbouter
207 73 mhrivnak
#### Uploading Artifacts
208 32 bmbouter
209 67 mhrivnak
As an authenticated user, I can create an Artifact by uploading a file. \[done\]
210 30 bmbouter
211 68 mhrivnak
As an authenticated user, I can specify a size and/or digest to validate the uploaded file. \[done\]
212
213 71 mhrivnak
#### Creating Content Units
214 70 mhrivnak
215 1 bmbouter
As an authenticated user, I can create a content unit by providing the content type (in the URL), references to Artifacts, and the metadata supplied in the POST body. \[done\]
216 102 bmbouter
217 29 bmbouter
#### Add / Remove Content from a Repository
218 99 bmbouter
219 113 bmbouter
As an authenticated user, I can add content (specific existing content) to a repository
220 99 bmbouter
221
  - I can specify one or more content units by id/href
222
  - I can follow the progress. (adding are asynchronous).
223
224 113 bmbouter
As an authenticated user, I can remove specified content from a repository
225 99 bmbouter
226
  - I can specify one or more content units by id/href
227
  - I can follow the progress. (removing are asynchronous).
228 101 bmbouter
229 1 bmbouter
#### Simple Copy
230 101 bmbouter
231 113 bmbouter
As an authenticated user, I can search (synchronous call) a repository's content using filtering.
232 101 bmbouter
233
  - note: In a separate call (async), I can add this content to another repository. This is effectively a copy operation in two calls.
234
235
As an authenticated user, I can import all content from one repository into another repository in a single async call. (Clone use case)
236
237
  - I can follow the progress. (adding are asynchronous).
238
239
#### Complex Copy
240
241
As a plugin writer I can provide a rich search features with abitrary viewsets. e.g. depsolving, verisoning, etc
242
243
Examples of specific plugin use cases motivating the above general viewset
244
245
  - As an authenticated user, I can add an Errata from one repository to another repository along with packages mentioned in the Errata and all their dependencies that are present in the source repository.
246
  - As an authenticated user, I can add bunch of dependencies and store n versions back for each RPM.
247
  - As an authenticated user, I can use depsolving and versioning copy features together
248
  - As an authenticated user, I can copy a puppet module and all of it's dependencies from one repository to another. 
249 71 mhrivnak
  - As an authenticated user, I can depsolve units to be added to a destination repo based on an errata
250 1 bmbouter
251 95 bmbouter
#### Delete
252 1 bmbouter
253 109 amacdona@redhat.com
FAs an authenticated user, I can delete a specific content unit%  
254 95 bmbouter
<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>  
255
<span style="color:red;">\* Artifacts and associated files from the deleted unit are cleaned up</span>
256
257
<span style="color:red;">As an authenticated user, I can delete multiple content units with filtering</span>  
258
<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>  
259
<span style="color:red;">\* Artifacts and associated files from deleted units are cleaned up</span>
260 1 bmbouter
261 112 bmbouter
#### Filtering
262
263
As an authenticated user, I can filter Content by repository information when plugin writers have provided such a filter
264
265
As an authenticated user, I can filter content by repository
266
267
As an authenticated user, I can filter content by type
268
269
As an authenticated user, I can filter content on plugin specific attributes when plugin writers have provided such a filter
270
271 74 mhrivnak
## <span style="color:red;">Versioned Repositories</span>
272 1 bmbouter
273 40 bmbouter
As an authenticated user, I can list the content in a particular repository version
274
275
  - All fields are included
276
  - Pagination is supported
277
  - <span style="color:red;">Filtering support</span>
278
279
As an authenticated user, I can discover a URL to the latest version of a repository  
280
<span class="resource repository the on attributes or endpoint, API dedicated a through \^ Is" style="color:red;"></span>
281 1 bmbouter
282 43 bmbouter
As an authenticated user, I can run a publisher without a repository version and have it default to the latest version.
283
284 1 bmbouter
<span style="color:red;">As an authenticated user, I can delete a repository version by specifying the version</span>
285
286 43 bmbouter
<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>
287
288 95 bmbouter
## Orphan Content Units and Artifacts
289 43 bmbouter
290 95 bmbouter
As an authenticated user, I can cause an action that cleans up **both** orphaned content units and orphaned artifacts.
291 43 bmbouter
292 95 bmbouter
  - I cannot specify the units specifically (all types).
293
  - I can follow the progress of all cleanups. (Cleanups are asynchronous.)
294 1 bmbouter
295 22 bmbouter
## Task Management
296
297 76 mhrivnak
As an authenticated user, I can list all tasks
298
299 22 bmbouter
  - <span style="color:orange;">Filtering support on \['state', 'id', 'group'\]</span>
300 76 mhrivnak
  - <span style="color:orange;">This does not include associated progress reports</span>
301 22 bmbouter
302
As an authenticated user, I can see a detail view for a specific task \[done\]
303
304
  - all attributes of a task
305 76 mhrivnak
  - all associated progress reports
306 1 bmbouter
307
As an authenticated user, I can cancel a task \[done\]
308
309 77 mhrivnak
  - don't dare to use the DELETE verb!
310
311 1 bmbouter
As an authenticated user, I can delete tasks.
312
313 114 daviddavis
As an authenticated user, I can filter tags by: \[[3144](https://pulp.plan.io/issues/3144)\]
314 110 daviddavis
315
  - state (equality, state_in_list)
316
  - started_at(started_in_range)
317
  - finished_at(finished_in_range)
318
  - worker (equality)
319
  - parent (equality)
320
321 78 mhrivnak
## Task Group
322 1 bmbouter
323
<span style="color:red;">I can view a summary of the status of all tasks in a group</span>
324
325 82 mhrivnak
## Status
326 1 bmbouter
327 121 bmbouter
As an unauthenticated user I can view the status of Pulp workers and resource managers. \[done\]
328 42 dkliban@redhat.com
329 80 mhrivnak
As an unauthenticated user I can view the status of the web server's connection to the database and message broker. \[done\]
330 46 bmbouter
331 28 bmbouter
As an unauthenticated user I can view the versions of core and each installed plugin.
332 110 daviddavis
333 115 daviddavis
## Workers
334 110 daviddavis
335 115 daviddavis
As an authenticated user, I can filter workers by: \[[3143](https://pulp.plan.io/issues/3143)\]
336 110 daviddavis
337
  - last_heartbeat (range)
338
  - name (substring)
339 116 daviddavis
  - gracefully_stopped (equality)
340 1 bmbouter
341 83 mhrivnak
## Plugin API
342 1 bmbouter
343 83 mhrivnak
As a plugin writer, I have a plugin API that is semantically versioned at 0.x separate from the REST API \[done\]
344 28 bmbouter
345 83 mhrivnak
As a plugin writer, I can report progress with a message and state \[done\]
346 28 bmbouter
347 83 mhrivnak
As a plugin writer, I can report progress with an optional suffix \[done\]
348 28 bmbouter
349 83 mhrivnak
As a plugin writer, I can report progress with a total count of things to do an the current count of things done \[done\]
350 28 bmbouter
351 83 mhrivnak
As a plugin writer, non-fatal exceptions 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. \[done\]
352 28 bmbouter
353 83 mhrivnak
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. \[done\]
354 28 bmbouter
355 84 bmbouter
<span style="color:red;">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. (a circular import problem needs to be discussed and may cause this to change) \[done\]</span>
356 28 bmbouter
357 83 mhrivnak
<span style="color:red;">As a plugin writer, I can provide a subclassed Publisher. The publisher's responsibility is to publish content. (a circular import problem needs to be discussed and may cause this to change) \[done\]</span>
358 28 bmbouter
359 83 mhrivnak
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. \[done\]
360 28 bmbouter
361 83 mhrivnak
As a plugin writer, I can interact with and create Artifacts \[done\]
362 28 bmbouter
363 83 mhrivnak
As a plugin writer, my app will be discovered by Pulp's app via an entry point provided by the plugin writer \[done\]
364 6 Ichimonji10
365 83 mhrivnak
As a plugin writer, I can use the plugin API to query content units/artifacts associated with a repository. \[done\]
366 1 bmbouter
367 8 Ichimonji10
As a plugin writer, I can add and remove content units to and from a repository. \[done\]
368 1 bmbouter
369 112 bmbouter
As a plugin writer, I have documentation that shows how I can add filters to filter content responsibly.
370
371
As a plugin writer, I have documentation on how to write a filter for my Content that can use the RepositoryContent through table.
372
373
  - note: This will allow users to filter content by repository information
374
375 103 bmbouter
## Plugin Writer "live APIs"
376
377 106 bmbouter
As a plugin writer, I can provide a Live API with arbitrary views and viewsets.  
378
As a plugin writer, I have documentation on what URLs I should -not use for my views and viewsets
379
380 108 bmbouter
Here are some concrete use cases driving the very Live API use cases above:
381
382
~~~
383
# Concrete user use cases:
384 113 bmbouter
    As an authenticated user, I can use the puppet client to fetch content from Pulp using the Forge API
385
    As an authenticated user I can use the docker client to fetch content from Pulp using the Docker v1 API
386
    As an authenticated user I can use the docker client to fetch content from Pulp using the Docker v2 API
387 108 bmbouter
388
# Concrete plugin writer use cases
389
    As a puppet plugin developer, I can provide a viewset which handles the server side of the puppet Forge v3 API
390
    As a docker plugin developer, I can provide a viewset which handles the server side of the docker v1 API
391
    As a docker plugin developer, I can provide a viewset which handles the server side of the docker v2 API
392
~~~
393
394 117 bmbouter
## Webserver Deployment
395 106 bmbouter
396 113 bmbouter
As an authenticated user, I can deploy all Pulp webservices on one process
397 106 bmbouter
398 113 bmbouter
<span style="color:red;">As an authenticated user, I can deploy the Pulp REST API exclusively in one process</span>  
399
<span style="color:red;">As an authenticated user, I can deploy the Pulp content serving view exclusively in one process</span>  
400
<span style="color:red;">As an authenticated user, I can deploy the Pulp content serving view with reduced permissions.</span>  
401
<span style="color:red;">As an authenticated user, I can deploy a Plugin's Live API exclusively in one process.</span>
402 103 bmbouter
403 94 bizhang
## CLI
404 93 bizhang
405 1 bmbouter
We will use coreapi-cli to generate a one to one mapping of cli commands to rest api schema #3068  
406 26 bmbouter
<span style="color:orange;">We will have a wrapper for coreapi-cli. This wrapper will handle parallel progress reporting</span>
407
408
## Download API
409
410
As a plugin writer, I can download files via
411
412
  - http://
413
  - https://
414
  - file://
415 27 bmbouter
416
As a plugin writer, I can configure a downloader with:
417 26 bmbouter
418
  - Basic Auth
419
  - SSL Cert Client Auth
420
  - 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.
421
422
As a plugin writer, I can provide arbitrary behaviors for customized downloaders
423
424
  - For example token authentication in the docker plugin
425
426
As a plugin writer, I can have connection pooling/reuse
427
428
As a plugin writer, I have proxy settings
429
430
  - proxy url (containing basic auth info)
431
432
As a plugin writer, I can have great logs
433
434 113 bmbouter
As an authenticated user, I have documentation about how to use something for bandwidth limiting
435 26 bmbouter
436
As a plugin writer, I can configure the validation mechanisms used at download time
437
438
  - checksum validation - minimum (md5, sha1, sha256, sha512)
439
  - size validation
440 1 bmbouter
441
<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>
442
443 26 bmbouter
<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>
444
445 112 bmbouter
<span style="color:red;">As a plugin writer I can configure mirror lists and rotate between the mirrors</span>  
446
<span style="color:red;">\* round robin</span>  
447
<span style="color:red;">\* nearest mirror support</span>
448 26 bmbouter
449 1 bmbouter
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.
450 26 bmbouter
451 27 bmbouter
As a plugin writer I can manage the catalog by using ChangeSets
452 26 bmbouter
453
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.
454 1 bmbouter
455
As a plugin writer, I can fetch content myself (but I am not encouraged to do so) with code I write
456
457 56 ttereshc
As a plugin writer, I can CRUD content units
458 1 bmbouter
459 118 bmbouter
## <span style="color:red;">Consumer Profile Applicability</span>
460 1 bmbouter
461 118 bmbouter
<span style="color:red;">Using Consumer Profiles and repository bindings I can compute applicability with 2.y parity</span>
462 1 bmbouter
463 118 bmbouter
  - Performance needs to be awesome%
464 36 bmbouter
465 86 mhrivnak
## Migrations only involving Pulp 3
466 1 bmbouter
467 87 mhrivnak
Users can run "pulp-manager migrate" to migrate the database and adjust state in other locations (filesystem, message broker, ...). \[done\]
468 1 bmbouter
469
## Web Server Integration
470
471 122 jortel@redhat.com
As a user, I can have content efficiently served to me by Apache by Pulp using the X-SEND response headers. \[done\]  
472
As a user, I can have content efficiently served to me by Nginx by Pulp using the X-Accel-Redirect response headers. \[done\]
473 105 bmbouter
474
<span style="color:red;">As a user, I can have an Ansible role to install Apache which enables Apache integration for Pulp and configures Apache to serve Pulp. \[[2921](https://pulp.plan.io/issues/2921)\]</span>  
475
<span style="color:red;">As a user, I can have an Ansible role to install Nginx which enables Nginx integration for Pulp and configures Nginx to serve Pulp. \[[2922](https://pulp.plan.io/issues/2922)\]</span>
476 87 mhrivnak
477 89 mhrivnak
## Glossary
478 88 mhrivnak
479 1 bmbouter
Repository - A named collection of content.
480
481 39 jortel@redhat.com
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.
482
483
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.
484 95 bmbouter
485
Orphan Content (unit): A content unit that is a member of 0 repositories
486
487
Orphan Artifact: An Artifact that is associated with 0 Content Units and 0 Publications
488 98 bmbouter
489
Add (Content Unit): An operation causing a repository to contain a content unit(s)
490
491
Remove (content unit): An operation causing a repository to not contain a content unit(s)
492 119 bmbouter
493
Consumer Profile - A set of installed units on a specific machine. In Pulp3 this machine is not a "consumer" in the same sense as Pulp2. Pulp is not "managing" the machine anymore; Pulp3 only collects Profile information.
494
495
Applicability - A plugin defined term meaning when a package update available in a repository is applicable to a given consumer as determined by the Consumer Profile.
496 124 bmbouter
497
Distribution: Where and how the content app serves a Publication. i.e. http vs https and base path component of the URL. A Distribution defines:
498
499
  - the base bath of the repository publication (required)
500
  - serving via http (default=False)
501
  - serving via https (default=True)
502
  - relationship w/ a Publisher for auto-distribution (should be allowed to be NULL)
503
  - relationship with Publication (should be allowed to be NULL)