.. SPDX-License-Identifier: CC-BY-4.0
.. Copyright (C) 2021 Wind River Systems, Inc.
-O-Cloud O2 Services API 1.0.0
+INF O2 Services API 1.0.0
=============================
.. toctree::
Description
~~~~~~~~~~~
-Swagger OpenAPI document for O-Cloud O2 Services
+Swagger OpenAPI document for INF O2 Services
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. SPDX-License-Identifier: CC-BY-4.0
.. Copyright (C) 2021 Wind River Systems, Inc.
-.. rtp documentation master
+.. INF documentation master
-Welcome to RTP O2 documentation
+Welcome to INF O2 documentation
===============================
kubectl get pods -A
-2. Deploy O2 service
---------------------
+2. Deploy INF O2 service
+------------------------
2.1 Retrieve Helm chart for deploying of O2 service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
kubectl -n ${NAMESPACE} get services |grep o2service
-2.4 Verify O2 service
-~~~~~~~~~~~~~~~~~~~~~
+2.4 Verify INF O2 service
+~~~~~~~~~~~~~~~~~~~~~~~~~
.. code:: shell
curl -k http(s)://<OAM IP>:30205/o2ims_infrastructureInventory/v1/
-2.5 O2 Service API Swagger
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+2.5 INF O2 Service API Swagger
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Swagger UI can be found with URL: http(s)://<OAM IP>:30205
-3. Register O-Cloud to SMO
---------------------------
+3. Register INF O2 Service to SMO
+---------------------------------
- assumed you have setup SMO O2 endpoint for registration
-- O2 service will post the O-Cloud registration data to that SMO O2 endpoint
+- INF O2 service will post the O-Cloud registration data to that SMO O2 endpoint
.. code:: shell
In the E release, the following APIs are supported by INF O2 service:
-1. O-Cloud Infrastructure Management Service
+1. O-Cloud Infrastructure Management Service (IMS)
- O-Cloud provisioning API
- O2 service enables lookup of O-Cloud DMS endpoints via DeploymentManagementService resource as part of inventory
-2. Deployment Management Service
+2. Deployment Management Service (DMS)
- O2 service discovers kubernetes clusters hosted by INF platform, exposes them as Deployment Management Services via O-Cloud DMS endpoints
"http://${OAM_IP}:30205/o2ims_infrastructureInventory/v1/deploymentManagers" \
-H 'accept: application/json'
+- Provisioning O-Cloud with SMO endpoint configuration
+
+ Assume you have an SMO, then configure O-Cloud with SMO endpoint
+ address. This provisioning of O-Cloud will make a request from
+ O-Cloud to SMO, that make SMO know the O2 service is working.
+
+ It needs SMO to have an API like
+ “*http(s)://SMO_HOST:SMO_PORT/registration*”, which can accept JSON
+ format data.
+
+ .. code:: bash
+
+ curl -X 'POST' \
+ 'http://'${OAM_IP}':30205/provision/v1/smo-endpoint' \
+ -H 'accept: application/json' \
+ -H 'Content-Type: application/json' \
+ -d '{
+ "endpoint": "http://<SMO_HOST>:<SMO_PORT>/registration"
+ }'
+
- Subscribe to the O-Cloud resource change notification
- Assume you have a SMO, and the SMO have an API can be receive
+ Assume you have an SMO, and the SMO have an API can be receive
callback request
- Create subscription in O-Cloud IMS