.. code:: bash
- git clone "https://gerrit.o-ran-sc.org/r/ric-plt/ric-dep"
+ git clone "https://gerrit.o-ran-sc.org/r/ric-plt/ric-dep"
+
+Deploying the Infrastructure and Platform Groups
+------------------------------------------------
+
+Use the scripts below to install kubernetes, kubernetes-CNI, helm and docker on a fresh
+Ubuntu 20.04 installation. Note that since May 2022 there's no need for anything form the repo it/dep
+anymore.
+
+.. code:: bash
+
+ # install kubernetes, kubernetes-CNI, helm and docker
+ cd ric-dep/bin
+ ./install_k8s_and_helm.sh
+
+ # install chartmuseum into helm and add ric-common templates
+ ./install_common_templates_to_helm.sh
+
+After the recipes are edited and helm started, the Near Realtime RIC platform is ready to be deployed,
+but first update the deployment recipe as per instructions in the next section.
+
Modify the deployment recipe
----------------------------
-Edit the recipe files ./RECIPE_EXAMPLE/example_recipe.yaml.
+Edit the recipe files ./RECIPE_EXAMPLE/example_recipe_latest_stable.yaml (which is
+a softlink that points to the latest release version). "example_recipe_latest_unstable.yaml
+points to the latest example file that is under current development.
.. code:: bash
ricip: ""
auxip: ""
+- Deployment scripts support both helm v2 and v3. The deployment script will determine the helm version installed in cluster during the deployment.
- 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. Please note that the installation suite has already included credentials for O-RAN Linux Foundation docker registries. Please do not create duplicate entries.
For more advanced recipe configuration options, please refer to the recipe configuration guideline.
+Installing the RIC
+------------------
-Deploying the Infrastructure and Platform Groups
-------------------------------------------------
-
-Copy the ric-common helm charts for it/dep, configure the helm repo and start local helm server
-
-.. code:: bash
-
- git clone "https://gerrit.o-ran-sc.org/r/it/dep"
- HELM_HOME=$(helm home)
- COMMON_CHART_VERSION=$(cat dep/ric-common/Common-Template/helm/ric-common/Chart.yaml | grep version | awk '{print $2}')
- helm package -d /tmp dep/ric-common/Common-Template/helm/ric-common
- cp /tmp/ric-common-$COMMON_CHART_VERSION.tgz $HELM_HOME/repository/local/
- helm repo index $HELM_HOME/repository/local/
- helm serve >& /dev/null &
- helm repo remove local
- helm repo add local http://127.0.0.1:8879/charts
-
-
-After the recipes are edited and helm started, the Near Realtime RIC platform is ready to be deployed.
+After updating the recipe you can deploy the RIC with the command below. Note that generally use the
+latest recipe marked stable or one from a specific release.
.. code:: bash
cd ric-dep/bin
- ./install -f ../RECIPE_EXAMPLE/PLATFORM/example_recipe.yaml
+ ./install -f ../RECIPE_EXAMPLE/PLATFORM/example_recipe_latest_stable.yaml
Checking the Deployment Status
After a reboot of the VM, and a suitable delay for initialization,
all the containers should be running again as shown above.
+
+RIC Applications
+----------------
+
+.. include:: installation-xapps.rst
+
+OPTIONALLY use Redis Cluster (instead of Redis standalone)
+----------------------------------------------------------
+
+.. include:: installation-rediscluster.rst
Code Review / ric-plt / ric-dep.git / blobdiff