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 │   ├── bin              Contains deployment and uninstall scripts
   9 │   └── helm             Contains helm charts
  10 ├── 55-Ext-Services      Deployment scripts and chart for external service used by RIC to reach services outside of cluster
  11 └── README.md            This file
  12
  13
  14 In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
  15 *RICPLT_RELEASE_NAME
  16 *RICPLT_NAMESPACE
  17
  18
  19 ### To Deploy RIC Platform
  20 ```sh
  21 $ # An override file must be used.
  22 $ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE
  23 $ #. ./50-RIC-Platform/bin/install -f YOUR_OVERRIDE_FILE
  24 ```
  25
  26 ### RIC Platform Deployment Options
  27 You can configure the Helm release name, Kubernetes namespaces using the override file with
  28 parameters global.releasePrefix and global.namespace
  29
  30 ### To Undeploy RIC Platform
  31 ```sh
  32 $ . ./50-RIC-Platform/bin/uninstall
  33 ```
  34
  35 ### To Deploy External services
  36 The IP address described below should be the interface IP address of the VM hosting the aux cluster.
  37 If the aux cluster is multi-node, any of the nodes can be specified here.
  38
  39 ```sh
  40 $ # An override file must be used.
  41 $ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE
  42 $ # 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.
  43 $ # These values should be set in the override file
  44 $ . ./55-Ext-Services/bin/install -f YOUR_OVERRIDE_FILE
  45 ```
  46
  47 ### To Undeploy External services
  48 ```sh
  49 $ . ./55-Ext-Services/bin/uninstall
  50 ```