.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright (C) 2020 Nordix
+.. Copyright (C) 2021-2023 Nordix Foundation. All rights Reserved
+.. Copyright (C) 2023 OpenInfra Foundation Europe. All Rights Reserved
Installation Guide
==================
-.. contents::
- :depth: 3
- :local:
-
Abstract
--------
-This document describes how to install the Non-RT RIC SDNC A1 Controller, its dependencies and required system resources.
-
-This work is in progress. Please visit :ref:`api_docs` for more information about the SDNC A1 Controller and the Policy Agent.
-
-.. _api-docs page: ./api-docs.html
-
-Installation
-------------
-
-Download the SDNC repo:
-
- git clone "https://gerrit.o-ran-sc.org/r/nonrtric"
-
-The SDNC A1 Controller could be found in this repo.
-
-Build SDNC project:
-
- Enter into the sdnc-a1-controller project, northbound and oam project will located there.
-
- cd sdnc-a1-controller
+This document describes how to install some of the Non-RT RIC components, their dependencies and required system resources.
- Build northbound project with command:
+Software Installation and Deployment
+------------------------------------
- mvn clean install -Dmaven.test.skip=true
+Install with Helm in Kubernetes
++++++++++++++++++++++++++++++++
- Build oam project with command:
+The easiest and preferred way to install NONRTRIC functions is using Kubernetes, with installation instructions provided in Helm Charts.
+Full details of how to install NONRTRIC functions are provided in `Deploy NONRTRIC in Kubernetes <nonrtricwikik8s_>`_.
- mvn clean install -Dmaven.test.skip=true -P docker
+Helm charts and an example recipe are provided in the `it/dep repo <https://gerrit.o-ran-sc.org/r/admin/repos/it/dep>`_,
+under "nonrtric". By modifying the variables named "installXXX" in the beginning of the example recipe file, which
+components that will be installed can be controlled. Then the components can be installed and started by running the
+following command:
- Enter into this directory:
+ .. code-block:: bash
- cd nonrtric/sdnc-a1-controller/oam/installation/src/main/yaml
+ bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml
- and run the command:
+Install with Docker
++++++++++++++++++++
- MTU=1500 docker-compose up a1-controller
+Some NONRTRIC functions, and simpler usecases can be install directly using Docker.
+Full details of how to use Docker for NONRTRIC functions are provided in `Deploy NONRTRIC in Docker <nonrtricwikidocker_>`_.
-Version history
----------------
+Install with Docker Compose
++++++++++++++++++++++++++++
-+--------------------+--------------------+--------------------+--------------------+
-| **Date** | **Ver.** | **Author** | **Comment** |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| 2019-11-12 | 0.1.0 | Maxime Bonneau | First draft |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| 2020-03-24 | 0.1.1 | Maxime Bonneau | Second draft |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
-| | 1.0 | | |
-| | | | |
-| | | | |
-+--------------------+--------------------+--------------------+--------------------+
+Some older docker compose files are provided, in the "docker-compose" folder, to install the components. Run the following
+command to start the components:
+ .. code-block:: bash
+ docker-compose -f docker-compose.yaml
+ -f policy-service/docker-compose.yaml
+ -f ics/docker-compose.yaml
+The example above is just an example to start some of the components.
+For more information on running and configuring the functions can be found in the README file in the "`docker-compose <https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric.git;a=tree;f=docker-compose>`_" folder, and on the `wiki page <https://wiki.o-ran-sc.org/display/RICNR/Release+E+-+Run+in+Docker>`_
Code Review / nonrtric.git / blobdiff