change ricplt kong port to avoid conflict with dashboard

[it/dep.git] / README.md

diff --git a/README.md b/README.md
index 13eeaaa..6b84be2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,59 @@
 # RIC Integration
-
+  
 This repo contains RAN Intelligent Controller (RIC) deployments related files.
 
 
+### Overview
+
+The RIC deployment scripts are designed to deploy RIC components using helm charts. A deployment recipe yaml file that
+contains parameter key:value pairs can be provided as a parameter for any deployment script in this repository. The
+deployment recipe is acting as the helm override value.yaml file. If no deployment recipe is provided, defaul parameters
+are used. The default parameters are set up to deploy a RIC instance using Linux Foundation repositories in a
+self-contained environment. 
+
+
 ### Directory Structure
-- kubernetes: scripts for kubernetes related tasks
-- LICENSES.txt:
-- localize.sh: a script for inserting localized infrastructure parameters (docker registry host, port, etc) into helm charts and scripts in this repo
-- ricplt: RIC Platform Helm charts and related scripts
-- runric_env.sh: the env variables for local infrastructure
-- xapps: xapps Helm charts and chart templates
+.
+├── bin
+├── etc
+├── LICENSES.txt License information
+├── README.md           This file
+├── RECIPE_EXAMPLE       Directory that contains deploy recipe examples
+├── ric-aux              Deployment scripts, charts and configuration files for RIC auxiliry functions
+├── ric-infra            Deployment scripts, charts and configuration files for infrastructure support
+├── ric-platform Deployment scripts, charts and configuration files for RIC platform components
+└── ric-xapps            xApp related scripts, charts and configuration files
+
+### Directory Naming Convention
 
-### To Generate Localized Charts and Scripts
+The root directories are orgainzed according to the deployment plans. Each directory contains subdirectories for
+different deployable components. The prefix of these subdirectories represents the deployment order. The smaller the
+prefix number the eariler the corresponding component will be deployed.  Consider the following example,
+├── ric-aux
+│   ├── 80-Auxiliary-Functions
+│   ├── 85-Ext-Services
+│   └── README.md
+├── ric-infra
+│   ├── 00-Kubernetes
+│   ├── 10-Nexus
+│   ├── 20-Monitoring
+│   ├── 40-Credential
+│   └── README.md
+├── ric-platform
+│   ├── 50-RIC-Platform
+│   ├── 55-Ext-Services
+│   └── README.md
+└── ric-xapps
+    ├── 90-xApps
+    └── README.md
+when deploys the ric-platform, the credential is deployed before RIC-Platform.
 
-First we will need to edit the ./runric_env.sh and fill values with local infrastructure parameters.
+In each of the component directory, ./etc contains the configuration file, ./bin contains the binary and script files,
+./helm contains the helm charts, and ./docker contains docker related files for building the docker images. Please refer
+to the README.md files in individual directory for more details.
 
-```sh
-$ then run:
-$ ./localize.sh
-$ cd generated
-```
+### To deploy RIC
+TBD will update when we have the root installer.
 
-Now the localized scripts and charts are ready to use.
+### Configure the RIC deployment
+TBD will update when we have the root installer.