| Lusheng Ji | 37534a5 | 2020-08-02 21:25:26 -0400 | [diff] [blame] | 1 | ################################################################################ |
| 2 | # Copyright (c) 2020 AT&T # |
| 3 | # # |
| 4 | # Licensed under the Creative Commons License, Attribution 4.0 Intl. (the # |
| 5 | # "License"); you may not use this file except in compliance with the # |
| 6 | # License. You may obtain a copy of the License at # |
| 7 | # # |
| 8 | # https://creativecommons.org/licenses/by/4.0/ # |
| 9 | # # |
| 10 | # Unless required by applicable law or agreed to in writing, documentation # |
| 11 | # distributed under the Documentation License is distributed on an "AS IS" # |
| 12 | # BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or # |
| 13 | # implied. See the Documentation License for the specific language governing # |
| 14 | # permissions and limitations under the Documentation License. # |
| 15 | # # |
| 16 | ################################################################################ |
| 17 | |
| 18 | |
| 19 | This directory contains a set of scripts used in the Bronze Release "Getting |
| 20 | Started" series of demonstrations. The video recordings of these demonstrations |
| 21 | are available at https://wiki.o-ran-sc.org/display/GS/Getting+Started. |
| 22 | |
| 23 | To run these demonstration scripts, it is assumed that two Kubernetes clusters |
| 24 | have been set up, and the SMO and (Near Realtime) RIC have been deployed into |
| 25 | these two clusters following the instructions at |
| 26 | https://wiki.o-ran-sc.org/display/GS/SMO+Installation and |
| 27 | https://wiki.o-ran-sc.org/display/GS/Near+Realtime+RIC+Installation respectively. |
| 28 | |
| 29 | |
| 30 | __config-ip.sh |
| 31 | This script configures the IP addresses of the RIC and SMO clusters into the |
| 32 | Helm charts and scripts in the cloned it/dep repository. Prior to the running |
| 33 | of this script, the IP addresses of the SMO and RIC clusters can be configured |
| 34 | as environment variables, or the script will prompt the user to input them. |
| 35 | This script must be run in both the RIC and SMO clusters before starting any |
| 36 | of the demonstrations. |
| 37 | |
| 38 | xapp-hw.sh, xapp-ts.sh |
| 39 | These two scripts demonstrate the Hello World and the Traffic Steering xApps |
| 40 | respectively. They are to be run in a shell with sufficient privilege (e.g. |
| 41 | kubectl) to operate the RIC cluster. |
| 42 | |
| 43 | a1-ric.sh, a1-smo.sh |
| 44 | These two scripts demonstrate the A1 Bronze use case. The *-ric.sh script is to |
| 45 | be run in the RIC cluster and the *-smo.sh script is to be run in the SMO cluster. |
| 46 | The scripts are interactive and will prompt the user to perform actions in sequence |
| 47 | in these two clusters. |
| 48 | |
| 49 | odu-high.sh |
| 50 | The odu-high.sh script is to be run in a server outside of the (Near Realtime) RIC |
| 51 | cluster. It completes the steps of cloning, compiling, and running the O-DU High |
| 52 | to interact with the (Near Realtime) RIC to complete the E2 Setup handshake. |
| 53 | |
| 54 | |
| 55 | o1-ric.sh, o1-smo.sh, test-raise-alarm.sh |
| 56 | These three scripts demonstrate the O1 Bronze use case. The *-ric.sh script is to |
| 57 | be run in the RIC cluster and the *-smo.sh script is to be run in the SMO cluster. |
| 58 | The scripts are interactive and will prompt the user to perform actions in sequence |
| 59 | in these two clusters. The test-raise-alarm.sh script shows how to raise artificial |
| 60 | alarms in the RIC cluster. |