docs/nrtric/installation-nrtric.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 Clone the it/dep git repository that has deployment scripts and support files on the target VM.
  22 (You might have already done this in a previous step.)
  23
  24 ::
  25
  26   % git clone https://gerrit.o-ran-sc.org/r/it/dep
  27
  28 Check out the appropriate branch of the repository with the release you want to deploy.
  29 For example:
  30
  31 .. code:: bash
  32
  33   git clone https://gerrit.o-ran-sc.org/r/it/dep
  34   cd dep
  35   git submodule update --init --recursive --remote
  36
  37 **Modify the deployment recipe**
  38
  39 Edit the recipe files ./RECIPE_EXAMPLE/NONRTRIC/example_recipe.yaml.
  40
  41 - To specify which version of the non-realtime RIC platform components will be deployed, update the platform component container tags in their corresponding section.
  42 - 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. Please note that the installation suite has already included credentials for O-RAN Linux Foundation docker registries. Please do not create duplicate entries.
  43
  44 .. code:: bash
  45
  46   docker-credential:
  47     enabled: true
  48     credential:
  49       SOME_KEY_NAME:
  50         registry: ""
  51         credential:
  52           user: ""
  53           password: ""
  54           email: ""
  55
  56
  57
  58 **Deploying Platform**
  59
  60 After the recipes are edited, the Near Realtime RIC platform is ready to be deployed.
  61
  62 .. code:: bash
  63
  64   cd dep/bin
  65   ./deploy-nonrtric ../RECIPE_EXAMPLE/PLATFORM/example_recipe.yaml
  66
  67
  68 **Checking the Deployment Status**
  69
  70 Now check the deployment status after a short wait. Results similar to the
  71 output shown below indicate a complete and successful deployment. Check the
  72 STATUS column from both kubectl outputs to ensure that all are either
  73 "Completed" or "Running", and that none are "Error" or "ImagePullBackOff".
  74
  75 .. code::
  76
  77   # helm list
  78   NAME                  REVISION        UPDATED                         STATUS          CHART           APP VERSION     NAMESPACE
  79   r2-dev-nonrtric       1               Sat Dec 12 02:55:52 2020        DEPLOYED        nonrtric-2.0.0                  nonrtric
  80
  81   # kubectl get pods -n ricplt
  82   NAME                                      READY   STATUS     RESTARTS   AGE
  83   a1-sim-osc-0                              1/1     Running    0          2m8s
  84   a1-sim-std-0                              1/1     Running    0          2m8s
  85   a1controller-ff7c8979f-l7skk              1/1     Running    0          2m8s
  86   controlpanel-859d8c6c6f-hmzrj             1/1     Running    0          2m8s
  87   db-6b94f965dc-dsch6                       1/1     Running    0          2m8s
  88   enrichmentservice-587d7d8984-vllst        1/1     Running    0          2m8s
  89   policymanagementservice-d648f7c9b-54mwc   1/1     Running    0          2m8s
  90   rappcatalogueservice-7cbbc99b8d-rl2nz     1/1     Running    0          2m8s
  91
  92
  93 **Undeploying Platform**
  94
  95 To undeploy all the containers, perform the following steps in a root shell
  96 within the it-dep repository.
  97
  98 .. code:: bash
  99
 100   # cd bin
 101   # ./undeploy-nonrtric
 102
 103 Results similar to below indicate a complete and successful cleanup.
 104
 105 .. code::
 106
 107   # ./undeploy-ric-platform
 108   Undeploying NONRTRIC components [controlpanel a1controller a1simulator policymanagementservice enrichmentservice rappcatalogueservice]
 109   release "r2-dev-nonrtric" deleted
 110   configmap "nonrtric-recipe" deleted
 111   namespace "nonrtric" deleted
 112