Add docs for pti o2 service
[pti/o2.git] / docs / overview.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. Copyright (C) 2021 Wind River Systems, Inc.
4
5 INF O2 Service Overview
6 =======================
7
8 This project implements a reference O2 IMS and DMS service to expose O2 interface to SMO.
9
10 In the E release, the following API of O2 interface is enabled:
11
12 1. O-Cloud registration and inventory query
13
14    - O2 service discovers INF platform as O-Cloud, register the O-Cloud to SMO with provisioned SMO O2 endpoint.
15
16      - Provision SMO O2 endpoint
17
18      - Register INF as O-Cloud to SMO via SMO O2 endpoint
19
20    - O2 service discovers following resources of INF platform to answer queries from SMO
21
22      - O-Cloud information
23
24      - Resource Pool of the O-Cloud
25
26      - Resources of the Resource Pool, including pserver, cpu, memory, port, interface
27
28      - kubernetes API endpoint as Deployment Management Service
29
30
31 2. Deployment Management Service
32
33    - O2 service expose DMS on behalf of kubernetes API endpoint hosted by INF platform, which support NfDeployment described by Helm charts
34
35      - Management of NfDeploymentDescriptor
36
37      - Management of NfDeployment
38
39
40 3. Subscription and Notification
41
42    - O2 service exposes Subscription API to enable SMO subscribes to Notification of changes of resources
43
44      - Management of Subscriptions
45
46      - Notification delivery via Rest API provided by specific Subscriptions