X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-aux.rst;h=41d891ffbdee2741b4df5b0f2ed387415bca10c2;hb=2fcd391f36ba041a675a4e3012067eb673294857;hp=30cc8a278add911c19d5337a311e25bce06b4286;hpb=c1be4252fcf2a9fa9132e71899b29e4fb0d6e3b1;p=it%2Fdep.git diff --git a/docs/installation-aux.rst b/docs/installation-aux.rst index 30cc8a27..41d891ff 100644 --- a/docs/installation-aux.rst +++ b/docs/installation-aux.rst @@ -1,10 +1,10 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 .. ===============LICENSE_START======================================================= -.. Copyright (C) 2019 AT&T Intellectual Property +.. Copyright (C) 2019-2020 AT&T Intellectual Property .. =================================================================================== -.. This documentation file is distributed under the Creative Commons Attribution -.. 4.0 International License (the "License"); you may not use this file except in +.. This documentation file is distributed under the Creative Commons Attribution +.. 4.0 International License (the "License"); you may not use this file except in .. compliance with the License. You may obtain a copy of the License at .. .. http://creativecommons.org/licenses/by/4.0 @@ -15,8 +15,12 @@ .. limitations under the License. .. ===============LICENSE_END========================================================= -Installing Near Realtime RIC in RIC Cluster -=========================================== +Resource Requirements +--------------------- + +To run the RIC-AUX cluster in a dev testing setting, the minimum requirement +for resources is a VM with 4 vCPUs, 16G RAM and at least 40G of disk space. + Getting and Preparing Deployment Scripts ---------------------------------------- @@ -25,27 +29,53 @@ Run the following commands in a root shell: .. code:: bash - git clone http://gerrit.o-ran-sc.org/r/it/dep - cd RECIPE_EXAMPLE + git clone https://gerrit.o-ran-sc.org/r/it/dep + cd dep + git submodule update --init --recursive --remote -Edit the recipe files RIC_INFRA_RECIPE_EXAMPLE and RIC_PLATFORM_RECIPE_EXAMPLE. In particular the following values often need adaptation to local deployments: -1. Docker registry URL; -2. Docker registry credential; -3. Helm repo credential; -4. Component docker container image tags. +Modify the deployment recipe +---------------------------- +Edit the recipe file ./RECIPE_EXAMPLE/AUX/example_recipe.yaml. -Deploying the Infrastructure and Platform Groups ------------------------------------------------- +- Specify the IP addresses used by the RIC and AUX cluster ingress controller (e.g., the main interface IP) in the following section. + 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). + +.. code:: bash -After the recipes are edited, the Near Realtime RIIC is ready to be deployed. + extsvcplt: + ricip: "" + auxip: "" + +- To specify which version of the RIC platform components will be deployed, update the RIC platform component container tags in their corresponding section. +- 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. + Note that the installation script has already included credentials for O-RAN Linux Foundation docker registries. Please do not create duplicate entries. + +.. code:: bash + + docker-credential: + enabled: true + credential: + SOME_KEY_NAME: + registry: "" + credential: + user: "" + password: "" + email: "" + +For more advanced recipe configuration options, refer to the recipe configuration guideline. + + +Deploying the Aux Group +----------------------- + +After the recipes are edited, the AUX group is ready to be deployed. .. code:: bash cd dep/bin - ./deploy-ric-infra ../RECIPE_EXAMPLE/RIC_INFRA_RECIPE_EXAMPLE - ./deploy-ric-platform ../RECIPE_EXAMPLE/RIC_PLATFORM_RECIPE_EXAMPLE + ./deploy-ric-aux ../RECIPE_EXAMPLE/AUX/example_recipe.yaml Checking the Deployment Status @@ -56,41 +86,34 @@ Now check the deployment status and results similar to the below indicate a comp .. code:: # helm list - NAME REVISION UPDATED STATUS CHART APP VERSION NAMESPACE - r1-a1mediator 1 Tue Nov 26 00:47:12 2019 DEPLOYED a1mediator-1.0.0 1.0 ricplt - r1-appmgr 1 Tue Nov 26 00:47:09 2019 DEPLOYED appmgr-1.1.0 1.0 ricplt - r1-dbaas1 1 Tue Nov 26 00:47:10 2019 DEPLOYED dbaas1-1.1.0 1.0 ricplt - r1-chartmuseum 1 Tue Nov 26 03:16:42 2019 DEPLOYED chartmuseum-0.0.1 0.1 ricinfra - r1-e2mgr 1 Tue Nov 26 00:47:10 2019 DEPLOYED e2mgr-1.1.0 1.0 ricplt - r1-e2term 1 Tue Nov 26 00:47:11 2019 DEPLOYED e2term-1.1.0 1.0 ricplt - r1-extsvcplt 1 Tue Nov 26 00:47:17 2019 DEPLOYED extsvcplt-0.2.0 1.0 ricplt - r1-jaegeradapter 1 Tue Nov 26 00:47:16 2019 DEPLOYED jaegeradapter-0.1.0 1.0 ricplt - r1-kong 1 Tue Nov 26 00:45:36 2019 DEPLOYED kong-1.0.0 1.0 ricinfra - r1-ricaux-credential 1 Tue Nov 26 00:45:42 2019 DEPLOYED credential-1.1.0 1.0 ricaux - r1-ricinfra-credential 1 Tue Nov 26 00:45:43 2019 DEPLOYED credential-1.1.0 1.0 ricinfra - r1-ricplt-credential 1 Tue Nov 26 00:45:42 2019 DEPLOYED credential-1.1.0 1.0 ricplt - r1-ricxapp-credential 1 Tue Nov 26 00:45:42 2019 DEPLOYED credential-1.1.0 1.0 ricxapp - r1-rsm 1 Tue Nov 26 00:47:15 2019 DEPLOYED rsm-2.0.6 1.0 ricplt - r1-rtmgr 1 Tue Nov 26 00:47:09 2019 DEPLOYED rtmgr-1.1.0 1.0 ricplt - r1-submgr 1 Tue Nov 26 00:47:13 2019 DEPLOYED submgr-1.1.0 1.0 ricplt - r1-vespamgr 1 Tue Nov 26 00:47:14 2019 DEPLOYED vespamgr-0.0.1 1.0 ricplt - r1-xapp-tiller 1 Tue Nov 26 00:45:44 2019 DEPLOYED xapp-tiller-0.1.0 1.0 ricinfra - # kubectl get pods -n ricplt - NAME READY STATUS RESTARTS AGE - deployment-ricplt-a1mediator-5c4df477f9-6zxxx 1/1 Running 0 132m - deployment-ricplt-appmgr-65bc8b958c-tggg7 1/1 Running 0 132m - deployment-ricplt-dbaas-74bf584449-k484v 1/1 Running 0 132m - deployment-ricplt-e2mgr-74cd9865bc-hpn6b 1/1 Running 0 132m - deployment-ricplt-e2term-cc7b5d99-pkctr 1/1 Running 0 132m - deployment-ricplt-jaegeradapter-cc49c64dc-vj622 1/1 Running 0 131m - deployment-ricplt-rsm-599cd4d6c8-4jhft 1/1 Running 0 131m - deployment-ricplt-rtmgr-85d89868d6-58wvl 1/1 Running 1 132m - deployment-ricplt-submgr-7cbd697c7f-p9x4x 1/1 Running 0 132m - deployment-ricplt-vespamgr-7bb4c7585f-9z6qm 1/1 Running 0 132m - # kubectl get pods -n ricinfra - NAME READY STATUS RESTARTS AGE - deployment-ricinfra-chartmuseum-7d97f4b995-gkxsq 1/1 Running 0 133m - deployment-tiller-ricxapp-65f9cbc8d7-qcr5t 1/1 Running 0 133m - r1-kong-kong-84695ff65d-9sjwg 2/2 Running 2 133m - tiller-secret-generator-w6bnd 0/1 Completed 0 133m - + NAME REVISION UPDATED STATUS CHART APP VERSION NAMESPACE + r3-aaf 1 Mon Jan 27 13:24:59 2020 DEPLOYED aaf-5.0.0 onap + r3-dashboard 1 Mon Jan 27 13:22:52 2020 DEPLOYED dashboard-1.2.2 1.0 ricaux + r3-infrastructure 1 Mon Jan 27 13:22:44 2020 DEPLOYED infrastructure-3.0.0 1.0 ricaux + r3-mc-stack 1 Mon Jan 27 13:23:37 2020 DEPLOYED mc-stack-0.0.1 1 ricaux + r3-message-router 1 Mon Jan 27 13:23:09 2020 DEPLOYED message-router-1.1.0 ricaux + r3-mrsub 1 Mon Jan 27 13:23:24 2020 DEPLOYED mrsub-0.1.0 1.0 ricaux + r3-portal 1 Mon Jan 27 13:24:12 2020 DEPLOYED portal-5.0.0 ricaux + r3-ves 1 Mon Jan 27 13:23:01 2020 DEPLOYED ves-1.1.1 1.0 ricaux + + # kubectl get pods -n ricaux + NAME READY STATUS RESTARTS AGE + deployment-ricaux-dashboard-f78d7b556-m5nbw 1/1 Running 0 6m30s + deployment-ricaux-ves-69db8c797-v9457 1/1 Running 0 6m24s + elasticsearch-master-0 1/1 Running 0 5m36s + r3-infrastructure-kong-7697bccc78-nsln7 2/2 Running 3 6m40s + r3-mc-stack-kibana-78f648bdc8-nfw48 1/1 Running 0 5m37s + r3-mc-stack-logstash-0 1/1 Running 0 5m36s + r3-message-router-message-router-0 1/1 Running 3 6m11s + r3-message-router-message-router-kafka-0 1/1 Running 1 6m11s + r3-message-router-message-router-kafka-1 1/1 Running 2 6m11s + r3-message-router-message-router-kafka-2 1/1 Running 1 6m11s + r3-message-router-message-router-zookeeper-0 1/1 Running 0 6m11s + r3-message-router-message-router-zookeeper-1 1/1 Running 0 6m11s + r3-message-router-message-router-zookeeper-2 1/1 Running 0 6m11s + r3-mrsub-5c94f5b8dd-wxcw5 1/1 Running 0 5m58s + r3-portal-portal-app-8445f7f457-dj4z8 2/2 Running 0 4m53s + r3-portal-portal-cassandra-79cf998f69-xhpqg 1/1 Running 0 4m53s + r3-portal-portal-db-755b7dc667-kjg5p 1/1 Running 0 4m53s + r3-portal-portal-db-config-bfjnc 2/2 Running 0 4m53s + r3-portal-portal-zookeeper-5f8f77cfcc-t6z7w 1/1 Running 0 4m53s