<style>
.title {
color: #009933;
font-weight:bold;
}
.highlight {
color: #ff4d4d;
font-weight:bold;
border-bottom:2px red solid; padding-bottom:2px;
}
</style>
<!-- <font class="highlight"> -->
<!-- <font class="title"> -->
<!-- 縮寫提示 -->
<!-- *[O-RAN]:Open Radio Access Network -->

:::warning
# <center><i class="fa fa-book"></i> O-RAN Training Course Note </center>
:::
###### tags: `study` `Training Course`

:::success
**🎯 Goals:**
- [x] - <a href="#Topic-1-Near-RT-RIC-Functional-Block-Concept-O-RAN-Specification">Topic 1: Near-RT RIC Functional Block Concept (O-RAN Specification)</a>
- [x] - <a href="#Topic-2-Near-RT-RIC-Platform-Introduction-O-RAN-Software-Community">Topic 2: Near-RT RIC Platform Introduction (O-RAN Software Community)</a>
- [x] - <a href="#Topic-3-xApp-Introduction-O-RAN-Software-Community">Topic 3: xApp Introduction (O-RAN Software Community)</a>
- [x] - <a href="#Topic-4-xApp-LCM-O-RAN-Software-Community">Topic 4: xApp LCM (O-RAN Software Community)</a>
---
- [x] - <a href="#Topic-5-E2-Interface-O-RAN-Specification">Topic 5: E2 Interface (O-RAN Specification)</a>
- [x] - <a href="#Topic-6-E2-Procedure-O-RAN-Software-Community">Topic 6: E2 Procedure (O-RAN Software Community)</a>
- [x] - <a href="#Topic-7-Traffic-Steering-Usecase">Topic 7: Traffic Steering Usecase</a>
- [x] - <a href="#Topic-8-Alarm-System-O-RAN-Software-Community">Topic 8: Alarm System (O-RAN Software Community)</a>
- [x] - <a href="#Topic-9-RIC-Test-Introduction">Topic 9: RIC Test Introduction</a>
<!-- ---
- [ ] - <a href="">Topic 10: O-DU Overview</a>
- [ ] - <a href="">Topic 11: O-DU E2 Message Handler (O-RAN Software Community)</a>
- [ ] - <a href="">Topic 12: O-DU Scheduler (O-RAN Software Community)</a> -->
<!-- - [ ] - <a href="">Summary </a> -->
:::
:::info
:bookmark: **Reference:**
- **Speakers:**
- Yueh-Huan
- Tori
- Winnie
- **Slide:**
- [**Topic slide**](https://hackmd.io/@Yueh-Huan/Byzhx1gjc#21-Near-RT-RIC-Lecture-Program-Unit)
:::

:::spoiler Training Course
:::
<br>

[toc]

# Topic 1: Near-RT RIC Functional Block Concept (O-RAN Specification)
- [ Introduction to Near-RT RIC ](/9WPk-nVpQbGhQs6o5_jFMA)
# Topic 2: Near-RT RIC Platform Introduction <br> (O-RAN Software Community)

## 2.1 RIC Message Router (RMR)
- Communication between Xapps
<!--  -->
- **Example:**

## 2.2 Routing Manager
- each component in platform can create/update routing
- Dynamic Routing Create and Update
<!--  -->
## 2.3 Redis Database
- Share Data Layer(SDL) API
- Access the database
<!--  -->
## 2.4 E2 Termination
- SCTP Connection
- E2 Procedures
- E2AP 

<!--  -->
## 2.5 E2 Manager
- E2 connection between Near-RT RIC platform and E2 Node
- Trigger Routing Update
<!--  -->
## 2.6 Subscription Manager
- When Xapp wants to communicate with E2
- Manage subscription between xApp and E2 Node
<!--  -->
## 2.7 xAPP Manager
- Life Cycle Management
<!--  -->
## 2.8 A1 Mediator
- Between xAPP and Non-Real Time RIC
- Support RESTful API
- JSON 
<!--  -->
## 2.9 Alarm System
- Warning MSG
- Error MSG
- can know what event was occur
<!--  -->

## 2.10 Infrastrusture
- Helm is a management tool to manage kubernetes applications
- Kubernetes is a container management system (automatic deployment)
- Docker enables virtualization of OS (create containers)
<!--  -->

## 2.11 Near-RT RIC Platform (necessary)
- **Optional Components**
- deployment-ricplt-jaegeradapter
- ricplt-influxdb
- **API Gateway**
- r4-infrastructure
<!--  -->

## 2.12 Useful Command
- Easy to copy

helm ls -A
kubectl get pods -A
kubectl get pods -n <namespace>
kubectl logs -f -n <namespace><pods name>
kubectl exec -it -n <namespace><pods name><command>
docker images
docker ps

# Topic 3: xApp Introduction (O-RAN Software Community)
## 3.1 Support language:
■ Go
■ Python
■ C++

## 3.2 xAPP types
### 3.2.1 Reactive xApp
- Only tacke action upon receipt of an RMR message.
- Example: QP(QoE Predictor) xApp
### 3.2.2 General xApp
- Acts according to its own criteria
- Example: AD(Anomaly Detection) xApp
<!--  -->

## 3.3 Framweork file (Only for Python)
<!--
### class SDLWrapper
### class NewSubscriber & RestHandler
### [RMR](#RIC-Message-Router-RMR)
### RIC Alarm API
 -->

# Topic 4: xApp LCM (O-RAN Software Community)
## 4.1 Flow of Onboarding & Deoloyment
1. Onboard Command (xApp config)
2. Creat the helm chart
3. Deploy command
4. Fetch the helm chart
5. Helm install
6. (a) Registering message (form xApp to xApp manager)
(b) Registering message (form user to xApp manager)
7. Notification message to Rt manager
8. Notification message to Vespa

:::spoiler **Only move the Slide here**

## Flow of Termination

## Preparation
- Set up the environment var. for dms_cli connection

$ export NODE_PORT=$(kubectl get --namespace ricinfra -o jsonpath="{.spec.ports[0].nodePort}" services r4-chartmuseum-chartmuseum)
$ export NODE_IP=$(kubectl get nodes --namespace ricinfra -o jsonpath="{.items[0].status.addresses[0].address}")
$ export CHART_REPO_URL=http://$NODE_IP:$NODE_PORT/charts

<!--  -->
## Commands of xApp onboarding

$ dms_cli onboard --config_file_path=<CONFIG_FILE_PATH> --shcema_file_path=<SCHEMA_FILE_PATH>

<!--  -->
## xApp configuration
- **Provide the basic information of the xApp**
- DMS Tool use it to create the helm chart of xApp
- xApp Manager use it to manage the xApp
- Routing Manager create the routing path by using it
## Commands of xApp deploying

$ dms_cli install --xapp_chart_name=<XAPP_CHART_NAME> --version=<VERSION> --namespace=<NAMESPACE>


## Commands of xApp registering

$ curl -X 'POST' 'http://<appmgr IP>:8080/ric/v1/register' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{
"appName": "<xApp name>",
"appVersion": "<xApp version>",
"appInstanceName": "<xApp name>",
"httpEndpoint": " ",
"rmrEndpoint": "<RMR IP of ad xApp>:4560",
"config": " <xApp descriptor> "
}'


## Commands of xApp Termination - Deregister

$ curl -X 'POST' 'http://<appmgr IP>:8080/ric/v1/deregister' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{
"appName": "<xApp name>",
"appInstanceName": "<xApp name>"
}'


## Commands of xApp Termination - Undeploy

dms_cli uninstall --xapp_chart_name=<XAPP_CHART_NAME> --namespace=<NAMESPACE>


## Example:
### Onboarding & Deployment
- Set up the environment variables for dms_cli connection

$ export NODE_PORT=$(kubectl get --namespace ricinfra -o jsonpath="{.spec.ports[0].nodePort}" services r4-chartmuseum-chartmuseum)
$ export NODE_IP=$(kubectl get nodes --namespace ricinfra -o jsonpath="{.items[0].status.addresses[0].address}")
$ export CHART_REPO_URL=http://$NODE_IP:$NODE_PORT/charts

- Onboard and install the hw-go xApp

$ dms_cli onboard --config_file_path=config.json --shcema_file_path=shcema.json
$ dms_cli install --xapp_chart_name=hw-go --version=1.0.1 --namespace=ricxapp


### Termination
- Deregister the hw-go xApp

$ curl -X 'POST' "http://${Appmgr_IP}:8080/ric/v1/deregister" -H 'accept: application/json' -H 'Content-Type: application/json' -d '{
"appName": "hw-go",
"appInstanceName": "hw-go"
}'

- Undeploy the hw-go xApp

$ dms_cli uninstall --xapp_chart_name=hw-go --namespace=ricxapp


:::

## 4.2 Q&A
### 4.2.1 Question 1:
- **Q1:** What happens if I deploy directly without sending the message to the xapp manager (The place of the second chapter diagram)
- > **Ans:** If you don't follow the steps to register, all components will not know that there is this xApp

# Topic 5: E2 Interface (O-RAN Specification)

## 5.1 E2 Interface
- Connect the Near-RT RIC and E2 nodes

## 5.2 E2AP
In the Specifications
- The E2 interface is composed of
○ 4 RIC Services
○ 13 E2AP Procedures
○ 32 E2AP Information Elements (IE)

## 5.3 Four RIC Service
1. report to Near-RT RIC
2. insert
3. control
4. Policy
### 5.3.1 E2 set up
let Near RT-RIC and E2 know each other

### 5.3.2 RIC Subscription
set the ==event== E2 Node

### 5.3.3 RIC Indication
insert

# Topic 6: E2 Procedure (O-RAN Software Community)

## 6.1 E2 Service Model
- it is for between xApp and E2 Node

## 6.2 E2AP
managerment the platform
## 6.3 E2SM
important to let xApp comuntion to E2 Node

## 6.4 E2 set up
1. E2 Node ask to E2 Termination
2. E2 Termination will do task for E2 Manager, then E2 Manager will judge
3. if can do it: Update Information

## 6.5 E2 Subscription
:::success
- Goal: set the event
:::
1. Ex: Timer, set fve min. Timer
2. xApp REST Request to Manager
3. judge if correct will Creat Routing and take task to E2 Termination
4. E2 Termination Request to E2 Node
5. if successfully: E2 Node will use SCTP Responde

## 6.6 E2 Indication
:::success
- Goal: notify xApp if event is triggered
:::
1. E2 Node -> E2 Termination -> xApp

## 6.7 E2 Control
:::success
- Goal: xApp adk E2 Node execute something
:::
1. xApp send Request to E2 Termination
2. E2 Node will recive E2 Termination Request
3. if success response

## 6.8 Example:
### 6.8.1 E2SM
:::success
- Goal: collect cell and UE data over E2 interface
:::
- user Produre:
- Subscription
- Indication

## 6.9 Q&A
### Q1: The data returned by O-DU is directly back to xApp, but how does it know
>**Ans:** It does Roution Path registration through Subscription Manager, so that E2 Node knows the route that needs to be taken when returning data to xApp through Indication
### Q2: What should I do if multiple xApps need to obtain this information?
> **Ans:** It is not allowed in the specification. The solution is to obtain the data through the subscribed xApp, upload the data to the database, and then share the data in parallel
### Q3: Two xApps should subscribe to the same service at the same time
> **Ans:** If there is already an xApp subscribed to a service (O-DO) then Subscription will not let other xApps continue to subscribe to this service
<!-- ### Q1: O-DU回傳資料是直接回到xApp的，但是他是如何知道的
> Ans: 他是透過Subscription Manager去做Roution Path 註冊，讓E2 Node知道 之後如果要透過Indication回傳資料給xApp的時候需經的路線
### Q2: 如果多的xApp都要取得這項資訊，要如何處理
> Ans:在規格書上是不允許的，解決方法是透過以訂閱的這個xApp取得資料後，將資料上傳至資料庫，再將資料平行共享
### Q3: 兩個xApp要同時訂閱一個相同的服務
> Ans:如果已經有xApp訂閱一個服務(O-DO)那麼Subscription 就不會再讓其他xApp繼續訂閱這項服務了 -->

# Topic 7: Traffic Steering Usecase

- TS use case
:::success
- Balance of Base Stations via Handover
:::
- Make Handovwe decision => TS xApp

## 7.1 Q&A
- Q1: influxDB可以用其他DB取代嗎(像是SQL..等)？
>Ans:influxDB is time series Data base

# Topic 8: Alarm System (O-RAN Software Community)
:::success
- moniation the alarm meassage
- belon to the Fault Management
:::
- Alert Manager to Post Alarms

## 8.1 Flow
1. define the Alarm
- AlarmID
- Text
- Type
- Opera
2. Raise the Alarm
- Alarm Message
- SpecificProblem
3. Post the Alerts
4. send to VES Angent

# Topic 9: RIC Test Introduction
- Configuration
- O-CU
- O-DU
- UE data
:::success
**Goals:**
- play as many E2 Node
- E2 Loading
- verify E2AP E2SM
:::

<!-- # Topic 10: O-DU Overview

# Topic 11: O-DU E2 Message Handler (O-RAN Software Community)

# Topic 12: O-DU Scheduler (O-RAN Software Community) -->

<!-- # End: Summary -->

----
<!-- >**Name**: `名稱` -->