Requirements
This tutorial will show you how to manage your ORS on the Rapid.Space panel.
Join your project on panel.rapid.space
You must first join your project on panel.rapid.space with the invitation link given in the email. Please make sure you are already logged in with your account before clicking the link.
If you do not have the link anymore or if it expires, please ask us and we will send you another one.
Find your services
In the "Services" section, you will find by default:
- orsXX-enb, orxXX-gnb and orsXX-core-network: eNB, gNB and Core Network services running Amarisoft Stack
- orsXX-conference and orsXX-mail-server: PTT Video Conference and Mail Servers, please refer to the MCPTT tutorial
- orsXX-health: here you will find many promises to check the health of your ORS machine such as CPU temperature
By default, only one eNB or gNB service will be started, you should not run multiple gNB or eNB services at the same time as ORS can only run one at a time.
Here is the meaning of the "Status" button:
- Green means the service is currently running without any errors
- Orange or red means the service is running but has some errors (a following section will show you how to investigate)
- Grey means the service is stopped.
Find the server corresponding to your ORS
In the "Server" section, you will find an entry corresponding to your ORS. This represents the physical ORS. If the "Node" status is green, it means your ORS is connected to internet. If the "Partitions" status is green, it means all softwares have been correctly installed on the ORS, if it is orange or red it means a software had trouble installing itself.
Find your project
In the "Projects" section, you will your project. After clicking on your project, you will see your two ORS services and the server corresponding to your ORS from the previous sections. Projects allows you to give people access to your services and servers by inviting them. To invite someone, generate an invitation link by clicking on the Invite User button.
Contract deactivated warning
When clicking on your ORS service, you might see a message warning you your contract is deactivated. Please ignore this message, you only need an activated contract to request services on Rapid.Space servers, it is not needed for ORS management.
Monitor your ORS - Monitor Setup URL
To investigate potential errors with the services or to get statistics you can use our monitoring app. Please go to your service page (by clicking on the service in the service section) and find the "monitor-setup-url" connection parameter, as shown on the screenshot. If the parameter is not present, please wait for 20 minutes after starting the service.
Monitor your ORS - Synchronization
Monitor your ORS - Synchronization
You will notice that when you enter the monitor App, the information of your ORS has been filled in automatically and started synchronisation. Once synchronisation finishes, the Monitor will load and display the list of Promises for your hosting subscriptions.
Before we get into the promise list, let's have a look at the App. The Monitor has a multiple-functions side panel:
- Promises: all promises of all services on all computers.
- Software Instances: all instances (hosting subscriptions) of all services on all computers.
- Instance Trees: all services from all computers (similar to Rapid.Space Panel).
- Monitor Configurations: all data sources (instances), loaded from master.
- Syncronize: update the monitor data by querying all services and crawling data.
- OPML Import / Export: used to import and export the current configuration.
For instance you can click on "Software Instances" and then on the enb instance to get statistics regarding eNB.
Monitor your ORS - Promise List
Here you can see the monitor page for the enb instance. On this page you can see the list of promises for this instance. Each promises checks a specific part of the instance is working correctly. Promises will appear orange or red if they are failing, which can help you investigate why your ORS is not working properly. Promises will also give you useful data.
Promises in Rapid.Space are executables doing arbitrary tasks and exiting with exit code 0 ("it works") or greater ("it doesn't work"). Everything in Rapid.Space is based on such Promises in order to automate the management of a Rapid.Space network. In case a Promise fails (eg. a computer not responding), a ticket will be created on the Rapid.Space Master in order for a user to follow up with this failing promise (more info in Understanding SlapOS Promises).
Monitor your ORS - Access ORS logs
Please click on the "access private files" link to access the ORS logs.
Monitor your ORS - Access ORS logs
Next you can go the log folder.
Monitor your ORS - Access ORS logs
Here are some useful entries from the log folder:
- amarisoft-stats.json.log: JSON dump of all radio statistics, such as RF power levels, saturation events etc...
- enb-output.log: Standard output from Amarisoft lteenb software
- enb.log: Log from Amarisoft lteenb software
- monitor: Logs from the promises, can contain useful data
To learn how to interpret the logs, please refer to How To Interpret ORS Logs.
Monitor your ORS - Access ORS logs
After navigating to the monitor folder and then the promise folder, you will find logs from the promises. For instance, the "check-rx-saturated" JSON log will contain data about the RF levels from the RX antennas, which can be used to adjust rx_gain.
Monitor your ORS - Access ORS logs
The sample values should ideally be below -10, if they are too high then the reception will be saturated which can prevent the ORS from correctly receiving radio.
Add a service
By default, your ORS already has one NR and one LTE service. It is also possible to add services yourself by clicking on the "Add" button in the "Services" section of panel.rapid.space as shown here.
Add a service - Select Software
First you need to select the software, here are some software which can be used on ORS:
- Galene: Will run a videoconference server on your ORS, you can then make local videoconferences on your private 4G/5G network with your UEs
- SlapOS IDE (using Theia): Web IDE which you can use to integrate and test softwares of your own on the ORS
- ORS (TDD XXXX): 4G and 5G Amarisoft stack for frequency XXXX
Add a service - Select Software Type
Next you need to input a Title for your service and select the software type. Here are the different possible software types on ORS:
- gNB/eNB: will run a gNodeB (5G) or eNodeB (4G) on your ORS
- Core Network: will run a local core network which will automatically connect to any gNB/eNB service you have running, or can be connected to external gNB/eNB
The other software types are for special uses.
Add a service - Choose your server
Finally you need to select which ORS you want to request the service on.
Service list
Then, after refreshing the Services section you should see your service in the list. It will initally be red until everything is properly initialized. This can take up to 30mn for a fully functional service with monitoring.
Transfer your service
If you want other people with different account to access the service you added, please transfer it first to your project by clicking on the service and clicking the Transfer button as shown here.
Transfer your service
Next, select your project.
Add a service
Then, click on Proceed to confirm the transfer. The service will then be in your project and accessible to everyone who has joined the project.
Stop and Start the services
To switch between LTE and NR, you can stop and start the enb and gnb services. First click on the service in "Services" section, then click on the Start / Stop button, then click Proceed button. Both services should not be started at the same time as ORS do not support 4G and 5G simultaneously.
Choose Parameters
To manage your ORS, you can the parameters of your service by going to your service page and scrolling down to the parameter list.
Here are some examples of parameters you can change for the eNB/gNB and EPC software type:
- RX / TX gain: gain of the RF transceivers
- DL EARFCN / DL NR ARFCN: Downlink E-UTRA / NR Absolute Radio Frequency Channel Number, changes the downlink central frequency
- (NR only) NR band
- (LTE only) DL RB: Downlink Ressource Blocks, changes the bandwidth (Values: 6 (1.4 MHz), 15 (3MHz), 25 (5MHz), 50 (10MHz), 75 (15MHz), 100 (20MHz))
- (NR only) Bandwidth: bandwidth in MHz (40MHz maximum)
Add SIM Card
To add a SIM Card, please go to your core network service and click "Add shared", then enter a title and all the SIM information (you can modify this later), and click "Proceed".
If you would like to check your SIM card has been added correctly search for the SIM card you just created (using the title you entered previously), and wait and refresh the page until you see "Your SIM card with IMSI XXXX has been attached to service orsXX-core-network."