ric-platform/README.md

   1 # RIC Platform Components
   2
   3 Helm charts, deployment scripts and configuration files for RIC platform components.
   4
   5 ### Directory Structure
   6 .
   7 ├── 50-RIC-Platform      Deployment scripts, charts and configuration files for RIC platform components
   8 ├── 55-Ext-Services      Deployment scripts and chart for external service used by RIC to reach services outside of cluster
   9 └── README.md            This file
  10
  11
  12 In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
  13 *RICPLT_RELEASE_NAME
  14 *RICPLT_NAMESPACE
  15
  16
  17 ### To Deploy RIC Platform
  18 ```sh
  19 $ # Modify the configuration files in ./50-RIC-Platform/etc/
  20 $ . ./50-RIC-Platform/bin/install
  21 $ # If you have an override value.yaml file, please use
  22 $ #. ./50-RIC-Platform/bin/install YOUR_OVERRIDE_FILE
  23 ```
  24
  25 ### RIC Platform Deployment Options
  26 You can configure the Helm release name, Kubernetes namespace using configuration files located in ./50-RIC-Platform/etc/
  27 Please make sure that the namespace is the same one as the one used for RIC platform components.
  28
  29 In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
  30 *RICPLT_RELEASE_NAME
  31 *RICPLT_NAMESPACE
  32
  33 ### To Undeploy RIC Platform
  34 ```sh
  35 $ . ./50-RIC-Platform/bin/uninstall
  36 ```
  37
  38 ### To Deploy External services
  39 The IP address described below should be the interface IP address of the VM hosting the aux cluster.
  40 If the aux cluster is multi-node, any of the nodes can be specified here.
  41
  42 ```sh
  43 $ # 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,
  44 $ # make sure it is set correctly.
  45 $ . ./55-Ext-Services/bin/install
  46 $ # If you have an override value.yaml file, please use
  47 $ #. ./50-Ext-Services/bin/install YOUR_OVERRIDE_FILE
  48 ```
  49
  50 ### To Undeploy External services
  51 ```sh
  52 $ . ./55-Ext-Services/bin/uninstall
  53 ```