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.11.5
  29   Helm         2.9.1
  30   kubectl      1.11.5
  31   Docker       17.03.x
  32   ===========  =========
  33
  34 The ONAP full installation is validated with the following footprint:
  35  - 14 VM (1 Rancher, 13 K8s nodes)
  36    - 8 vCPU
  37    - 16 GB RAM
  38  - 160 GB Storage
  39
  40 Installation
  41 ------------
  42
  43 Creation of Kubernetes cluster is described here:
  44
  45 .. toctree::
  46    :maxdepth: 1
  47    :titlesonly:
  48
  49    ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
  50
  51 ONAP installation is described here:
  52
  53 .. toctree::
  54    :maxdepth: 1
  55    :titlesonly:
  56
  57    ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst
  58
  59 Alternative way of offline ONAP installation is described here:
  60
  61 .. toctree::
  62    :maxdepth: 1
  63    :titlesonly:
  64
  65    ../../../../submodules/oom/offline-installer.git/docs/index.rst
  66
  67 NodePorts
  68 ---------
  69
  70 NodePorts are used to allow client applications, that run outside of
  71 Kubernetes, access to ONAP components deployed by OOM.
  72 A NodePort maps an externally reachable port to an internal port of an ONAP
  73 microservice.
  74 It should be noted that the use of NodePorts is temporary.
  75 An alternative solution is currently being scoped for the Dublin Release.
  76
  77 More information from official Kubernetes documentation about
  78 `NodePort <https://kubernetes.io/docs/concepts/services-networking/service/#nodeport>`_.
  79
  80 The following table lists all the NodePorts used by ONAP.
  81
  82 .. csv-table:: NodePorts table
  83    :file: nodeports.csv
  84    :widths: 20,20,20,20,20
  85    :header-rows: 1
  86
  87 This table retrieves information from the ONAP deployment using the following
  88 Kubernetes command:
  89
  90 .. code-block:: bash
  91
  92   kubectl get svc -n onap -o go-template='{{range .items}}{{range.spec.ports}}{{if .nodePort}}{{.nodePort}}{{.}}{{"\n"}}{{end}}{{end}}{{end}}'
  93
  94
  95 .. note::
  96    Prior to deployment of ONAP, there is no need to download manually any Docker container.
  97    The OOM deployment takes care to automatically download the Docker containers.
  98
  99    It is also possible to deploy a subset of ONAP components on a single VM.
 100    The VM flavor to be used depends on the number of ONAP components to be
 101    deployed.
 102
 103 .. note::
 104    For test purposes, it is possible to use other installations:
 105
 106 .. toctree::
 107    :maxdepth: 1
 108    :titlesonly:
 109
 110    onap_heat.rst
 111    onap_individual.rst