From 79668fcf4509d0f4538828d726e807b83ff4f2bc Mon Sep 17 00:00:00 2001 From: ulik Date: Fri, 10 Feb 2017 16:31:06 +0100 Subject: 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 --- docs/scenario-lifecycle/parent-child-relations.rst | 62 ++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/scenario-lifecycle/parent-child-relations.rst (limited to 'docs/scenario-lifecycle/parent-child-relations.rst') diff --git a/docs/scenario-lifecycle/parent-child-relations.rst b/docs/scenario-lifecycle/parent-child-relations.rst new file mode 100644 index 0000000..ca15619 --- /dev/null +++ b/docs/scenario-lifecycle/parent-child-relations.rst @@ -0,0 +1,62 @@ +.. 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) + + +Parent - Child Relations +------------------------- + +In many cases, development adds a feature to an existing scenario by adding additional +components. This is called creating a child scenario from a parent. + +* Parent scenarios typically are more stable than children. +* Children should plan to merge their feature back to the parent. +* Merge back will often add components to the parent. + +.. figure:: parent-child.png + +* Child scenarios can be part of releases. +* Child scenarios should merge back to their parent after 2 releases. +* If a child scenario lives through several releases, it might be desirable + to “rebase/cherrypick” a child scenario to follow changes in the parent scenario. +* Child scenarios typically support a smaller number of deployment options than + their parent + +Child scenarios are specific scenarios. Parent scenarios can be generic or specific +scenarios. + +Child scenarios can be created any time. If they want to join a release, they have +to be created before MS0 of that release. + + +Siblings +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +In some cases it could make more sense to create a sibling rather than a child +(e.g. if expected that merging back to parent will be difficult). +In other words, the content of a child scenario will be incompatible with content +of the parent scenario. +In that case, the child scenario should rather become a new branch instead of +merging back to the parent. + +.. figure:: sibling.png + +Typically the sibling uses alternate components/solutions than the parent – in +long term it might evolve into a new generic scenario, that is a new branch +in the scenario tree. + +Creation of the sibling shall not be gated. It should be covered in the scope of +an approved project, so there cannot be too big surprises. + +But at a certain time the new scenario will want to change its status from a +specific scenario to a generic scenario. This move will need TSC approval. +For the application, the scenario owner shall demonstrate that the scenario +fulfills the requirements of a generic scenario (see later). + +Examples: SDN controller options, Container technologies, data plane solutions, +MANO solutions. + +Please note that from time to time, the TSC will need to review the +set of generic scenarios and "branches" in the scenario tree. + + -- cgit 1.2.3-korg