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 http://gerrit.o-ran-sc.org/r/it/dep
  33   cd RECIPE_EXAMPLE
  34
  35 Edit the recipe files RIC_INFRA_RECIPE_EXAMPLE and RIC_PLATFORM_RECIPE_EXAMPLE.
  36 In particular the following values often need adaptation to local deployments:
  37
  38 #. Docker registry URL
  39 #. Docker registry credential
  40 #. Helm repo credential
  41 #. Component docker container image tags.
  42
  43
  44 Deploying the Aux Group
  45 -----------------------
  46
  47 After the recipes are edited, the AUX group is ready to be deployed.
  48
  49 .. code:: bash
  50
  51   cd dep/bin
  52   ./deploy-ric-infra ../RECIPE_EXAMPLE/RIC_INFRA_AUX_RECIPE_EXAMPLE
  53   ./deploy-ric-aux ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE
  54
  55
  56 Checking the Deployment Status
  57 ------------------------------
  58
  59 Now check the deployment status and results similar to the below indicate a complete and successful deployment.
  60
  61 .. code::
  62
  63   TBD