VNFRQTS - overlapped PNF node type requirements
[vnfrqts/requirements.git] / docs / Chapter5 / Creating-Vendor-Specific-VNFM-Adaptor-Microservices.rst
1 .. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
2
3 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.
4    (the "License"); you may not use this documentation except in compliance
5    with the License. You may obtain a copy of the License at
6
7 .. https://creativecommons.org/licenses/by/4.0/
8
9 .. Unless required by applicable law or agreed to in writing, software
10    distributed under the License is distributed on an "AS IS" BASIS,
11    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12    See the License for the specific language governing permissions and
13    limitations under the License.
14
15
16 Creating Vendor-Specific VNFM Adaptor Microservices
17 ---------------------------------------------------
18
19 VNFs can be managed by vendor-specific VNFMs. To add a vendor-specific
20 VNFM to ONAP, a vendor-specific VNFM adaptor is added to ONAP implementing
21 the interface of the vendor-specific VNFM.
22
23 A vendor-specific VNFM adaptor is a microservice with a unique name and
24 an appointed port. When started up, the vendor-specific VNFM adaptor
25 microservice is automatically registered to the Microservices Bus (MSB).
26 The following RESTful example describes the scenario of registering a
27 vendor-specific VNFM adaptor to MSB:
28
29 .. code-block:: java
30
31     POST /api/microservices/v1/services
32     {
33         "serviceName": "catalog",
34         "version": "v1",
35         "url": "/api/catalog/v1",
36         "protocol": "REST",
37         "visualRange": "1",
38         "nodes": [
39         {
40             "ip": "10.74.56.36",
41             "port": "8988",
42             "ttl": 0
43         }
44         ]
45     }