Project

Profile

Help

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

amacdona@redhat.com, 04/11/2018 05:22 PM
Remove ansible installers of Nginx and Apache

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 1 bmbouter
## Authentication
12
13 59 bmbouter
As an authenticated user I can manage user(s). \[done\]
14 17 semyers
15
  - Add a user
16
  - View user(s)
17 58 mhrivnak
  - Update any user detail
18 1 bmbouter
  - Delete a user
19
20 135 bmbouter
As an API user, I can authenticate any API call with Basic auth \[done\]
21 1 bmbouter
22 110 daviddavis
As an authenticated user, I can filter users by: \[[3142](https://pulp.plan.io/issues/3142)\]
23
24
  - username: (equality, username_in_list)
25
26 1 bmbouter
## Repositories
27
28 18 dkliban@redhat.com
As an authenticated user, I can list all repos.
29
30 60 bmbouter
  - All fields are included \[done\]
31
  - Pagination is supported \[done\]
32 1 bmbouter
33 112 bmbouter
As an authenticated user I can use filters on Repositories list: \[[3079](https://pulp.plan.io/issues/3079)\]
34 109 amacdona@redhat.com
35
  - name: (equality, name_in_list)
36
37 18 dkliban@redhat.com
As an authenticated user, I can CRUD a repository
38
39 60 bmbouter
  - Create a repo \[done\]
40
  - Read a repo \[done\]
41 152 amacdona@redhat.com
  - Update all mutable repo fields (asynchronous) \[done\]
42 130 daviddavis
  - Delete a repo (asynchronous)
43 112 bmbouter
44 152 amacdona@redhat.com
As an authenticated user, when viewing a repository, I can discover a URL to the latest version of a repository. \[done\]\[[3235](https://pulp.plan.io/issues/3235)\]
45 130 daviddavis
46 149 dkliban@redhat.com
## Remotes
47 51 bmbouter
48 149 dkliban@redhat.com
note: Remote attributes will commonly be available on remotes, but aren't guaranteed to be used by all remotes.
49 51 bmbouter
50 149 dkliban@redhat.com
As an authenticated user, I can CRUD an remote
51 18 dkliban@redhat.com
52 149 dkliban@redhat.com
  - Create an remote
53
  - Read an remote
54 152 amacdona@redhat.com
  - Update all mutable remote fields (asynchronous)
55 1 bmbouter
  - Delete an remote (asynchronous)
56 149 dkliban@redhat.com
57 155 amacdona@redhat.com
As an authenticated user, I have filters on the Remote list: \[[3080](https://pulp.plan.io/issues/3080)\]
58 21 bmbouter
59 1 bmbouter
  - name: (equality, name_in_list)
60 109 amacdona@redhat.com
61 155 amacdona@redhat.com
As an authenticated user I can configure the following attributes on an Remote: \[done\]
62 109 amacdona@redhat.com
63
  - validate (bool) \[optional: defaults to True\]: If true, the plugin will validate imported content.
64 48 amacdona@redhat.com
  - ssl_ca_certificate (str) \[optional\] String containing a PEM encoded CA certificate used to validate the server certificate presented by the external source.
65 1 bmbouter
  - ssl_client_certificate (str) \[optional\] Contains a PEM encoded client certificate used for authentication.
66 135 bmbouter
  - ssl_client_key (str) \[optional\] Contains a PEM encoded private key used for authentication.
67
  - ssl_validation (bool) \[optional: defaults to True\]: If true, SSL peer validation must be performed.
68 1 bmbouter
  - proxy_url (str) \[optional\] Contains the proxy URL. Format: scheme://user:password@host:port.
69 136 daviddavis
  - username (str) \[optional\] Contains the username to be used for authentication when syncing.
70 63 mhrivnak
  - password (str) \[optional\] Contains the password to be used for authentication when syncing.
71 1 bmbouter
  - name (str) \[required\] Contains the name.
72 149 dkliban@redhat.com
  - last_updated (datetime) \[read-only\] Contains the datetime of the last remote update.
73
  - last_synced (datetime) \[read-only\] Contains the datetime of the last remote sync.
74 50 bmbouter
75 52 bmbouter
## Publishers
76 51 bmbouter
77
note: Publisher attributes will commonly be available on publishers, but aren't guaranteed to be used by all publishers.
78 47 bmbouter
79 18 dkliban@redhat.com
As an authenticated user, I can CRUD a publisher
80
81
  - Create a publisher
82 1 bmbouter
  - Read a publisher
83 152 amacdona@redhat.com
  - Update all mutable publisher fields (asynchronous)
84 50 bmbouter
  - Delete a publisher (asynchronous)
85 1 bmbouter
86 109 amacdona@redhat.com
As an authenticated user, I have filters on the Publisher list: \[[3081](https://pulp.plan.io/issues/3081)\]
87
88
  - name: (equality, name_in_list)
89
90 50 bmbouter
As an authenticated user I can configure the following attributes on a Publisher:
91
92 1 bmbouter
  - relative_path (str) \[optional\] The (relative) path component of the published url.
93 152 amacdona@redhat.com
  - name (str) \[required\] contains the name.
94 109 amacdona@redhat.com
  - last_published (datetime) \[read-only\] When the last successful publis%{color:red}h occurred.
95 50 bmbouter
  - last_updated (datetime) \[read-only\] The datetime of the last publisher update.
96 1 bmbouter
97 123 bmbouter
## Distributions
98 1 bmbouter
99
As an authenticated user, I can CRUD Distributions:
100 123 bmbouter
101 1 bmbouter
  - Create a Distribution.
102 123 bmbouter
  - Read a Distribution
103
  - List Distributions
104
  - Update all mutable Distribution fields (synchronous)  
105 155 amacdona@redhat.com
    \- base path
106 123 bmbouter
  - Delete an Distribution (synchronous)
107
108 153 dkliban@redhat.com
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)\]
109 123 bmbouter
110 1 bmbouter
As an authenticated user, I can create or update a distribution that is not associated with any publication (NULL)
111
112 161 amacdona@redhat.com
As an authenticated user, I can create or update a distribution that is not associated with any publisher/repository (NULL)
113
114
  - publisher and repository are used together. If one is null, both must be null.
115 1 bmbouter
116 153 dkliban@redhat.com
As a user, I can update a Distribution to distribute a specific Publication  
117
As a user, I want a newly created publication to be automatically served by the content as defined by distributions.
118 150 dkliban@redhat.com
119 153 dkliban@redhat.com
As a user, I can see the full urls my base path is served at  
120
As an authenticated user, I have filters on the Distribution list: \[[3082](https://pulp.plan.io/issues/3082)\]%
121 109 amacdona@redhat.com
122 1 bmbouter
  - name: (equality, name_in_list) 
123
  - base_path: (equality, substring, base_path_in_list)
124
125
## Publications
126
127 141 daviddavis
As an authenticated user, when creating a Publication, I can post a repo version href to be published. \[[3221](https://pulp.plan.io/issues/3221)\]
128 1 bmbouter
129 142 daviddavis
As an authenticated user, I can publish a repository's latest version by posting a repository href to be published. \[[3223](https://pulp.plan.io/issues/3223)\]
130 130 daviddavis
131 140 daviddavis
As an authenticated user, I can view which repository version was used to create a particular publication. \[[3237](https://pulp.plan.io/issues/3237)\]
132 130 daviddavis
133
As an authenticated user, I can read Publication(s)
134
135
  - Read a Publication - id, created datetime, list of distribution hrefs, repo version
136 120 bmbouter
  - List all Publications - ordered by created datetime in descending order
137
138 130 daviddavis
As an authenticated user, I can delete publications.  
139
\- asynchronously with a lock on the repository version.  
140
\- prevented if associated with a distribution.  
141
\- single object only.
142 1 bmbouter
143
As an authenticated user, I can list publications and I have enough information to choose which ones to delete.
144
145 130 daviddavis
  - choose by created (older ones or perhaps latest)
146 120 bmbouter
  - choose not associated to a distribution.
147
  - does not imply filtering
148
149
As an authenticated user, I can list publications and i have enough information to select a publication to be associated with a distribution.
150
151 155 amacdona@redhat.com
  - choose by created (latest or just by publish date)
152
      - manual promotion. "My rawhide publication has been tested and now I want to promote it to stable".
153
      - rollback to an earlier publication.
154 120 bmbouter
  - does not imply filtering
155 109 amacdona@redhat.com
156 72 mhrivnak
As an authenticated user, I can determine if and how a publication is distributed.
157 1 bmbouter
158 144 dkliban@redhat.com
## Exporters
159 70 mhrivnak
160 1 bmbouter
<span style="color:black;">As a plugin writer, I can contribute an exporter that is discovered by core</span>  
161 102 bmbouter
<span style="color:black;">As a plugin writer, I have docs on how to create a discoverable exporter</span>  
162 151 dkliban@redhat.com
<span style="color:black;">As a plugin writer, I can contribute an exporter that uses a publication.</span>
163 99 bmbouter
164 156 amacdona@redhat.com
## Artifacts
165 1 bmbouter
166 99 bmbouter
As an authenticated user, I can create an Artifact by uploading a file. \[done\]
167
168 162 amacdona@redhat.com
As an authenticated user, I can optionally specify a size and/or digest to validate the uploaded file. \[done\]
169 1 bmbouter
170 156 amacdona@redhat.com
## Content Units
171 1 bmbouter
172 156 amacdona@redhat.com
As an authenticated user, I can create a content unit.
173 127 bmbouter
174 156 amacdona@redhat.com
As an authenticated user, I can read and list content units.  
175
<span style="color:red;">\* As an authenticated user, I can filter content by repository version</span>
176 130 daviddavis
177 156 amacdona@redhat.com
<span style="color:red;">As an authenticated user, I can delete a specific content unit if it is not in any repository version. (orphan)</span>
178 1 bmbouter
179
  - 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.
180 129 daviddavis
  - As a user, I know that files (Artifacts) associated with the Content unit are not removed by this call (docs)
181 1 bmbouter
182
## Versioned Repositories
183 129 daviddavis
184 1 bmbouter
#### CRD
185
186
As an authenticated user, I can list versions for a particular repository. \[done\]
187 129 daviddavis
188
  - Pagination is supported
189 1 bmbouter
190
As an authenticated user, I can filter repository versions by: \[[3238](https://pulp.plan.io/issues/3238)\]
191
192 137 daviddavis
  - number (equality, lt/lte, gt/gte)
193 129 daviddavis
  - content id (equality, content_in_list)
194 136 daviddavis
  - created datetime (range)
195
196 140 daviddavis
As an authenticated user, I can delete any repository version. \[[3219](https://pulp.plan.io/issues/3219)\]
197 129 daviddavis
198 155 amacdona@redhat.com
  - Latest versions are deleted simply.
199
  - Content set changes are "squashed" into the following version when non-latest versions are deleted.
200
201 136 daviddavis
As an authenticated user, I can view content that was added or removed in a particular repository version (as compared to the previous version). \[done\]
202 133 amacdona@redhat.com
203 155 amacdona@redhat.com
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)\]
204
205 138 daviddavis
#### Repository Version Content
206 129 daviddavis
207
As a user, I know content sets for repository versions are immutable. \[done\]
208
209 139 daviddavis
As an authenticated user, I can list the content in a particular repository version \[done\]
210 129 daviddavis
211 139 daviddavis
  - All fields are included
212 40 bmbouter
  - Pagination is supported
213 43 bmbouter
214 139 daviddavis
As an authenticated user, I can create a new version by adding or removing content to the latest version. \[[3234](https://pulp.plan.io/issues/3234)\]
215 130 daviddavis
216 136 daviddavis
  - I can follow the progress. (adding/removing are asynchronous).
217 130 daviddavis
  - can add and remove together in a single call
218 152 amacdona@redhat.com
219 43 bmbouter
## Orphan Content Units and Artifacts
220 95 bmbouter
221 153 dkliban@redhat.com
As an authenticated user, I can cause an action that cleans up **both** orphaned content units and orphaned artifacts.
222 151 dkliban@redhat.com
223 22 bmbouter
  - I cannot specify the units specifically (all types).
224
  - I can follow the progress of all cleanups. (Cleanups are asynchronous.)
225 76 mhrivnak
226
## Task Management
227 22 bmbouter
228 76 mhrivnak
As an authenticated user, I can list all tasks
229 1 bmbouter
230
  - This does not include associated progress reports
231
232
As an authenticated user, I can see a detail view for a specific task \[done\]
233
234
  - all attributes of a task
235
  - all associated progress reports
236
237
As an authenticated user, I can cancel a task \[done\]
238
239
  - don't dare to use the DELETE verb!
240
241
As an authenticated user, I can delete tasks.
242
243
As an authenticated user, I can filter tasks by: \[[3144](https://pulp.plan.io/issues/3144)\]
244
245
  - state (equality, state_in_list)
246
  - started_at(started_in_range)
247
  - finished_at(finished_in_range)
248
  - worker (equality)
249
  - parent (equality)
250
251 146 daviddavis
## Status
252 153 dkliban@redhat.com
253 22 bmbouter
As an unauthenticated user I can view the status of Pulp workers and resource managers. \[done\]
254
255 76 mhrivnak
As an unauthenticated user I can view the status of the web server's connection to the database and message broker. \[done\]
256 1 bmbouter
257
As an unauthenticated user I can view the versions of core and each installed plugin.
258
259 77 mhrivnak
## Workers
260
261 1 bmbouter
As an authenticated user, I can filter workers by: \[[3143](https://pulp.plan.io/issues/3143)\]
262
263 114 daviddavis
  - last_heartbeat (range)
264 110 daviddavis
  - name (substring)
265 147 daviddavis
  - gracefully_stopped (equality)
266 156 amacdona@redhat.com
267 159 bmbouter
## Plugin User Content Management stories
268 156 amacdona@redhat.com
269
#### Simple Copy
270
271
As an authenticated user of a plugin, I can search (synchronous call) a repository version's content using filtering.
272
273
  - note: In a separate call (async), I can add_content_units or remove_content_units to another repository's latest version.
274
275
#### Complex Copy
276
277
As a plugin writer I can provide a rich search features with arbitrary viewsets. e.g. depsolving, versioning, etc
278
279
Examples of specific plugin use cases motivating the above general viewset
280
281
  - 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.
282
  - As an authenticated user, I can add bunch of dependencies and store n versions back for each RPM.
283
  - As an authenticated user, I can use depsolving and versioning copy features together
284
  - As an authenticated user, I can copy a puppet module and all of it's dependencies from one repository to another. 
285
  - As an authenticated user, I can depsolve units to be added to a destination repo based on an errata
286 1 bmbouter
287 83 mhrivnak
## Plugin API
288 28 bmbouter
289 83 mhrivnak
As a plugin writer, I have a plugin API that is semantically versioned at 0.x separate from the REST API \[done\]
290 28 bmbouter
291 157 amacdona@redhat.com
As a plugin writer, my app will be discovered by Pulp's app via an entry point provided by the plugin writer \[done\]
292
293
#### Task
294
295 1 bmbouter
As a plugin writer, I can report progress with a message and state \[done\]
296 83 mhrivnak
297 28 bmbouter
As a plugin writer, I can report progress with an optional suffix \[done\]
298
299 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\]
300 1 bmbouter
301 28 bmbouter
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\]
302 83 mhrivnak
303 28 bmbouter
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\]
304 1 bmbouter
305 157 amacdona@redhat.com
#### Remote
306
307 154 dkliban@redhat.com
As a plugin writer, I can provide a subclassed Remote. I can add custom fields to the subclassed Remote.
308 28 bmbouter
309 154 dkliban@redhat.com
As a plugin writer, I can provide a UserFacingTask to perform a sync operation using information stored in a Remote.
310 1 bmbouter
311 155 amacdona@redhat.com
As a plugin writer, I can provide a ViewSet for the subclassed Remote that has a 'sync' endpoint that dispatches the sync task with a reservation for Repository and Remote.
312 154 dkliban@redhat.com
313 157 amacdona@redhat.com
#### Publisher
314
315 154 dkliban@redhat.com
As a plugin writer, I can provide a subclassed Publisher. I can add custom fields to the subclassed Publisher.
316
317
As a plugin writer, I can provide a UserFacingTask to perform a publish operation using information from the subclassed Publisher.
318 112 bmbouter
319
As a plugin writer, I can provide a ViewSet for the subclassed Publisher that has a 'publish' endpoint that dispatches the publish task with a reservation for Repository and Publisher.
320 1 bmbouter
321 157 amacdona@redhat.com
#### Content
322 1 bmbouter
323 157 amacdona@redhat.com
As a plugin writer, I can provide a subclassed Content unit. I can add custom fields to the subclassed Content. \[done\]
324
325
<span style="color:red;">As a plugin writer, I have documentation that shows how I can add filters to filter content responsibly.</span>
326
327
<span style="color:red;">As a plugin writer, I have documentation on how to write a filter for my Content that can use the RepositoryVersion manager.</span>  
328
<span style="color:red;">\* note: This will allow users to filter content by repository version</span>
329
330
#### Content Management
331
332 1 bmbouter
As a plugin writer, I can interact with and create Artifacts \[done\]
333
334 157 amacdona@redhat.com
As a plugin writer, I can query content units/artifacts associated with a repository. \[done\]
335 1 bmbouter
336 157 amacdona@redhat.com
As a plugin writer, I can create a new repository version: \[done\]
337 1 bmbouter
338 157 amacdona@redhat.com
  - When I create the new version, it is incomplete.
339
  - The new version starts with all the content from the previous version.
340
  - I can add and remove content units to and from an incomplete repository version. 
341
  - When I am finished with the incomplete version, core finalizes the repository version for me. 
342
  - I have exclusive access to the new repository version while my code is running.
343 1 bmbouter
344 157 amacdona@redhat.com
#### Publishing
345 1 bmbouter
346 157 amacdona@redhat.com
As a plugin writer, I can create a new publication: \[done\]
347 1 bmbouter
348 157 amacdona@redhat.com
  - When I create the new publication, it is incomplete.
349
  - When I am finished with the incomplete publication, core finalizes the publication for me. 
350
  - I have exclusive access to the repository version while my code is running.
351
  - I have exclusive access to the new publication while my code is running.
352 1 bmbouter
353 157 amacdona@redhat.com
#### "live APIs"
354
355 163 amacdona@redhat.com
As a plugin writer, I can register views and viewsets to arbitrary endpoints. \[3360\]  
356
As a plugin writer, I have documentation on what URLs I should not use for my views and viewsets \[3473\]
357 1 bmbouter
358 136 daviddavis
Here are some concrete use cases driving the very Live API use cases above:
359 134 bmbouter
360 155 amacdona@redhat.com
~~~
361
# Concrete user use cases:
362 134 bmbouter
    As an authenticated user, I can use the puppet client to fetch content from Pulp using the Forge API
363 1 bmbouter
    As an authenticated user I can use the docker client to fetch content from Pulp using the Docker v1 API
364
    As an authenticated user I can use the docker client to fetch content from Pulp using the Docker v2 API
365 134 bmbouter
366 136 daviddavis
# Concrete plugin writer use cases
367 154 dkliban@redhat.com
    As a puppet plugin developer, I can provide a viewset which handles the server side of the puppet Forge v3 API
368 134 bmbouter
    As a docker plugin developer, I can provide a viewset which handles the server side of the docker v1 API
369
    As a docker plugin developer, I can provide a viewset which handles the server side of the docker v2 API
370
~~~
371 154 dkliban@redhat.com
372 157 amacdona@redhat.com
  
373
h4. Storage
374 134 bmbouter
375 157 amacdona@redhat.com
As a plugin writer, the plugin API provides an API that returns a fully qualified path to a shared and namespaced storage location used to store content. \["3182"https://pulp.plan.io/issues/3182\]  
376
\*****\*****\*\*\*\*
377 106 bmbouter
378 132 bmbouter
## Webserver Deployment
379
380
As a system administrator, I can deploy all Pulp web applications on one process  
381 113 bmbouter
As a system administrator, I can deploy the Pulp REST API exclusively in one process  
382 132 bmbouter
As a system administrator, I can deploy the Pulp content serving view exclusively in one process
383
384 93 bizhang
As a system administrator, I can deploy all Pulp web applications inside a virtualenv.  
385 1 bmbouter
As a system administrator, I can deploy all Pulp web applications without root permissions.
386 26 bmbouter
387
## CLI
388
389
We will use coreapi-cli to generate a one to one mapping of cli commands to rest api schema #3068  
390 160 bmbouter
<span style="color:red;">We will have a wrapper for coreapi-cli. This wrapper will handle parallel progress reporting</span>
391 26 bmbouter
392
## Download API
393
394 27 bmbouter
As a plugin writer, I can download files via
395 26 bmbouter
396
  - http://
397
  - https://
398 1 bmbouter
  - file://
399
400 26 bmbouter
As a plugin writer, I can configure a downloader with:
401
402
  - Basic Auth
403
  - SSL Cert Client Auth
404
  - 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.
405
406
As a plugin writer, I can provide arbitrary behaviors for customized downloaders
407
408
  - For example token authentication in the docker plugin
409 1 bmbouter
410
As a plugin writer, I can have connection pooling/reuse
411
412 26 bmbouter
As a plugin writer, I have proxy settings
413 113 bmbouter
414 1 bmbouter
  - proxy url (containing basic auth info)
415 154 dkliban@redhat.com
416 26 bmbouter
<span style="color:red;">As a plugin writer, I can have great logs</span>
417 154 dkliban@redhat.com
418 26 bmbouter
<span style="color:red;">As an authenticated user, I have documentation about how to use something for bandwidth limiting</span>
419
420 1 bmbouter
As a plugin writer, I can configure the validation mechanisms used at download time
421
422
  - checksum validation - minimum (md5, sha1, sha256, sha512)
423 26 bmbouter
  - size validation
424
425 1 bmbouter
<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>
426 26 bmbouter
427 27 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>
428 154 dkliban@redhat.com
429 26 bmbouter
<span style="color:red;">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.</span>
430 154 dkliban@redhat.com
431 1 bmbouter
<span style="color:red;">As a plugin writer I can manage the catalog by using ChangeSets</span>
432 154 dkliban@redhat.com
433 118 bmbouter
<span style="color:red;">As a plugin writer, the plugin can participate in adding content for cases where the decision to add additional content is based on the content that has been downloaded.</span>
434
435 1 bmbouter
As a plugin writer, I can fetch content myself (but I am not encouraged to do so) with code I write
436 154 dkliban@redhat.com
437 86 mhrivnak
<span style="color:red;">As a plugin writer, I can CRUD content units</span> need a convention to handle multiple content units - see https://pulp.plan.io/issues/3472
438 1 bmbouter
439 87 mhrivnak
## Migrations only involving Pulp 3
440 1 bmbouter
441
Users can run "pulp-manager migrate" to migrate the database and adjust state in other locations (filesystem, message broker, ...). \[done\]
442 122 jortel@redhat.com
443 1 bmbouter
## Web Server Integration
444 122 jortel@redhat.com
445 105 bmbouter
As a user, I can have content efficiently served to me by Apache by Pulp using the X-SEND response headers. \[done\]  
446 132 bmbouter
As a user, I can have content efficiently served to me by Nginx by Pulp using the X-Accel-Redirect response headers. \[done\]
447
448 131 bmbouter
## Glossary
449 130 daviddavis
450 119 bmbouter
Add (Content Unit): An operation causing a new repository version to contain a content unit(s)
451 1 bmbouter
452
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.
453
454 131 bmbouter
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.
455 1 bmbouter
456
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.
457
458
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:
459
460
  - the base path of the repository publication (required)
461
  - serving via http (default=False)
462
  - serving via https (default=True)
463 134 bmbouter
  - relationship w/ a Publisher for auto-distribution (should be allowed to be NULL)
464 145 dkliban@redhat.com
  - relationship with Publication (should be allowed to be NULL)
465 132 bmbouter
466
Exporter: An Exporter exports a Publication out of Pulp. e.g. rsync exporter exports content to a remote server
467 131 bmbouter
468
Live API: a viewset endpoint contributed by plugin. For examples see the [associated MVP section](https://pulp.plan.io/projects/pulp/wiki/Pulp_3\_Minimum_Viable_Product#Plugin-Writer-live-APIs)
469
470
Orphan Artifact: An Artifact that is associated with 0 Content Units and 0 Publications
471
472
Orphan Content (unit): A content unit that is a member of 0 repository versions
473
474
Remove (content unit): An operation causing a new repository version to not contain a content unit(s)
475
476
Repository - A named collection of repository versions.
477 1 bmbouter
478
Repository Version - An immutable set of content which is versioned by a sequential number.