Project

Profile

Help

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

amacdona@redhat.com, 04/11/2018 05:13 PM
Live API View registration to black

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