diff options
| -rw-r--r-- | docs/guides/onap-developer/settingup/components.rst | 65 | ||||
| -rw-r--r-- | docs/guides/onap-developer/settingup/index.rst | 9 | ||||
| -rw-r--r-- | docs/guides/onap-developer/settingup/install-designate.rst | 85 | ||||
| -rw-r--r-- | docs/guides/onap-developer/settingup/onap_heat.rst (renamed from docs/guides/onap-developer/settingup/fullonap.rst) | 187 | ||||
| -rw-r--r-- | docs/guides/onap-developer/settingup/onap_oom.rst | 25 |
5 files changed, 79 insertions, 292 deletions
diff --git a/docs/guides/onap-developer/settingup/components.rst b/docs/guides/onap-developer/settingup/components.rst deleted file mode 100644 index 4574aeb9f..000000000 --- a/docs/guides/onap-developer/settingup/components.rst +++ /dev/null @@ -1,65 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - http://creativecommons.org/licenses/by/4.0 - -.. _index-setting-individual-components: - -========================================= -**Setting Up individual ONAP components** -========================================= -From a developer perspective, ONAP can be installed component per component. This 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 installation procedures for the various components are provided below: - -User Interfaces ---------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - CLAMP - Closed Loop Automation Platform<../../../submodules/clamp.git/docs/index.rst> - SDC - Service Design and Creation <../../../submodules/sdc.git/docs/installation.rst> - Use-Case UI <../../../submodules/usecase-ui.git/docs/platform/installation.rst> - VID - Virtual Infrastructure Deployment <../../../submodules/vid.git/docs/installation.rst> - -Platform Components -------------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - APPC - Application Controller <../../../submodules/appc/deployment.git/docs/APPC Deployment Guidelines/APPC Deployment Guidelines.rst> - DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/installation.rst> - Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/installation.rst> - Policy <../../../submodules/policy/engine.git/docs/platform/installation.rst> - SDNC - Software-Defined Networks Controller <../../../submodules/sdnc/oam.git/docs/installation.rst> - SO - Service Orchestration <../../../submodules/so.git/docs/Install_Configure_SO.rst> - VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/installation.rst> - NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/installation/installation.rst> - -Common Services ---------------- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/platform/installation.rst> - DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/Installation/Installation.rst> - Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/nfvparser/installation/installation.instruction.rst> - MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/installation.rst> - MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-Heat-Deployment-Guide.rst> - VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/installation.rst> - -SDK ---- - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - CLI - Command Line Interface<../../../submodules/cli.git/docs/installation_guide.rst> - Portal <../../../submodules/portal.git/docs/tutorials/portal-sdk/setting-up.rst> - VNF Software Development Kit <../../../submodules/vnfsdk/model.git/docs/files/mktplace-install.rst> diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst index 3dc8e5ce3..f9b4881fe 100644 --- a/docs/guides/onap-developer/settingup/index.rst +++ b/docs/guides/onap-developer/settingup/index.rst @@ -1,4 +1,5 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under +.. a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 AT&T Intellectual Property. All rights reserved. @@ -6,9 +7,11 @@ Setting Up ONAP =============== +ONAP can be deployed using 2 different solutions: + .. toctree:: :maxdepth: 1 :titlesonly: - fullonap.rst - components.rst + onap_heat.rst + onap_oom.rst diff --git a/docs/guides/onap-developer/settingup/install-designate.rst b/docs/guides/onap-developer/settingup/install-designate.rst deleted file mode 100644 index ddc2cd546..000000000 --- a/docs/guides/onap-developer/settingup/install-designate.rst +++ /dev/null @@ -1,85 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - http://creativecommons.org/licenses/by/4.0 - Copyright 2017 ONAP - - -.. contents:: - :depth: 2 -.. - -===================================== -**Setting Up Designate on Openstack** -===================================== - -.. tip:: - - `Openstack Designate documentation (LATEST) <https://docs.openstack.org/designate/latest/index.html>`_ is an important starting point for configuring Designate. Here, the focus will be on designate for ONAP. - - Notice the documentation version mentioned in the URL, e.g. ocata/, pike/, latest/ ... - -**Designate Overview** -====================== -Designate is a *DNS as a Service* components. It allows API based interaction with a DNS server. - -This DNS server can be any *well configured* DNS server. - -Designate allows to create **any** entries in the DNS and thus has to be used wisely (see `Designate Production Guidelines <https://docs.openstack.org/designate/latest/admin/production-guidelines.html>` to have a complete explanation). - -In order to be valuable, Designate must be plugged with a DNS Server that will be used: - - - your global (pool of) DNS Server(s). Every entries put by Designate will be seen by everybody. It may then be very dangerous. - - a specific (pool of) DNS Server(s) for your openstack deployment. DNS resolution will work only for your VM. **This is the one that has been tested**. - - a specific (pool of) DNS Server(s) for an openstack tenant. Not a lot of doc is available for that so this part won't be explained here. - -**Designate usage in ONAP** -=========================== - -Currently, only DCAE Gen2 deployment needs designate to work. - -DCAE deployment use cloudify with openstack plugin to start the needed VM for DCAE. In particular, Designate is used to give the IP address of consul server. Thus, the others VMs needs to access the DNS server where Designate push records. - -In order to do that, we'll have to deploy DNS Server(s), configure them to accept dns updates and configure our networks to point to this DNS. -This How-To will use bind but you can change to any of the `proposed backends <https://docs.openstack.org/designate/latest/contributor/support-matrix.html>`. - -Limitations with Heat automated deployment ------------------------------------------- -The current design of Heat installer installs DCAE needed VM into the same tenant of the same openstack of the other ONAP components. Thus, this openstack tenant must support Designate. - -Limitations with Kubernetes automated deployment ------------------------------------------------- -The current design of kubernetes deployment installs DCAE into any openstack instances in any tenant. It still mandates designate on the tenant. - -**Quick Install Guide** -======================= - -Few steps have to be performed. The detail of each steps are in `the config guide of Openstack Designate <https://docs.openstack.org/designate/latest/install/index.html>`: - -1. Install bind9 nameserver -2. Configure it to accept dns updates and forward to your master DNS Server. Example configuration is below: - - .. code:: bash - - root@designate:~# cat /etc/bind/named.conf.options - include "/etc/bind/rndc.key"; - options { - directory "/var/cache/bind"; - allow-new-zones yes; - dnssec-validation auto; - listen-on port 53 { 10.203.157.79; }; - forwarders { - 8.8.8.8; - 8.8.4.4; - }; - forward only; - allow-query { any; }; - recursion yes; - minimal-responses yes; - }; - controls { - inet 10.203.157.79 port 953 allow { 10.203.157.79; } keys { "rndc-key"; }; - }; - root@designate:~# - -3. Configure Designate in openstack. Please see `this guide <https://docs.openstack.org/mitaka/networking-guide/config-dns-int.html>` for more details. -4. Create a pool pointing to your nameserver - -Now, when starting the Heat Deployment, use this nameserver. When the stack heat has started, retrieve the random string (XXX in the example) and create the zone XXX.yourdomain (yourdomain is what you have filled in `dcae_domain` in onap_openstack.env). -For OOM, use the DNS on the container host so it can give it to the relevant VM. diff --git a/docs/guides/onap-developer/settingup/fullonap.rst b/docs/guides/onap-developer/settingup/onap_heat.rst index d8529ef97..db372c589 100644 --- a/docs/guides/onap-developer/settingup/fullonap.rst +++ b/docs/guides/onap-developer/settingup/onap_heat.rst @@ -1,19 +1,19 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 - International License. - http://creativecommons.org/licenses/by/4.0 - Copyright 2017-2018 ONAP +.. This work is licensed undera Creative Commons Attribution 4.0 +.. International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017-2018 ONAP .. contents:: :depth: 2 .. -.. index:: Setting Up Full ONAP +.. index:: Setting Up Full ONAP using Virtual Machines -======================== -**Setting Up Full ONAP** -======================== +=============================================== +**Setting Up Full ONAP using Virtual Machines** +=============================================== .. _demo-installing-running-onap: @@ -23,19 +23,12 @@ ONAP may be deployed in different contexts depending on your requirements. The recommended installation for Beijng Release over virtual machines is based on OpenStack HEAT Template. -Using the Beijing 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. 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 components deployed in -High Availability mode. - -The installation requires some manual tasks to setup the DCAE components. +components will be hosted in a unique tenant). .. _demo-installing-running-onap-requirements: @@ -55,7 +48,6 @@ You can use your private Cloud infrastructure. The following OpenStack components must be deployed in the infrastructure: - *Cinder* - - *Designate* - *Glance* - *Heat* - *Horizon* @@ -77,14 +69,6 @@ To deploy OpenStack, you can use various solutions: - `OpenStack installation with Ansible (All openstack services) <https://docs.openstack.org/openstack-ansible/latest/>`_ - `OpenStack Ocata installation scripts for testing environment(DO NOT install Heat, Designate and Cinder Volume services) <https://github.com/reachsrirams/openstack-scripts>`_ -Use the procedure below to deploy and configure *Designate* manually - -.. toctree:: - :maxdepth: 1 - - install-designate.rst - - The OpenStack infrastructure must enable internet access and you need to have an "External network" already configured properly. The External network ID will have to be provided in the Heat environment file. @@ -103,7 +87,7 @@ components, and provides VM information (flavor and image): onap-clamp CLAMP medium Ubuntu 16.04 onap-dns-server *Internal DNS* small Ubuntu 14.04 onap-message-router DMAAP large Ubuntu 14.04 - onap-multi-service MSB, VF-C, VNFSDK xxlarge Ubuntu 16.04 + onap-multi-service MSB, VF-C, VNFSDK xlarge Ubuntu 16.04 onap-policy Policy xlarge Ubuntu 14.04 onap-portal Portal, CLI large Ubuntu 14.04 onap-robot Integration medium Ubuntu 16.04 @@ -111,34 +95,22 @@ components, and provides VM information (flavor and image): onap-sdnc SDNC, CCSDK large Ubuntu 14.04 onap-so SO large Ubuntu 16.04 onap-vid VID medium Ubuntu 14.04 - onap-dcae-bootstrap DCAE, Holmes small Ubuntu 14.04 - dcaeorcl00 DCAE/Orchestr. medium CentOS 7 - dcaecnsl00 DCAE/Consul medium Ubuntu 16.04 - dcaecnsl01 DCAE/Consul medium Ubuntu 16.04 - dcaecnsl02 DCAE/Consul medium Ubuntu 16.04 - dcaedokp00 DCAE/Policy Hand. medium Ubuntu 16.04 - dcaedoks00 DCAE/VES, Holmes medium Ubuntu 16.04 - dcaepgvm00 DCAE/Postrges medium Ubuntu 16.04 - dcaecdap00 DCAE/CDAP large Ubuntu 16.04 - dcaecdap01 DCAE/CDAP large Ubuntu 16.04 - dcaecdap02 DCAE/CDAP large Ubuntu 16.04 - dcaecdap03 DCAE/CDAP large Ubuntu 16.04 - dcaecdap04 DCAE/CDAP large Ubuntu 16.04 - dcaecdap05 DCAE/CDAP large Ubuntu 16.04 - dcaecdap06 DCAE/CDAP large Ubuntu 16.04 + onap-dcae DCAE, Holmes small Ubuntu 14.04 + onap-music Music large Ubuntu 14.04 + onap-oof OOF large Ubuntu 16.04 + onap-aaf AAF medium Ubuntu 16.04 + onap-sms AAF medium Ubuntu 16.04 + onap-nbi External API small Ubuntu 16.04 =================== ================= ======= ============ Footprint --------- The ONAP installation requires the following footprint: - - 29 VM - - 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 update flavors of basic ONAP installation. + - 20 VM + - 88 vCPU + - 176 GB RAM + - 1.76 TB Storage + - 20 floating IP addresses .. Note: You should also reserve some resources for the VNFs to be deployed. @@ -149,16 +121,13 @@ The following artifacts must be deployed on the OpenStack infrastructure: - private SSH key and public key SSH key for the DCAE VM - Ubuntu 14.04 image (https://cloud-images.ubuntu.com/releases/14.04/14.04/) - Ubuntu 16.04 image (https://cloud-images.ubuntu.com/releases/16.04/release/) - - CentOS 7 image (http://cloud.centos.org/centos/7/images/) - - Set of flavors: small, medium, large, medium, large, xlarge, xxlarge + - Set of flavors: small, medium, large, xlarge .. 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 configured using the following values: - 12 vCPU, 64 GB RAM and 120 GB storage. Security -------- @@ -191,11 +160,11 @@ The environment file must be customized as described in the following sections. Description ----------- -The ONAP HEAT template spins up all the components expect the DCAE. +The ONAP Heat template spins up all the components including the DCAE. The template, onap_openstack.yaml, comes with an environment file, onap_openstack.env, in which all the default values are defined. -The HEAT template is composed of two sections: (i) parameters, and (ii) +The Heat template is composed of two sections: (i) parameters, and (ii) resources. The parameter section contains the declaration and description of the parameters that will be used to spin up ONAP, such as @@ -220,14 +189,14 @@ 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. -When the HEAT template is executed, the OpenStack HEAT engine creates -the resources defined in the HEAT template, based on the parameters +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. Environment file ---------------- -Before running HEAT, it is necessary to customize the environment file. +Before running Heat, it is necessary to customize the environment file. Indeed, some parameters, namely public_net_id, pub_key, openstack_tenant_id, openstack_username, and openstack_api_key, need to be set depending on the user's environment: @@ -291,7 +260,6 @@ OpenStack-based cloud. flavor_medium: PUT THE MEDIUM FLAVOR NAME HERE flavor_large: PUT THE LARGE FLAVOR NAME HERE flavor_xlarge: PUT THE XLARGE FLAVOR NAME HERE - flavor_xxlarge: PUT THE XXLARGE FLAVOR NAME HERE To get the images in your OpenStack environment, use the following OpenStack CLI command: @@ -311,12 +279,9 @@ following OpenStack CLI command: :: - dns_list: PUT THE ADDRESS OFTHE EXTERNAL DNS HERE (e.g. a comma-separated list - of IP addresses in your /etc/resolv.conf in UNIX-based Operating Systems). - THIS LIST MUST INCLUDE THE DNS SERVER THAT OFFERS DNS AS AS SERVICE - see DCAE section below for more details) + dns_list: PUT THE ADDRESS OF THE EXTERNAL DNS HERE (e.g. a comma-separated list + of IP addresses in your /etc/resolv.conf in UNIX-based Operating Systems) external_dns: PUT THE FIRST ADDRESS OF THE EXTERNAL DNS LIST HERE - 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 @@ -325,73 +290,18 @@ DNS servers. ONAP installs a DNS server used to resolve IP addresses in the ONAP OAM private network. -ONAP Beijing Release also requires OpenStack Designate DNS support for the -DCAE platform, so as to allow IP address discovery and communication among -DCAE elements. -This is required because the ONAP HEAT template only installs the DCAE -bootstrap container, which will in turn install the entire DCAE platform. -As such, at installation time, the IP addresses of the DCAE components are -unknown. - -The DNS server that ONAP installs needs to be connected to the Designate DNS to -allow communication between the DCAE elements and the other ONAP components. -To this end, dns\_list, external\_dns, and dns\_forwarder should all have the -IP address of the Designate DNS. -These three parameters are redundant, but still required for Beijing Release. -Originally, dns\_list and external\_dns were both used to circumvent some -limitations of older OpenStack versions. -In future releases, the DNS settings and parameters in HEAT will be -consolidated. -The Designate DNS is configured to access the external DNS. -As such, the ONAP DNS will forward to the Designate DNS the queries from ONAP -components to the external world. -The Designate DNS will then forward those queries to the external DNS. **DCAE Parameters** -DCAE spins up ONAP's data collection and analytics system in two phases. - -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: - -- 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. - -These parameters are described below: - +For Beijing Release, all the DCAE components are deployed in a single +virtual machine. +You must specify R2 to run R2 DCAE components. +Is you are using R1 to get R1 ONAP, you must fill all the other +DCAE parameters. +Please refer to the Amsterdam documentation to fill these parameters. :: - dcae_keystone_url: PUT THE MULTIVIM PROVIDED KEYSTONE API URL HERE - dcae_centos_7_image: PUT THE CENTOS7 VM IMAGE NAME HERE FOR DCAE LAUNCHED CENTOS7 VM - dcae_domain: PUT THE NAME OF DOMAIN THAT DCAE VMS REGISTER UNDER - dcae_public_key: PUT THE PUBLIC KEY OF A KEYPAIR HERE TO BE USED BETWEEN DCAE LAUNCHED VMS - dcae_private_key: PUT THE SECRET KEY OF A KEYPAIR HERE TO BE USED BETWEEN DCAE LAUNCHED VMS - - dnsaas_config_enabled: PUT WHETHER TO USE PROXYED DESIGNATE - dnsaas_region: PUT THE DESIGNATE PROVIDING OPENSTACK'S REGION HERE - dnsaas_keystone_url: PUT THE DESIGNATE PROVIDING OPENSTACK'S KEYSTONE URL HERE - dnsaas_tenant_name: PUT THE TENANT NAME IN THE DESIGNATE PROVIDING OPENSTACK HERE (FOR R1 USE THE SAME AS openstack_tenant_name) - dnsaas_username: PUT THE DESIGNATE PROVIDING OPENSTACK'S USERNAME HERE - dnsaas_password: PUT THE DESIGNATE PROVIDING OPENSTACK'S PASSWORD HERE + dcae_deployment_profile: PUT DCAE DEPLOYMENT PROFILE (R1, R2MVP, R2, or R2PLUS) Instantiation ------------- @@ -439,27 +349,25 @@ or Command Line. :: - # Old HEAT client + # Old Heat client + +:: + heat stack-create STACK_NAME -f PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE OR +:: + # New OpenStack client openstack stack create -t PATH_TO_HEAT_TEMPLATE(YAML FILE) -e PATH_TO_ENV_FILE STACK_NAME -.. Note The HEAT template deployment may take time (up to one hour) +.. Note The Heat template deployment may take time (up to one hour) depending on your hardware environment. -Deploy DCAE ------------ -The HEAT template deployed the onap-dcae-bootstrap virtual machine. - -.. Note To provide the manual tasks to configure the local environment - - Test the installation --------------------- Every ONAP component offers a HealthCheck REST API. The Robot Virtual Machine @@ -475,7 +383,7 @@ Run the following command to perform the HealthCheck: -V /share/config/integration_preload_parameters.py -V /share/config/vm_properties.py -This test suite will execute 30 tests towards the various ONAP components. +This test suite will execute 40 tests towards the various ONAP components. After the installation, it is possible to deploy the various use-cases described in `ONAP wiki - demos <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_. @@ -554,9 +462,10 @@ Other UI documentation: The list of various services and ports used can be found on the `ONAP wiki - services <https://wiki.onap.org/display/DW/ONAP+Services+List#ONAPServicesList-ONAPServices>`_ -.. 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 ONAP .. contents:: diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst new file mode 100644 index 000000000..d793376fa --- /dev/null +++ b/docs/guides/onap-developer/settingup/onap_oom.rst @@ -0,0 +1,25 @@ +.. This work is licensed undera Creative Commons Attribution 4.0 +.. International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 ONAP + + +.. contents:: + :depth: 2 +.. + +.. index:: Setting Up Full ONAP using Containers + + +========================================= +**Setting Up Full ONAP using Containers** +========================================= + + +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 ONAP + + +.. contents::
\ No newline at end of file |