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 are 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 ### Directory Structure
  10 .
  11 ├── 80-Auxiliary-Functions    Contains components that interact with RIC through A1/O1
  12 │   ├── bin                   Contains deployment and uninstall scripts
  13 │   └── helm                  Contains helm charts
  14 ├── 85-External Services      Deployment scripts and chart for external service used by RIC to reach services outside of cluster
  15 └── README.md                 This file
  16
  17
  18 ### To deploy the Auxiliary Functions
  19 ```sh
  20 $ # An override file must be used.
  21 $ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_AUX_RECIPE_EXAMPLE
  22 $ #. ./80-Auxiliary-Functions/bin/install -f YOUR_OVERRIDE_FILE
  23 ```
  24
  25
  26 ### To undeploy the Auxiliary Functions
  27 ```sh
  28 $ . ./80-Auxiliary-Functions/bin/uninstall
  29 ```
  30
  31
  32 ### Deployment Options
  33 You can configure the Helm release name, Kubernetes namespaces using the override file with
  34 parameters global.releasePrefix and global.namespace
  35
  36
  37 ### To deploy the External services
  38 The IP address described below should be the interface IP address of the VM hosting the platform cluster.
  39 If the platform cluster is multi-node, any of the nodes can be specified here.
  40
  41 ```sh
  42 $ # An override file must be used.
  43 $ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_AUX_RECIPE_EXAMPLE
  44 $ # Set the values of extsvcaux/ricip and extsvcaux/auxip to be the external IP addresses of VM hosting RIC cluster and VM hosting AUX cluster, respectively.
  45 $ # These values should be set ih the override file.
  46 $ . ./85-Ext-Services/bin/install -f YOUR_OVERRIDE_FILE
  47 ```
  48
  49
  50 ### To undeploy the External services
  51 ```sh
  52 $ . ./85-Ext-Services/bin/uninstall
  53 ```