README.md

   1 # RIC Integration
   2
   3 This repo contains RAN Intelligent Controller (RIC) deployments related files.
   4
   5 ### Directory Structure
   6 .
   7 ├── aux                  Deployment scripts, charts and configuration files for RIC auxiliry functions
   8 ├── infra                Deployment scripts, charts and configuration files for infrastructure support
   9 ├── LICENSES.txt         License information
  10 ├── README.md            This file
  11 ├── ric-platform         Deployment scripts, charts and configuration files for RIC platform components
  12 └── xapps                xApp related scripts, charts and configuration files
  13
  14 ### Directory Naming Convention
  15
  16 The root directories are orgainzed according to the deployment plans. Each directory contains subdirectories for
  17 different deployable components. The prefix of these subdirectories represents the deployment order. The smaller the
  18 prefix number the eariler the corresponding component will be deployed.  Consider the following example,
  19 .
  20 ├── aux
  21 │   └── 80-Auxiliary-Functions
  22 ├── infra
  23 │   ├── 00-Kubernetes
  24 │   └── 10-Nexus
  25 ├── LICENSES.txt
  26 ├── README.md
  27 ├── ric-platform
  28 │   ├── 20-Credential
  29 │   └── 50-RIC-Platform
  30 └── xapps
  31     └── 90-xApps
  32 when deploys the ric-platform, the credential is deployed before RIC-Platform.
  33
  34 In each of the component directory, ./etc contains the configuration file, ./bin contains the binary and script files,
  35 ./helm contains the helm charts, and ./docker contains docker related files for building the docker images. Please refer
  36 to the README.md files in individual directory for more details.
  37
  38 ### To deploy RIC
  39 TBD will update when we have the root installer.
  40
  41 ### Configure the RIC deployment
  42 TBD will update when we have the root installer.