X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=ric-platform%2FREADME.md;h=915c7d3c932c90a931e439251fd7b52501924f3e;hb=refs%2Fchanges%2F34%2F1234%2F9;hp=44f67c263f63d991587b94205128c154c2e2d3a2;hpb=2df61c2fcf64b32ecf7f064ef9cbbe6b54a15bc0;p=it%2Fdep.git diff --git a/ric-platform/README.md b/ric-platform/README.md index 44f67c26..915c7d3c 100644 --- a/ric-platform/README.md +++ b/ric-platform/README.md @@ -5,6 +5,8 @@ Helm charts, deployment scripts and configuration files for RIC platform compone ### Directory Structure . ├── 50-RIC-Platform Deployment scripts, charts and configuration files for RIC platform components +│   ├── bin Contains deployment and uninstall scripts +│   └── helm Contains helm charts ├── 55-Ext-Services Deployment scripts and chart for external service used by RIC to reach services outside of cluster └── README.md This file @@ -16,19 +18,14 @@ In the one-click deployment solution, the above setting will be overrided by env ### To Deploy RIC Platform ```sh -$ # Modify the configuration files in ./50-RIC-Platform/etc/ -$ . ./50-RIC-Platform/bin/install -$ # If you have an override value.yaml file, please use -$ #. ./50-RIC-Platform/bin/install YOUR_OVERRIDE_FILE +$ # An override file must be used. +$ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE +$ #. ./50-RIC-Platform/bin/install -f YOUR_OVERRIDE_FILE ``` ### RIC Platform Deployment Options -You can configure the Helm release name, Kubernetes namespace using configuration files located in ./50-RIC-Platform/etc/ -Please make sure that the namespace is the same one as the one used for RIC platform components. - -In the one-click deployment solution, the above setting will be overrided by environment variables shown below. -*RICPLT_RELEASE_NAME -*RICPLT_NAMESPACE +You can configure the Helm release name, Kubernetes namespaces using the override file with +parameters global.releasePrefix and global.namespace ### To Undeploy RIC Platform ```sh @@ -40,11 +37,11 @@ The IP address described below should be the interface IP address of the VM host If the aux 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. -$ . ./55-Ext-Services/bin/install -$ # If you have an override value.yaml file, please use -$ #. ./50-Ext-Services/bin/install YOUR_OVERRIDE_FILE +$ # An override file must be used. +$ # Modify the override file, for example ../RECIPE_EXAMPLE/RIC_PLATFORM_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 in the override file +$ . ./55-Ext-Services/bin/install -f YOUR_OVERRIDE_FILE ``` ### To Undeploy External services