X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;fp=docs%2Finstallation-guide.rst;h=18371522551838aa806c3aa957839d6c7aaaf101;hb=02cb601e28586dee95122e9fd8e19f77dedb5e08;hp=0000000000000000000000000000000000000000;hpb=9de328bf4631ed5d713f0501b9c14bd0f9003af3;p=nonrtric%2Fplt%2Fa1policymanagementservice.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst new file mode 100644 index 0000000..1837152 --- /dev/null +++ b/docs/installation-guide.rst @@ -0,0 +1,41 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2021 Nordix + +Installation Guide +================== + +Abstract +-------- + +This document describes how to install the Non-RT RIC components, their dependencies and required system resources. + +Software Installation and Deployment +------------------------------------ + +Install with Docker ++++++++++++++++++++ + +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 `__" folder, and on the `wiki page `_ + +Install with Helm ++++++++++++++++++ + +Helm charts and an example recipe are provided in the `it/dep repo `_, +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: + + .. code-block:: bash + + bin/deploy-nonrtric -f nonrtric/RECIPE_EXAMPLE/example_recipe.yaml