Copy scenario-lifecycle docs into pharos
[pharos.git] / docs / release / scenario-lifecycle / workflows.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 Workflows
7 ----------
8
9 Summary
10 ^^^^^^^^
11
12 The general principle can be summarized by the following diagram:
13
14 .. figure:: pdf-and-sdf.png
15
16 Workflows for Scenario Owners
17 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
18
19 The scenario owner creates the descriptor file based on the template.
20
21 .. figure:: create-sdf.png
22
23 Create new scenario from scratch
24 +++++++++++++++++++++++++++++++++++++++++++++++++
25
26 This workflow will be exceptional.
27 Most scenarios can easier start as children of an existing scenario;
28 thus the author (scenario owner) can derive the SDF from the parent.
29 But scenarios introducing new technologies affecting the whole architecture,
30 e.g.containers, or higher level scenarios (e.g.MANO and Multisite which
31 reference existing scenarios) can start without a parent.
32
33 The following steps need to be done:
34
35   #. (Project team) Define set of components that need to be deployed
36   #. (Project) Find installers that can deploy the components
37   #. (Project&installer&CI) Agree on new keywords in SDF (e.g. component, feature name)
38   #. (Project) Assign owner
39   #. (Owner) Edit SDF, submit to octopus repo
40   #. (Owner) register scenario to participate in release as appropriate
41   #. (Owner&CI-team) Adapt jenkins triggers, so new scenario can be scheduled in valid installer/POD/Options combination(s).
42   #. (Installer-team) test deployment of components
43   #. (Project-team) Define test cases; register in test db
44
45 Create child scenario by adding feature to existing scenario
46 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
47
48 Add additional installer to a specific scenario
49 ++++++++++++++++++++++++++++++++++++++++++++++++
50
51 Add additional hardware or availability option to a scenario
52 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
53
54 Merge child scenario back to parent
55 ++++++++++++++++++++++++++++++++++++
56
57 Promote specific scenario to generic scenario
58 ++++++++++++++++++++++++++++++++++++++++++++++
59
60 Introduce SDF for existing Danube/Euphrates scenarios
61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
62
63
64 Workflows for Installers
65 ^^^^^^^^^^^^^^^^^^^^^^^^^
66
67 Workflows for CI Tools
68 ^^^^^^^^^^^^^^^^^^^^^^^^^^
69
70