diff options
author | ulik <ulik@localhost.localdomain> | 2017-02-10 16:31:06 +0100 |
---|---|---|
committer | ulik <ulrich.kleber@huawei.com> | 2017-03-14 09:33:24 +0100 |
commit | 79668fcf4509d0f4538828d726e807b83ff4f2bc (patch) | |
tree | a847a52a27eecb3cef8155ace84e600936d0d038 /docs/scenario-lifecycle/generic-scenarios.rst | |
parent | a80ff748730bd3ee8c42b8f00f5c01ba8e41dd92 (diff) |
Scenario Lifecycle Document - First version with content
1.step(patchset 1&2): provide index.rst and overview
2.step(patchset 3): provide sceleton
3.step(patchset 4): fix comments and provide first content
patchset 5: fix comments in 8 files, one file deleted.
patchset 6: fix more comments
patchset 7: fix more comments adding some editors notes
Jira OCTO-162
Change-Id: I8928953da29aef2bddeb42510fb5983eee9ea30f
Signed-off-by: ulik <ulrich.kleber@huawei.com>
Diffstat (limited to 'docs/scenario-lifecycle/generic-scenarios.rst')
-rw-r--r-- | docs/scenario-lifecycle/generic-scenarios.rst | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/scenario-lifecycle/generic-scenarios.rst b/docs/scenario-lifecycle/generic-scenarios.rst new file mode 100644 index 0000000..f159c0c --- /dev/null +++ b/docs/scenario-lifecycle/generic-scenarios.rst @@ -0,0 +1,53 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 OPNFV Ulrich Kleber (Huawei) + + +Generic Scenarios +------------------ + +Generic scenarios provide a stable environment for users who want to base their +products on them. + +* Generic scenarios provide a basic combination of upstream components together + with the superset of possible mature features that can be deployed on them. +* Generic scenarios should be supported by all installers. +* All generic scenarios in a release should have the same common major versions + of the included upstream components. + These upstream versions can then be seen as the upstream versions for the + release. E.g. that way we can say: “OPNFV xxx contains OpenStack abc, + ODL def, ONOS ghi, OVS jkl“. + But most installers cannot directly reference any + upstream version. This may lead to minor differences. + Nevertheless features and test cases require all installers using the same + major versions. +* Generic scenarios should use stable sources + and lock the versions before the release by either pointing to a tag or sha1. + According to the LF badging program it should be possible to reproduce + the release from source again. + Thus the upstream repos should be in safe locations. + Also only tagged source versions should be used for the release, so the + release can be reproduced identically for different purposes such as + reproducing a baug reported by users and issuing the fix appropriately, + even after the upstream project has applied patches. + .. Editors note: There is discussion ongoing in INFRA and SEC working groups how + .. to realize this. Thus the description is still a bit vague. Details will be + .. added later either here or in some INFRA document. +* Generic scenarios should be stable and mature. Therefore they will be tested more + thoroughly and run special release testing so a high level of stability can be + provided. +* Generic scenarios will live through many OPNFV releases. +* More resources will be allocated to maintaining generic scenarios and they will + have priority for CI resources. + .. Editors note: Discussion ongoing in INFRA about toolchain issues. + +Note: in some cases it might be difficult for an installer to support all generic +scenarios immediately. In this case an exception can be defined, but the installer +has to provide a plan how to achieve support for all generic scenarios. + +Note: in some cases, upstream projects don‘t have proper CI process with +tagged stable versions. Also some installers‘ way of working doesn‘t allow +selecting the repo and tag. Thus a stepwise approach will be necessary to +fulfill this requirement. + + |