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