Project

Profile

Help

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

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