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
   9 Setting Up ONAP
  10 ===============
  11
  12 .. _installing-onap:
  13
  14 ONAP is deployed using the ONAP Operations Manager (OOM).
  15
  16 The recommended ONAP deployment is based on Kubernetes, Docker containers
  17 and Helm installer.
  18
  19 Requirements
  20 ------------
  21
  22 The following is the recommended component version.
  23
  24   ===========  =========
  25   Software     Version
  26   ===========  =========
  27   Kubernetes   1.11.2
  28   Helm         2.9.1
  29   kubectl      1.11.2
  30   Docker       17.03.x
  31   ===========  =========
  32
  33 The ONAP full installation is validated with the following footprint:
  34  - 14 VM (1 Rancher, 13 K8s nodes)
  35    - 8 vCPU
  36    - 16 GB RAM
  37  - 160 GB Storage
  38
  39 Installation
  40 ------------
  41
  42 Creation of Kubernetes cluster is described here:
  43
  44 .. toctree::
  45    :maxdepth: 1
  46    :titlesonly:
  47
  48    ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
  49
  50 ONAP installation is described here:
  51
  52 .. toctree::
  53    :maxdepth: 1
  54    :titlesonly:
  55
  56    ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst
  57
  58 NodePorts
  59 ---------
  60
  61 NodePorts are used to allow client applications, that run outside of
  62 Kubernetes, access to ONAP components deployed by OOM.
  63 A NodePort maps an externally reachable port to an internal port of an ONAP
  64 microservice.
  65 It should be noted that the use of NodePorts is temporary.
  66 An alternative solution is currently being scoped for the Dublin Release.
  67
  68 * The list of node ports used by ONAP is documented
  69   in `ONAP Node Port List <https://wiki.onap.org/display/DW/OOM+NodePort+List>`_.
  70
  71 .. note::
  72    Prior to deployment of ONAP, there is no need to download manually any Docker container.
  73    The OOM deployment takes care to automatically download the Docker containers.
  74
  75    It is also possible to deploy a subset of ONAP components on a single VM.
  76    The VM flavor to be used depends on the number of ONAP components to be
  77    deployed.
  78
  79 .. note::
  80    For test purposes, it is possible to use other installations:
  81
  82 .. toctree::
  83    :maxdepth: 1
  84    :titlesonly:
  85
  86    onap_heat.rst
  87    onap_individual.rst