docs/installation-guides.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. ===============LICENSE_START=======================================================
   4 .. Copyright (C) 2019-2020 AT&T Intellectual Property
   5 .. ===================================================================================
   6 .. This documentation file is distributed under the Creative Commons Attribution
   7 .. 4.0 International License (the "License"); you may not use this file except in
   8 .. compliance with the License.  You may obtain a copy of the License at
   9 ..
  10 .. http://creativecommons.org/licenses/by/4.0
  11 ..
  12 .. This file is distributed on an "AS IS" BASIS,
  13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 .. See the License for the specific language governing permissions and
  15 .. limitations under the License.
  16 .. ===============LICENSE_END=========================================================
  17
  18 ===================
  19 Installation Guides
  20 ===================
  21
  22 This document describes how to install the RIC components deployed by scripts and Helm charts
  23 under the it/dep repository, including the dependencies and required system resources.
  24
  25 .. contents::
  26    :depth: 3
  27    :local:
  28
  29 Version history
  30 ===============
  31
  32 +--------------------+--------------------+--------------------+--------------------+
  33 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  34 |                    |                    |                    |                    |
  35 +--------------------+--------------------+--------------------+--------------------+
  36 | 2019-11-25         | 0.1.0              |Lusheng Ji          | Amber              |
  37 |                    |                    |                    |                    |
  38 +--------------------+--------------------+--------------------+--------------------+
  39 | 2020-01-23         | 0.2.0              |Zhe Huang           | Bronze RC          |
  40 |                    |                    |                    |                    |
  41 +--------------------+--------------------+--------------------+--------------------+
  42
  43
  44
  45 Overview
  46 ========
  47
  48 The installation of Near Realtime RAN Intelligent Controller is spread onto two separate
  49 Kubernetes clusters.  The first cluster is used for deploying the Near Realtime RIC (platform and
  50 applications), and the other is for deploying other auxiliary functions.  They are referred to as
  51 RIC cluster and AUX cluster respectively.
  52
  53 The following diagram depicts the installation architecture.
  54
  55 .. image:: images/nrtric-amber.png
  56    :width: 600
  57
  58 Within the RIC cluster, Kubernetes resources are deployed using three name spaces: ricinfra, ricplt,
  59 and ricxapp by default.  Similarly, within the AUX cluster, Kubernetes resources are deployed using two name spaces:
  60 ricinfra, and ricaux.
  61
  62 For each cluster, there is a Kong ingress controller that proxies incoming API calls into the cluster.
  63 With Kong, service APIs provided by Kubernetes resources can be accessed at the cluster node IP and
  64 port via a URL path.  For cross-cluster communication, in addition to Kong, each Kubernetes namespace
  65 has a special Kubernetes service defined with an endpoint pointing to the other cluster's Kong. This
  66 way any pod can access services exposed at the other cluster via the internal service hostname and port of
  67 this special service.  The figure below illustrates the details of how Kong and external services work
  68 together to realize cross-cluster communication.
  69
  70 .. image:: images/kong-extservice.png
  71    :width: 600
  72
  73
  74
  75 Prerequisites
  76 =============
  77
  78 Both RIC and AUX clusters need to fulfill the following prerequisites.
  79
  80 - Kubernetes v.1.16.0 or above
  81 - helm v2.12.3 or above
  82 - Read-write access to directory /mnt
  83
  84 The following two sections show two example methods to create an environment for installing RIC.
  85
  86 VirtualBox VMs as Installation Hosts
  87 ------------------------------------
  88
  89 The deployment of Near Realtime RIC can be done on a wide range of hosts, including
  90 bare metal servers, OpenStack VMs, and VirtualBox VMs.  This section provides detailed instructions
  91 for setting up Oracle VirtualBox VMs to be used as installation hosts.
  92
  93 .. include:: ./installation-virtualbox.rst
  94
  95
  96 One-Node Kubernetes Cluster
  97 ---------------------------
  98
  99 This section describes how to set up a one-node Kubernetes cluster onto a VM installation host.
 100
 101 .. include:: ./installation-k8s1node.rst
 102
 103
 104 Installing Near Realtime RIC in RIC Cluster
 105 ===========================================
 106
 107 After the Kubernetes cluster is installed, the next step is to install the (Near Realtime) RIC Platform.
 108
 109 .. include:: ./installation-ric.rst
 110
 111
 112 Installing Auxiliary Functions in AUX Cluster
 113 =============================================
 114
 115 .. include:: ./installation-aux.rst
 116
 117
 118 Installing RIC Applications
 119 ===========================
 120
 121 .. include:: ./installation-xapps.rst
 122