-Update Release Notes on developers skill required for independant installation
-Update ONAP getting star with typo, links and clarifications
Issue-Id: DOC-150
Change-Id: I59b3bad9eda994b65d13a99f33d8edb3396740c2
Signed-off-by: Gildas Lanilis <gildas.lanilis@huawei.com>
-ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on OpenStack.
+ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Amsterdam Release is currently based on OpenStack HEAT Template.
-Using the Amsterdam Release installer, ONAP components may be deployed in a single tenant or multiple tenants. One tenant for all the components except DCAE, and another tenant dedicated to the DCAE components.
+Using the Amsterdam HEAT Template installer, ONAP can be deployed in a single tenant or multiple tenants. One tenant for all the components except DCAE, and another tenant dedicated to the DCAE components.
-The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure (cf MultiCloud project).
+The VNFs managed by ONAP may be deployed in different OpenStack tenants or based on top of VMware based infrastructure. For details, refer :ref:`to MultiCloud project<index-multicloud>`.
-The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) with DCAE componntes deployed in High Availability mode.
+The current installation is based on the single tenant deployment (all the ONAP components will be hosted in a unique tenant) with DCAE components deployed in High Availability mode.
-The installation requires some manual taks to setup the DCAE components.
+The installation requires some manual tasks to setup the DCAE components.
**Requirements**
================
**Requirements**
================
- `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.
- `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*
+Use the procedure below to deploy and configure *Designate*
.. toctree::
:maxdepth: 1
.. toctree::
:maxdepth: 1
ONAP components
---------------
ONAP components
---------------
-The following table presents the mapping between the created VM and the ONAP components, and provides informtaion about he VM (flavor and image):
+The following table presents the mapping between the created VM and the ONAP components, and provides VM information (flavor and image):
=================== ================= ======= ============
VM name ONAP project(s) Flavor Image
=================== ================= ======= ============
VM name ONAP project(s) Flavor Image
- 148 vCPU
- 336 GB RAM
- 3 TB Storage
- 148 vCPU
- 336 GB RAM
- 3 TB Storage
+ - 29 floating IP addresses
-.. Note: the default flavor size may be optimized. The ONAP community is working to provide adpted flavors for basic ONAP installation.
+.. Note: The default flavor size may be optimized. The ONAP community is working to update flavors of basic ONAP installation.
-.. Note: you should also reserve some resourcse for the VNFs to be deployed.
+.. Note: You should also reserve some resources for the VNFs to be deployed.
-The following artifacts must be deployed on the OpenStack infrastructure.
+The following artifacts must be deployed on the OpenStack infrastructure:
- a public SSH key to access the various VM
- private SSH key and public key SSH key for the DCAE VM
- Ubuntu 14.04 image
- a public SSH key to access the various VM
- private SSH key and public key SSH key for the DCAE VM
- Ubuntu 14.04 image
- CentOS 7 image
- Set of flavors: small, medium, large, medium, large, xlarge, xxlarge
- CentOS 7 image
- Set of flavors: small, medium, large, medium, large, xlarge, xxlarge
-.. Note that floating IP may be private IP.
+.. Note: The floating IP may be private IP.
-.. Note Basic flavors can reuse the default flavors as defined by `OpenStack <https://docs.openstack.org/horizon/latest/admin/manage-flavors.html>`_
- The xxlarge flavor should be confiured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage.
+.. Note: Basic flavors can reuse the default flavors as defined by `OpenStack <https://docs.openstack.org/horizon/latest/admin/manage-flavors.html>`_
+ The xxlarge flavor should be configured using the following values: 12 vCPU, 64 GB RAM and 120 GB storage.
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 need to open some security groups (eg when using the portal from your desktop).
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 need to open some security groups (eg when using the portal from your desktop).
-The list of various services and ports used can be found on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_
+The list of various services and ports used can be found on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_.
**Deployment**
==============
**Deployment**
==============
Source files
------------
Source files
------------
-The following files must be downloaded:
+Both following files must be downloaded and configured to match your configuration:
- Template file: https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml
- Environment file: https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env
- Template file: https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.yaml
- Environment file: https://git.onap.org/demo/plain/heat/ONAP/onap_openstack.env
-The environment file must be customized as decribed in the following sections.
+The environment file must be customized as described in the following sections.
.. Note Amsterdam release files
.. Note Amsterdam release files
- ONAP Virtual Machines (VMs)
- Public/private key pair used to access ONAP VMs
- Virtual interfaces towards the ONAP Private Management Network
- ONAP Virtual Machines (VMs)
- Public/private key pair used to access ONAP VMs
- Virtual interfaces towards the ONAP Private Management Network
Each VM specification includes Operating System image name, VM size
(i.e. flavor), VM name, etc. Each VM has two virtual network interfaces:
Each VM specification includes Operating System image name, VM size
(i.e. flavor), VM name, etc. Each VM has two virtual network interfaces:
Management network, as described above. Furthermore, each VM runs a
post-instantiation script that downloads and installs software
dependencies (e.g. Java JDK, gcc, make, Python, ...) and ONAP software
Management network, as described above. Furthermore, each VM runs a
post-instantiation script that downloads and installs software
dependencies (e.g. Java JDK, gcc, make, Python, ...) and ONAP software
-packages and docker containers from remote repositories.
+packages and Docker containers from remote repositories.
-When the HEAT template is executed, the Openstack HEAT engine creates
+When the HEAT template is executed, the OpenStack HEAT engine creates
the resources defined in the HEAT template, based on the parameters
values defined in the environment file.
the resources defined in the HEAT template, based on the parameters
values defined in the environment file.
user@ubuntu:~$ ssh-keygen -t rsa
user@ubuntu:~$ ssh-keygen -t rsa
-The following operations to create the public/private key pair occur:
+The following operations create the public/private key pair:
dns_forwarder: PUT THE IP OF DNS FORWARDER FOR ONAP DEPLOYMENT'S OWN DNS SERVER
oam_network_cidr: 10.0.0.0/16
dns_forwarder: PUT THE IP OF DNS FORWARDER FOR ONAP DEPLOYMENT'S OWN DNS SERVER
oam_network_cidr: 10.0.0.0/16
-You can use the Google Public DNS 8.8.8.8 and 4.4.4.4 address or your internal DNS servers
+You can use the Google Public DNS 8.8.8.8 and 4.4.4.4 address or your internal DNS servers.
ONAP installs a DNS server used to resolve IP addresses in the ONAP OAM private network.
ONAP Amsterdam Release also requires OpenStack Designate DNS support for the DCAE platform, so as to allow IP address discovery and communication among DCAE elements.
ONAP installs a DNS server used to resolve IP addresses in the ONAP OAM private network.
ONAP Amsterdam Release also requires OpenStack Designate DNS support for the DCAE platform, so as to allow IP address discovery and communication among DCAE elements.
DCAE spins up ONAP's data collection and analytics system in two phases.
DCAE spins up ONAP's data collection and analytics system in two phases.
-The first is the launching of a bootstrap VM that is specified in the ONAP Heat template, as described above. This VM requires a number of deployment-specific configuration parameters being provided so that it can subsequently bring up the DCAE system.
+The first phase consists of launching a bootstrap VM that is specified in the ONAP HEAT template, as described above. This VM requires a number of deployment-specific configuration parameters being provided so that it can subsequently bring up the DCAE system.
+
+There are two groups of parameters:
-There are two groups of parameters.
+- The first group relates to the launching of DCAE VMs, including parameters such as the keystone URL and additional VM image IDs/names. Hence these parameters need to be provided to DCAE. Note that although DCAE VMs will be launched in the same tenant as the rest of ONAP, because DCAE may use MultiCloud node as the agent for interfacing with the underlying cloud, it needs a separate keystone URL (which points to MultiCloud node instead of the underlying cloud).
-The first group relates to the launching of DCAE VMs, including parameters such as the keystone URL and additional VM image IDs/names.
-Hence these parameters need to be provided to DCAE.
-Note that although DCAE VMs will be launched in the same tenant as the rest of ONAP, because DCAE may use MultiCloud node as the agent for interfacing with the underlying cloud, it needs a separate keystone URL (which points to MultiCloud node instead of the underlying cloud).
-The second group of configuration parameters relate to DNS As A Service support (DNSaaS).
-DCAE requires DNSaaS for registering its VMs into organization-wide DNS service.
-For OpenStack, DNSaaS is provided by Designate, as mentioned above.
-Designate support can be provided via an integrated service endpoint listed under the service catalog of the OpenStack installation; or proxyed by the ONAP MultiCloud service.
-For the latter case, a number of parameters are needed to configure MultiCloud to use the correct Designate service.
+- The second group of configuration parameters relate to DNS As A Service support (DNSaaS). DCAE requires DNSaaS for registering its VMs into organization-wide DNS service. For OpenStack, DNSaaS is provided by Designate, as mentioned above. Designate support can be provided via an integrated service endpoint listed under the service catalog of the OpenStack installation; or proxyed by the ONAP MultiCloud service. For the latter case, a number of parameters are needed to configure MultiCloud to use the correct Designate service.
These parameters are described below:
These parameters are described below:
openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME # New Openstack client
openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME # New Openstack client
-.. Note The Heat template deployment may take time (up to one hour) depending on your hardware environment.
+.. Note The HEAT template deployment may take time (up to one hour) depending on your hardware environment.
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
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
-This testsuite will execute 30 tests towards the various ONAP components.
+This test suite will execute 30 tests towards the various ONAP components.
-After the installation, it is possible to deploy the various use-cases described `ONAP wiki <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
+After the installation, it is possible to deploy the various use-cases described in `ONAP wiki <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_.
Detect problems
---------------
Detect problems
---------------
* Connect to the Virtual Machine and check that the various containers are running.
The list of containers are described on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_
* Connect to the Virtual Machine and check that the various containers are running.
The list of containers are described on the `ONAP wiki <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_
-. In case some containers are missing, check the docker logs using the following command:
+. In case some containers are missing, check the Docker logs using the following command:
<onap-aai-inst2_ip> aai.ui.simpledemo.onap.org
<onap-aai-inst2_ip> aai.ui.simpledemo.onap.org
-You can use the Horizon dashboard to get the IP adresses associated with the Virtual Machines or use the following command line:
+You can use the Horizon dashboard to get the IP addresses associated with the Virtual Machines or use the following command line:
Advanced installation to install individual components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Advanced installation to install individual components
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-From a developer perspective. ONAP can be installed component per component, refer to :ref:`the installation procedure available for each component<doc_onap-developer_guide_projects>`.
+From a developer perspective, ONAP can be installed component per component. For details, refer to :ref:`the installation procedure available for each component<doc_onap-developer_guide_projects>`.
+The advanced installation procedure is recommended only for experienced developers who desire to focus their attention on a few components and who have a deep understanding of dependencies between components.
+This type of installation is not recommended to fully install ONAP.
* The list of ports used by default within ONAP is documented in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
* The ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/.
* The list of ports used by default within ONAP is documented in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_.
* The ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/.
* If you don't know you are facing a bug or have a question, post your question into the `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
You will need a Linux Foundation ID to login and post your question. Get a Linux Foundation Identity using this `quick procedure <https://wiki.onap.org/display/DW/Joining+the+Community>`_.
* If you don't know you are facing a bug or have a question, post your question into the `Ask question <https://wiki.onap.org/display/DW/questions/all>`_.
You will need a Linux Foundation ID to login and post your question. Get a Linux Foundation Identity using this `quick procedure <https://wiki.onap.org/display/DW/Joining+the+Community>`_.
-You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list.
+You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing.
.. Include files referenced by link in the toctree as hidden
.. Include files referenced by link in the toctree as hidden
Code Review / doc.git / commitdiff