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