Updating README files based on new directory structure

Change-Id: I269696f85230d1fb7a1e1c5b39b1324747cd19a1
Signed-off-by: rshacham <rshacham@research.att.com>

diff --git a/README.md b/README.md
index 742ceb7..6b84be2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -31,14 +31,17 @@ different deployable components. The prefix of these subdirectories represents t
 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-Credential
+│   ├── 20-Monitoring
+│   ├── 40-Credential
 │   └── README.md
 ├── ric-platform
 │   ├── 50-RIC-Platform
+│   ├── 55-Ext-Services
 │   └── README.md
 └── ric-xapps
     ├── 90-xApps

diff --git a/ric-aux/README.md b/ric-aux/README.md
index 34ce2cf..c9ab476 100644 (file)
--- a/ric-aux/README.md
+++ b/ric-aux/README.md
@@ -13,6 +13,7 @@ VEScollector) that interact with RIC using A1/O1 interfaces.
 │   ├── bin                   Contains deployment and uninstall scripts
 │   ├── etc                   Contains deployment configuration files
 │   └── helm                  Contains helm charts
+├── 85-External Services      Deployment scripts and chart for external service used by RIC to reach services outside of cluster
 └── README.md                 This file
 
 
@@ -38,3 +39,21 @@ In the one-click deployment solution, the above setting will be overrided by env
 *RICAUX_RELEASE_NAME
 *RICAUX_NAMESPACE
 
+
+### To deploy the External services
+The IP address described below should be the interface IP address of the VM hosting the platform cluster.
+If the platform cluster is multi-node, any of the nodes can be specified here.
+
+```sh
+$ # Set the value of ext/ip in values.yaml to be the external IP address.  If you will use an override file and it has ext/ip set,
+$ # make sure it is set correctly.
+$ . ./85-Ext-Services/bin/install
+$ # If you have an override value.yaml file, please use
+$ #. ./85-Ext-Services/bin/install YOUR_OVERRIDE_FILE
+```
+
+
+### To undeploy the Auxiliary Functions
+```sh
+$ . ./85-Ext-Services/bin/uninstall
+```
\ No newline at end of file

diff --git a/ric-infra/README.md b/ric-infra/README.md
index 55251a6..487bfb7 100644 (file)
--- a/ric-infra/README.md
+++ b/ric-infra/README.md
@@ -1,15 +1,16 @@
 # RIC Infrastructure Support
   
 Helm charts, configuration files, and automation scripts that deploy a development enviroment for RIC.
-A developer should star from here to create a kubernetes cluster that is pre-configured for RIC.
-Such development cluster is mimicking a closed field-trial environment. 
-
+A developer should start from here to create a kubernetes cluster that is pre-configured for RIC.
+Such a development cluster is mimicking a closed field-trial environment. 
 
 
 ### Directory Structure
 .
 ├── 00-Kubernetes             Contains scripts to deploy K8S cluster
 ├── 10-Nexus                  Contains scripts and helm charts to deploy the docker registry and helm repo
+├── 20-Monitoring             Helm charts for installed ELFK stack
+├── 40-Credential             Helm charts to onboard credential and secrets for docker registry and helm repo
 └── README.md                 This file
 
 
@@ -40,4 +41,26 @@ In the one-click deployment solution, the above setting will be overrided by env
 The installation process of the Nexus repo manager will generate certificates and credential for docker registry and
 helm repo.
 
+### To deploy ELFK stack
+```sh
+$ # Modify the configuration files in ./20-Monitoring/etc/
+$ . ./20-Monitoring/bin/install
+```
+
+
+### To onboard credentials
+```sh
+$ # Modify the user name and password in ./40-Credential/helm/values.yaml
+$ # Alternatively, include the credential information in an override value yaml file
+$ . ./40-Credential/bin/install
+$ # If you have an override value.yaml file, please use
+$ #. ./40-Credential/bin/install YOUR_OVERRIDE_FILE
+```
+
+### Credential Deployment Options
+You can configure the Helm release name, Kubernetes namespace using configuration files located in ./40-Credential/etc/
+Please make sure that the namespace is the same one as the one used for RIC platform components.
+
+
+
 TODO: Fill in the details about how to pass the credential to RIC 

diff --git a/ric-platform/README.md b/ric-platform/README.md
index 6b8f3a0..44f67c2 100644 (file)
--- a/ric-platform/README.md
+++ b/ric-platform/README.md
@@ -4,22 +4,10 @@ Helm charts, deployment scripts and configuration files for RIC platform compone
 
 ### Directory Structure
 .
-├── 20-Credential        Helm charts to onboard credential and secrets for docker registry and helm repo
 ├── 50-RIC-Platform      Deployment scripts, charts and configuration files for RIC platform components
+├── 55-Ext-Services      Deployment scripts and chart for external service used by RIC to reach services outside of cluster
 └── README.md            This file
 
-### To onboard credentials
-```sh
-$ # Modify the user name and password in ./20-Credential/helm/values.yaml
-$ # Alternatively, include the credential information in an override value yaml file
-$ . ./20-Credential/bin/install
-$ # If you have an override value.yaml file, please use
-$ #. ./20-Credential/bin/install YOUR_OVERRIDE_FILE
-```
-
-### Credential Deployment Options
-You can configure the Helm release name, Kubernetes namespace using configuration files located in ./20-Credential/etc/
-Please make sure that the namespace is the same one as the one used for RIC platform components.
 
 In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
 *RICPLT_RELEASE_NAME
@@ -45,3 +33,21 @@ In the one-click deployment solution, the above setting will be overrided by env
 ### To Undeploy RIC Platform
 ```sh
 $ . ./50-RIC-Platform/bin/uninstall
+```
+
+### To Deploy External services
+The IP address described below should be the interface IP address of the VM hosting the aux cluster.
+If the aux cluster is multi-node, any of the nodes can be specified here.
+
+```sh
+$ # Set the value of ext/ip in values.yaml to be the external IP address.  If you will use an override file and it has ext/ip set,
+$ # make sure it is set correctly.
+$ . ./55-Ext-Services/bin/install
+$ # If you have an override value.yaml file, please use
+$ #. ./50-Ext-Services/bin/install YOUR_OVERRIDE_FILE
+```
+
+### To Undeploy External services
+```sh
+$ . ./55-Ext-Services/bin/uninstall
+```
\ No newline at end of file