Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / aa55c500e3a1d05880863824913f7f6e530116d7 / . / docs / guides / onap-developer / settingup / index.rst
blob: 2b9f8b133e07b7a526452caf75b9bba3d5cdfe52 [file] [log] [blame]
Eric Debeau3cf9a632018-05-22 19:57:38 +0000[diff] [blame]1.. This work is licensed under
2.. a Creative Commons Attribution 4.0 International License.
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]3.. http://creativecommons.org/licenses/by/4.0
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]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
Eric Debeauaa55c502019-04-15 07:00:19 +0000[diff] [blame^]8.. Modifications Copyright 2019 Orange
Eric Debeau7e900412017-11-09 22:02:38 +0000[diff] [blame]9
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]10Setting Up ONAP
11===============
Eric Debeau7e900412017-11-09 22:02:38 +0000[diff] [blame]12
Eric Debeau43f5aec2018-11-24 08:29:47 +0000[diff] [blame]13.. _installing-onap:
14
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]15ONAP is deployed using the ONAP Operations Manager (OOM).
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]16
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]17The recommended ONAP deployment is based on Kubernetes, Docker containers
18and Helm installer.
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]19
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]20Requirements
21------------
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]22
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]23The following is the recommended component version.
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]24
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]25 =========== =========
26 Software Version
27 =========== =========
Krzysztof Opasiak0bbc14d2019-01-18 14:29:48 +0100[diff] [blame]28 Kubernetes 1.11.5
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]29 Helm 2.9.1
Krzysztof Opasiak0bbc14d2019-01-18 14:29:48 +0100[diff] [blame]30 kubectl 1.11.5
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]31 Docker 17.03.x
32 =========== =========
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]33
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]34The 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
40Installation
41------------
42
43Creation of Kubernetes cluster is described here:
Eric Debeau3cf9a632018-05-22 19:57:38 +0000[diff] [blame]44
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]45.. toctree::
46 :maxdepth: 1
47 :titlesonly:
Eric Debeau7e900412017-11-09 22:02:38 +0000[diff] [blame]48
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]49 ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
50
51ONAP installation is described here:
52
53.. toctree::
54 :maxdepth: 1
55 :titlesonly:
56
57 ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst
58
Petr Ospalý26338532019-03-15 17:47:46 +0100[diff] [blame]59Alternative 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
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]67NodePorts
68---------
69
70NodePorts are used to allow client applications, that run outside of
71Kubernetes, access to ONAP components deployed by OOM.
72A NodePort maps an externally reachable port to an internal port of an ONAP
73microservice.
74It should be noted that the use of NodePorts is temporary.
75An alternative solution is currently being scoped for the Dublin Release.
76
Eric Debeauaa55c502019-04-15 07:00:19 +0000[diff] [blame^]77More information from official Kubernetes documentation about
78`NodePort <https://kubernetes.io/docs/concepts/services-networking/service/#nodeport>`_.
79
80The 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
87This table retrieves information from the ONAP deployment using the following
88Kubernetes 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
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]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
Rich Bennett52b5c092018-09-01 09:48:13 -0400[diff] [blame]110 onap_heat.rst
111 onap_individual.rst