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          | First draft        |
  37 |                    |                    |                    |                    |
  38 +--------------------+--------------------+--------------------+--------------------+
  39
  40
  41 Overview
  42 ========
  43
  44 The installation of Amber Near Realtime RAN Intelligent Controller is spread onto two separate
  45 Kubernetes clusters.  The first cluster is used for deploying the Near Realtime RIC (platform and
  46 applications), and the other is for deploying other auxiliary functions.  They are referred to as
  47 RIC cluster and AUX cluster respectively.
  48
  49 The following diagram depicts the installation architecture.
  50
  51 .. image:: images/nrtric-amber.png
  52    :width: 600
  53
  54 Within the RIC cluster, Kubernetes resources are deployed using three name spaces: ricinfra, ricplt,
  55 and ricxapp.  Similarly, within the AUX cluster, Kubernetes resources are deployed using two name spaces:
  56 ricinfra, and ricaux.
  57
  58 For each cluster, there is a Kong ingress controller that proxies incoming API calls into the cluster.
  59 With Kong, service APIs provided by Kubernetes resources can be accessed at the cluster node IP and
  60 port via a URL path.  For cross-cluster communication, in addition to Kong, each Kubernetes namespace
  61 has a special Kubernetes service defined with an endpoint pointing to the other cluster's Kong. This
  62 way any pod can access services exposed at the other cluster via the internal service hostname and port of
  63 this special service.  The figure below illustrates the details of how Kong and external services work
  64 together to realize cross-cluster communication.
  65
  66 .. image:: images/kong-extservice.png
  67    :width: 600
  68
  69
  70 VirtualBox VMs as Installation Hosts
  71 ====================================
  72
  73 The deployment of Amber Near Realtime RIC can be done on a wide range of hosts, including
  74 bare metal servers, OpenStack VMs, and VirtualBox VMs.  This section provides detailed instructions
  75 for setting up Oracle VirtualBox VMs to be used as installation hosts.
  76
  77 .. include:: ./installation-virtualbox.rst
  78
  79
  80 One-Node Kubernetes Cluster
  81 ===========================
  82
  83 This section describes how to set up a one-node Kubernetes cluster onto a VM installation host.
  84
  85 .. include:: ./installation-k8s1node.rst
  86
  87
  88 Installing Near Realtime RIC in RIC Cluster
  89 ===========================================
  90
  91 After the Kubernetes cluster is installed, the next step is to install the (Near Realtime) RIC Platform.
  92
  93 .. include:: ./installation-ric.rst
  94
  95
  96 Installing Auxiliary Functions in AUX Cluster
  97 =============================================
  98
  99 .. include:: ./installation-aux.rst
 100
 101
 102 Installing RIC Applications
 103 ===========================
 104
 105 .. include:: ./installation-xapps.rst
 106