X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=ric-platform%2FREADME.md;h=44f67c263f63d991587b94205128c154c2e2d3a2;hb=7469f99d1eba44f0a97ea0279fd96a26d948f8a4;hp=6b8f3a0a1c17047bb8d8226fcaf5e1bd76c7c841;hpb=1185de0a37a13edef909d9159b4b45687ae05205;p=it%2Fdep.git diff --git a/ric-platform/README.md b/ric-platform/README.md index 6b8f3a0a..44f67c26 100644 --- a/ric-platform/README.md +++ b/ric-platform/README.md @@ -4,22 +4,10 @@ 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 +├── 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 @@ -45,3 +33,21 @@ In the one-click deployment solution, the above setting will be overrided by env ### 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 +$ # 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 +``` + +### To Undeploy External services +```sh +$ . ./55-Ext-Services/bin/uninstall +``` \ No newline at end of file