fcbfb88e0285ecf7575e07884d1917229a2366f6
[doctor.git] / docs / development / requirements / index.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 ****************************************
5 Doctor: Fault Management and Maintenance
6 ****************************************
7
8 :Project: Doctor, https://wiki.opnfv.org/doctor
9 :Editors: Ashiq Khan (NTT DOCOMO), Gerald Kunzmann (NTT DOCOMO)
10 :Authors: Ryota Mibu (NEC), Carlos Goncalves (NEC), Tomi Juvonen (Nokia),
11           Tommy Lindgren (Ericsson), Bertrand Souville (NTT DOCOMO),
12           Balazs Gibizer (Ericsson), Ildiko Vancsa (Ericsson) and others.
13
14 :Abstract: Doctor is an OPNFV requirement project [DOCT]_. Its scope is NFVI
15            fault management, and maintenance and it aims at developing and
16            realizing the consequent implementation for the OPNFV reference
17            platform.
18
19            This deliverable is introducing the use cases and operational
20            scenarios for Fault Management considered in the Doctor project.
21            From the general features, a high level architecture describing
22            logical building blocks and interfaces is derived. Finally,
23            a detailed implementation is introduced, based on available open
24            source components, and a related gap analysis is done as part of
25            this project. The implementation plan finally discusses an initial
26            realization for a NFVI fault management and maintenance solution in
27            open source software.
28
29 :History:
30
31           ========== =====================================================
32           Date       Description
33           ========== =====================================================
34           02.12.2014 Project creation
35           14.04.2015 Initial version of the deliverable uploaded to Gerrit
36           18.05.2015 Stable version of the Doctor deliverable
37           25.02.2016 Updated version for the Brahmaputra release
38           26.09.2016 Updated version for the Colorado release
39           xx.xx.2017 Updated version for the Danube release
40           ========== =====================================================
41
42 .. raw:: latex
43
44     \newpage
45
46 .. include::
47     glossary.rst
48
49 .. toctree::
50     :maxdepth: 4
51     :numbered:
52
53     01-intro.rst
54     02-use_cases.rst
55     03-architecture.rst
56     04-gaps.rst
57     05-implementation.rst
58     06-summary.rst
59     07-annex.rst
60
61 .. include::
62     99-references.rst