Browse Source

Fix queens spec directory structure

This patch fixes the queens spec directory structure which is
missed by this commit: b08b7ce819.

Change-Id: I31ac869f22ee472a5dced3dee2473bf160dc11c9
changes/19/522219/1
Dinesh Bhor 1 year ago
parent
commit
e44b4731dd

+ 1
- 0
doc/source/index.rst View File

@@ -12,6 +12,7 @@ Here you can find the specs, and spec template, for each release:
12 12
    :glob:
13 13
    :maxdepth: 1
14 14
 
15
+   specs/queens/index
15 16
    specs/ocata/index
16 17
    specs/pike/index
17 18
 

+ 1
- 0
doc/source/specs/queens/approved View File

@@ -0,0 +1 @@
1
+../../../../specs/queens/approved

+ 1
- 0
doc/source/specs/queens/implemented View File

@@ -0,0 +1 @@
1
+../../../../specs/queens/implemented

+ 26
- 0
doc/source/specs/queens/index.rst View File

@@ -0,0 +1,26 @@
1
+==============================
2
+Masakari Queens Specifications
3
+==============================
4
+
5
+Template:
6
+
7
+.. toctree::
8
+   :maxdepth: 1
9
+
10
+   Specification Template (Queens release) <template>
11
+
12
+Queens implemented specs:
13
+
14
+.. toctree::
15
+   :glob:
16
+   :maxdepth: 1
17
+
18
+   implemented/*
19
+
20
+Queens approved (but not implemented) specs:
21
+
22
+.. toctree::
23
+   :glob:
24
+   :maxdepth: 1
25
+
26
+   approved/*

+ 1
- 0
doc/source/specs/queens/redirects View File

@@ -0,0 +1 @@
1
+../../../../specs/queens/redirects

+ 1
- 0
doc/source/specs/queens/template.rst View File

@@ -0,0 +1 @@
1
+../../../../specs/queens-template.rst

+ 389
- 0
specs/queens-template.rst View File

@@ -0,0 +1,389 @@
1
+..
2
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
3
+ License.
4
+
5
+ http://creativecommons.org/licenses/by/3.0/legalcode
6
+
7
+==========================================
8
+Example Spec - The title of your blueprint
9
+==========================================
10
+
11
+Include the URL of your launchpad blueprint:
12
+
13
+https://blueprints.launchpad.net/masakari/+spec/example
14
+
15
+Introduction paragraph -- why are we doing anything? A single paragraph of
16
+prose that operators can understand. The title and this first paragraph
17
+should be used as the subject line and body of the commit message
18
+respectively.
19
+
20
+Some notes about the masakari-spec and blueprint process:
21
+
22
+* Not all blueprints need a spec. For more information see
23
+  https://wiki.openstack.org/wiki/Masakari-specs
24
+
25
+* The aim of this document is first to define the problem we need to solve,
26
+  and second agree the overall approach to solve that problem.
27
+
28
+* This is not intended to be extensive documentation for a new feature.
29
+  For example, there is no need to specify the exact configuration changes,
30
+  nor the exact details of any DB model changes. But you should still define
31
+  that such changes are required, and be clear on how that will affect
32
+  upgrades.
33
+
34
+* You should aim to get your spec approved before writing your code.
35
+  While you are free to write prototypes and code before getting your spec
36
+  approved, its possible that the outcome of the spec review process leads
37
+  you towards a fundamentally different solution than you first envisaged.
38
+
39
+* But, API changes are held to a much higher level of scrutiny.
40
+  As soon as an API change merges, we must assume it could be in production
41
+  somewhere, and as such, we then need to support that API change forever.
42
+  To avoid getting that wrong, we do want lots of details about API changes
43
+  upfront.
44
+
45
+Some notes about using this template:
46
+
47
+* Your spec should be in ReSTructured text, like this template.
48
+
49
+* Please wrap text at 79 columns.
50
+
51
+* The filename in the git repository should match the launchpad URL, for
52
+  example a URL of: https://blueprints.launchpad.net/masakari/+spec/awesome-thing
53
+  should be named awesome-thing.rst
54
+
55
+* Please do not delete any of the sections in this template.  If you have
56
+  nothing to say for a whole section, just write: None
57
+
58
+* For help with syntax, see http://sphinx-doc.org/rest.html
59
+
60
+* To test out your formatting, build the docs using tox and see the generated
61
+  HTML file in doc/build/html/specs/<path_of_your_file>
62
+
63
+* If you would like to provide a diagram with your spec, ascii diagrams are
64
+  required.  http://asciiflow.com/ is a very nice tool to assist with making
65
+  ascii diagrams.  The reason for this is that the tool used to review specs is
66
+  based purely on plain text.  Plain text will allow review to proceed without
67
+  having to look at additional files which can not be viewed in gerrit.  It
68
+  will also allow inline feedback on the diagram itself.
69
+
70
+* If your specification proposes any changes to the Masakari REST API such
71
+  as changing parameters which can be returned or accepted, or even
72
+  the semantics of what happens when a client calls into the API, then
73
+  you should add the APIImpact flag to the commit message.
74
+
75
+Problem description
76
+===================
77
+
78
+A detailed description of the problem. What problem is this blueprint
79
+addressing?
80
+
81
+Use Cases
82
+---------
83
+
84
+What use cases does this address? What impact on actors does this change have?
85
+Ensure you are clear about the actors in each use case: Developer, End User,
86
+Deployer etc.
87
+
88
+Proposed change
89
+===============
90
+
91
+Here is where you cover the change you propose to make in detail. How do you
92
+propose to solve this problem?
93
+
94
+If this is one part of a larger effort make it clear where this piece ends. In
95
+other words, what's the scope of this effort?
96
+
97
+At this point, if you would like to just get feedback on if the problem and
98
+proposed change fit in Masakari, you can stop here and post this for
99
+review to get preliminary feedback. If so please say:
100
+Posting to get preliminary feedback on the scope of this spec.
101
+
102
+Alternatives
103
+------------
104
+
105
+What other ways could we do this thing? Why aren't we using those? This doesn't
106
+have to be a full literature review, but it should demonstrate that thought has
107
+been put into why the proposed solution is an appropriate one.
108
+
109
+Data model impact
110
+-----------------
111
+
112
+Changes which require modifications to the data model often have a wider impact
113
+on the system.  The community often has strong opinions on how the data model
114
+should be evolved, from both a functional and performance perspective. It is
115
+therefore important to capture and gain agreement as early as possible on any
116
+proposed changes to the data model.
117
+
118
+Questions which need to be addressed by this section include:
119
+
120
+* What new data objects and/or database schema changes is this going to
121
+  require?
122
+
123
+* What database migrations will accompany this change.
124
+
125
+* How will the initial set of new data objects be generated, for example if you
126
+  need to take into account existing instances, or modify other existing data
127
+  describe how that will work.
128
+
129
+REST API impact
130
+---------------
131
+
132
+Each API method which is either added or changed should have the following
133
+
134
+* Specification for the method
135
+
136
+  * A description of what the method does suitable for use in
137
+    user documentation
138
+
139
+  * Method type (POST/PUT/GET/DELETE)
140
+
141
+  * Normal http response code(s)
142
+
143
+  * Expected error http response code(s)
144
+
145
+    * A description for each possible error code should be included
146
+      describing semantic errors which can cause it such as
147
+      inconsistent parameters supplied to the method, or when an
148
+      instance is not in an appropriate state for the request to
149
+      succeed. Errors caused by syntactic problems covered by the JSON
150
+      schema definition do not need to be included.
151
+
152
+  * URL for the resource
153
+
154
+    * URL should not include underscores, and use hyphens instead.
155
+
156
+  * Parameters which can be passed via the url
157
+
158
+  * JSON schema definition for the request body data if allowed
159
+
160
+    * Field names should use snake_case style, not CamelCase or MixedCase
161
+      style.
162
+
163
+  * JSON schema definition for the response body data if any
164
+
165
+    * Field names should use snake_case style, not CamelCase or MixedCase
166
+      style.
167
+
168
+* Example use case including typical API samples for both data supplied
169
+  by the caller and the response
170
+
171
+* Discuss any policy changes, and discuss what things a deployer needs to
172
+  think about when defining their policy.
173
+
174
+Note that the schema should be defined as restrictively as
175
+possible. Parameters which are required should be marked as such and
176
+only under exceptional circumstances should additional parameters
177
+which are not defined in the schema be permitted (eg
178
+additionaProperties should be False).
179
+
180
+Reuse of existing predefined parameter types such as regexps for
181
+passwords and user defined names is highly encouraged.
182
+
183
+Security impact
184
+---------------
185
+
186
+Describe any potential security impact on the system.  Some of the items to
187
+consider include:
188
+
189
+* Does this change touch sensitive data such as tokens, keys, or user data?
190
+
191
+* Does this change alter the API in a way that may impact security, such as
192
+  a new way to access sensitive information or a new way to login?
193
+
194
+* Does this change involve cryptography or hashing?
195
+
196
+* Does this change require the use of sudo or any elevated privileges?
197
+
198
+* Does this change involve using or parsing user-provided data? This could
199
+  be directly at the API level or indirectly such as changes to a cache layer.
200
+
201
+* Can this change enable a resource exhaustion attack, such as allowing a
202
+  single API interaction to consume significant server resources? Some examples
203
+  of this include launching subprocesses for each connection, or entity
204
+  expansion attacks in XML.
205
+
206
+For more detailed guidance, please see the OpenStack Security Guidelines as
207
+a reference (https://wiki.openstack.org/wiki/Security/Guidelines).  These
208
+guidelines are a work in progress and are designed to help you identify
209
+security best practices.  For further information, feel free to reach out
210
+to the OpenStack Security Group at openstack-security@lists.openstack.org.
211
+
212
+Notifications impact
213
+--------------------
214
+
215
+Please specify any changes to notifications. Be that an extra notification,
216
+changes to an existing notification, or removing a notification.
217
+
218
+Other end user impact
219
+---------------------
220
+
221
+Aside from the API, are there other ways a user will interact with this
222
+feature?
223
+
224
+* Does this change have an impact on python-masakariclient? What does the user
225
+  interface there look like?
226
+
227
+Performance Impact
228
+------------------
229
+
230
+Describe any potential performance impact on the system, for example
231
+how often will new code be called, and is there a major change to the calling
232
+pattern of existing code.
233
+
234
+Examples of things to consider here include:
235
+
236
+* A periodic task might look like a small addition but if it calls conductor or
237
+  another service the load is multiplied by the number of nodes in the system.
238
+
239
+* Scheduler filters get called once per host for every instance being created,
240
+  so any latency they introduce is linear with the size of the system.
241
+
242
+* A small change in a utility function or a commonly used decorator can have a
243
+  large impacts on performance.
244
+
245
+* Calls which result in a database queries (whether direct or via conductor)
246
+  can have a profound impact on performance when called in critical sections of
247
+  the code.
248
+
249
+* Will the change include any locking, and if so what considerations are there
250
+  on holding the lock?
251
+
252
+Other deployer impact
253
+---------------------
254
+
255
+Discuss things that will affect how you deploy and configure OpenStack
256
+that have not already been mentioned, such as:
257
+
258
+* What config options are being added? Should they be more generic than
259
+  proposed (for example a flag that other hypervisor drivers might want to
260
+  implement as well)? Are the default values ones which will work well in
261
+  real deployments?
262
+
263
+* Is this a change that takes immediate effect after its merged, or is it
264
+  something that has to be explicitly enabled?
265
+
266
+* If this change is a new binary, how would it be deployed?
267
+
268
+* Please state anything that those doing continuous deployment, or those
269
+  upgrading from the previous release, need to be aware of. Also describe
270
+  any plans to deprecate configuration values or features.  For example, if we
271
+  change the directory name that instances are stored in, how do we handle
272
+  instance directories created before the change landed?  Do we move them?  Do
273
+  we have a special case in the code? Do we assume that the operator will
274
+  recreate all the instances in their cloud?
275
+
276
+Developer impact
277
+----------------
278
+
279
+Discuss things that will affect other developers working on OpenStack,
280
+such as:
281
+
282
+* If the blueprint proposes a change to the driver API, discussion of how
283
+  other hypervisors would implement the feature is required.
284
+
285
+
286
+Implementation
287
+==============
288
+
289
+Assignee(s)
290
+-----------
291
+
292
+Who is leading the writing of the code? Or is this a blueprint where you're
293
+throwing it out there to see who picks it up?
294
+
295
+If more than one person is working on the implementation, please designate the
296
+primary author and contact.
297
+
298
+Primary assignee:
299
+  <launchpad-id or None>
300
+
301
+Other contributors:
302
+  <launchpad-id or None>
303
+
304
+Work Items
305
+----------
306
+
307
+Work items or tasks -- break the feature up into the things that need to be
308
+done to implement it. Those parts might end up being done by different people,
309
+but we're mostly trying to understand the timeline for implementation.
310
+
311
+
312
+Dependencies
313
+============
314
+
315
+* Include specific references to specs and/or blueprints in Masakari,
316
+  or in other projects, that this one either depends on or is related to.
317
+
318
+* If this requires functionality of another project that is not currently used
319
+  by Masakari (such as nova, or masakari-monitors, python-masakariclient),
320
+  document that fact.
321
+
322
+* Does this feature require any new library dependencies or code otherwise not
323
+  included in OpenStack? Or does it depend on a specific version of library?
324
+
325
+
326
+Testing
327
+=======
328
+
329
+Please discuss the important scenarios needed to test here, as well as
330
+specific edge cases we should be ensuring work correctly. For each
331
+scenario please specify if this requires specialized hardware, a full
332
+openstack environment, or can be simulated inside the Masakari tree.
333
+
334
+Please discuss how the change will be tested. We especially want to know what
335
+tempest tests will be added. It is assumed that unit test coverage will be
336
+added so that doesn't need to be mentioned explicitly, but discussion of why
337
+you think unit tests are sufficient and we don't need to add more tempest
338
+tests would need to be included.
339
+
340
+Is this untestable in gate given current limitations (specific hardware /
341
+software configurations available)? If so, are there mitigation plans (3rd
342
+party testing, gate enhancements, etc).
343
+
344
+
345
+Documentation Impact
346
+====================
347
+
348
+Which audiences are affected most by this change, and which documentation
349
+titles on docs.openstack.org should be updated because of this change? Don't
350
+repeat details discussed above, but reference them here in the context of
351
+documentation for multiple audiences. For example, the Operations Guide targets
352
+cloud operators, and the End User Guide would need to be updated if the change
353
+offers a new feature available through the CLI or dashboard. If a config option
354
+changes or is deprecated, note here that the documentation needs to be updated
355
+to reflect this specification's change.
356
+
357
+References
358
+==========
359
+
360
+Please add any useful references here. You are not required to have any
361
+reference. Moreover, this specification should still make sense when your
362
+references are unavailable. Examples of what you could include are:
363
+
364
+* Links to mailing list or IRC discussions
365
+
366
+* Links to notes from a summit session
367
+
368
+* Links to relevant research, if appropriate
369
+
370
+* Related specifications as appropriate (e.g.  if it's an EC2 thing, link the
371
+  EC2 docs)
372
+
373
+* Anything else you feel it is worthwhile to refer to
374
+
375
+
376
+History
377
+=======
378
+
379
+Optional section intended to be used each time the spec is updated to describe
380
+new design, API or any database schema updated. Useful to let reader understand
381
+what's happened along the time.
382
+
383
+.. list-table:: Revisions
384
+   :header-rows: 1
385
+
386
+   * - Release Name
387
+     - Description
388
+   * - Queens
389
+     - Introduced

+ 389
- 0
specs/queens/approved/queens-template.rst View File

@@ -0,0 +1,389 @@
1
+..
2
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
3
+ License.
4
+
5
+ http://creativecommons.org/licenses/by/3.0/legalcode
6
+
7
+==========================================
8
+Example Spec - The title of your blueprint
9
+==========================================
10
+
11
+Include the URL of your launchpad blueprint:
12
+
13
+https://blueprints.launchpad.net/masakari/+spec/example
14
+
15
+Introduction paragraph -- why are we doing anything? A single paragraph of
16
+prose that operators can understand. The title and this first paragraph
17
+should be used as the subject line and body of the commit message
18
+respectively.
19
+
20
+Some notes about the masakari-spec and blueprint process:
21
+
22
+* Not all blueprints need a spec. For more information see
23
+  https://wiki.openstack.org/wiki/Masakari-specs
24
+
25
+* The aim of this document is first to define the problem we need to solve,
26
+  and second agree the overall approach to solve that problem.
27
+
28
+* This is not intended to be extensive documentation for a new feature.
29
+  For example, there is no need to specify the exact configuration changes,
30
+  nor the exact details of any DB model changes. But you should still define
31
+  that such changes are required, and be clear on how that will affect
32
+  upgrades.
33
+
34
+* You should aim to get your spec approved before writing your code.
35
+  While you are free to write prototypes and code before getting your spec
36
+  approved, its possible that the outcome of the spec review process leads
37
+  you towards a fundamentally different solution than you first envisaged.
38
+
39
+* But, API changes are held to a much higher level of scrutiny.
40
+  As soon as an API change merges, we must assume it could be in production
41
+  somewhere, and as such, we then need to support that API change forever.
42
+  To avoid getting that wrong, we do want lots of details about API changes
43
+  upfront.
44
+
45
+Some notes about using this template:
46
+
47
+* Your spec should be in ReSTructured text, like this template.
48
+
49
+* Please wrap text at 79 columns.
50
+
51
+* The filename in the git repository should match the launchpad URL, for
52
+  example a URL of: https://blueprints.launchpad.net/masakari/+spec/awesome-thing
53
+  should be named awesome-thing.rst
54
+
55
+* Please do not delete any of the sections in this template.  If you have
56
+  nothing to say for a whole section, just write: None
57
+
58
+* For help with syntax, see http://sphinx-doc.org/rest.html
59
+
60
+* To test out your formatting, build the docs using tox and see the generated
61
+  HTML file in doc/build/html/specs/<path_of_your_file>
62
+
63
+* If you would like to provide a diagram with your spec, ascii diagrams are
64
+  required.  http://asciiflow.com/ is a very nice tool to assist with making
65
+  ascii diagrams.  The reason for this is that the tool used to review specs is
66
+  based purely on plain text.  Plain text will allow review to proceed without
67
+  having to look at additional files which can not be viewed in gerrit.  It
68
+  will also allow inline feedback on the diagram itself.
69
+
70
+* If your specification proposes any changes to the Masakari REST API such
71
+  as changing parameters which can be returned or accepted, or even
72
+  the semantics of what happens when a client calls into the API, then
73
+  you should add the APIImpact flag to the commit message.
74
+
75
+Problem description
76
+===================
77
+
78
+A detailed description of the problem. What problem is this blueprint
79
+addressing?
80
+
81
+Use Cases
82
+---------
83
+
84
+What use cases does this address? What impact on actors does this change have?
85
+Ensure you are clear about the actors in each use case: Developer, End User,
86
+Deployer etc.
87
+
88
+Proposed change
89
+===============
90
+
91
+Here is where you cover the change you propose to make in detail. How do you
92
+propose to solve this problem?
93
+
94
+If this is one part of a larger effort make it clear where this piece ends. In
95
+other words, what's the scope of this effort?
96
+
97
+At this point, if you would like to just get feedback on if the problem and
98
+proposed change fit in Masakari, you can stop here and post this for
99
+review to get preliminary feedback. If so please say:
100
+Posting to get preliminary feedback on the scope of this spec.
101
+
102
+Alternatives
103
+------------
104
+
105
+What other ways could we do this thing? Why aren't we using those? This doesn't
106
+have to be a full literature review, but it should demonstrate that thought has
107
+been put into why the proposed solution is an appropriate one.
108
+
109
+Data model impact
110
+-----------------
111
+
112
+Changes which require modifications to the data model often have a wider impact
113
+on the system.  The community often has strong opinions on how the data model
114
+should be evolved, from both a functional and performance perspective. It is
115
+therefore important to capture and gain agreement as early as possible on any
116
+proposed changes to the data model.
117
+
118
+Questions which need to be addressed by this section include:
119
+
120
+* What new data objects and/or database schema changes is this going to
121
+  require?
122
+
123
+* What database migrations will accompany this change.
124
+
125
+* How will the initial set of new data objects be generated, for example if you
126
+  need to take into account existing instances, or modify other existing data
127
+  describe how that will work.
128
+
129
+REST API impact
130
+---------------
131
+
132
+Each API method which is either added or changed should have the following
133
+
134
+* Specification for the method
135
+
136
+  * A description of what the method does suitable for use in
137
+    user documentation
138
+
139
+  * Method type (POST/PUT/GET/DELETE)
140
+
141
+  * Normal http response code(s)
142
+
143
+  * Expected error http response code(s)
144
+
145
+    * A description for each possible error code should be included
146
+      describing semantic errors which can cause it such as
147
+      inconsistent parameters supplied to the method, or when an
148
+      instance is not in an appropriate state for the request to
149
+      succeed. Errors caused by syntactic problems covered by the JSON
150
+      schema definition do not need to be included.
151
+
152
+  * URL for the resource
153
+
154
+    * URL should not include underscores, and use hyphens instead.
155
+
156
+  * Parameters which can be passed via the url
157
+
158
+  * JSON schema definition for the request body data if allowed
159
+
160
+    * Field names should use snake_case style, not CamelCase or MixedCase
161
+      style.
162
+
163
+  * JSON schema definition for the response body data if any
164
+
165
+    * Field names should use snake_case style, not CamelCase or MixedCase
166
+      style.
167
+
168
+* Example use case including typical API samples for both data supplied
169
+  by the caller and the response
170
+
171
+* Discuss any policy changes, and discuss what things a deployer needs to
172
+  think about when defining their policy.
173
+
174
+Note that the schema should be defined as restrictively as
175
+possible. Parameters which are required should be marked as such and
176
+only under exceptional circumstances should additional parameters
177
+which are not defined in the schema be permitted (eg
178
+additionaProperties should be False).
179
+
180
+Reuse of existing predefined parameter types such as regexps for
181
+passwords and user defined names is highly encouraged.
182
+
183
+Security impact
184
+---------------
185
+
186
+Describe any potential security impact on the system.  Some of the items to
187
+consider include:
188
+
189
+* Does this change touch sensitive data such as tokens, keys, or user data?
190
+
191
+* Does this change alter the API in a way that may impact security, such as
192
+  a new way to access sensitive information or a new way to login?
193
+
194
+* Does this change involve cryptography or hashing?
195
+
196
+* Does this change require the use of sudo or any elevated privileges?
197
+
198
+* Does this change involve using or parsing user-provided data? This could
199
+  be directly at the API level or indirectly such as changes to a cache layer.
200
+
201
+* Can this change enable a resource exhaustion attack, such as allowing a
202
+  single API interaction to consume significant server resources? Some examples
203
+  of this include launching subprocesses for each connection, or entity
204
+  expansion attacks in XML.
205
+
206
+For more detailed guidance, please see the OpenStack Security Guidelines as
207
+a reference (https://wiki.openstack.org/wiki/Security/Guidelines).  These
208
+guidelines are a work in progress and are designed to help you identify
209
+security best practices.  For further information, feel free to reach out
210
+to the OpenStack Security Group at openstack-security@lists.openstack.org.
211
+
212
+Notifications impact
213
+--------------------
214
+
215
+Please specify any changes to notifications. Be that an extra notification,
216
+changes to an existing notification, or removing a notification.
217
+
218
+Other end user impact
219
+---------------------
220
+
221
+Aside from the API, are there other ways a user will interact with this
222
+feature?
223
+
224
+* Does this change have an impact on python-masakariclient? What does the user
225
+  interface there look like?
226
+
227
+Performance Impact
228
+------------------
229
+
230
+Describe any potential performance impact on the system, for example
231
+how often will new code be called, and is there a major change to the calling
232
+pattern of existing code.
233
+
234
+Examples of things to consider here include:
235
+
236
+* A periodic task might look like a small addition but if it calls conductor or
237
+  another service the load is multiplied by the number of nodes in the system.
238
+
239
+* Scheduler filters get called once per host for every instance being created,
240
+  so any latency they introduce is linear with the size of the system.
241
+
242
+* A small change in a utility function or a commonly used decorator can have a
243
+  large impacts on performance.
244
+
245
+* Calls which result in a database queries (whether direct or via conductor)
246
+  can have a profound impact on performance when called in critical sections of
247
+  the code.
248
+
249
+* Will the change include any locking, and if so what considerations are there
250
+  on holding the lock?
251
+
252
+Other deployer impact
253
+---------------------
254
+
255
+Discuss things that will affect how you deploy and configure OpenStack
256
+that have not already been mentioned, such as:
257
+
258
+* What config options are being added? Should they be more generic than
259
+  proposed (for example a flag that other hypervisor drivers might want to
260
+  implement as well)? Are the default values ones which will work well in
261
+  real deployments?
262
+
263
+* Is this a change that takes immediate effect after its merged, or is it
264
+  something that has to be explicitly enabled?
265
+
266
+* If this change is a new binary, how would it be deployed?
267
+
268
+* Please state anything that those doing continuous deployment, or those
269
+  upgrading from the previous release, need to be aware of. Also describe
270
+  any plans to deprecate configuration values or features.  For example, if we
271
+  change the directory name that instances are stored in, how do we handle
272
+  instance directories created before the change landed?  Do we move them?  Do
273
+  we have a special case in the code? Do we assume that the operator will
274
+  recreate all the instances in their cloud?
275
+
276
+Developer impact
277
+----------------
278
+
279
+Discuss things that will affect other developers working on OpenStack,
280
+such as:
281
+
282
+* If the blueprint proposes a change to the driver API, discussion of how
283
+  other hypervisors would implement the feature is required.
284
+
285
+
286
+Implementation
287
+==============
288
+
289
+Assignee(s)
290
+-----------
291
+
292
+Who is leading the writing of the code? Or is this a blueprint where you're
293
+throwing it out there to see who picks it up?
294
+
295
+If more than one person is working on the implementation, please designate the
296
+primary author and contact.
297
+
298
+Primary assignee:
299
+  <launchpad-id or None>
300
+
301
+Other contributors:
302
+  <launchpad-id or None>
303
+
304
+Work Items
305
+----------
306
+
307
+Work items or tasks -- break the feature up into the things that need to be
308
+done to implement it. Those parts might end up being done by different people,
309
+but we're mostly trying to understand the timeline for implementation.
310
+
311
+
312
+Dependencies
313
+============
314
+
315
+* Include specific references to specs and/or blueprints in Masakari,
316
+  or in other projects, that this one either depends on or is related to.
317
+
318
+* If this requires functionality of another project that is not currently used
319
+  by Masakari (such as nova, or masakari-monitors, python-masakariclient),
320
+  document that fact.
321
+
322
+* Does this feature require any new library dependencies or code otherwise not
323
+  included in OpenStack? Or does it depend on a specific version of library?
324
+
325
+
326
+Testing
327
+=======
328
+
329
+Please discuss the important scenarios needed to test here, as well as
330
+specific edge cases we should be ensuring work correctly. For each
331
+scenario please specify if this requires specialized hardware, a full
332
+openstack environment, or can be simulated inside the Masakari tree.
333
+
334
+Please discuss how the change will be tested. We especially want to know what
335
+tempest tests will be added. It is assumed that unit test coverage will be
336
+added so that doesn't need to be mentioned explicitly, but discussion of why
337
+you think unit tests are sufficient and we don't need to add more tempest
338
+tests would need to be included.
339
+
340
+Is this untestable in gate given current limitations (specific hardware /
341
+software configurations available)? If so, are there mitigation plans (3rd
342
+party testing, gate enhancements, etc).
343
+
344
+
345
+Documentation Impact
346
+====================
347
+
348
+Which audiences are affected most by this change, and which documentation
349
+titles on docs.openstack.org should be updated because of this change? Don't
350
+repeat details discussed above, but reference them here in the context of
351
+documentation for multiple audiences. For example, the Operations Guide targets
352
+cloud operators, and the End User Guide would need to be updated if the change
353
+offers a new feature available through the CLI or dashboard. If a config option
354
+changes or is deprecated, note here that the documentation needs to be updated
355
+to reflect this specification's change.
356
+
357
+References
358
+==========
359
+
360
+Please add any useful references here. You are not required to have any
361
+reference. Moreover, this specification should still make sense when your
362
+references are unavailable. Examples of what you could include are:
363
+
364
+* Links to mailing list or IRC discussions
365
+
366
+* Links to notes from a summit session
367
+
368
+* Links to relevant research, if appropriate
369
+
370
+* Related specifications as appropriate (e.g.  if it's an EC2 thing, link the
371
+  EC2 docs)
372
+
373
+* Anything else you feel it is worthwhile to refer to
374
+
375
+
376
+History
377
+=======
378
+
379
+Optional section intended to be used each time the spec is updated to describe
380
+new design, API or any database schema updated. Useful to let reader understand
381
+what's happened along the time.
382
+
383
+.. list-table:: Revisions
384
+   :header-rows: 1
385
+
386
+   * - Release Name
387
+     - Description
388
+   * - Queens
389
+     - Introduced

+ 389
- 0
specs/queens/implemented/queens-template.rst View File

@@ -0,0 +1,389 @@
1
+..
2
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
3
+ License.
4
+
5
+ http://creativecommons.org/licenses/by/3.0/legalcode
6
+
7
+==========================================
8
+Example Spec - The title of your blueprint
9
+==========================================
10
+
11
+Include the URL of your launchpad blueprint:
12
+
13
+https://blueprints.launchpad.net/masakari/+spec/example
14
+
15
+Introduction paragraph -- why are we doing anything? A single paragraph of
16
+prose that operators can understand. The title and this first paragraph
17
+should be used as the subject line and body of the commit message
18
+respectively.
19
+
20
+Some notes about the masakari-spec and blueprint process:
21
+
22
+* Not all blueprints need a spec. For more information see
23
+  https://wiki.openstack.org/wiki/Masakari-specs
24
+
25
+* The aim of this document is first to define the problem we need to solve,
26
+  and second agree the overall approach to solve that problem.
27
+
28
+* This is not intended to be extensive documentation for a new feature.
29
+  For example, there is no need to specify the exact configuration changes,
30
+  nor the exact details of any DB model changes. But you should still define
31
+  that such changes are required, and be clear on how that will affect
32
+  upgrades.
33
+
34
+* You should aim to get your spec approved before writing your code.
35
+  While you are free to write prototypes and code before getting your spec
36
+  approved, its possible that the outcome of the spec review process leads
37
+  you towards a fundamentally different solution than you first envisaged.
38
+
39
+* But, API changes are held to a much higher level of scrutiny.
40
+  As soon as an API change merges, we must assume it could be in production
41
+  somewhere, and as such, we then need to support that API change forever.
42
+  To avoid getting that wrong, we do want lots of details about API changes
43
+  upfront.
44
+
45
+Some notes about using this template:
46
+
47
+* Your spec should be in ReSTructured text, like this template.
48
+
49
+* Please wrap text at 79 columns.
50
+
51
+* The filename in the git repository should match the launchpad URL, for
52
+  example a URL of: https://blueprints.launchpad.net/masakari/+spec/awesome-thing
53
+  should be named awesome-thing.rst
54
+
55
+* Please do not delete any of the sections in this template.  If you have
56
+  nothing to say for a whole section, just write: None
57
+
58
+* For help with syntax, see http://sphinx-doc.org/rest.html
59
+
60
+* To test out your formatting, build the docs using tox and see the generated
61
+  HTML file in doc/build/html/specs/<path_of_your_file>
62
+
63
+* If you would like to provide a diagram with your spec, ascii diagrams are
64
+  required.  http://asciiflow.com/ is a very nice tool to assist with making
65
+  ascii diagrams.  The reason for this is that the tool used to review specs is
66
+  based purely on plain text.  Plain text will allow review to proceed without
67
+  having to look at additional files which can not be viewed in gerrit.  It
68
+  will also allow inline feedback on the diagram itself.
69
+
70
+* If your specification proposes any changes to the Masakari REST API such
71
+  as changing parameters which can be returned or accepted, or even
72
+  the semantics of what happens when a client calls into the API, then
73
+  you should add the APIImpact flag to the commit message.
74
+
75
+Problem description
76
+===================
77
+
78
+A detailed description of the problem. What problem is this blueprint
79
+addressing?
80
+
81
+Use Cases
82
+---------
83
+
84
+What use cases does this address? What impact on actors does this change have?
85
+Ensure you are clear about the actors in each use case: Developer, End User,
86
+Deployer etc.
87
+
88
+Proposed change
89
+===============
90
+
91
+Here is where you cover the change you propose to make in detail. How do you
92
+propose to solve this problem?
93
+
94
+If this is one part of a larger effort make it clear where this piece ends. In
95
+other words, what's the scope of this effort?
96
+
97
+At this point, if you would like to just get feedback on if the problem and
98
+proposed change fit in Masakari, you can stop here and post this for
99
+review to get preliminary feedback. If so please say:
100
+Posting to get preliminary feedback on the scope of this spec.
101
+
102
+Alternatives
103
+------------
104
+
105
+What other ways could we do this thing? Why aren't we using those? This doesn't
106
+have to be a full literature review, but it should demonstrate that thought has
107
+been put into why the proposed solution is an appropriate one.
108
+
109
+Data model impact
110
+-----------------
111
+
112
+Changes which require modifications to the data model often have a wider impact
113
+on the system.  The community often has strong opinions on how the data model
114
+should be evolved, from both a functional and performance perspective. It is
115
+therefore important to capture and gain agreement as early as possible on any
116
+proposed changes to the data model.
117
+
118
+Questions which need to be addressed by this section include:
119
+
120
+* What new data objects and/or database schema changes is this going to
121
+  require?
122
+
123
+* What database migrations will accompany this change.
124
+
125
+* How will the initial set of new data objects be generated, for example if you
126
+  need to take into account existing instances, or modify other existing data
127
+  describe how that will work.
128
+
129
+REST API impact
130
+---------------
131
+
132
+Each API method which is either added or changed should have the following
133
+
134
+* Specification for the method
135
+
136
+  * A description of what the method does suitable for use in
137
+    user documentation
138
+
139
+  * Method type (POST/PUT/GET/DELETE)
140
+
141
+  * Normal http response code(s)
142
+
143
+  * Expected error http response code(s)
144
+
145
+    * A description for each possible error code should be included
146
+      describing semantic errors which can cause it such as
147
+      inconsistent parameters supplied to the method, or when an
148
+      instance is not in an appropriate state for the request to
149
+      succeed. Errors caused by syntactic problems covered by the JSON
150
+      schema definition do not need to be included.
151
+
152
+  * URL for the resource
153
+
154
+    * URL should not include underscores, and use hyphens instead.
155
+
156
+  * Parameters which can be passed via the url
157
+
158
+  * JSON schema definition for the request body data if allowed
159
+
160
+    * Field names should use snake_case style, not CamelCase or MixedCase
161
+      style.
162
+
163
+  * JSON schema definition for the response body data if any
164
+
165
+    * Field names should use snake_case style, not CamelCase or MixedCase
166
+      style.
167
+
168
+* Example use case including typical API samples for both data supplied
169
+  by the caller and the response
170
+
171
+* Discuss any policy changes, and discuss what things a deployer needs to
172
+  think about when defining their policy.
173
+
174
+Note that the schema should be defined as restrictively as
175
+possible. Parameters which are required should be marked as such and
176
+only under exceptional circumstances should additional parameters
177
+which are not defined in the schema be permitted (eg
178
+additionaProperties should be False).
179
+
180
+Reuse of existing predefined parameter types such as regexps for
181
+passwords and user defined names is highly encouraged.
182
+
183
+Security impact
184
+---------------
185
+
186
+Describe any potential security impact on the system.  Some of the items to
187
+consider include:
188
+
189
+* Does this change touch sensitive data such as tokens, keys, or user data?
190
+
191
+* Does this change alter the API in a way that may impact security, such as
192
+  a new way to access sensitive information or a new way to login?
193
+
194
+* Does this change involve cryptography or hashing?
195
+
196
+* Does this change require the use of sudo or any elevated privileges?
197
+
198
+* Does this change involve using or parsing user-provided data? This could
199
+  be directly at the API level or indirectly such as changes to a cache layer.
200
+
201
+* Can this change enable a resource exhaustion attack, such as allowing a
202
+  single API interaction to consume significant server resources? Some examples
203
+  of this include launching subprocesses for each connection, or entity
204
+  expansion attacks in XML.
205
+
206
+For more detailed guidance, please see the OpenStack Security Guidelines as
207
+a reference (https://wiki.openstack.org/wiki/Security/Guidelines).  These
208
+guidelines are a work in progress and are designed to help you identify
209
+security best practices.  For further information, feel free to reach out
210
+to the OpenStack Security Group at openstack-security@lists.openstack.org.
211
+
212
+Notifications impact
213
+--------------------
214
+
215
+Please specify any changes to notifications. Be that an extra notification,
216
+changes to an existing notification, or removing a notification.
217
+
218
+Other end user impact
219
+---------------------
220
+
221
+Aside from the API, are there other ways a user will interact with this
222
+feature?
223
+
224
+* Does this change have an impact on python-masakariclient? What does the user
225
+  interface there look like?
226
+
227
+Performance Impact
228
+------------------
229
+
230
+Describe any potential performance impact on the system, for example
231
+how often will new code be called, and is there a major change to the calling
232
+pattern of existing code.
233
+
234
+Examples of things to consider here include:
235
+
236
+* A periodic task might look like a small addition but if it calls conductor or
237
+  another service the load is multiplied by the number of nodes in the system.
238
+
239
+* Scheduler filters get called once per host for every instance being created,
240
+  so any latency they introduce is linear with the size of the system.
241
+
242
+* A small change in a utility function or a commonly used decorator can have a
243
+  large impacts on performance.
244
+
245
+* Calls which result in a database queries (whether direct or via conductor)
246
+  can have a profound impact on performance when called in critical sections of
247
+  the code.
248
+
249
+* Will the change include any locking, and if so what considerations are there
250
+  on holding the lock?
251
+
252
+Other deployer impact
253
+---------------------
254
+
255
+Discuss things that will affect how you deploy and configure OpenStack
256
+that have not already been mentioned, such as:
257
+
258
+* What config options are being added? Should they be more generic than
259
+  proposed (for example a flag that other hypervisor drivers might want to
260
+  implement as well)? Are the default values ones which will work well in
261
+  real deployments?
262
+
263
+* Is this a change that takes immediate effect after its merged, or is it
264
+  something that has to be explicitly enabled?
265
+
266
+* If this change is a new binary, how would it be deployed?
267
+
268
+* Please state anything that those doing continuous deployment, or those
269
+  upgrading from the previous release, need to be aware of. Also describe
270
+  any plans to deprecate configuration values or features.  For example, if we
271
+  change the directory name that instances are stored in, how do we handle
272
+  instance directories created before the change landed?  Do we move them?  Do
273
+  we have a special case in the code? Do we assume that the operator will
274
+  recreate all the instances in their cloud?
275
+
276
+Developer impact
277
+----------------
278
+
279
+Discuss things that will affect other developers working on OpenStack,
280
+such as:
281
+
282
+* If the blueprint proposes a change to the driver API, discussion of how
283
+  other hypervisors would implement the feature is required.
284
+
285
+
286
+Implementation
287
+==============
288
+
289
+Assignee(s)
290
+-----------
291
+
292
+Who is leading the writing of the code? Or is this a blueprint where you're
293
+throwing it out there to see who picks it up?
294
+
295
+If more than one person is working on the implementation, please designate the
296
+primary author and contact.
297
+
298
+Primary assignee:
299
+  <launchpad-id or None>
300
+
301
+Other contributors:
302
+  <launchpad-id or None>
303
+
304
+Work Items
305
+----------
306
+
307
+Work items or tasks -- break the feature up into the things that need to be
308
+done to implement it. Those parts might end up being done by different people,
309
+but we're mostly trying to understand the timeline for implementation.
310
+
311
+
312
+Dependencies
313
+============
314
+
315
+* Include specific references to specs and/or blueprints in Masakari,
316
+  or in other projects, that this one either depends on or is related to.
317
+
318
+* If this requires functionality of another project that is not currently used
319
+  by Masakari (such as nova, or masakari-monitors, python-masakariclient),
320
+  document that fact.
321
+
322
+* Does this feature require any new library dependencies or code otherwise not
323
+  included in OpenStack? Or does it depend on a specific version of library?
324
+
325
+
326
+Testing
327
+=======
328
+
329
+Please discuss the important scenarios needed to test here, as well as
330
+specific edge cases we should be ensuring work correctly. For each
331
+scenario please specify if this requires specialized hardware, a full
332
+openstack environment, or can be simulated inside the Masakari tree.
333
+
334
+Please discuss how the change will be tested. We especially want to know what
335
+tempest tests will be added. It is assumed that unit test coverage will be
336
+added so that doesn't need to be mentioned explicitly, but discussion of why
337
+you think unit tests are sufficient and we don't need to add more tempest
338
+tests would need to be included.
339
+
340
+Is this untestable in gate given current limitations (specific hardware /
341
+software configurations available)? If so, are there mitigation plans (3rd
342
+party testing, gate enhancements, etc).
343
+
344
+
345
+Documentation Impact
346
+====================
347
+
348
+Which audiences are affected most by this change, and which documentation
349
+titles on docs.openstack.org should be updated because of this change? Don't
350
+repeat details discussed above, but reference them here in the context of
351
+documentation for multiple audiences. For example, the Operations Guide targets
352
+cloud operators, and the End User Guide would need to be updated if the change
353
+offers a new feature available through the CLI or dashboard. If a config option
354
+changes or is deprecated, note here that the documentation needs to be updated
355
+to reflect this specification's change.
356
+
357
+References
358
+==========
359
+
360
+Please add any useful references here. You are not required to have any
361
+reference. Moreover, this specification should still make sense when your
362
+references are unavailable. Examples of what you could include are:
363
+
364
+* Links to mailing list or IRC discussions
365
+
366
+* Links to notes from a summit session
367
+
368
+* Links to relevant research, if appropriate
369
+
370
+* Related specifications as appropriate (e.g.  if it's an EC2 thing, link the
371
+  EC2 docs)
372
+
373
+* Anything else you feel it is worthwhile to refer to
374
+
375
+
376
+History
377
+=======
378
+
379
+Optional section intended to be used each time the spec is updated to describe
380
+new design, API or any database schema updated. Useful to let reader understand
381
+what's happened along the time.
382
+
383
+.. list-table:: Revisions
384
+   :header-rows: 1
385
+
386
+   * - Release Name
387
+     - Description
388
+   * - Queens
389
+     - Introduced

+ 0
- 0
specs/queens/redirects View File


Loading…
Cancel
Save