X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Foverview.rst;h=4ab4f1d18f860dc6dcb1fb33cd7e11dacd53848c;hb=refs%2Fheads%2Fh-release;hp=f05aa934aede39f870d7688d968980cf1f0ecfea;hpb=f5627e99aaba6380ecd57e497efc8fbafa1f2d86;p=pti%2Fo2.git diff --git a/docs/overview.rst b/docs/overview.rst index f05aa93..4ab4f1d 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,48 +1,45 @@ .. 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. +.. Copyright (C) 2021-2022 Wind River Systems, Inc. INF O2 Service Overview ======================= -This project implements a reference O2 IMS and DMS service to expose INF platform to SMO via O2 interface. +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. -In the E release, the following APIs are supported by INF O2 service: +In the G release, the following APIs are supported by the INF O2 +service: -1. O-Cloud Infrastructure Management Service (IMS) +1. INF O2 service Infrastructure Management Service (IMS) - - O-Cloud provisioning API + - INF O2 service Inventory API - - Provision SMO O2 endpoint into INF O2 service + - O2 service discovers following resources of INF platform to + answer queries from SMO - - O2 service discovers INF platform as O-Cloud and register INF as O-Cloud to SMO via the provisioned SMO O2 endpoint + - INF platform information + - Resource Pool of the INF platform + - Resources of the Resource Pool, including pserver, cpu, memory, interface, accelerator + - Resource Types associated with Resources - - O-Cloud Inventory API + - INF platform Subscription and Notification - - O2 service discovers following resources of INF platform to answer queries from SMO + - INF O2 service exposes Subscription API to enable SMO + subscribes to Notification of changes of resources - - O-Cloud information + - INF platform Deployment Management Service profile queries API - - Resource Pool of the O-Cloud + - INF O2 service enables lookup of INF Native Kubernetes API information as part of inventory - - Resources of the Resource Pool, including pserver, cpu, memory, port, interface + - INF O2 service Monitoring API - - Resource Types associated with Resources + - O2 service discovers alarms of INF platform to answer queries from SMO - - O-Cloud Subscription and Notification + - INF alarm event record information - - O2 service exposes Subscription API to enable SMO subscribes to Notification of changes of resources + - INF alarm Subscription and Notification - - O-Cloud Deployment Management Service Endpoint discovery API + - INF O2 service exposes alarm Subscription API to enable SMO + subscribes to Notification of changes of alarms - - O2 service enables lookup of O-Cloud DMS endpoints via DeploymentManagementService resource as part of inventory - -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 - - - The exposed DMS endpoint supports Lifecycle Management of NfDeployment which represents CNF described in helm chart, the API supports APIs below: - - - Management of NfDeploymentDescriptor - - - Management of NfDeployment