updates to use new doc toolchain
[escalator.git] / docs / 01-Scope.rst
1 Scope
2 -----
3
4 This document describes the user requirements on the smooth upgrade
5 function of the NFVI and VIM with respect to the upgrades of the OPNFV
6 platform from one version to another. Smooth upgrade means that the
7 upgrade results in no service outage for the end-users. This requires
8 that the process of the upgrade is automatically carried out by a tool
9 (code name: Escalator) with pre-configured data. The upgrade process
10 includes preparation, validation, execution, monitoring and
11 conclusion.
12   
13 .. <MT> While it is good to have a tool for the entire upgrade process,
14    but it is a challenging task, so maybe we shouldn't require automation
15    for the entire process right away. Automation is essential at
16    execution.
17   
18 .. <hujie> Maybe we can analysis information flows of the upgrade tool,
19    abstract the basic / essential actions from the tool (or tools), and
20    map them to a command set of NFVI / VIM's interfaces.
21
22 The requirements are defined in a stepwise approach, i.e. in the first
23 phase focusing on the upgrade of the VIM then widening the scope to the
24 NFVI.
25
26 The requirements may apply to different NFV functions (NFVI, or VIM, or
27 both of them). They will be classified in the Appendix of this
28 document.