Skip to content
Snippets Groups Projects
Commit f648c09d authored by Sagar Arora's avatar Sagar Arora :bicyclist_tone1:
Browse files

system requirements, cpu frequency information 


Signed-off-by: Sagar Arora's avatararora <sagar.arora@openairinterface.org>
parent 0800dad0
No related branches found
No related tags found
2 merge requests!3014Integration: `2024.w40`,!2886(doc): Added a new doc on hardware requirements
Hide whitespace changes
Inline Side-by-side
README.md
+ 1
− 0
View file @ f648c09d
......@@ -43,6 +43,7 @@ Please see [NOTICE](NOTICE.md) file for third party software that is included in
* [General overview of documentation](./doc/README.md)
* [The implemented features](./doc/FEATURE_SET.md)
* [System Requirements for Using OAI Stack](./doc/system_requirements.md)
* [How to build](./doc/BUILD.md)
* [How to run the modems](./doc/RUNMODEM.md)
......
doc/HARDWARE_REQUIREMENTS.md → doc/system_requirements.md
+ 54
− 55
View file @ f648c09d
......@@ -7,12 +7,12 @@
</a>
</td>
<td style="border-collapse: collapse; border: none; vertical-align: center;">
<b><font size = "5">Hardware Requirement for Using OAI Stack</font></b>
<b><font size = "5">System Requirements for Using OAI Stack</font></b>
</td>
</tr>
</table>
This document explains the minimal and performance hardware requirement for OpenAirInterface (OAI) software stack (UE and RAN stack). The information provided in this document is based on experimentation, if you have a feedback then open an issue or send an email on the mailing list.
This document describes the minimal and performant system requirements for OpenAirInterface (OAI) 4G/5G software stack (UE and gNB stack). The information provided in this document is based on experimentation, if you have a feedback then open an issue or send an email on the mailing list.
**Table of Contents**
......@@ -29,108 +29,107 @@ This document explains the minimal and performance hardware requirement for Open
- On `x86_64` platform the CPU should support `avx2` instruction set (Minimum requirement).
# Supported Operating System
|Operating System |
|-----------------|
|Ubuntu 20/22/24 |
|RHEL 9 |
|Fedora 40 |
|Debian 11 |
|Rocky 9 |
# Minimum Hardware Requirement for x86_64 Platforms
The minimum hardware requirements depends on the radio unit you would like to use or the test case that you would like to execute.
## Simulated Radio
OAI offers an inbuilt simulated radio, [RFSimulator](../radio/rfsimulator/README.md). It can be used to understand how different channel model behaves. It is not designed to do high performance testing. The above requirements are valid for both 4G and 5G RAN and UE Stack.
OAI offers an inbuilt simulated radio, [RFSimulator](../radio/rfsimulator/README.md). It can be used to familiarize oneself with OAI, for development and debugging, and offers the possibility to use basic channel models. It is not designed to do high performance testing. The below requirements are valid for both 4G and 5G RAN and UE Stack.
### Minimum requirements for RAN Stack
The following requirements are minimum requirements for all use cases:
- CPU: 4
### Minimum requirements for gNB Stack
- CPU: 2
- Minimum frequency > 2GHz
- Memory: 4Gi
- `avx2` instruction set
- `sctp` protocol should be enabled
**NOTE**: We have not tested on Intel Atom or Celeron processors, and they
likely won't work well.
### Minimum requirements for UE Stack
- CPU: 3
- CPU: 2
- Minimum frequency > 2GHz
- Memory: 3Gi
- `avx2` instruction set
**NOTE**: We have not tested on Intel Atom or Celeron processors
## USRP B2XX or Blade RF
USRP B2XX or Blade RF are USB based radios recommended to use with USB 3.0. You can choose a minimum hardware to do functional testing and performance hardware for performance testing. This hardware you can find in Mini-PCs or laptops.
### Minimum requirements for RAN Stack
- CPU: 4
- Memory: 4Gi
- `avx2` instruction set
- `sctp` protocol should be enabled
- USB 3.0
### Minimum requirements for UE Stack only with USRP B2XXX
The minimum requirements stated in [simulated radio](.##simulated-radio) apply.
- CPU: X
- Memory: X
- `avx2` instruction set
- USB 3.0
### Minimum requirements for both gNB and UE Stack
### Recommended for performance for RAN Stack
- High clock speed CPUs > 4GHz
- DDR4 or DDR5 RAM
- Use only performance cores
- CPU: 3
- Memory: 5Gi
- Disable CPU sleep states
- CPU: X
- Memory: 4Gi
- `avx2` instruction set
- `sctp` protocol should be enabled
- USB 3.0
- Intel i5, AMD Ryzen 5
### Recommended for performance for UE Stack only with USRP B2XXX
### Recommended for performance for gNB and UE Stack
- High clock speed CPUs > 4GHz
- DDR4 or DDR5 RAM
- CPU: 4
- Boost Frequency > 3GHz
- Use only performance cores
- Disable hyper-threading
- Disable CPU sleep states
- CPU: X
- Memory: 4Gi
- `avx2` instruction set
- DDR4 or DDR5 RAM, minimum 5Gi
- USB 3.0
Apart from this you should follow [this document](./tuning_and_security.md) to
Apart from this you should follow [tuning and security tips](./tuning_and_security.md) to
tune your system to get high performance.
## USRP N3XX/X3XX/X4XX
## USRP N3XX/X3XX/X4XX/AW2S
USRP N3XX/X3XX/X4XX requires two dedicated 10G SFP+ connections. For these radios we only recommend having performance hardware. This hardware you can find in Desktop servers or rack/blade servers. For the gNB, the same applies in case of using AW2S radios.
The minimum requirements stated in [simulated radio](.##simulated-radio) apply.
USRP N3XX/X3XX/X4XX requires two dedicated 10G SFP+ connections. For these radios we only recommend having performance hardware. This hardware you can find in Desktop servers or rack/blade servers.
Apart from this you should follow [tuning and security tips](./tuning_and_security.md) to
tune your system to get high performance.
**NOTE**: In case you are using Mellanox NIC cards then you have to download `mlnx-ofed` and configure your NIC for performance.
### Recommended for performance for RAN Stack
### Recommended for performance for gNB Stack
- High clock speed CPUs > 4GHz
- DDR4 or DDR5 RAM
- CPU: 8-10
- Boost Frequency > 4GHz
- Use only performance cores
- Disable CPU sleep states
- CPU: X
- Memory: X
- `avx2` instruction set
- `sctp` protocol should be enabled
- DDR4 or DDR5 RAM, 5 Gi
- (Optional) Realtime kernel to have better Jitter statistics
- Intel x710/xx710/E-810 or Mellanox connect 5x or 6x
### Recommended for performance for UE Stack
- High clock speed CPUs > 4GHz
- DDR4 or DDR5 RAM
- CPU: 4
- Boost Frequency > 4GHz
- DDR4 or DDR5 RAM, 5Gi
- Use only performance cores
- Disable CPU sleep states
- CPU: X
- Memory: X
- `avx2` instruction set
- (Optional) Realtime kernel to have better Jitter statistics
- Intel x710/xx710/E-810 or Mellanox connect 5x or 6x
In case you are using Mellanox NIC cards then you have to download `mlnx-ofed` and configure your NIC for performance.
Apart from this you should follow [this document](./tuning_and_security.md) to
tune your system to get high performance.
## O-RAN Radio Units
We have dedicated documentation for O-RAN Radio Units. [Refer to that documentation](./ORAN_FHI7.2_Tutorial.md) before purchasing a Desktop server or rack/blade server.
We have dedicated documentation for O-RAN Radio Units. [Refer to 7.2 FH documentation](./ORAN_FHI7.2_Tutorial.md) before purchasing a Desktop server or rack/blade server.
The minimum requirements stated in [simulated radio](.##simulated-radio) apply.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment