X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=ric-platform%2FREADME.md;h=915c7d3c932c90a931e439251fd7b52501924f3e;hb=0011afae26ce8f51b964ddc47d8d4b4f80830a4c;hp=6b8f3a0a1c17047bb8d8226fcaf5e1bd76c7c841;hpb=1185de0a37a13edef909d9159b4b45687ae05205;p=it%2Fdep.git diff --git a/ric-platform/README.md b/ric-platform/README.md index 6b8f3a0a..915c7d3c 100644 --- a/ric-platform/README.md +++ b/ric-platform/README.md @@ -4,22 +4,12 @@ Helm charts, deployment scripts and configuration files for RIC platform compone ### Directory Structure . -├── 20-Credential Helm charts to onboard credential and secrets for docker registry and helm repo ├── 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 -### To onboard credentials -```sh -$ # Modify the user name and password in ./20-Credential/helm/values.yaml -$ # Alternatively, include the credential information in an override value yaml file -$ . ./20-Credential/bin/install -$ # If you have an override value.yaml file, please use -$ #. ./20-Credential/bin/install YOUR_OVERRIDE_FILE -``` - -### Credential Deployment Options -You can configure the Helm release name, Kubernetes namespace using configuration files located in ./20-Credential/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 @@ -28,20 +18,33 @@ 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 $ . ./50-RIC-Platform/bin/uninstall +``` + +### To Deploy External services +The IP address described below should be the interface IP address of the VM hosting the aux cluster. +If the aux cluster is multi-node, any of the nodes can be specified here. + +```sh +$ # 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 +```sh +$ . ./55-Ext-Services/bin/uninstall +``` \ No newline at end of file