-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
- http://creativecommons.org/licenses/by/4.0
- Copyright 2017 ONAP
+.. This work is licensed under
+.. a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017-2018 AT&T Intellectual Property. All rights reserved.
+.. Modifications Copyright 2018 Orange
+.. Modifications Copyright 2018 Amdocs
+.. Modifications Copyright 2018 Huawei
+.. Modifications Copyright 2019 Orange
+Setting Up ONAP
+===============
-.. contents::
- :depth: 2
-..
+.. _installing-onap:
-========================
-**Setting Up Full ONAP**
-========================
+ONAP is deployed using the ONAP Operations Manager (OOM).
+The recommended ONAP deployment is based on Kubernetes, Docker containers
+and Helm installer.
-**Context**
-===========
-ONAP may be deployed in different contexts depending on the service provider requirements. The official installation for Amsterdam Release is currenly based on OpenStack.
+Requirements
+------------
-Using the Amsterdam Release installer, ONAP components may be deployed in a single tenant or can be distributed in various tenants: one for all the components except the DCAE one and another tenant dedicated to the DCAE components.
+The following is the recommended component version.
-The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of Vmware based infrastructure (cf MultiCloud project).
+ =========== =========
+ Software Version
+ =========== =========
+ Kubernetes 1.11.5
+ Helm 2.9.1
+ kubectl 1.11.5
+ Docker 17.03.x
+ =========== =========
-Figure 1
+The ONAP full installation is validated with the following footprint:
+ - 14 VM (1 Rancher, 13 K8s nodes)
+ - 8 vCPU
+ - 16 GB RAM
+ - 160 GB Storage
-The current installation is based on the mono-tenant deployment (all the ONAP components will be hosted in a unique tenant)
+Installation
+------------
+Creation of Kubernetes cluster is described here:
-**Requirements**
-================
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
-OpenStack
----------
-ONAP installation is validated on `OpenStack Ocata <https://releases.openstack.org/ocata/>`_ or latter release.
-
-The following OpenStack components must be deployed in the infrastructure:
- - *Cinder*
- - *Designate*
- - *Glance*
- - *Horizon*
- - *Keystone*
-
-To deploy OpenStack, you can use various solutions:
- - `OpenStack installer <https://docs.openstack.org/install-guide/>`_
- - `OPNFV Cross Community Continuous Integration - XCI installer <http://docs.opnfv.org/en/latest/infrastructure/xci.html>`_
-
-*Designate* component is usually not deployed using standard OpenStack installers.
-Please find a guide to deploy and configure *Designate*
-
-Footprint
----------
-The ONAP installation requires the following footprint:
- - xx VM
- - xxx vCPU
- - xxx RAM
- - xxx Storage
- - xxx floating IP
- - a public SSH key
- - a private SSH key
-
-Note that floating IP may be private IP.
-
-Security
---------
-The default installation assumes that the Default security group is configured to enable full access between the ONAP components.
-Depending on your environment, we may be forced to open some security groups (eg when using the portal from your desktop)
-
-The following YAML file presents the ports exposed by the various components:
-
-.. code-block:: yaml
-
- ---
- aai:
- - 8889
-
-TODO Generate the YAML file with installation
-
-TODO Provide a command to create the security groups
-
-**Deployment**
-==============
+ ../../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst
-Instantiation
--------------
-- To deploy ONAP, use the Heat template and follow the described in integration project.
+ONAP installation is described here:
-- The Heat template deployment may take time (up to one hour) depending on your hardware envionment.
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
-Test the installation
----------------------
-Every ONAP component offers a HealthCheck REST API. The *Robot Virtual Machine* can be used to test that every
-Run the following command to
+ ../../../../submodules/oom.git/docs/oom_quickstart_guide.rst
-.. code-block:: bash
-
- docker exec -it openecompete_container /var/opt/OpenECOMP_ETE/runTags.sh -i health h -d ./html -V /share/config/integration_robot_properties.py -V /share/config/integration_preload_parameters.py -V /share/config/vm_properties.py
+Alternative way of offline ONAP installation is described here:
-This testsuite will execute 31 tests towards the various ONAP components.
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
-Detect problems
----------------
-If all the tests are not OK, many causes are possible.
-Here is a simple procedure to detect where the problem occurs:
-- Check the OpenStack Virtual Machine logs
-- Connect to Virtual Machine and check that the various containers are runnings. The list of containers aer described in the foloqing section. Is some containers are missing, check the docker logs using the following command:
-
-.. code-block:: bash
+ ../../../../submodules/oom/offline-installer.git/docs/index.rst
- sudo docker ps -a
- sudo docker logs <containerid>
+NodePorts
+---------
+NodePorts are used to allow client applications, that run outside of
+Kubernetes, access to ONAP components deployed by OOM.
+A NodePort maps an externally reachable port to an internal port of an ONAP
+microservice.
+It should be noted that the use of NodePorts is temporary.
+An alternative solution is currently being scoped for the Dublin Release.
-**Portal configuration**
-========================
-The current ONAP installation is using the onap.org domain.
-To use the portal on your desktop, you must configure the following information in your *host* file (located in /etc/host for Linux or /windows/system32/drivers/etc/hosts for Windows:
+More information from official Kubernetes documentation about
+`NodePort <https://kubernetes.io/docs/concepts/services-networking/service/#nodeport>`_.
-.. code-block:: bash
+The following table lists all the NodePorts used by ONAP.
- 104.239.249.17 policy.api.simpledemo.onap.org
- 104.130.31.25 portal.api.simpledemo.onap.org
- 104.239.249.15 sdc.api.simpledemo.onap.org
- 104.130.170.142 vid.api.simpledemo.onap.org
- 104.239.249.72 aai.api.simpledemo.onap.org
- TODO ADD ui.aai
+.. csv-table:: NodePorts table
+ :file: nodeports.csv
+ :widths: 20,20,20,20,20
+ :header-rows: 1
-You can use the Horizon dashboard to get the IP adresses associated with the Virtual Machines or use the following command line:
+This table retrieves information from the ONAP deployment using the following
+Kubernetes command:
.. code-block:: bash
- openstack server list
-
-Launch the portal on the http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/login.htm
-
-Go to the Portal component user guide.
-
-Other UI documentation:
- - CLAMP
- - SDC Portal
- - UI Case
-
-
-**Components**
-==============
-
-The following YAML file presents the list of containers for every Virtual Machine
-
-.. code-block:: yaml
-
- aai:
- - traversal
- - be
- - fe
- appc
- - fe
+ kubectl get svc -n onap -o go-template='{{range .items}}{{range.spec.ports}}{{if .nodePort}}{{.nodePort}}{{.}}{{"\n"}}{{end}}{{end}}{{end}}'
+.. note::
+ Prior to deployment of ONAP, there is no need to download manually any Docker container.
+ The OOM deployment takes care to automatically download the Docker containers.
-========================================
-**Setting Up indiviual ONAP components**
-========================================
-It is possible to deploy individual components.
+ It is also possible to deploy a subset of ONAP components on a single VM.
+ The VM flavor to be used depends on the number of ONAP components to be
+ deployed.
-The documentation to install the various components is available here:
+.. note::
+ For test purposes, it is possible to use other installations:
-TODO Link to installations
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+ onap_heat.rst
+ onap_individual.rst
Code Review / doc.git / blobdiff