README.md

   1 <!---
   2
   3 Copyright (c) 2019 AT&T Intellectual Property.
   4
   5 Licensed under the Creative Commons License, Attribution 4.0 Intl.
   6 (the"Documentation License"); you may not use this documentation
   7 except incompliance with the Documentation License. You may obtain
   8 a copy of the Documentation License at
   9
  10     https://creativecommons.org/licenses/by/4.0/
  11
  12 Unless required by applicable law or agreed to in writing,
  13 documentation distributed under the Documentation License is
  14 distributed on an "AS IS"BASIS, WITHOUT WARRANTIES OR CONDITIONS
  15 OF ANY KIND, either express or implied. See the Documentation
  16 License for the specific language governing permissions and
  17 limitations under the Documentation License.
  18
  19 -->
  20
  21 This is a comment, it will not be included)
  22 [comment]: <> (in  the output file unless you use it in)
  23 [comment]: <> (a reference style link.)
  24
  25
  26 # RIC Integration
  27
  28 This repo contains RAN Intelligent Controller (RIC) deployments related files.
  29
  30
  31 ### Overview
  32
  33 The RIC deployment scripts are designed to deploy RIC components using helm charts. A deployment recipe yaml file that
  34 contains parameter key:value pairs can be provided as a parameter for any deployment script in this repository. The
  35 deployment recipe is acting as the helm override values.yaml file. The default parameters are set up to deploy a
  36 RIC instance using Linux Foundation repositories in a self-contained environment.
  37
  38
  39 ### Directory Structure
  40 .
  41 ├── bin
  42 ├── ci
  43 ├── docs
  44 ├── LICENSES.txt  License information
  45 ├── README.md           This file
  46 ├── RECIPE_EXAMPLE        Directory that contains deploy recipe examples
  47 ├── ric-aux               Deployment scripts, charts and configuration files for RIC auxilary functions
  48 ├── ric-common            Deployment scripts, charts and configuration files for RIC common template
  49 ├── ric-dep               Deployment scripts, charts and configuration files for RIC platform components
  50 └── tools         Deployment scripts, charts and configuration files for K8S deployment
  51
  52 The deployment scripts are designed to be modularized. Each submodule is managed independently in other Git repo and they can be deployed and undeployed separately. These submodules are coupled together throught the ric-common template which provides common references to naming convention, settings, and configurations. Currently ric-dep is the submodule for RIC platform deployment, and ric-aux is the submodule for the auxilary functions deployment (currently ric-aux is still managed by it/dep repo). In the future, more submodules can be added without changing the structure.
  53
  54 The one-click RIC deployment/undeployment scripts in the ./bin directory will call the deployment/undeployment scripts in the corresponding submodule directory respectively.
  55 In each of the submodule directories, ./bin contains the binary and script files and ./helm contains the helm charts. For the rest of the non-submodule directories please refer to the README.md files in them for more details.
  56
  57
  58 ### Prerequisites
  59
  60 To deploy RIC, you need to have a cluster that runs kubernetes (version > v.1.16.0) and helm (version v2.14.3).
  61 Tools to install a K8S environment in an openstack cloud can be found in ./tools/k8s.
  62 Please refer to the README.md file for more details
  63
  64 ### To deploy RIC Platform
  65 Choose a deployment recipe (e.g, ./RECIPE_EXAMPLE/PLATFORM/amber_example_recipe.yaml)
  66 Make a copy of the recipe and edit the key:value pairs in it according to your needs
  67 Make sure that you have the correct docker image registry, name, and tag spcified for all the components.
  68 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.
  69 Then run the following to deploy:
  70 ```sh
  71 $ . ./deploy-ric-platform -f <PATH_TO_YOUR_MODIFIED_RECIPE>
  72 ```
  73 Run the following to undeploy:
  74 ```sh
  75 $ . ./undeploy-ric-platform
  76 ```
  77
  78 ### To deploy RIC Auxiliary functions
  79 Choose a deployment recipe (e.g, ./RECIPE_EXAMPLE/AUX/amber_example_recipe.yaml)
  80 Make a copy of the recipe and edit the key:value pairs in it according to your needs
  81 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.
  82 ```sh
  83 $ . ./deploy-ric-aux -f <PATH_TO_YOUR_MODIFIED_RECIPE>
  84 ```
  85 Run the following to undeploy:
  86 ```sh
  87 $ . ./undeploy-ric-aux
  88 ```