Project

Profile

Help

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

bmbouter, 04/13/2017 11:20 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 1 bmbouter
## Authentication
6
7 17 semyers
As an authenticated user I can manage user(s).
8
9
  - Add a user
10
  - View user(s)
11
  - Update any user detail
12
  - Delete a user
13
14
As an API user, I can have documentation to generate a JSON Web Token (JWT) without the server being online.
15
16
A user authenticated with HTTP/HTTPS "Basic" auth can acquire a non-expiring JWT to access the API.
17
18
  - The JWT shall have a created timestamp which can be used to invalidate
19
  - The JWT shall have a user identifier (its primary key)
20
21
I can authenticate to any API call using HTTP/HTTPS "Basic" auth with a username and password that Pulp stores.
22
23
  - The password is stored as a hash (for security).
24
25
As an API user, I can authenticate any API call with a JWT.
26
27
As an API user, I can invalidate all JWT tokens for a given user issued earlier than now.
28
29
As an authenticated user, when deleting a user 'foo', all of user 'foo's JWTs are invalidated.
30 1 bmbouter
31
## Repositories
32
33 18 dkliban@redhat.com
As an authenticated user, I can list all repos.
34
35
  - All fields are included
36
  - Pagination is supported
37 22 bmbouter
  - <span style="color:red;">Filtering support</span>
38 18 dkliban@redhat.com
39
As an authenticated user, I can CRUD a repository
40
41
  - Create a repo
42
  - Read a repo
43
  - Update all mutable repo fields
44 21 bmbouter
  - Delete a repo (asynchronous)
45 18 dkliban@redhat.com
46
As an authenticated user, I can list a repository's associated importers and publishers
47
48
  - All fields are included
49
  - Pagination is supported
50 22 bmbouter
  - <span style="color:red;">Filtering support</span>
51 18 dkliban@redhat.com
52
As an authenticated user, I can list content in a repository
53
54
  - All fields are included
55
  - Pagination is supported
56 22 bmbouter
  - <span style="color:red;">Filtering support</span>
57 1 bmbouter
58 20 bmbouter
<span style="color:red;">As an authenticated user, I can summarize content in a repo (including counts)</span>
59 18 dkliban@redhat.com
60
As an authenticated user, I can CRUD an importer
61
62
  - Create an importer
63
  - Read an importer
64
  - Update all mutable importer fields
65 21 bmbouter
  - Delete an importer (asynchronous)
66 18 dkliban@redhat.com
67
As an authenticated user, I can CRUD a publisher
68
69
  - Create a publisher
70
  - Read a publisher
71
  - Update all mutable publisher fields
72 21 bmbouter
  - Delete a publisher (asynchronous)
73 1 bmbouter
74
## Content Manipulation
75
76 19 bmbouter
As an authenticated user, I can trigger an importer to sync.
77
78
  - I can follow the progress of all syncs. (Syncs are asynchronous.)
79
  - I cannot pass "sync" options.
80
  - Auto-publish is not included as an importer property.
81
82
As an authenticated user, I can trigger a publisher to publish.
83
84
  - I can follow the progress of all publishes. (Publishes are asynchronous.)
85
  - I cannot pass "publish" options.
86
87
As an authenticated user, I can upload files that will become part of a unit
88
89
As an authenticated user, I can create a unit based on uploaded files
90
91
As an authenticated user, I can associate a unit with a repo.
92
93
As an authenticated user, I can copy a unit(s) from one repo to another
94
95 22 bmbouter
  - <span style="color:red;">Filtering support for specifying the unit(s)</span>
96 1 bmbouter
  - I can follow the progress of all copies. (Copies are asynchronous.)
97
98 20 bmbouter
<span style="color:red;">As an authenticated user, I can clean up orphans</span>  
99
<span style="color:red;">\* I can follow the progress of all cleanups. (Cleanups are asynchronous.)</span>
100 1 bmbouter
101
## Filter
102
103
I can filter all nouns *(What is the meaning of "filter?" What is a noun?)*
104
105
## Task Management
106
107 22 bmbouter
As an authenticated user, I can list all tasks
108
109
  - Filtering support on \['state', 'id', 'group'\]
110
  - This does not include associated progress reports
111
112
As an authenticated user, I can see a detail view for a specific task
113
114
  - all attributes of a task
115
  - all associated progress reports
116
117
As an authenticated user, I can cancel a task
118
119
  - don't dare to use the DELETE verb!
120 1 bmbouter
121
## Task Group
122
123
I can view a summary of the status of all tasks in a group
124
125
## Event Listener Notifier
126
127
I can receive serialized task info via AMQP on each task save
128
129 12 Ichimonji10
*Can this be restated in more pedantic terms? Does this mean that an arbitrary host can attach itself to Pulp's AMQP message bus and get updates on the progress of tasks?*
130
131 1 bmbouter
## Status
132
133
I can view the status of all pulp components  
134
I can view an overall health attribute  
135
I can view information about unapplied migrations
136
137
## Plugin API
138
139
We will have one  
140
We will use one  
141
It will be semantically versioned at 0.x separate from the REST API
142
143 6 Ichimonji10
*Will this API be a Python code interface, a networked HTTP interface, or something else? In other words, for Pulp to use a plugin, will Pulp look for Python code, will it make HTTP calls to some networked resource, or something else?*
144
145
*What are three examples of plugins that will be written? (One goal is "we will use one," so presumably some specific plug-ins are already in mind.)*
146
147 1 bmbouter
## CLI
148
149 8 Ichimonji10
We will port what is there with as little effort as possible *(Does this mean that porting will be easy for developers, or that switching from the Pulp 2-3 CLI will be easy for users? If the former, isn't this an implementation detail that doesn't belong in an MVP document? If the latter, does this mean that we're going to carry forward the issues with pulp-admin, like a lack of status codes?)*
150
151 1 bmbouter
repo CRUD  
152
CRUD for importers  
153
CRUD for publishers  
154
trigger syncs  
155
trigger publish  
156
list content in a repo  
157
upload  
158
server status  
159
list and cancel tasks  
160 8 Ichimonji10
authn via basic auth  
161
*(Should the supported set of operations be stated in terms of "The capabilities listed in the 'Authenctication,' 'Repositories,' and 'Filter' sections will be supported by the CLI."?)*
162 1 bmbouter
163 24 bmbouter
## Download API
164 1 bmbouter
165 9 Ichimonji10
*(Is it correct to say that "I, the user, can download files via HTTP, HTTPS and file://," or "Nectar, the application, can download files via HTTP, HTTPS and file://?")*  
166 1 bmbouter
I can download files via HTTP, HTTPS  
167
I can download via file://  
168 9 Ichimonji10
Authentication parity with 2.y *(Again, is this an "I can do X" statement or a "Nectar can do X" statement?)*  
169 1 bmbouter
Recommend something for bandwidth limiting  
170
Verify integrity of downloaded files  
171 10 Ichimonji10
Alternate content source support *(Please clarify what this means. Does this mean that content can be downloaded via a protocol other than HTTP, HTTPS and file://? Does it mean that a single importer may attempt to download content from a prioritized list of locations? Something else? Assuming this is an importer-related things, which types of importers will support this? RPM? Python? Etc?)*  
172 1 bmbouter
Streamer parity with 2.y
173
174
## Consumer Applicability
175
176
Using consumer profiles and repo bindings I can compute applicability with 2.y parity  
177
Performance needs to be awesome
178
179 11 Ichimonji10
*(Is the Pulp Consumer going away in Pulp 3? If so, is this section still appropriate?)*
180
181 1 bmbouter
## Plugin compatibility
182
183
rpm will work with platform  
184
puppet will work with platform  
185
ostree will work with platform  
186
python will work with platform  
187
file_plugin will work with platform  
188
docker will work with platform
189
190
## Migrations
191
192
users can run an executable similar to pulp-manage-db that is not named pulp-manage-db *(Why the change in name?)*
193 20 bmbouter
194
<span style="color:red;">What about migrating fields that we don't use in 3.0 but will use in 3.1+. For example the auto-publish feature?</span>