Gitiles
Code Review Sign In
gerrit.nordix.org / onap / doc / a232b7987910aa8f4bf5f9148c3bb2993a782a75 / . / docs / guides / onap-developer / settingup / index.rst
blob: f96388891d09114e77c3cadef1918c2ac00c31e4 [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 =========== =========
Eric Debeau4378efd2019-05-22 07:37:45 +0000[diff] [blame]28 Kubernetes 1.13.5
29 Helm 2.12.3
30 kubectl 1.13.5
31 Docker 18.09.5
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]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:
Eric Debeau4378efd2019-05-22 07:37:45 +0000[diff] [blame]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/
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]43
44Installation
45------------
46
47Creation of Kubernetes cluster is described here:
Eric Debeau3cf9a632018-05-22 19:57:38 +0000[diff] [blame]48
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]49.. toctree::
Rene_Robert6654af62019-07-04 09:48:56 +0200[diff] [blame]50 :maxdepth: 2
Rich Bennetta4cf27d2017-11-12 23:11:28 -0500[diff] [blame]51 :titlesonly:
Eric Debeau7e900412017-11-09 22:02:38 +0000[diff] [blame]52
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]53 ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
54
55ONAP installation is described here:
56
57.. toctree::
Rene_Robert6654af62019-07-04 09:48:56 +0200[diff] [blame]58 :maxdepth: 2
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]59 :titlesonly:
60
61 ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst
Rene_Robert6654af62019-07-04 09:48:56 +0200[diff] [blame]62 ../../../../submodules/oom.git/docs/oom_user_guide.rst
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]63
Petr Ospalý26338532019-03-15 17:47:46 +0100[diff] [blame]64Alternative way of offline ONAP installation is described here:
65
66.. toctree::
Rene_Robert6654af62019-07-04 09:48:56 +0200[diff] [blame]67 :maxdepth: 2
Petr Ospalý26338532019-03-15 17:47:46 +0100[diff] [blame]68 :titlesonly:
69
70 ../../../../submodules/oom/offline-installer.git/docs/index.rst
71
Eric Debeau4378efd2019-05-22 07:37:45 +0000[diff] [blame]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
Eric Debeau0f2c2832018-11-19 19:47:29 +0000[diff] [blame]80NodePorts
81---------
82
83NodePorts are used to allow client applications, that run outside of
84Kubernetes, access to ONAP components deployed by OOM.
85A NodePort maps an externally reachable port to an internal port of an ONAP
86microservice.
87It should be noted that the use of NodePorts is temporary.
88An alternative solution is currently being scoped for the Dublin Release.
89
Eric Debeauaa55c502019-04-15 07:00:19 +0000[diff] [blame]90More information from official Kubernetes documentation about
91`NodePort <https://kubernetes.io/docs/concepts/services-networking/service/#nodeport>`_.
92
93The 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
100This table retrieves information from the ONAP deployment using the following
101Kubernetes 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}}'