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