Add missing ref links
[doc.git] / docs / guides / onap-user / instantiate / instantiation / service_instance / index.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0
2 .. International License. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2019 ONAP Contributors.  All rights reserved.
4
5
6 Service Instantiation
7 =====================
8
9 **Pre-requisites**
10
11 - The Service has been designed and distributed (see: :ref:`Service Design <doc_guide_user_des_ser-des>`)
12 - pre-instantiation operations have been performed
13   (see: :ref:`pre instantiation section <doc_guide_user_pre_ser-inst>`)
14
15 **Possible Tools to perform Service Instantiation**
16
17 - **via a Graphical User Interface tool**
18   using ONAP applications such as **ONAP VID** and **ONAP UUI** tools
19
20 - **via any tool able to perform REST API requests**
21   (for example : Robot Framework, Postman, Curl...) connected
22   to **ONAP SO** legacy API or **ONAP extAPI/NBI** standard TMF641 API
23   to add/delete Service.
24
25 **Possible methods with ONAP to instantiate a Service**
26
27 - **A La Carte**
28   method requires the user to build and send
29   operations **for each object** to instantiate : Service, VNFs,
30   VFModules and Networks (in other words : once you have instantiated
31   the Service object, you still have to instantiate the various VNFs
32   or Networks that compose your Service).
33   To build those requests, the user needs to define/collect by himself
34   all necessary parameters/values.
35
36 - **Macro**
37   method allows the user to build and send
38   **only one request to instantiate all objects** : Service, VNFs,
39   VFModules and Networks. Thanks to templates (see CDS Blueprint in
40   Design section),
41   ONAP will collect and assign all required parameters/values by itself.
42
43
44   .. Note:: **Macro** method is not (yet) available via ONAP VID
45    nor via extAPI/NBI
46
47 With "A La Carte" method
48 ------------------------
49
50 .. toctree::
51    :maxdepth: 1
52
53       using ONAP VID Portal  <../vid/index.rst>
54       using ONAP NBI REST API (TM Forum) <../nbi/index.rst>
55       using ONAP SO REST API <../so1/index.rst>
56
57 With "Macro" method
58 -------------------
59
60 .. toctree::
61    :maxdepth: 1
62
63       using ONAP SO REST API <../so2/index.rst>