Browse Source

Add Rocky specs repo

This patch adds rocky specs repo.

In addition to that it also fixes below issues:
1. Adds a single template.rst for all branches in
   doc/source/specs repo.
2. Fixes incorrect references in history section.
3. Creates missing symbolic links to specs templates.
4. Moves implemented specs from 'approved' to 'implemented'
   directory.
   In future we should have a tox script similar to [1] for
   moving implemented specs from approved to implemented directory.

[1] dad9782fc1/tox.ini (L32)

Change-Id: I4499facd28b1cc48d425a8fe15930ebaa4ac24d9
dineshbhor 1 year ago
parent
commit
c6c09dbe3c

+ 13
- 3
doc/source/index.rst View File

@@ -3,7 +3,7 @@
3 3
    You can adapt this file completely to your liking, but it should at least
4 4
    contain the root `toctree` directive.
5 5
 
6
-masakari-specs Design Specifications
6
+Masakari specs Design Specifications
7 7
 ====================================
8 8
 
9 9
 Here you can find the specs, and spec template, for each release:
@@ -12,12 +12,13 @@ Here you can find the specs, and spec template, for each release:
12 12
    :glob:
13 13
    :maxdepth: 1
14 14
 
15
+   specs/rocky/index
15 16
    specs/queens/index
16
-   specs/ocata/index
17 17
    specs/pike/index
18
+   specs/ocata/index
18 19
 
19 20
 
20
-masakari-specs Repository Information
21
+Masakari specs Repository Information
21 22
 =====================================
22 23
 
23 24
 .. toctree::
@@ -27,6 +28,15 @@ masakari-specs Repository Information
27 28
    contributing
28 29
 
29 30
 
31
+Masakari specs template
32
+=======================
33
+
34
+.. toctree::
35
+   :maxdepth: 2
36
+
37
+   specs/template
38
+
39
+
30 40
 Indices and tables
31 41
 ==================
32 42
 

+ 0
- 7
doc/source/specs/ocata/index.rst View File

@@ -2,13 +2,6 @@
2 2
 Masakari Ocata Specifications
3 3
 =============================
4 4
 
5
-Template:
6
-
7
-.. toctree::
8
-   :maxdepth: 1
9
-
10
-   Specification Template (Ocata release) <template>
11
-
12 5
 Ocata implemented specs:
13 6
 
14 7
 .. toctree::

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

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

+ 4
- 8
doc/source/specs/pike/index.rst View File

@@ -1,10 +1,6 @@
1
-===================
2
-Pike Specifications
3
-===================
4
-
5
-.. toctree::
6
-   :glob:
7
-   :maxdepth: 1
1
+=============================
2
+Masakari Pike Specifications
3
+=============================
8 4
 
9 5
 Pike implemented specs:
10 6
 
@@ -12,7 +8,7 @@ Pike implemented specs:
12 8
    :glob:
13 9
    :maxdepth: 1
14 10
 
15
-..   implemented/*
11
+   implemented/*
16 12
 
17 13
 Pike approved (but not implemented) specs:
18 14
 

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

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

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

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

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

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

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

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

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

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

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

@@ -2,13 +2,6 @@
2 2
 Masakari Queens Specifications
3 3
 ==============================
4 4
 
5
-Template:
6
-
7
-.. toctree::
8
-   :maxdepth: 1
9
-
10
-   Specification Template (Queens release) <template>
11
-
12 5
 Queens implemented specs:
13 6
 
14 7
 .. toctree::

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

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

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

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

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

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

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

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

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

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

+ 19
- 0
doc/source/specs/rocky/index.rst View File

@@ -0,0 +1,19 @@
1
+=============================
2
+Masakari Rocky Specifications
3
+=============================
4
+
5
+Rocky implemented specs:
6
+
7
+.. toctree::
8
+   :glob:
9
+   :maxdepth: 1
10
+
11
+   implemented/*
12
+
13
+Rocky approved (but not implemented) specs:
14
+
15
+.. toctree::
16
+   :glob:
17
+   :maxdepth: 1
18
+
19
+   approved/*

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

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

doc/source/template.rst → doc/source/specs/template.rst View File


specs/ocata/approved/implement-reserved-host-action.rst → specs/ocata/implemented/implement-reserved-host-action.rst View File

@@ -123,14 +123,14 @@ host's "reserved" property as False.
123 123
 
124 124
 Rest API can be::
125 125
 
126
-method: PUT
127
-URL: URL that is passed to the workflow(contains notification_id)
128
-Body:
129
-result {
130
-    notification_status: status of the notification, either 'error' or
131
-    'finished', used_reserved_hosts: list of actually used reserved_hosts
132
-    by workflow
133
-}
126
+    method: PUT
127
+    URL: URL that is passed to the workflow(contains notification_id)
128
+    Body:
129
+    result {
130
+        notification_status: status of the notification, either 'error' or
131
+        'finished', used_reserved_hosts: list of actually used reserved_hosts
132
+        by workflow
133
+    }
134 134
 
135 135
 Pros:
136 136
 -----

+ 1
- 1
specs/pike-template.rst View File

@@ -385,5 +385,5 @@ what's happened along the time.
385 385
 
386 386
    * - Release Name
387 387
      - Description
388
-   * - Ocata
388
+   * - Pike
389 389
      - Introduced

+ 0
- 71
specs/queens/approved/lite-specs.rst View File

@@ -1,71 +0,0 @@
1
-==================
2
-Masakari Spec Lite
3
-==================
4
-
5
-Please keep this template section in place and add your own copy of it between
6
-the markers. Please fill only one Spec Lite per commit.
7
-
8
-<Title of your Spec Lite>
9
--------------------------
10
-
11
-:link: <Link to the blueprint.>
12
-
13
-:problem: <What is the driver to make the change.>
14
-
15
-:solution: <High level description what needs to get done. For example:
16
-            "We need to add client function X.Y.Z to interact with new server
17
-            functionality Z".>
18
-
19
-:impacts: <All possible \*Impact flags (same as in commit messages) or 'None'.>
20
-
21
-Optionals (please remove this line and fill or remove the rest until End):
22
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
23
-
24
-:how: <More technical details than the high level overview of `solution`
25
-       if needed.>
26
-
27
-:alternatives: <Any alternative approaches that might be worth of bringing
28
-                to discussion.>
29
-
30
-:timeline: <Estimation of the time needed to complete the work.>
31
-
32
-:reviewers: <If reviewers has been agreed for the functionality, list them
33
-             here.>
34
-
35
-:assignee: <If known, list who is going to work on the feature implementation
36
-            here>
37
-
38
-End of Template
39
-+++++++++++++++
40
-
41
-Auto compute node registration
42
-------------------------------
43
-
44
-:link: https://blueprints.launchpad.net/masakari-monitors/+spec/auto-compute-node-registration
45
-
46
-:problem: If an user runs hostmonitor/instancemonitor/processmonitor without
47
-          registering the hosts in a segment and they detect a failure,
48
-          masakari doesn't perform the recovery process since source host is
49
-          unknown. Therefore, it will be more convenient if these monitors can
50
-          register a host automatically on startup.
51
-
52
-:solution: Hostmonitor/Instancemonitor/Processmonitor will register a host in
53
-           a particular segment if not already done on startup of these
54
-           services. The name of the host will be pickup automatically where
55
-           these monitors are running and it will call masakari create host
56
-           API to add a host in a particular segment. The segment to which the
57
-           host will be registered will be configurable. Also, a new config
58
-           option will be introduced to decide whether to register a host
59
-           automatically or an operator will configure it manually outside the
60
-           scope of monitors.
61
-
62
-:impacts: None
63
-
64
-:timeline: Expected to be merged within the Queens time frame.
65
-
66
-:reviewers: sam47priya@gmail.com, honjo.rikimaru@po.ntt-tx.co.jp
67
-
68
-:assignee: Kengo Takahara
69
-
70
-Auto compute node registration
71
-++++++++++++++++++++++++++++++

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

@@ -1,389 +0,0 @@
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

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

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

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

@@ -1,389 +0,0 @@
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

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

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

+ 390
- 0
specs/rocky-template.rst View File

@@ -0,0 +1,390 @@
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
+   * - Rocky
389
+     - Introduced
390
+

+ 1
- 0
specs/rocky/approved/rocky-template.rst View File

@@ -0,0 +1 @@
1
+../../rocky-template.rst

+ 1
- 0
specs/rocky/implemented/rocky-template.rst View File

@@ -0,0 +1 @@
1
+../../rocky-template.rst

+ 0
- 0
specs/rocky/redirects View File


Loading…
Cancel
Save