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 implmemet their VNFMDriver to integrate with VF-C and ONAP.
  13
  14
  15
  16 VFC Northbound API
  17 ------------------
  18
  19 Network services lifecycle management APIs
  20
  21 In Dublin release, VF-C provides SOL005 compliant APIs as follows
  22
  23 ::
  24
  25     api/nslcm/v1/ns_instances
  26     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)
  27     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/instantiate
  28     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/update
  29     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/scale
  30     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/heal
  31     api/nslcm/v1/ns_instances/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/terminate
  32     api/nslcm/v1/ns_lcm_op_occs/(?P<lcmopoccid>[0-9a-zA-Z_-]+)
  33     api/nslcm/v1/subscriptions
  34     api/nslcm/v1/ns_lcm_op_occs
  35
  36 But for the previous APIs, we still keep in Dublin, but the following APIs will be deprecated in the future release
  37
  38 ::
  39
  40         api/nslcm/v1/ns
  41     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/instantiate
  42     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/terminate
  43     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)
  44     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/postdeal
  45     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/scale
  46     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/heal
  47     api/nslcm/v1/ns/(?P<ns_instance_id>[0-9a-zA-Z_-]+)/update
  48
  49
  50 More APIs defination and reference can be found in the following page:
  51
  52 .. toctree::
  53    :maxdepth: 1
  54
  55    NSLCM_API/index
  56
  57
  58 VNFM Integration APIs
  59 ---------------------
  60
  61 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
  62 These integration APIs includ two part:
  63
  64 * The VNF life cycle management APIs for the VNFMDriver should be implemented
  65 * The NFVO APIs for the VNFMDri1 will be request, like grant APIs
  66
  67 .. toctree::
  68    :maxdepth: 1
  69
  70    VNFMDriver_API/index
  71
  72
  73
  74 GVNFM Northbound & Southbound APIs
  75 ----------------------------------
  76
  77 VF-C provides the Generic VFNM , it can be as the GVNFM reference implementaton.
  78 Now the Northbound APIs of GVNFM has been compli1t with SOL003 and it now can be integrate with VF-C NFVO.
  79 In tosca-based vCPE use case, the GVNFM founction have been verified in Casablanca release.
  80
  81 GVNFM Northbound & Southbound APIs for VNF Integration
  82
  83 .. toctree::
  84    :maxdepth: 1
  85
  86    VNFLCM_API/index
  87
  88
  89 CATALOG  APIs
  90 -------------
  91
  92 CATALOG APIs for VNF Integration
  93
  94 .. toctree::
  95    :maxdepth: 1
  96
  97    CATALOG_API/index