docs/requirements/105-Use_Cases.rst

   1 =========
   2 Use Cases
   3 =========
   4
   5 This section describes the use cases in different system configuration
   6 to verify the requirements of Escalator.
   7
   8 System Configurations
   9 =====================
  10
  11 HA configuration
  12 ^^^^^^^^^^^^^^^^
  13
  14 A HA configuration system is very popular in the operator's data centre.
  15 It is a typical product environment. It is always running 7\*24 with VNFs
  16 running on it to provide services to the end users.
  17
  18
  19 Non-HA configuration
  20 ^^^^^^^^^^^^^^^^^^^^
  21
  22 A non-HA configuration system is normally deployed for experimental or
  23 development usages, such as a Vagrant/VM environment.
  24
  25 Escalator supports the upgrade system in this configuration, but it may
  26 not guarantee a smooth upgrade.
  27
  28 Use cases
  29 =========
  30
  31 Use case #1: Smooth upgrade in a HA configuration
  32 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  33 For a system with HA configuration, the operator can use Escalator to
  34 smooth-upgrade  NFVI/VIM components into a new version without any service
  35 outage.
  36
  37 When a compute node being upgraded, the VMs on the node may need to be migrated
  38 to other compute nodes to avoid service outage, so it is requred that there are
  39 enough redundant resources to migrate VMs on this compute node.
  40
  41 Before upgrade, the operator can use Escalator to check whether smooth upgrade
  42 conditions are all satisfied. These conditions include whether there are enough
  43 idle resources to migrate VMs during updrading, and whether the new version is
  44 compatible with the current one, etc. If there are some conditions not
  45 satisfied, Escalator will show them. Escalator can also provide the solutions if
  46 there is any, such as the number and configuration of spare compute nodes which
  47 are needed.
  48
  49 When upgrade starts, Escalator will also automatically check whether smooth
  50 upgrade conditions are all satisfied. If some smooth upgrade conditions are not
  51 satisfied, Escalator will show the failure of smooth upgrade.
  52
  53 - Pre-Conditions
  54
  55   1. The system is running as normal.
  56   2. The VNFs are providing services as usual.
  57
  58 - Upgrading steps
  59
  60   1. The VNFs are continually providing services during the upgrade.
  61   2. The operator successfully logged in the GUI of Escalator to select the
  62      software packages including Linux OS, Hypervisor, OpenStack, ODL and other
  63      OPNFV components, ect. (All or part of components could be selected.)
  64   3. Select the nodes to be upgraded. i.e. controller node, network node,
  65      storage node and compute node, etc.
  66   4. Select "Disable Scale-up". It will limit the scale-up operation when
  67      upgrade is in progress to prevent failures due to the shortage of
  68      resources.
  69   5. Select "Check Smooth Upgrade Conditions". If Escalator shows that there are
  70      some conditions not satisfied, try to resolve them according to the
  71      solutions provided.
  72   6. Select "Smooth Upgrade", then apply the upgrade operation.
  73   7. Select "Restore Scale-up" after the upgrade. It will restore scale-up to
  74      the original enabled/disabled state before upgrade.
  75
  76 - Post-Conditions
  77
  78   1. The system is upgraded successfully.
  79   2. There is no service outage during the upgrade.
  80   3. The VNFs are providing services as usual after the upgrade.
  81
  82 Use case #2: Roll-back after a failed smooth upgrade in a HA configuration
  83 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  84 For a system with HA configuration, if the upgrade fails when the operator is
  85 smooth-upgrading NFVI/VIM components into a new version using Escalator, the
  86 operator can roll-back the system without any service outage.
  87
  88 - Pre-Conditions
  89
  90   1. The system is running as normal.
  91   2. The VNFs are providing services as usual.
  92   3. Scale-up operation is disabled.
  93   4. Smooth upgrade failed.
  94
  95 - Roll-back steps
  96
  97   1. Escalator concludes that the upgrade has failed and provides the operator
  98      with the reason.
  99   2. Select the "Roll-back" operation.
 100   3. If the roll-back is successful, go to step 4, otherwise the operator can
 101      select "Restore Backup" to restore the system from the backup data.
 102   4. Select "Restore Scale-up" after the roll-back. It will restore scale-up to
 103      the original enabled/disabled state before upgrade.
 104
 105 - Post-Conditions
 106
 107   1. The system is rolled-back successfully when the upgrade failed.
 108   2. There is no service outage during the roll-back.
 109   3. The VNFs are providing services as usual after the roll-back.
 110
 111 Use case #3: Roll-back after a successful smooth upgrade in a HA configuration
 112 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 113 When a smooth upgrade in a HA configuration is successful, the operator may want
 114 to roll-back for some reasons, such as performance issues.
 115 Escalator supports roll-back after a successful smooth upgrade without any
 116 service outage.
 117
 118 - Pre-Conditions
 119
 120   1. The system is running as normal.
 121   2. The VNFs are providing services as usual.
 122   3. Smooth upgrade succeeded.
 123
 124 - Roll-back steps
 125
 126   1. Select "Disable Scale-up". It will limit the scale-up operation when roll-
 127      back is in progress to prevent failures due to the shortage of resources.
 128   2. Select "Check Smooth Roll-back Conditions". If Escalator shows that there
 129      are some conditions not satisfied, try to resolve them according to the
 130      solutions provided.
 131   3. Select "Roll-back", then apply the roll-back operation.
 132   4. If the roll-back is successful, go to step 5, otherwise the operator can
 133      select "Restore Backup" to restore the system from the backup data.
 134   5. Select "Restore Scale-up" after the roll-back. It will restore scale-up to
 135      the original enabled/disabled state before roll-back.
 136
 137 - Post-Conditions
 138
 139   1. The system is rolled-back successfully.
 140   2. There is no service outage during the roll-back.
 141   3. The VNFs are providing services as usual after the roll-back.
 142
 143 Use case #4: Non-smooth upgrade in a non-HA/HA configuration
 144 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 145 For a system with non-HA configuration, the operator can also use Escalator to
 146 upgrade  NFVI/VIM components into a new version. In this case, the upgrade may
 147 result in service outage. In other words, the upgrade is non-smooth.
 148 For a system with HA configuration, if the service outage is acceptable or
 149 inevitable, the operator can also use Escalator to non-smoothly upgrade the
 150 system.
 151
 152 - Pre-Conditions
 153
 154   1. The system is running as normal.
 155
 156 - Upgrading steps
 157
 158   1. The operator successfully logged in the GUI of Escalator to select the
 159      software packages including Linux OS, Hypervisor, OpenStack, ODL and other
 160      OPNFV components, ect. (All or part of components could be selected.)
 161   2. Select the nodes to be upgraded. i.e. controller node, network node,
 162      storage node and compute node, etc.
 163   3. Select "Non-Smooth Upgrade", then apply the upgrade operation.
 164
 165 - Post-Conditions
 166
 167   1. The system is upgraded successfully.
 168
 169 Use case #5: Roll-back after a failed non-smooth upgrade in a non-HA/HA configuration
 170 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 171 For a system with non-HA/HA configuration, if the upgrade fails when the
 172 operator is non-smoothly upgrading NFVI/VIM components into a new version using
 173 Escalator, the operator can roll-back the system. In this case, the roll-back
 174 may result in service outage.
 175
 176 - Pre-Conditions
 177
 178   1. The system is running as normal.
 179   2. Non-smooth upgrade failed.
 180
 181 - Roll-back steps
 182
 183   1. Escalator concludes that the upgrade has failed and provides the operator
 184      with the reason.
 185   2. Select the "Roll-back" operation.
 186   3. If the roll-back fails, the operator can select "Restore Backup" to restore
 187      the system from the backup data.
 188
 189 - Post-Conditions
 190
 191   1. The system is rolled-back successfully when the upgrade failed.
 192
 193 Use case #6: Roll-back after a successful non-smooth upgrade in a non-HA/HA configuration
 194 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 195 When a non-smooth upgrade in a non-HA/HA configuration is successful, the
 196 operator may want to roll-back for some reasons, such as performance issues.
 197 Escalator supports roll-back after a successful non-smooth upgrade. In this
 198 case,the roll-back may result in service outage.
 199
 200 - Pre-Conditions
 201
 202   1. The system is running as normal.
 203   2. Non-smooth upgrade succeeded.
 204
 205 - Roll-back steps
 206
 207   1. Select the "Roll-back" operation.
 208   2. If the roll-back fails, the operator can select "Restore Backup" to restore
 209      the system from the backup data.
 210
 211 - Post-Conditions
 212
 213   1. The system is rolled-back successfully when the upgrade failed.