docs/platform/APIs/index.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
   5 VF-C Offered APIs
   6 ==================
   7
   8 .. contents::
   9    :depth: 2
  10
  11 Now VF-C provides the NS life cycle management APIs to UUI,SO,Policy and package management APIs to UUI.
  12 For VNFM vendor, VF-C also provides the VNFM integration APIs, they can reference these APIs to implement their VNFMDriver to integrate with VF-C and ONAP.
  13
  14   |image0|
  15
  16   .. |image0| image:: vfc-api.png
  17    :width: 1000px
  18    :height: 600px
  19
  20 NFVO provided interfaces:
  21
  22 * Network Service LCM interface
  23
  24   Provides Network Service LCM interface(NS instantiate/scale/heal/terminate/query/…)
  25
  26 * VNF Operation Granting interface
  27
  28   Provides VNF Operation Granting interface and make granting decision
  29
  30 * NS package management interface
  31
  32   Provides runtime NS package management interface
  33
  34 * VNF package management interface
  35
  36   Provides runtime VNF package management interface
  37
  38
  39 GVNFM provided interfaces:
  40
  41 * VNF LCM interface
  42
  43   Provides the VNF LCM interface(VNF instantiate/terminate/query/…)
  44
  45 More interface defination can be found in the following part.
  46
  47 VFC Northbound API
  48 ------------------
  49
  50 Network services lifecycle management APIs
  51
  52 In Dublin release, VF-C provides SOL005 compliant APIs as follows
  53
  54 ::
  55
  56     api/nslcm/v1/ns_instances
  57     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)
  58     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/instantiate
  59     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/update
  60     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/scale
  61     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/heal
  62     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/terminate
  63     api/nslcm/v1/ns_lcm_op_occs/(?P<lcmopoccid>[0-9a-zA-Z_-]+)
  64     api/nslcm/v1/subscriptions
  65     api/nslcm/v1/ns_lcm_op_occs
  66
  67 But for the previous APIs, we still keep in Dublin, but the following APIs will be deprecated in the future release
  68
  69 ::
  70
  71         api/nslcm/v1/ns
  72     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/instantiate
  73     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/terminate
  74     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)
  75     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/postdeal
  76     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/scale
  77     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/heal
  78     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/update
  79
  80
  81 More APIs defination and reference can be found in the following page:
  82
  83 .. toctree::
  84    :maxdepth: 1
  85
  86    NSLCM_API/index
  87
  88
  89 VNFM Integration APIs
  90 ---------------------
  91
  92 VNFM Driver Integration Related APIs, these APIs are mainly provided for Vendor, if you want to integrate with VF-C and ONAP, you can reference these APIs to implement your VNFMDriver
  93 These integration APIs includ two part:
  94
  95 * The VNF life cycle management APIs for the VNFMDriver should be implemented
  96 * The NFVO APIs for the VNFMDri1 will be request, like grant APIs
  97
  98 .. toctree::
  99    :maxdepth: 1
 100
 101    VNFMDriver_API/index
 102
 103
 104
 105 GVNFM Northbound & Southbound APIs
 106 ----------------------------------
 107
 108 VF-C provides the Generic VFNM , it can be as the GVNFM reference implementaton.
 109 Now the Northbound APIs of GVNFM has been compete with SOL003 and it now can be integrate with VF-C NFVO.
 110 In tosca-based vCPE use case, the GVNFM function have been verified in Casablanca release.
 111
 112 GVNFM Northbound & Southbound APIs for VNF Integration
 113
 114 .. toctree::
 115    :maxdepth: 1
 116
 117    VNFLCM_API/index
 118
 119
 120 CATALOG  APIs
 121 -------------
 122
 123 CATALOG APIs for VNF Integration
 124
 125 .. toctree::
 126    :maxdepth: 1
 127
 128    CATALOG_API/index