ESCALATOR-31 Adjusting documentation
[escalator.git] / docs / requirements / 101-Scope.rst
1 =====
2 Scope
3 =====
4
5 This document describes the user requirements on the smooth upgrade
6 function of the NFVI and VIM with respect to the upgrades of the OPNFV
7 platform from one version to another. Smooth upgrade means that the
8 upgrade results in no service outage for the end-users. This requires
9 that the process of the upgrade is automatically carried out by a tool
10 (code name: Escalator) with pre-configured data. The upgrade process
11 includes preparation, validation, execution, monitoring and
12 conclusion.
13
14 .. <MT> While it is good to have a tool for the entire upgrade process,
15    but it is a challenging task, so maybe we shouldn't require automation
16    for the entire process right away. Automation is essential at
17    execution.
18
19 .. <hujie> Maybe we can analysis information flows of the upgrade tool,
20    abstract the basic / essential actions from the tool (or tools), and
21    map them to a command set of NFVI / VIM's interfaces.
22
23 The requirements are defined in a stepwise approach, i.e. in the first
24 phase focusing on the upgrade of the VIM then widening the scope to the
25 NFVI.
26
27 The requirements may apply to different NFV functions (NFVI, or VIM, or
28 both of them). They will be classified in the Appendix of this
29 document.
30
31 The objects being upgraded described in this document are software modules covered by
32 red box in the picture below which includes: VIM and NFVI.
33
34 The target of the upgrade is to reduce the impact on the applications in the
35 blue box below as much as possible.
36
37 Please keep in mind that the upgrade tool does not take Vi-Vnfm and Or-Vi into
38 consideration.  In other words, these two interfaces may not provided service normally
39 during upgrade procedure.
40
41
42 .. figure:: images/figure1.png
43    :name: figure1
44    :width: 100%
45