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