Merge "Add one-click deployment scripts for deploying INFRA PLT and AUX"
[it/dep.git] / 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 ├── 85-External Services      Deployment scripts and chart for external service used by RIC to reach services outside of cluster
17 └── README.md                 This file
18
19
20 ### To deploy the Auxiliary Functions
21 ```sh
22 $ # Modify the configuration files in ./80-Auxiliary-Functions/etc/
23 $ . ./80-Auxiliary-Functions/bin/install
24 $ # If you have an override value.yaml file, please use
25 $ #. ./80-Auxiliary-Functions/bin/install YOUR_OVERRIDE_FILE
26 ```
27
28
29 ### To undeploy the Auxiliary Functions
30 ```sh
31 $ . ./80-Auxiliary-Functions/bin/uninstall
32 ```
33
34
35 ### Deployment Options
36 You can configure the Helm release name, Kubernetes namespace using configuration files located in ./80-Auxiliary-Functions/etc/
37
38 In the one-click deployment solution, the above setting will be overrided by environment variables shown below.
39 *RICAUX_RELEASE_NAME
40 *RICAUX_NAMESPACE
41
42
43 ### To deploy the External services
44 The IP address described below should be the interface IP address of the VM hosting the platform cluster.
45 If the platform cluster is multi-node, any of the nodes can be specified here.
46
47 ```sh
48 $ # 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,
49 $ # make sure it is set correctly.
50 $ . ./85-Ext-Services/bin/install
51 $ # If you have an override value.yaml file, please use
52 $ #. ./85-Ext-Services/bin/install YOUR_OVERRIDE_FILE
53 ```
54
55
56 ### To undeploy the Auxiliary Functions
57 ```sh
58 $ . ./85-Ext-Services/bin/uninstall
59 ```