X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guides.rst;h=6f734a0fa68856df64970fd036aac10a2cde1e8b;hb=HEAD;hp=f8717548607dc4f89d7ad2d4b08691e2cc0de814;hpb=dc00cdf008775e2ac5dddb186d1eb81e80370b69;p=it%2Fdep.git diff --git a/docs/installation-guides.rst b/docs/installation-guides.rst index f8717548..dee4e95d 100644 --- a/docs/installation-guides.rst +++ b/docs/installation-guides.rst @@ -39,84 +39,10 @@ Version history | 2020-01-23 | 0.2.0 |Zhe Huang | Bronze RC | | | | | | +--------------------+--------------------+--------------------+--------------------+ +| 2020-01-23 | 0.3.0 |Zhe Huang | Cherry | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ - -Overview -======== - -The installation of Near Realtime RAN Intelligent Controller is spread onto two separate -Kubernetes clusters. The first cluster is used for deploying the Near Realtime RIC (platform and -applications), and the other is for deploying other auxiliary functions. They are referred to as -RIC cluster and AUX cluster respectively. - -The following diagram depicts the installation architecture. - -.. image:: images/nrtric-amber.png - :width: 600 - -Within the RIC cluster, Kubernetes resources are deployed using three name spaces: ricinfra, ricplt, -and ricxapp by default. Similarly, within the AUX cluster, Kubernetes resources are deployed using two name spaces: -ricinfra, and ricaux. - -For each cluster, there is a Kong ingress controller that proxies incoming API calls into the cluster. -With Kong, service APIs provided by Kubernetes resources can be accessed at the cluster node IP and -port via a URL path. For cross-cluster communication, in addition to Kong, each Kubernetes namespace -has a special Kubernetes service defined with an endpoint pointing to the other cluster's Kong. This -way any pod can access services exposed at the other cluster via the internal service hostname and port of -this special service. The figure below illustrates the details of how Kong and external services work -together to realize cross-cluster communication. - -.. image:: images/kong-extservice.png - :width: 600 - - - -Prerequisites -============= - -Both RIC and AUX clusters need to fulfill the following prerequisites. - -- Kubernetes v.1.16.0 or above -- helm v2.12.3 or above -- Read-write access to directory /mnt - -The following two sections show two example methods to create an environment for installing RIC. - -VirtualBox VMs as Installation Hosts ------------------------------------- - -The deployment of Near Realtime RIC can be done on a wide range of hosts, including -bare metal servers, OpenStack VMs, and VirtualBox VMs. This section provides detailed instructions -for setting up Oracle VirtualBox VMs to be used as installation hosts. - -.. include:: ./installation-virtualbox.rst - - -One-Node Kubernetes Cluster ---------------------------- - -This section describes how to set up a one-node Kubernetes cluster onto a VM installation host. - -.. include:: ./installation-k8s1node.rst - - -Installing Near Realtime RIC in RIC Cluster -=========================================== - -After the Kubernetes cluster is installed, the next step is to install the (Near Realtime) RIC Platform. - .. include:: ./installation-ric.rst - - -Installing Auxiliary Functions in AUX Cluster -============================================= - -.. include:: ./installation-aux.rst - - -Installing RIC Applications -=========================== - -.. include:: ./installation-xapps.rst - +.. include:: ./installation-nonrtric.rst