docs/installation-ric.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 Getting and Preparing Deployment Scripts
  20 ----------------------------------------
  21
  22 Run the following commands in a root shell:
  23
  24 .. code:: bash
  25
  26   git clone http://gerrit.o-ran-sc.org/r/it/dep
  27   cd RECIPE_EXAMPLE
  28
  29 Edit the recipe files RIC_INFRA_RECIPE_EXAMPLE and RIC_PLATFORM_RECIPE_EXAMPLE.  In particular the following values often need adaptation to local deployments:
  30
  31 #. Docker registry URL;
  32 #. Docker registry credential;
  33 #. Helm repo credential;
  34 #. Component docker container image tags.
  35
  36
  37 Deploying the Infrastructure and Platform Groups
  38 ------------------------------------------------
  39
  40 After the recipes are edited, the Near Realtime RIIC is ready to be deployed.
  41
  42 .. code:: bash
  43
  44   cd dep/bin
  45   ./deploy-ric-infra ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE
  46   ./deploy-ric-platform ../RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE
  47
  48
  49 Checking the Deployment Status
  50 ------------------------------
  51
  52 Now check the deployment status and results similar to the below indicate a complete and successful deployment.
  53
  54 .. code::
  55
  56   # helm list
  57   NAME                  REVISION UPDATED                   STATUS       CHART                   APP VERSION     NAMESPACE
  58   r1-a1mediator         1        Tue Nov 26 00:47:12 2019  DEPLOYED     a1mediator-1.0.0        1.0             ricplt
  59   r1-appmgr             1        Tue Nov 26 00:47:09 2019  DEPLOYED     appmgr-1.1.0            1.0             ricplt
  60   r1-dbaas1             1        Tue Nov 26 00:47:10 2019  DEPLOYED     dbaas1-1.1.0            1.0             ricplt
  61   r1-chartmuseum        1        Tue Nov 26 03:16:42 2019  DEPLOYED     chartmuseum-0.0.1       0.1             ricinfra
  62   r1-e2mgr              1        Tue Nov 26 00:47:10 2019  DEPLOYED     e2mgr-1.1.0             1.0             ricplt
  63   r1-e2term             1        Tue Nov 26 00:47:11 2019  DEPLOYED     e2term-1.1.0            1.0             ricplt
  64   r1-extsvcplt          1        Tue Nov 26 00:47:17 2019  DEPLOYED     extsvcplt-0.2.0         1.0             ricplt
  65   r1-jaegeradapter      1        Tue Nov 26 00:47:16 2019  DEPLOYED     jaegeradapter-0.1.0     1.0             ricplt
  66   r1-kong               1        Tue Nov 26 00:45:36 2019  DEPLOYED     kong-1.0.0              1.0             ricinfra
  67   r1-ricaux-credential  1        Tue Nov 26 00:45:42 2019  DEPLOYED     credential-1.1.0        1.0             ricaux
  68   r1-ricinfra-credential 1       Tue Nov 26 00:45:43 2019  DEPLOYED     credential-1.1.0        1.0             ricinfra
  69   r1-ricplt-credential  1        Tue Nov 26 00:45:42 2019  DEPLOYED     credential-1.1.0        1.0             ricplt
  70   r1-ricxapp-credential 1        Tue Nov 26 00:45:42 2019  DEPLOYED     credential-1.1.0        1.0             ricxapp
  71   r1-rsm                1        Tue Nov 26 00:47:15 2019  DEPLOYED     rsm-2.0.6               1.0             ricplt
  72   r1-rtmgr              1        Tue Nov 26 00:47:09 2019  DEPLOYED     rtmgr-1.1.0             1.0             ricplt
  73   r1-submgr             1        Tue Nov 26 00:47:13 2019  DEPLOYED     submgr-1.1.0            1.0             ricplt
  74   r1-vespamgr           1        Tue Nov 26 00:47:14 2019  DEPLOYED     vespamgr-0.0.1          1.0             ricplt
  75   r1-xapp-tiller        1        Tue Nov 26 00:45:44 2019  DEPLOYED     xapp-tiller-0.1.0       1.0             ricinfra
  76   # kubectl get pods -n ricplt
  77   NAME                                              READY   STATUS    RESTARTS   AGE
  78   deployment-ricplt-a1mediator-5c4df477f9-6zxxx     1/1     Running   0          132m
  79   deployment-ricplt-appmgr-65bc8b958c-tggg7         1/1     Running   0          132m
  80   deployment-ricplt-dbaas-74bf584449-k484v          1/1     Running   0          132m
  81   deployment-ricplt-e2mgr-74cd9865bc-hpn6b          1/1     Running   0          132m
  82   deployment-ricplt-e2term-cc7b5d99-pkctr           1/1     Running   0          132m
  83   deployment-ricplt-jaegeradapter-cc49c64dc-vj622   1/1     Running   0          131m
  84   deployment-ricplt-rsm-599cd4d6c8-4jhft            1/1     Running   0          131m
  85   deployment-ricplt-rtmgr-85d89868d6-58wvl          1/1     Running   1          132m
  86   deployment-ricplt-submgr-7cbd697c7f-p9x4x         1/1     Running   0          132m
  87   deployment-ricplt-vespamgr-7bb4c7585f-9z6qm       1/1     Running   0          132m
  88   # kubectl get pods -n ricinfra
  89   NAME                                         READY   STATUS      RESTARTS   AGE
  90   deployment-ricinfra-chartmuseum-7d97f4b995-gkxsq   1/1     Running     0    133m
  91   deployment-tiller-ricxapp-65f9cbc8d7-qcr5t   1/1     Running     0          133m
  92   r1-kong-kong-84695ff65d-9sjwg                2/2     Running     2          133m
  93   tiller-secret-generator-w6bnd                0/1     Completed   0          133m
  94