docs/design/specs/template.rst

   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 OPNFV wiki page description:
  12
  13 https://wiki.opnfv.org/display/ovsnfv/OVSFV+Requirement+-+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 process:
  21
  22 * The aim of this document is first to define the problem we need to solve,
  23   and second agree the overall approach to solve that problem.
  24
  25 * This is not intended to be extensive documentation for a new feature.
  26
  27 * You should aim to get your spec approved before writing your code.
  28   While you are free to write prototypes and code before getting your spec
  29   approved, its possible that the outcome of the spec review process leads
  30   you towards a fundamentally different solution than you first envisaged.
  31
  32 * But, API changes are held to a much higher level of scrutiny.
  33   As soon as an API change merges, we must assume it could be in production
  34   somewhere, and as such, we then need to support that API change forever.
  35   To avoid getting that wrong, we do want lots of details about API changes
  36   upfront.
  37
  38 Some notes about using this template:
  39
  40 * Your spec should be in ReSTructured text, like this template.
  41
  42 * Please wrap text at 79 columns.
  43
  44 * Please do not delete any of the sections in this template.  If you have
  45   nothing to say for a whole section, just write: None
  46
  47 * For help with syntax, see http://sphinx-doc.org/rest.html
  48
  49 * To test out your formatting, build the docs using sphinx
  50
  51 * If you would like to provide a diagram with your spec, ascii diagrams are
  52   required.  http://asciiflow.com/ is a very nice tool to assist with making
  53   ascii diagrams.  The reason for this is that the tool used to review specs is
  54   based purely on plain text.  Plain text will allow review to proceed without
  55   having to look at additional files which can not be viewed in gerrit.  It
  56   will also allow inline feedback on the diagram itself.
  57
  58 Problem description
  59 ===================
  60
  61 A detailed description of the problem. What problem is this blueprint
  62 addressing?
  63
  64 Use Cases
  65 ---------
  66
  67 What use cases does this address? What impact on actors does this change have?
  68 Ensure you are clear about the actors in each use case: Developer, End User,
  69 Deployer etc.
  70
  71 Proposed change
  72 ===============
  73
  74 Here is where you cover the change you propose to make in detail. How do you
  75 propose to solve this problem?
  76
  77 If this is one part of a larger effort make it clear where this piece ends. In
  78 other words, what's the scope of this effort?
  79
  80 At this point, if you would like to just get feedback on the problem and
  81 proposed change, you can stop here and post this for review to get
  82 preliminary feedback. If so please say:
  83 Posting to get preliminary feedback on the scope of this spec.
  84
  85 Alternatives
  86 ------------
  87
  88 What other ways could we do this thing? Why aren't we using those? This doesn't
  89 have to be a full literature review, but it should demonstrate that thought has
  90 been put into why the proposed solution is an appropriate one.
  91
  92 OVSDB schema impact
  93 -------------------
  94
  95 Changes which require modifications to the data model often have a wider impact
  96 on the system.  The community often has strong opinions on how the data model
  97 should be evolved, from both a functional and performance perspective. It is
  98 therefore important to capture and gain agreement as early as possible on any
  99 proposed changes to the data model.
 100
 101 Questions which need to be addressed by this section include:
 102
 103 * What new data objects and/or database schema changes is this going to
 104   require?
 105
 106 User interface impact
 107 ---------------------
 108
 109 Each user interface that is either added, changed or removed should have the
 110 following:
 111
 112 * Specification for the user interface
 113
 114 * Example use case including typical examples for both data supplied
 115   by the caller and the response
 116
 117 Security impact
 118 ---------------
 119
 120 Describe any potential security impact on the system.  Some of the items to
 121 consider include:
 122
 123 * Does this change touch sensitive data such as tokens, keys, or user data?
 124
 125 * Does this change alter the interface in a way that may impact security, such as
 126   a new way to access sensitive information?
 127
 128 * Does this change involve cryptography or hashing?
 129
 130 * Does this change require the use of sudo or any elevated privileges?
 131
 132 * Does this change involve using or parsing user-provided data? This could
 133   be directly at the API level or indirectly such as changes to a cache layer.
 134
 135 * Can this change enable a resource exhaustion attack, such as allowing a
 136   single interaction to consume significant server resources?
 137
 138 Other end user impact
 139 ---------------------
 140
 141 Aside from the user interfaces, are there other ways a user will interact with this
 142 feature?
 143
 144 Performance Impact
 145 ------------------
 146
 147 Describe any potential performance impact on the system, for example
 148 how often will new code be called, and is there a major change to the calling
 149 pattern of existing code.
 150
 151 Examples of things to consider here include:
 152
 153 * Will the change include any locking, and if so what considerations are there
 154   on holding the lock?
 155
 156 Other deployer impact
 157 ---------------------
 158
 159 Discuss things that will affect how you deploy and configure Open vSwitch
 160 that have not already been mentioned, such as:
 161
 162 * What config options are being added? Should they be more generic than
 163   proposed? Are the default values ones which will work well in
 164   real deployments?
 165
 166 * Is this a change that takes immediate effect after its merged, or is it
 167   something that has to be explicitly enabled?
 168
 169 * If this change is a new binary, how would it be deployed?
 170
 171 * Please state anything that those doing continuous deployment, or those
 172   upgrading from the previous release, need to be aware of. Also describe
 173   any plans to deprecate configuration values or features.
 174
 175 Developer impact
 176 ----------------
 177
 178 Discuss things that will affect other developers working on Open vSwitch,
 179 such as:
 180
 181 Implementation
 182 ==============
 183
 184 Assignee(s)
 185 -----------
 186
 187 Who is leading the writing of the code? Or is this a blueprint where you're
 188 throwing it out there to see who picks it up?
 189
 190 If more than one person is working on the implementation, please designate the
 191 primary author and contact.
 192
 193 Primary assignee:
 194   <email address>
 195
 196 Other contributors:
 197   <email address>
 198
 199 Work Items
 200 ----------
 201
 202 Work items or tasks -- break the feature up into the things that need to be
 203 done to implement it. Those parts might end up being done by different people,
 204 but we're mostly trying to understand the timeline for implementation.
 205
 206
 207 Dependencies
 208 ============
 209
 210 * If this requires functionality of another project that is not currently used
 211   document that fact.
 212
 213 * Does this feature require any new library dependencies or code otherwise not
 214   included in Open vSwitch? Or does it depend on a specific version of library?
 215
 216
 217 Testing
 218 =======
 219
 220 Please discuss the important scenarios needed to test here, as well as
 221 specific edge cases we should be ensuring work correctly. For each
 222 scenario please specify if this requires specialized hardware.
 223
 224 Please discuss how the change will be tested: Open vSwitch unit tests, VSPERF
 225 performance tests, Yardstick tests, etc.
 226
 227 Is this untestable in gate given current limitations (specific hardware /
 228 software configurations available)? If so, are there mitigation plans (3rd
 229 party testing, gate enhancements, etc).
 230
 231
 232 Documentation Impact
 233 ====================
 234
 235 Which audiences are affected most by this change, and which documentation
 236 should be updated because of this change? Don't
 237 repeat details discussed above, but reference them here in the context of
 238 documentation for multiple audiences. If a config option
 239 changes or is deprecated, note here that the documentation needs to be updated
 240 to reflect this specification's change.
 241
 242 References
 243 ==========
 244
 245 Please add any useful references here. You are not required to have any
 246 reference. Moreover, this specification should still make sense when your
 247 references are unavailable. Examples of what you could include are:
 248
 249 * Links to mailing list or IRC discussions
 250
 251 * Links to relevant research, if appropriate
 252
 253 * Related specifications as appropriate
 254
 255 * Anything else you feel it is worthwhile to refer to
 256
 257
 258 History
 259 =======
 260
 261 Optional section intended to be used each time the spec
 262 is updated to describe new design, API or any database schema
 263 updated. Useful to let reader understand what's happened along the
 264 time.
 265
 266 .. list-table:: Revisions
 267    :header-rows: 1
 268
 269    * - Release Name
 270      - Description
 271    * - 2.x
 272      - Introduced