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 value.yaml file. If no deployment recipe is provided, defaul 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 ├── etc
  19 ├── LICENSES.txt  License information
  20 ├── README.md           This file
  21 ├── RECIPE_EXAMPLE        Directory that contains deploy recipe examples
  22 ├── ric-aux               Deployment scripts, charts and configuration files for RIC auxiliry functions
  23 ├── ric-infra             Deployment scripts, charts and configuration files for infrastructure support
  24 ├── ric-platform  Deployment scripts, charts and configuration files for RIC platform components
  25 └── ric-xapps             xApp related scripts, charts and configuration files
  26
  27 ### Directory Naming Convention
  28
  29 The root directories are orgainzed according to the deployment plans. Each directory contains subdirectories for
  30 different deployable components. The prefix of these subdirectories represents the deployment order. The smaller the
  31 prefix number the eariler the corresponding component will be deployed.  Consider the following example,
  32 ├── ric-aux
  33 │   ├── 80-Auxiliary-Functions
  34 │   ├── 85-Ext-Services
  35 │   └── README.md
  36 ├── ric-infra
  37 │   ├── 00-Kubernetes
  38 │   ├── 10-Nexus
  39 │   ├── 20-Monitoring
  40 │   ├── 40-Credential
  41 │   └── README.md
  42 ├── ric-platform
  43 │   ├── 50-RIC-Platform
  44 │   ├── 55-Ext-Services
  45 │   └── README.md
  46 └── ric-xapps
  47     ├── 90-xApps
  48     └── README.md
  49 when deploys the ric-platform, the credential is deployed before RIC-Platform.
  50
  51 In each of the component directory, ./etc contains the configuration file, ./bin contains the binary and script files,
  52 ./helm contains the helm charts, and ./docker contains docker related files for building the docker images. Please refer
  53 to the README.md files in individual directory for more details.
  54
  55 ### To deploy RIC
  56 TBD will update when we have the root installer.
  57
  58 ### Configure the RIC deployment
  59 TBD will update when we have the root installer.