X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=ric-aux%2FREADME.md;h=d567dc640573890c8cabe52c9e4ae78aa753a457;hb=1644ece1946a8eb4046e837ea02bba366be5814a;hp=c9ab4763b3ac5e03e2048b8bb3eec5925edf3c36;hpb=6910ceb38d4d5e39ed94dfc0e288d8763649d01b;p=it%2Fdep.git diff --git a/ric-aux/README.md b/ric-aux/README.md index c9ab4763..d567dc64 100644 --- a/ric-aux/README.md +++ b/ric-aux/README.md @@ -1,17 +1,15 @@ # RIC Auxiliary Functions Helm charts, configuration files, and automation scripts that deploy the auxiliary functions for RIC. The auxiliary -functions are defined as the features and services that interact with the RIC but they do not collocated with the RIC +functions are defined as the features and services that interact with the RIC but are not collocated with the RIC cluster. These functions includes but not limited to non-realtime management components (e.g., dashboard, DMaaP, VEScollector) that interact with RIC using A1/O1 interfaces. - ### Directory Structure . ├── 80-Auxiliary-Functions Contains components that interact with RIC through A1/O1 │   ├── bin Contains deployment and uninstall scripts -│   ├── etc Contains deployment configuration files │   └── helm Contains helm charts ├── 85-External Services Deployment scripts and chart for external service used by RIC to reach services outside of cluster └── README.md This file @@ -19,10 +17,9 @@ VEScollector) that interact with RIC using A1/O1 interfaces. ### To deploy the Auxiliary Functions ```sh -$ # Modify the configuration files in ./80-Auxiliary-Functions/etc/ -$ . ./80-Auxiliary-Functions/bin/install -$ # If you have an override value.yaml file, please use -$ #. ./80-Auxiliary-Functions/bin/install YOUR_OVERRIDE_FILE +$ # An override file must be used. +$ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_AUX_RECIPE_EXAMPLE +$ #. ./80-Auxiliary-Functions/bin/install -f YOUR_OVERRIDE_FILE ``` @@ -33,11 +30,8 @@ $ . ./80-Auxiliary-Functions/bin/uninstall ### Deployment Options -You can configure the Helm release name, Kubernetes namespace using configuration files located in ./80-Auxiliary-Functions/etc/ - -In the one-click deployment solution, the above setting will be overrided by environment variables shown below. -*RICAUX_RELEASE_NAME -*RICAUX_NAMESPACE +You can configure the Helm release name, Kubernetes namespaces using the override file with +parameters global.releasePrefix and global.namespace ### To deploy the External services @@ -45,15 +39,15 @@ The IP address described below should be the interface IP address of the VM host If the platform cluster is multi-node, any of the nodes can be specified here. ```sh -$ # 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, -$ # make sure it is set correctly. -$ . ./85-Ext-Services/bin/install -$ # If you have an override value.yaml file, please use -$ #. ./85-Ext-Services/bin/install YOUR_OVERRIDE_FILE +$ # An override file must be used. +$ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_AUX_RECIPE_EXAMPLE +$ # 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. +$ # These values should be set ih the override file. +$ . ./85-Ext-Services/bin/install -f YOUR_OVERRIDE_FILE ``` -### To undeploy the Auxiliary Functions +### To undeploy the External services ```sh $ . ./85-Ext-Services/bin/uninstall ``` \ No newline at end of file