README.md

   1 # RIC Integration
   2
   3 This repo contains RAN Intelligent Controller (RIC) deployments related files.
   4
   5
   6 ### Overview
   7
   8 The RIC deployment scripts are designed to deploy RIC components using helm charts. A deployment recipe yaml file that
   9 contains parameter key:value pairs can be provided as a parameter for any deployment script in this repository. The
  10 deployment recipe is acting as the helm override values.yaml file. If no deployment recipe is provided, default parameters
  11 are used. The default parameters are set up to deploy a RIC instance using Linux Foundation repositories in a
  12 self-contained environment.
  13
  14
  15 ### Directory Structure
  16 .
  17 ├── bin
  18 ├── ci
  19 ├── etc
  20 ├── LICENSES.txt  License information
  21 ├── README.md           This file
  22 ├── RECIPE_EXAMPLE        Directory that contains deploy recipe examples
  23 ├── ric-aux               Deployment scripts, charts and configuration files for RIC auxilary functions
  24 ├── ric-common            Deployment scripts, charts and configuration files for RIC common template
  25 ├── ric-infra             Deployment scripts, charts and configuration files for infrastructure support
  26 ├── ric-platform  Deployment scripts, charts and configuration files for RIC platform components
  27 └── ric-xapps             xApp related scripts, charts and configuration files
  28
  29 ### Directory Naming Convention
  30
  31 The root directories are organized according to the deployment plans. Each directory contains subdirectories for
  32 different deployable components. The prefixes of these subdirectories represent the deployment order. The smaller the
  33 prefix number the eariler the corresponding component will be deployed.  Consider the following example,
  34 ├── ric-aux
  35 │   ├── 80-Auxiliary-Functions
  36 │   ├── 85-Ext-Services
  37 │   └── README.md
  38 ├── ric-infra
  39 │   ├── 00-Kubernetes
  40 │   ├── 10-Nexus
  41 │   ├── 20-Monitoring
  42 │   ├── 30-Kong
  43 │   ├── 40-Credential
  44 │   ├── 45-Tiller
  45 │   └── README.md
  46 ├── ric-platform
  47 │   ├── 50-RIC-Platform
  48 │   ├── 55-Ext-Services
  49 │   └── README.md
  50 ├── ric-aux
  51 │   ├── 80-Auxiliary-Functions
  52 │   ├── 85-Ext-Services
  53 │   └── README.md
  54 └── ric-xapps
  55     ├── 90-xApps
  56     └── README.md
  57
  58 when deploying the ric-platform, the credential is deployed before RIC-Platform.
  59
  60 In each of the component directories, ./bin contains the binary and script files and ./helm contains the helm charts,
  61
  62 Some components contain an ./etc directory with configuration files and some contain a ./docker directory with docker related files for building the docker images.
  63
  64 Please refer to the README.md files in individual directory for more details.
  65
  66 Within ric-infra, ric-platform and ric-aux, each of the components above can be deployed and undeployed separately.
  67 There are also scripts for deploying the ric-infra, ric-platform or ric-aux in its entirety.
  68
  69 The ./bin directory contains these scripts
  70
  71 The following sections discuss one-script deployment for each
  72
  73 ### To deploy RIC Infrastructure
  74
  75 Edit ./RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE
  76 You can choose whether to enable Kubernetes deployment, Helm Chart museum and ELFKP stack
  77 You can specify the Helm release prefix and namespaces used
  78 You must specify username and password for Docker repo
  79 Then run the following to deploy:
  80 ```sh
  81 $ . ./deploy-ric-infra -f ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE
  82 ```
  83 Run the following to undeploy:
  84 ```sh
  85 $ . ./undeploy-ric-infra
  86 ```
  87
  88 ### To deploy RIC Platform
  89
  90 Edit ./RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE
  91 You can specify the Helm release prefix and namespaces used
  92 Set the values of extsvcaux/ricip and extsvcaux/auxip to be the external IP addresses of VM hosting RIC cluster and VM hosting AUX cluster, respectively.
  93 These values should be set in both the override file and the local values.yaml file
  94 ```sh
  95 $ . ./deploy-ric-platform -f ../RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE
  96 ```
  97 Run the following to undeploy:
  98 ```sh
  99 $ . ./undeploy-ric-platform
 100 ```
 101
 102 ### To deploy RIC Auxiliary functions
 103
 104 Edit ./RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE
 105 You can specify the Helm release prefix and namespaces used
 106 Set the values of extsvcaux/ricip and extsvcaux/auxip to be the external IP addresses of VM hosting RIC cluster and VM hosting AUX cluster, respectively.
 107 These values should be set in both the override file and the local values.yaml file
 108 ```sh
 109 $ . ./deploy-ric-aux -f ../RECIPE_EXAMPLE/RIC_AUX_RECIPE_EXAMPLE
 110 ```
 111 Run the following to undeploy:
 112 ```sh
 113 $ . ./undeploy-ric-aux
 114 ```