X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=4f1102fb426e9ff5bfa1fddcf6c4ea821d29091b;hb=refs%2Ftags%2F0.0.1;hp=13eeaaa0ef3e479ec1057268753803c583ad3fad;hpb=1a8a09deaeded3c6a50fa7c13594e46301375874;p=it%2Fdep.git diff --git a/README.md b/README.md index 13eeaaa0..4f1102fb 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,139 @@ -# RIC Integration + + +This is a comment, it will not be included) +[comment]: <> (in the output file unless you use it in) +[comment]: <> (a reference style link.) + + +# RIC Integration + This repo contains RAN Intelligent Controller (RIC) deployments related files. +### Overview + +The RIC deployment scripts are designed to deploy RIC components using helm charts. A deployment recipe yaml file that +contains parameter key:value pairs can be provided as a parameter for any deployment script in this repository. The +deployment recipe is acting as the helm override values.yaml file. If no deployment recipe is provided, default parameters +are used. The default parameters are set up to deploy a RIC instance using Linux Foundation repositories in a +self-contained environment. + + ### Directory Structure -- kubernetes: scripts for kubernetes related tasks -- LICENSES.txt: -- localize.sh: a script for inserting localized infrastructure parameters (docker registry host, port, etc) into helm charts and scripts in this repo -- ricplt: RIC Platform Helm charts and related scripts -- runric_env.sh: the env variables for local infrastructure -- xapps: xapps Helm charts and chart templates +. +├── bin +├── ci +├── etc +├── LICENSES.txt License information +├── README.md This file +├── RECIPE_EXAMPLE Directory that contains deploy recipe examples +├── ric-aux Deployment scripts, charts and configuration files for RIC auxilary functions +├── ric-common Deployment scripts, charts and configuration files for RIC common template +├── ric-infra Deployment scripts, charts and configuration files for infrastructure support +├── ric-platform Deployment scripts, charts and configuration files for RIC platform components +└── ric-xapps xApp related scripts, charts and configuration files + +### Directory Naming Convention + +The root directories are organized according to the deployment plans. Each directory contains subdirectories for +different deployable components. The prefixes of these subdirectories represent the deployment order. The smaller the +prefix number the eariler the corresponding component will be deployed. Consider the following example, +├── ric-aux +│   ├── 80-Auxiliary-Functions +│   ├── 85-Ext-Services +│   └── README.md +├── ric-infra +│   ├── 00-Kubernetes +│   ├── 10-Nexus +│   ├── 20-Monitoring +│   ├── 30-Kong +│   ├── 40-Credential +│   ├── 45-Tiller +│   └── README.md +├── ric-platform +│   ├── 50-RIC-Platform +│   ├── 55-Ext-Services +│   └── README.md +├── ric-aux +│   ├── 80-Auxiliary-Functions +│   ├── 85-Ext-Services +│   └── README.md +└── ric-xapps + ├── 90-xApps + └── README.md + +when deploying the ric-platform, the credential is deployed before RIC-Platform. + +In each of the component directories, ./bin contains the binary and script files and ./helm contains the helm charts, + +Some components contain an ./etc directory with configuration files and some contain a ./docker directory with docker related files for building the docker images. -### To Generate Localized Charts and Scripts +Please refer to the README.md files in individual directory for more details. -First we will need to edit the ./runric_env.sh and fill values with local infrastructure parameters. +Within ric-infra, ric-platform and ric-aux, each of the components above can be deployed and undeployed separately. +There are also scripts for deploying the ric-infra, ric-platform or ric-aux in its entirety. +The ./bin directory contains these scripts + +The following sections discuss one-script deployment for each + +### To deploy RIC Infrastructure + +Edit ./RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE +You can choose whether to enable Kubernetes deployment, Helm Chart museum and ELFKP stack +You can specify the Helm release prefix and namespaces used +You must specify username and password for Docker repo +Then run the following to deploy: +```sh +$ . ./deploy-ric-infra -f ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE +``` +Run the following to undeploy: +```sh +$ . ./undeploy-ric-infra +``` + +### To deploy RIC Platform + +Edit ./RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE +You can specify the Helm release prefix and namespaces used +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 both the override file and the local values.yaml file +```sh +$ . ./deploy-ric-platform -f ../RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE +``` +Run the following to undeploy: ```sh -$ then run: -$ ./localize.sh -$ cd generated +$ . ./undeploy-ric-platform ``` -Now the localized scripts and charts are ready to use. +### To deploy RIC Auxiliary functions + +Edit ./RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE +You can specify the Helm release prefix and namespaces used +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 both the override file and the local values.yaml file +```sh +$ . ./deploy-ric-aux -f ../RECIPE_EXAMPLE/RIC_AUX_RECIPE_EXAMPLE +``` +Run the following to undeploy: +```sh +$ . ./undeploy-ric-aux +```