docs/docs_5G_PNF_Software_Upgrade_With_Schema_Update.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 .. _docs_5g_pnf_software_upgrade_with_schema_update:
   5
   6
   7 Support xNF Software Upgrade in association to schema updates
   8 -------------------------------------------------------------
   9
  10 Description
  11 ~~~~~~~~~~~
  12
  13 A schema update in relation to a xNF software upgrades is a routine for network upgrade to support new xNF features, improve efficiency or increase xNF capacity on the field, and to  eliminate bugs.  This use case provides to ONAP an advantage in orchestrating and managing the Life Cycle of a Network Services in-line with business and service objectives. Deployment and orchestration of new services over CNFs,  VNFs and PNFs in a model and software driven way simplifies the network management. Enables operators and service providers to manage the Life Cycle of a Network Service. Assuring continuity of operation of services is crucial for production and carrier grade environments. The actualization or upgrades of software and in consequence required changes in the service model is a natural part of service instance life cycle. Without the support of ONAP service update with schema change, service life cycle management by ONAP can be very difficult which can impact the quality and continuity of services.
  14
  15
  16 Current Status in Guilin
  17 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18
  19 xNF Software Upgrade with xNF artifacts updating in Release G
  20 -------------------------------------------------------------
  21
  22 The following is the xNF software upgrade procedure with schema update.
  23
  24 .. image:: files/softwareUpgrade/SchemaUpdate.png
  25
  26 1. A vendor shall provide
  27      a. a new VNF/PNF package with updated artifacts, and
  28      b. the new VNF/ PNF software image to the operator.
  29 2. At receiving of the new package, the operator shall
  30      a. onboard the new package and create a new resource template or update the existing resource template (PNF or VNF)
  31      b. update the existing service template with the new or updated resource template
  32      c. distribute the updated service template to run time.
  33 3. At run time, the operator shall, based on the updated service template,
  34      a. upgrade a service instance and its resource instances, and
  35      b. update the AAI entry accordingly
  36
  37 The above procedure is based on the following conditions:
  38
  39 * When updating a service template at design time, the resource instance name and network topology shall be unchanged.
  40
  41 * A service template must be upgradable from any previous versions, including that any new resource template of a given resource instance (within the service template) must be upgradeable from any previous resource template versions.
  42
  43 * At run time, resource upgrade sequence is not sensitive in service instance upgrading procedure.
  44
  45 Function limitations in Release G
  46 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  47
  48 * The operator shall know the possible/feasible resource upgrade path based on vendor provided information.
  49
  50 * When operator updating a service template, the updated service template must be upgradable from any previous versions:
  51     - Within the service template, the resource instance name and network topology are unchanged.
  52     - The new resource template of a given resource instance (within the service template) must be upgradeable from any previous resource template versions.
  53 Note: This is to avoid adding possible upgrade paths info and upgrade sequence info into SDC model
  54
  55 Update a xNF resource template from a new onboarding package
  56 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  57
  58 When updating a resource template from a new VSP casr, the new onboarded descriptor and the new onboarded artifacts will be transformed into the new version of the resource csar. The current resource name and invariantUUID will be remained.
  59
  60 As an alternative, a resource csar can be updated manually using SDC GUI.
  61
  62 .. image:: files/softwareUpgrade/OnboardingCsar.png
  63
  64 The update path (green path in above picture) is supported in the current SDC implementation. However, there are bugs which need to be fixed.
  65
  66 Service level LCM workflow in SO
  67 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  68
  69 .. image:: files/softwareUpgrade/ServiceLevelWorkflow.png
  70
  71 A generic SO workflow is created which can be used to upgrade one service instance based on the updated service template. This service level workflow is network function type independent. When upgrade one resource instance, the subsequent resource level upgrade workflow is selected based on the network function type. It contains following main steps:
  72
  73 * Service Level Preparation
  74     - Creating resource template instance upgrade list by comparing the service templates
  75     - Select a resource level health check workflow based on the resource type
  76     - Execute the selected resource level health check workflow on all resource instances within the service
  77 * Service Level Upgrade
  78     - Select a resource level upgrade workflow based on the resource type
  79     - Execute the selected resource level upgrade workflow on each upgrading resource instances
  80     - Update the software version, model-invariant-id and model-version-id of the resource template in the A&AI entry at end of each Resource level upgrade workflow
  81 * Service Level Update
  82     - Update the model-version-id of the service template in the A&AI entry
  83 * Service Level postCheck
  84     - Select a resource level health check workflow based on the resource type
  85     - Execute the selected resource level health check workflow on all resource instances within the service
  86
  87 The following is an example of the service level workflow with PNF upgrade sub-workflow is called at Service Level Upgrade step:
  88
  89 .. image:: files/softwareUpgrade/ServiceLevelUpgrade.png
  90
  91 Workflow view
  92 ~~~~~~~~~~~~~
  93
  94 .. image:: files/softwareUpgrade/WorkflowView.png
  95
  96 SO APIs
  97 ~~~~~~~
  98 .. csv-table:: use case table
  99    :file: schema-update-apis.csv
 100    :widths: 60,20,20
 101    :header-rows: 1
 102
 103 Reference
 104 ~~~~~~~~~~~
 105
 106 `PNF Software Upgrade with Schema Update Wiki Page <https://wiki.onap.org/pages/viewpage.action?pageId=81400388#SupportxNFSoftwareUpgradeinassociationtoschemaupdates-DevelopmentStatus>`_