docs/guides/onap-operator/settingup/index.rst

   1 .. This work is licensed under
   2 .. a Creative Commons Attribution 4.0 International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. Copyright 2017-2018 AT&T Intellectual Property. All rights reserved.
   5 .. Modifications Copyright 2018 Orange
   6 .. Modifications Copyright 2018 Amdocs
   7 .. Modifications Copyright 2018 Huawei
   8 .. Modifications Copyright 2019 Orange
   9 .. Modifications Copyright 2021 Nokia
  10
  11 Setting Up ONAP
  12 ===============
  13
  14 .. _installing-onap:
  15
  16 ONAP is deployed using the ONAP Operations Manager (OOM).
  17
  18 The recommended ONAP deployment can be deployed on a private set of physical
  19 hosts or VMs (or even a combination of the two) and is based on Kubernetes,
  20 Docker containers and Helm installer.
  21
  22
  23 Requirements
  24 ------------
  25
  26 OOM requires the following  Software components.
  27
  28 * Kubernetes
  29 * Helm
  30 * kubectl
  31 * Docker
  32
  33 The Software versions needed for the specific ONAP release
  34 as well as the minimum Hardware configuration can be found in the
  35 :ref:`OOM Cloud Setup Guide<onap-oom:oom_cloud_setup_guide>`
  36
  37
  38 Installation
  39 ------------
  40
  41 Creation of Kubernetes cluster is described here:
  42
  43 .. toctree::
  44    :maxdepth: 2
  45    :titlesonly:
  46
  47 :ref:`OOM Cloud Setup Guide<onap-oom:oom_cloud_setup_guide>`
  48
  49 :ref:`ONAP on HA Kubernetes Cluster<onap-oom:onap-on-kubernetes-with-rancher>`
  50
  51 Some ONAP functionalities require optional PaaS components described here:
  52
  53 .. toctree::
  54    :maxdepth: 2
  55    :titlesonly:
  56
  57 :ref:`ONAP PaaS set-up (optional)<onap-oom:oom_setup_paas>`
  58
  59 ONAP installation is described here:
  60
  61 .. toctree::
  62    :maxdepth: 2
  63    :titlesonly:
  64
  65 :ref:`OOM Quickstart Guide<onap-oom:oom_quickstart_guide>`
  66
  67 :ref:`OOM User Guide<onap-oom:oom_user_guide>`
  68
  69 Alternative way of offline ONAP installation is described here:
  70
  71 .. toctree::
  72    :maxdepth: 2
  73    :titlesonly:
  74
  75 :ref:`OOM Offline-Installer<onap-oom-offline-installer:master_index>`
  76
  77 .. note::
  78    Prior to deployment of ONAP, there is no need to download manually any Docker
  79    container. The OOM deployment takes care to automatically download the Docker
  80    containers.
  81
  82    It is also possible to deploy a subset of ONAP components on a single VM.
  83    The VM flavor to be used depends on the number of ONAP components to be
  84    deployed.
  85
  86 NodePorts
  87 ---------
  88
  89 NodePorts are used to allow client applications, that run outside of
  90 Kubernetes, access to ONAP components deployed by OOM.
  91 A NodePort maps an externally reachable port to an internal port of an ONAP
  92 microservice.
  93 It should be noted that the use of NodePorts is temporary.
  94 An alternative solution based on Ingress Controller, which initial support is
  95 already in place. It is planned to become a default deployment option in the
  96 Guilin release.
  97
  98 More information from official Kubernetes documentation about
  99 `NodePort <https://kubernetes.io/docs/concepts/services-networking/service/#nodeport>`_.
 100
 101 The following table lists all the NodePorts used by ONAP.
 102
 103 .. csv-table:: NodePorts table
 104    :file: nodeports.csv
 105    :widths: 20,20,20,20,20
 106    :header-rows: 1
 107
 108 .. note::
 109    \*) POMBA, LOG and SNIRO are not part of the default Frankfurt ONAP
 110    deployment.
 111
 112 This table retrieves information from the ONAP deployment using the following
 113 Kubernetes command:
 114
 115 .. code-block:: bash
 116
 117   kubectl get svc -n onap -o go-template='{{range .items}}{{range.spec.ports}}{{if .nodePort}}{{.nodePort}}{{.}}{{"\n"}}{{end}}{{end}}{{end}}'