docs/scenario-lifecycle/generic-scenarios.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) 2017 OPNFV Ulrich Kleber (Huawei)
   4
   5
   6 Generic Scenarios
   7 ------------------
   8
   9 Generic scenarios provide a stable environment for users who want to base their
  10 products on them.
  11
  12 * Generic scenarios provide a basic combination of upstream components together
  13   with the superset of possible mature features that can be deployed on them.
  14 * Generic scenarios should be supported by all installers.
  15 * All generic scenarios in a release should have the same common major versions
  16   of the included upstream components.
  17   These upstream versions can then be seen as the upstream versions for the
  18   release. E.g. that way we can say: “OPNFV xxx contains OpenStack abc,
  19   ODL def, ONOS ghi, OVS jkl“.
  20   But most installers cannot directly reference any
  21   upstream version. This may lead to minor differences.
  22   Nevertheless features and test cases require all installers using the same
  23   major versions.
  24 * Generic scenarios should use stable sources
  25   and lock the versions before the release by either pointing to a tag or sha1.
  26   According to the LF badging program it should be possible to reproduce
  27   the release from source again.
  28   Thus the upstream repos should be in safe locations.
  29   Also only tagged source versions should be used for the release, so the
  30   release can be reproduced identically for different purposes such as
  31   reproducing a baug reported by users and issuing the fix appropriately,
  32   even after the upstream project has applied patches.
  33   .. Editors note: There is discussion ongoing in INFRA and SEC working groups how
  34   .. to realize this. Thus the description is still a bit vague. Details will be
  35   .. added later either here or in some INFRA document.
  36 * Generic scenarios should be stable and mature. Therefore they will be tested more
  37   thoroughly and run special release testing so a high level of stability can be
  38   provided.
  39 * Generic scenarios will live through many OPNFV releases.
  40 * More resources will be allocated to maintaining generic scenarios and they will
  41   have priority for CI resources.
  42   .. Editors note: Discussion ongoing in INFRA about toolchain issues.
  43
  44 Note: in some cases it might be difficult for an installer to support all generic
  45 scenarios immediately. In this case an exception can be defined, but the installer
  46 has to provide a plan how to achieve support for all generic scenarios.
  47
  48 Note: in some cases, upstream projects don‘t have proper CI process with
  49 tagged stable versions. Also some installers‘ way of working doesn‘t allow
  50 selecting the repo and tag. Thus a stepwise approach will be necessary to
  51 fulfill this requirement.
  52
  53