docs/installation-aux.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 Resource Requirements
  19 ---------------------
  20
  21 To run the RIC-AUX cluster in a dev testing setting, the minimum requirement
  22 for resources is a VM with 4 vCPUs, 16G RAM and at least 40G of disk space.
  23
  24
  25 Getting and Preparing Deployment Scripts
  26 ----------------------------------------
  27
  28 Run the following commands in a root shell:
  29
  30 .. code:: bash
  31
  32   git clone https://gerrit.o-ran-sc.org/r/it/dep
  33   cd dep
  34   git submodule update --init --recursive --remote
  35
  36
  37 Modify the deployment recipe
  38 ----------------------------
  39
  40 Edit the recipe file ./RECIPE_EXAMPLE/AUX/example_recipe.yaml.
  41
  42 - Specify the IP addresses used by the RIC and AUX cluster ingress controller (e.g., the main interface IP) in the following section.
  43   If you are only testing the AUX cluster, you can put down any private IPs (e.g., 10.0.2.1 and 10.0.2.2).
  44
  45 .. code:: bash
  46
  47   extsvcplt:
  48     ricip: ""
  49     auxip: ""
  50
  51 - To specify which version of the RIC platform components will be deployed, update the RIC platform component container tags in their corresponding section.
  52 - You can specify which docker registry will be used for each component. If the docker registry requires login credential, you can add the credential in the following section.
  53   Note that the installation script has already included credentials for O-RAN Linux Foundation docker registries. Please do not create duplicate entries.
  54
  55 .. code:: bash
  56
  57   docker-credential:
  58     enabled: true
  59     credential:
  60       SOME_KEY_NAME:
  61         registry: ""
  62         credential:
  63           user: ""
  64           password: ""
  65           email: ""
  66
  67 For more advanced recipe configuration options, refer to the recipe configuration guideline.
  68
  69
  70 Deploying the Aux Group
  71 -----------------------
  72
  73 After the recipes are edited, the AUX group is ready to be deployed.
  74
  75 .. code:: bash
  76
  77   cd dep/bin
  78   ./deploy-ric-aux ../RECIPE_EXAMPLE/AUX/example_recipe.yaml
  79
  80
  81 Checking the Deployment Status
  82 ------------------------------
  83
  84 Now check the deployment status and results similar to the below indicate a complete and successful deployment.
  85
  86 .. code::
  87
  88   # helm list
  89   NAME                  REVISION        UPDATED                         STATUS          CHART                   APP VERSION     NAMESPACE
  90   r3-aaf                1               Mon Jan 27 13:24:59 2020        DEPLOYED        aaf-5.0.0                               onap
  91   r3-dashboard          1               Mon Jan 27 13:22:52 2020        DEPLOYED        dashboard-1.2.2         1.0             ricaux
  92   r3-infrastructure     1               Mon Jan 27 13:22:44 2020        DEPLOYED        infrastructure-3.0.0    1.0             ricaux
  93   r3-mc-stack           1               Mon Jan 27 13:23:37 2020        DEPLOYED        mc-stack-0.0.1          1               ricaux
  94   r3-message-router     1               Mon Jan 27 13:23:09 2020        DEPLOYED        message-router-1.1.0                    ricaux
  95   r3-mrsub              1               Mon Jan 27 13:23:24 2020        DEPLOYED        mrsub-0.1.0             1.0             ricaux
  96   r3-portal             1               Mon Jan 27 13:24:12 2020        DEPLOYED        portal-5.0.0                            ricaux
  97   r3-ves                1               Mon Jan 27 13:23:01 2020        DEPLOYED        ves-1.1.1               1.0             ricaux
  98
  99   # kubectl get pods -n ricaux
 100   NAME                                           READY   STATUS     RESTARTS   AGE
 101   deployment-ricaux-dashboard-f78d7b556-m5nbw    1/1     Running    0          6m30s
 102   deployment-ricaux-ves-69db8c797-v9457          1/1     Running    0          6m24s
 103   elasticsearch-master-0                         1/1     Running    0          5m36s
 104   r3-infrastructure-kong-7697bccc78-nsln7        2/2     Running    3          6m40s
 105   r3-mc-stack-kibana-78f648bdc8-nfw48            1/1     Running    0          5m37s
 106   r3-mc-stack-logstash-0                         1/1     Running    0          5m36s
 107   r3-message-router-message-router-0             1/1     Running    3          6m11s
 108   r3-message-router-message-router-kafka-0       1/1     Running    1          6m11s
 109   r3-message-router-message-router-kafka-1       1/1     Running    2          6m11s
 110   r3-message-router-message-router-kafka-2       1/1     Running    1          6m11s
 111   r3-message-router-message-router-zookeeper-0   1/1     Running    0          6m11s
 112   r3-message-router-message-router-zookeeper-1   1/1     Running    0          6m11s
 113   r3-message-router-message-router-zookeeper-2   1/1     Running    0          6m11s
 114   r3-mrsub-5c94f5b8dd-wxcw5                      1/1     Running    0          5m58s
 115   r3-portal-portal-app-8445f7f457-dj4z8          2/2     Running    0          4m53s
 116   r3-portal-portal-cassandra-79cf998f69-xhpqg    1/1     Running    0          4m53s
 117   r3-portal-portal-db-755b7dc667-kjg5p           1/1     Running    0          4m53s
 118   r3-portal-portal-db-config-bfjnc               2/2     Running    0          4m53s
 119   r3-portal-portal-zookeeper-5f8f77cfcc-t6z7w    1/1     Running    0          4m53s