Update branch references
[integration.git] / docs / docs_usecases.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0
2    International License. http://creativecommons.org/licenses/by/4.0
3
4 .. _docs_usecases:
5
6 Verified Use Cases and Functional Requirements
7 ==============================================
8
9 Description
10 -----------
11 This session includes use cases and functional requirements which have been
12 officially verified in Frankfurt release by the ONAP community.
13
14 For each use case or functional requirement, you can find contact names and a
15 link to the associated documentation.
16
17 This documentation deals with
18
19   1. What has been implemented
20   2. Step by step instructions to deploy and execute the tests, including the
21      links to download the related assets and resources
22   3. Known issues and workarounds
23
24 Use cases
25 ~~~~~~~~~
26
27 .. csv-table:: use case table
28    :file: ./files/csv/usecases.csv
29    :widths: 10,40,20,30
30    :delim: ;
31    :header-rows: 1
32
33 Functional Requirements
34 ~~~~~~~~~~~~~~~~~~~~~~~
35
36 .. csv-table:: functional requirements table
37     :file: ./files/csv/usecases-functional-requirements.csv
38     :widths: 10,40,10,10,30
39     :delim: ;
40     :header-rows: 1
41
42 Automated Use Cases
43 ~~~~~~~~~~~~~~~~~~~
44
45 .. csv-table:: Infrastructure Healthcheck Tests
46     :file: ./files/csv/tests-infrastructure-healthcheck.csv
47     :widths: 20,40,20,20
48     :delim: ;
49     :header-rows: 1
50
51 .. csv-table:: Healthcheck Tests
52     :file: ./files/csv/tests-healthcheck.csv
53     :widths: 20,40,20,20
54     :delim: ;
55     :header-rows: 1
56
57 .. csv-table:: Smoke Tests
58     :file: ./files/csv/tests-smoke.csv
59     :widths: 20,40,20,20
60     :delim: ;
61     :header-rows: 1
62
63 .. csv-table:: Security Tests
64     :file: ./files/csv/tests-security.csv
65     :widths: 20,40,20,20
66     :delim: ;
67     :header-rows: 1
68
69 Deprecated Use Cases
70 ~~~~~~~~~~~~~~~~~~~~
71
72 The following use cases were included in Frankfurt or previous release but have
73 not been tested in Frankfurt, usually due to a lack of resources.
74 The resources are still available in previous branches, some adaptations may
75 however be needed for Frankfurt.
76
77 .. csv-table:: deprecated use case table
78     :file: ./files/csv/usecases-deprecated.csv
79     :widths: 50,20,10,20
80     :header-rows: 1