Add one-click deployment scripts and override file examples.

[it/dep.git] / README.md

diff --git a/README.md b/README.md
index 3987ce6..742ceb7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,33 +2,47 @@
   
 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
 .
-├── aux                  Deployment scripts, charts and configuration files for RIC auxiliry functions
-├── infra                Deployment scripts, charts and configuration files for infrastructure support
-├── LICENSES.txt         License information
-├── README.md            This file
-├── ric-platform         Deployment scripts, charts and configuration files for RIC platform components
-└── xapps                xApp related scripts, charts and configuration files
+├── 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
 
 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,
-.
-â\94\9câ\94\80â\94\80 aux
-│   └── 80-Auxiliary-Functions
-├── infra
+├── ric-aux
+â\94\82Â Â  â\94\9câ\94\80â\94\80 80-Auxiliary-Functions
+│   └── README.md
+├── ric-infra
 │   ├── 00-Kubernetes
-│   └── 10-Nexus
-├── LICENSES.txt
-├── README.md
-├── ric-platform
+│   ├── 10-Nexus
 │   ├── 20-Credential
-│   └── 50-RIC-Platform
-└── xapps
-    └── 90-xApps
+│   └── README.md
+├── ric-platform
+│   ├── 50-RIC-Platform
+│   └── README.md
+└── ric-xapps
+    ├── 90-xApps
+    └── README.md
 when deploys the ric-platform, the credential is deployed before RIC-Platform.
 
 In each of the component directory, ./etc contains the configuration file, ./bin contains the binary and script files,