Eric Debeau | 3cf9a63 | 2018-05-22 19:57:38 +0000 | [diff] [blame] | 1 | .. This work is licensed under |
| 2 | .. a Creative Commons Attribution 4.0 International License. |
Rich Bennett | a4cf27d | 2017-11-12 23:11:28 -0500 | [diff] [blame] | 3 | .. http://creativecommons.org/licenses/by/4.0 |
Eric Debeau | 0f2c283 | 2018-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 Debeau | aa55c50 | 2019-04-15 07:00:19 +0000 | [diff] [blame] | 8 | .. Modifications Copyright 2019 Orange |
Eric Debeau | 7e90041 | 2017-11-09 22:02:38 +0000 | [diff] [blame] | 9 | |
Rich Bennett | a4cf27d | 2017-11-12 23:11:28 -0500 | [diff] [blame] | 10 | Setting Up ONAP |
| 11 | =============== |
Eric Debeau | 7e90041 | 2017-11-09 22:02:38 +0000 | [diff] [blame] | 12 | |
Eric Debeau | 43f5aec | 2018-11-24 08:29:47 +0000 | [diff] [blame] | 13 | .. _installing-onap: |
| 14 | |
Eric Debeau | 0f2c283 | 2018-11-19 19:47:29 +0000 | [diff] [blame] | 15 | ONAP is deployed using the ONAP Operations Manager (OOM). |
Rich Bennett | 52b5c09 | 2018-09-01 09:48:13 -0400 | [diff] [blame] | 16 | |
andreasgeissler | 64847da | 2020-06-03 16:22:37 +0200 | [diff] [blame] | 17 | The recommended ONAP deployment can be deployed on a private set of physical |
| 18 | hosts or VMs (or even a combination of the two) and is based on Kubernetes, |
| 19 | Docker containers and Helm installer. |
| 20 | |
Rich Bennett | 52b5c09 | 2018-09-01 09:48:13 -0400 | [diff] [blame] | 21 | |
Eric Debeau | 0f2c283 | 2018-11-19 19:47:29 +0000 | [diff] [blame] | 22 | Requirements |
| 23 | ------------ |
Rich Bennett | 52b5c09 | 2018-09-01 09:48:13 -0400 | [diff] [blame] | 24 | |
andreasgeissler | 64847da | 2020-06-03 16:22:37 +0200 | [diff] [blame] | 25 | OOM requires the following Software components. |
Rich Bennett | 52b5c09 | 2018-09-01 09:48:13 -0400 | [diff] [blame] | 26 | |
andreasgeissler | 64847da | 2020-06-03 16:22:37 +0200 | [diff] [blame] | 27 | * Kubernetes |
| 28 | * Helm |
| 29 | * kubectl |
| 30 | * Docker |
Rich Bennett | 52b5c09 | 2018-09-01 09:48:13 -0400 | [diff] [blame] | 31 | |
andreasgeissler | 64847da | 2020-06-03 16:22:37 +0200 | [diff] [blame] | 32 | The Software versions needed for the specific ONAP release |
| 33 | as well as the minimum Hardware configuration can be found in the |
| 34 | :ref:`OOM Cloud Setup Guide<onap-oom:oom_cloud_setup_guide>` |
Eric Debeau | 4378efd | 2019-05-22 07:37:45 +0000 | [diff] [blame] | 35 | |
Eric Debeau | 0f2c283 | 2018-11-19 19:47:29 +0000 | [diff] [blame] | 36 | |
| 37 | Installation |
| 38 | ------------ |
| 39 | |
| 40 | Creation of Kubernetes cluster is described here: |
Eric Debeau | 3cf9a63 | 2018-05-22 19:57:38 +0000 | [diff] [blame] | 41 | |
Rich Bennett | a4cf27d | 2017-11-12 23:11:28 -0500 | [diff] [blame] | 42 | .. toctree:: |
Rene_Robert | 6654af6 | 2019-07-04 09:48:56 +0200 | [diff] [blame] | 43 | :maxdepth: 2 |
Rich Bennett | a4cf27d | 2017-11-12 23:11:28 -0500 | [diff] [blame] | 44 | :titlesonly: |
Eric Debeau | 7e90041 | 2017-11-09 22:02:38 +0000 | [diff] [blame] | 45 | |
andreasgeissler | 64847da | 2020-06-03 16:22:37 +0200 | [diff] [blame] | 46 | :ref:`OOM Cloud Setup Guide<onap-oom:oom_cloud_setup_guide>` |
| 47 | |
| 48 | :ref:`ONAP on HA Kubernetes Cluster<onap-oom:onap-on-kubernetes-with-rancher>` |
Eric Debeau | 0f2c283 | 2018-11-19 19:47:29 +0000 | [diff] [blame] | 49 | |
| 50 | ONAP installation is described here: |
| 51 | |
| 52 | .. toctree:: |
Rene_Robert | 6654af6 | 2019-07-04 09:48:56 +0200 | [diff] [blame] | 53 | :maxdepth: 2 |
Eric Debeau | 0f2c283 | 2018-11-19 19:47:29 +0000 | [diff] [blame] | 54 | :titlesonly: |
| 55 | |
andreasgeissler | 64847da | 2020-06-03 16:22:37 +0200 | [diff] [blame] | 56 | :ref:`OOM Quickstart Guide<onap-oom:oom_quickstart_guide>` |
| 57 | |
| 58 | :ref:`OOM User Guide<onap-oom:oom_user_guide>` |
Eric Debeau | 0f2c283 | 2018-11-19 19:47:29 +0000 | [diff] [blame] | 59 | |
Petr Ospalý | 2633853 | 2019-03-15 17:47:46 +0100 | [diff] [blame] | 60 | Alternative way of offline ONAP installation is described here: |
| 61 | |
| 62 | .. toctree:: |
Rene_Robert | 6654af6 | 2019-07-04 09:48:56 +0200 | [diff] [blame] | 63 | :maxdepth: 2 |
Petr Ospalý | 2633853 | 2019-03-15 17:47:46 +0100 | [diff] [blame] | 64 | :titlesonly: |
| 65 | |
andreasgeissler | 64847da | 2020-06-03 16:22:37 +0200 | [diff] [blame] | 66 | :ref:`OOM Offline-Installer<onap-oom-offline-installer:master_index>` |
Petr Ospalý | 2633853 | 2019-03-15 17:47:46 +0100 | [diff] [blame] | 67 | |
Eric Debeau | 4378efd | 2019-05-22 07:37:45 +0000 | [diff] [blame] | 68 | .. note:: |
andreasgeissler | 64847da | 2020-06-03 16:22:37 +0200 | [diff] [blame] | 69 | Prior to deployment of ONAP, there is no need to download manually any Docker |
| 70 | container. The OOM deployment takes care to automatically download the Docker |
| 71 | containers. |
Eric Debeau | 4378efd | 2019-05-22 07:37:45 +0000 | [diff] [blame] | 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 | |
Eric Debeau | 0f2c283 | 2018-11-19 19:47:29 +0000 | [diff] [blame] | 77 | NodePorts |
| 78 | --------- |
| 79 | |
| 80 | NodePorts are used to allow client applications, that run outside of |
| 81 | Kubernetes, access to ONAP components deployed by OOM. |
| 82 | A NodePort maps an externally reachable port to an internal port of an ONAP |
| 83 | microservice. |
| 84 | It should be noted that the use of NodePorts is temporary. |
andreasgeissler | 64847da | 2020-06-03 16:22:37 +0200 | [diff] [blame] | 85 | An alternative solution based on Ingress Controller, which initial support is |
| 86 | already in place. It is planned to become a default deployment option in the |
| 87 | Guilin release. |
Eric Debeau | 0f2c283 | 2018-11-19 19:47:29 +0000 | [diff] [blame] | 88 | |
Eric Debeau | aa55c50 | 2019-04-15 07:00:19 +0000 | [diff] [blame] | 89 | More information from official Kubernetes documentation about |
| 90 | `NodePort <https://kubernetes.io/docs/concepts/services-networking/service/#nodeport>`_. |
| 91 | |
| 92 | The following table lists all the NodePorts used by ONAP. |
| 93 | |
| 94 | .. csv-table:: NodePorts table |
| 95 | :file: nodeports.csv |
| 96 | :widths: 20,20,20,20,20 |
| 97 | :header-rows: 1 |
| 98 | |
andreasgeissler | 64847da | 2020-06-03 16:22:37 +0200 | [diff] [blame] | 99 | .. note:: |
| 100 | \*) POMBA, LOG and SNIRO are not part of the default Frankfurt ONAP |
| 101 | deployment. |
| 102 | |
Eric Debeau | aa55c50 | 2019-04-15 07:00:19 +0000 | [diff] [blame] | 103 | This table retrieves information from the ONAP deployment using the following |
| 104 | Kubernetes command: |
| 105 | |
| 106 | .. code-block:: bash |
| 107 | |
| 108 | kubectl get svc -n onap -o go-template='{{range .items}}{{range.spec.ports}}{{if .nodePort}}{{.nodePort}}{{.}}{{"\n"}}{{end}}{{end}}{{end}}' |