docs/guides/onap-developer/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 is based on Kubernetes, Docker containers
  18 and Helm installer.
  19
  20 Requirements
  21 ------------
  22
  23 The following is the recommended component version.
  24
  25   ===========  =========
  26   Software     Version
  27   ===========  =========
  28   Kubernetes   1.13.5
  29   Helm         2.12.3
  30   kubectl      1.13.5
  31   Docker       18.09.5
  32   ===========  =========
  33
  34 The ONAP full installation is validated with the following footprint:
  35
  36 .. csv-table:: Validated installation footprint
  37    :widths: 3,5,10
  38
  39    VM number, VM flavor, VM role
  40    12, 16 GB RAM - 8 vCPUs, Running the K8S worker role
  41    3, 8 GB RAM - 4 vCPUs, Running the K8S controller role
  42    1, 8 GB RAM - 4 vCPUs, Running the shared NFS server for /dockerdata-nfs/
  43
  44 Installation
  45 ------------
  46
  47 Creation of Kubernetes cluster is described here:
  48
  49 .. toctree::
  50    :maxdepth: 2
  51    :titlesonly:
  52
  53    ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
  54
  55 ONAP installation is described here:
  56
  57 .. toctree::
  58    :maxdepth: 2
  59    :titlesonly:
  60
  61    ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst
  62    ../../../../submodules/oom.git/docs/oom_user_guide.rst
  63
  64 Alternative way of offline ONAP installation is described here:
  65
  66 .. toctree::
  67    :maxdepth: 2
  68    :titlesonly:
  69
  70    ../../../../submodules/oom/offline-installer.git/docs/index.rst
  71
  72 .. note::
  73    Prior to deployment of ONAP, there is no need to download manually any Docker container.
  74    The OOM deployment takes care to automatically download the Docker containers.
  75
  76    It is also possible to deploy a subset of ONAP components on a single VM.
  77    The VM flavor to be used depends on the number of ONAP components to be
  78    deployed.
  79
  80 NodePorts
  81 ---------
  82
  83 NodePorts are used to allow client applications, that run outside of
  84 Kubernetes, access to ONAP components deployed by OOM.
  85 A NodePort maps an externally reachable port to an internal port of an ONAP
  86 microservice.
  87 It should be noted that the use of NodePorts is temporary.
  88 An alternative solution is currently being scoped for the Dublin Release.
  89
  90 More information from official Kubernetes documentation about
  91 `NodePort <https://kubernetes.io/docs/concepts/services-networking/service/#nodeport>`_.
  92
  93 The following table lists all the NodePorts used by ONAP.
  94
  95 .. csv-table:: NodePorts table
  96    :file: nodeports.csv
  97    :widths: 20,20,20,20,20
  98    :header-rows: 1
  99
 100 This table retrieves information from the ONAP deployment using the following
 101 Kubernetes command:
 102
 103 .. code-block:: bash
 104
 105   kubectl get svc -n onap -o go-template='{{range .items}}{{range.spec.ports}}{{if .nodePort}}{{.nodePort}}{{.}}{{"\n"}}{{end}}{{end}}{{end}}'