| commit | 1f51c412e870f102ea07acc5eaeb3ab628aa92b2 | [log] [tgz] |
|---|---|---|
| author | wrider <lji@research.att.com> | Sun Feb 02 23:39:34 2020 -0500 |
| committer | wrider <lji@research.att.com> | Sun Feb 02 23:39:39 2020 -0500 |
| tree | 96c40d218beb4cf7d3426f49a72e01ffb1823553 | |
| parent | 4e790ce07fcd1768bec75d5ec810f7a01de918c3 [diff] |
Update release notes for maintanence Change-Id: Id4aa39fc329dea6feae26704d23c0c56ea59f2f1 Signed-off-by: wrider <lji@research.att.com>
This is a comment, it will not be included) [comment]: <> (in the output file unless you use it in) [comment]: <> (a reference style link.)
This repo contains RAN Intelligent Controller (RIC) deployments related files.
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.
. ├── 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
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.
Please refer to the README.md files in individual directory for more details.
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
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:
$ . ./deploy-ric-infra -f ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE
Run the following to undeploy:
$ . ./undeploy-ric-infra
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
$ . ./deploy-ric-platform -f ../RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE
Run the following to undeploy:
$ . ./undeploy-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
$ . ./deploy-ric-aux -f ../RECIPE_EXAMPLE/RIC_AUX_RECIPE_EXAMPLE
Run the following to undeploy:
$ . ./undeploy-ric-aux