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 O-RAN O2 IMS and DMS service to expose the INF platform to SMO via the O-RAN O2 interface.
   9
  10 In the E release, the following APIs are supported by the INF O2 service:
  11
  12 1. INF O2 service Infrastructure Management Service (IMS)
  13
  14    - INF O2 service provisioning API
  15
  16      - Provision SMO O2 endpoint into INF O2 service
  17
  18      - O2 service discovers INF platform and registers INF platform to SMO via the provisioned SMO O2 endpoint
  19
  20    - INF O2 service Inventory API
  21
  22      - O2 service discovers following resources of INF platform to answer queries from SMO
  23
  24        - INF platform information
  25
  26        - Resource Pool of the INF platform
  27
  28        - Resources of the Resource Pool, including pserver, cpu, memory, port, interface
  29
  30        - Resource Types associated with Resources
  31
  32     - INF platform Subscription and Notification
  33
  34       - INF O2 service exposes Subscription API to enable SMO subscribes to Notification of changes of resources
  35
  36     - INF platform Deployment Management Service Endpoint discovery API
  37
  38       - INF O2 service enables lookup of INF O2 DMS endpoints via DeploymentManagementService resource as part of inventory
  39
  40 2. INF O2 service Deployment Management Service (DMS)
  41
  42    - INF O2 service discovers kubernetes clusters hosted by INF platform, exposes them as Deployment Management Services via DMS endpoints
  43
  44    - The exposed DMS endpoint supports Lifecycle Management of NfDeployment which represents CNF described in helm chart, the API supports APIs below:
  45
  46      - Management of NfDeploymentDescriptor
  47
  48      - Management of NfDeployment