blob: 2325fb99d3d8a1d7cdc4dcb1ca25d9f9e4b94b49 [file] [log] [blame]
wriderc1be4252019-11-26 10:13:54 -05001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. SPDX-License-Identifier: CC-BY-4.0
Zhe8326b642020-12-11 22:31:17 -05003.. ---------------LICENSE_START-------------------------------------------------------
Lott, Christopher (cl778h)c22d1ce2020-01-20 13:53:43 -05004.. Copyright (C) 2019-2020 AT&T Intellectual Property
Zhe8326b642020-12-11 22:31:17 -05005.. -----------------------------------------------------------------------------------
Lott, Christopher (cl778h)c22d1ce2020-01-20 13:53:43 -05006.. 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
wriderc1be4252019-11-26 10:13:54 -05008.. 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.
Zhe8326b642020-12-11 22:31:17 -050016.. ---------------LICENSE_END---------------------------------------------------------
wriderc1be4252019-11-26 10:13:54 -050017
18
Zhe8326b642020-12-11 22:31:17 -050019Installing Near-realtime RIC
20============================
wriderc1be4252019-11-26 10:13:54 -050021
Zhe8326b642020-12-11 22:31:17 -050022The installation of Near Realtime RAN Intelligent Controller is spread onto two separate
23Kubernetes clusters. The first cluster is used for deploying the Near Realtime RIC (platform and
24applications), and the other is for deploying other auxiliary functions. They are referred to as
25RIC cluster and AUX cluster respectively.
wriderc1be4252019-11-26 10:13:54 -050026
Zhe8326b642020-12-11 22:31:17 -050027The following diagram depicts the installation architecture.
wriderc1be4252019-11-26 10:13:54 -050028
Zhe8326b642020-12-11 22:31:17 -050029.. image:: images/nrtric-amber.png
30 :width: 600
wriderc1be4252019-11-26 10:13:54 -050031
Zhe8326b642020-12-11 22:31:17 -050032Within the RIC cluster, Kubernetes resources are deployed using three name spaces: ricinfra, ricplt,
33and ricxapp by default. Similarly, within the AUX cluster, Kubernetes resources are deployed using two name spaces:
34ricinfra, and ricaux.
wriderc1be4252019-11-26 10:13:54 -050035
Zhe8326b642020-12-11 22:31:17 -050036For each cluster, there is a Kong ingress controller that proxies incoming API calls into the cluster.
37With Kong, service APIs provided by Kubernetes resources can be accessed at the cluster node IP and
38port via a URL path. For cross-cluster communication, in addition to Kong, each Kubernetes namespace
39has a special Kubernetes service defined with an endpoint pointing to the other cluster's Kong. This
40way any pod can access services exposed at the other cluster via the internal service hostname and port of
41this special service. The figure below illustrates the details of how Kong and external services work
42together to realize cross-cluster communication.
Zhe Huangf7580a82020-02-13 13:59:50 -050043
Zhe8326b642020-12-11 22:31:17 -050044.. image:: images/kong-extservice.png
45 :width: 600
wriderc1be4252019-11-26 10:13:54 -050046
47
wriderc1be4252019-11-26 10:13:54 -050048
Zhe8326b642020-12-11 22:31:17 -050049Prerequisites
50-------------
wriderc1be4252019-11-26 10:13:54 -050051
Zhe8326b642020-12-11 22:31:17 -050052Both RIC and AUX clusters need to fulfill the following prerequisites.
wriderc1be4252019-11-26 10:13:54 -050053
Zhe8326b642020-12-11 22:31:17 -050054- Kubernetes v.1.16.0 or above
wahidwf52352d2022-02-03 07:21:22 +000055- helm v2.12.3/v3.5.x or above
Zhe8326b642020-12-11 22:31:17 -050056- Read-write access to directory /mnt
57
58The following two sections show two example methods to create an environment for installing RIC.
59
60VirtualBox VMs as Installation Hosts
61^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
62
63The deployment of Near Realtime RIC can be done on a wide range of hosts, including
64bare metal servers, OpenStack VMs, and VirtualBox VMs. This section provides detailed instructions
65for setting up Oracle VirtualBox VMs to be used as installation hosts.
66
67.. include:: ./ric/installation-virtualbox.rst
wriderc1be4252019-11-26 10:13:54 -050068
69
Zhe8326b642020-12-11 22:31:17 -050070One-Node Kubernetes Cluster
71^^^^^^^^^^^^^^^^^^^^^^^^^^^
Lott, Christopher (cl778h)ca9b3ee2020-01-20 15:56:57 -050072
73
Zhe8326b642020-12-11 22:31:17 -050074This section describes how to set up a one-node Kubernetes cluster onto a VM installation host.
Lott, Christopher (cl778h)ca9b3ee2020-01-20 15:56:57 -050075
Zhe8326b642020-12-11 22:31:17 -050076.. include:: ./ric/installation-k8s1node.rst
Lott, Christopher (cl778h)ca9b3ee2020-01-20 15:56:57 -050077
78
Zhe8326b642020-12-11 22:31:17 -050079RIC Platform
80-------------------------------------------
Lott, Christopher (cl778h)ca9b3ee2020-01-20 15:56:57 -050081
Zhe8326b642020-12-11 22:31:17 -050082After the Kubernetes cluster is installed, the next step is to install the (Near Realtime) RIC Platform.
83
84.. include:: ./ric/installation-ricplt.rst
85
86
87AUX Functionalities (Optional)
88---------------------------------------------
89
90.. include:: ./ric/installation-aux.rst
91
92
93RIC Applications
94---------------------------
95
96.. include:: ./ric/installation-xapps.rst
97