X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?p=escalator.git;a=blobdiff_plain;f=docs%2Frequirements%2F105-Use_Cases.rst;fp=docs%2F04-Use_Cases_and_Scenarios.rst;h=9f13110e8366853d2d2f117817707dd01737d1c8;hp=ee9b48876f38389baa82d12064109dcdb635c1fd;hb=61a851845546300cc2f5ee9f3dd6761c9ecd093e;hpb=0fdf3b89887dfb7a9ea303f58c5e06c348889aa0 diff --git a/docs/04-Use_Cases_and_Scenarios.rst b/docs/requirements/105-Use_Cases.rst similarity index 94% rename from docs/04-Use_Cases_and_Scenarios.rst rename to docs/requirements/105-Use_Cases.rst index ee9b488..9f13110 100644 --- a/docs/04-Use_Cases_and_Scenarios.rst +++ b/docs/requirements/105-Use_Cases.rst @@ -1,30 +1,33 @@ -Use Cases and Scenarios ------------------------ +========= +Use Cases +========= -This section describes the use cases and scenarios to verify the -requirements of Escalator. +This section describes the use cases in different system configuration +to verify the requirements of Escalator. -Scenarios -~~~~~~~~~ -1. Upgrade a system with HA configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +System Configurations +===================== + +HA configuration +^^^^^^^^^^^^^^^^ A HA configuration system is very popular in the operator's data centre. It is a typical product environment. It is always running 7\*24 with VNFs running on it to provide services to the end users. -2. Upgrade a system with non-HA configuration -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Non-HA configuration +^^^^^^^^^^^^^^^^^^^^ A non-HA configuration system is normally deployed for experimental or development usages, such as a Vagrant/VM environment. -Escalator supports the upgrade in this scenario, but it does not guarantee a -smooth upgrade. +Escalator supports the upgrade system in this configuration, but it may +not guarantee a smooth upgrade. Use cases -~~~~~~~~~ +========= + Use case #1: Smooth upgrade in a HA configuration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For a system with HA configuration, the operator can use Escalator to @@ -208,4 +211,3 @@ case,the roll-back may result in service outage. - Post-Conditions 1. The system is rolled-back successfully when the upgrade failed. -