ric-aux/README.md

   1 # RIC Auxiliary Functions
   2
   3 Helm charts, configuration files, and automation scripts that deploy the auxiliary functions for RIC. The auxiliary
   4 functions are defined as the features and services that interact with the RIC but they do not collocated with the RIC
   5 cluster. These functions includes but not limited to non-realtime management components (e.g., dashboard, DMaaP,
   6 VEScollector) that interact with RIC using A1/O1 interfaces.
   7
   8
   9
  10 ### Directory Structure
  11 .
  12 ├── 80-Auxiliary-Functions    Contains components that interact with RIC through A1/O1
  13 │   ├── bin                   Contains deployment and uninstall scripts
  14 │   ├── etc                   Contains deployment configuration files
  15 │   └── helm                  Contains helm charts
  16 └── README.md                 This file
  17
  18
  19 ### To deploy the Auxiliary Functions
  20 ```sh
  21 $ # Modify the configuration files in ./80-Auxiliary-Functions/etc/
  22 $ . ./80-Auxiliary-Functions/bin/install
  23 $ # If you have an override value.yaml file, please use
  24 $ #. ./80-Auxiliary-Functions/bin/install YOUR_OVERRIDE_FILE
  25 ```
  26
  27
  28 ### To undeploy the Auxiliary Functions
  29 ```sh
  30 $ . ./80-Auxiliary-Functions/bin/uninstall
  31 ```
  32
  33
  34 ### Deployment Options
  35 You can configure the Helm release name, Kubernetes namespace using configuration files located in ./80-Auxiliary-Functions/etc/
  36
  37 In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
  38 *RICAUX_RELEASE_NAME
  39 *RICAUX_NAMESPACE
  40