From 4f36fca628b68db603ddd95ab53b9ff4e1c8ab5e Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Tue, 5 Jun 2018 22:45:51 +0000 Subject: [PATCH] Update setting up ONAP Update release note with links to setting up files Update various setting up files Issue-ID: DOC-269 Change-Id: I2149026bdf10c694904a5b95a990775d288b40c1 Signed-off-by: Eric Debeau --- docs/guides/onap-developer/settingup/index.rst | 23 +++++++++++-- docs/guides/onap-developer/settingup/onap_heat.rst | 2 +- .../onap-developer/settingup/onap_individual.rst | 33 +++++++++++++++++++ docs/guides/onap-developer/settingup/onap_oom.rst | 38 +++++++++++++++++++--- docs/release/index.rst | 32 ++++++++++-------- 5 files changed, 106 insertions(+), 22 deletions(-) create mode 100644 docs/guides/onap-developer/settingup/onap_individual.rst diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst index f9b4881fe..bbd9fa72f 100644 --- a/docs/guides/onap-developer/settingup/index.rst +++ b/docs/guides/onap-developer/settingup/index.rst @@ -7,11 +7,30 @@ Setting Up ONAP =============== -ONAP can be deployed using 2 different solutions: +ONAP can be deployed using 3 different solutions: + +* Installation using Kubernetes (aka OOM). Recommended method. +* Installation using Heat template. +* Advanced installation to install individual components. + +The following table presents the required resources to deploy ONAP. + + ============ === ==== =========== ============ + Installation VM vCPU Memory (GB) Storage (GB) + ============ === ==== =========== ============ + Kubernetes 4 32 128 160 + Heat 20 88 176 1760 + Individual 1* 1* 2* 20* + ============ === ==== =========== ============ + +(*) For individual deployment, it depends on the components. .. toctree:: :maxdepth: 1 :titlesonly: - onap_heat.rst +Depending on + onap_oom.rst + onap_heat.rst + onap_individual.rst diff --git a/docs/guides/onap-developer/settingup/onap_heat.rst b/docs/guides/onap-developer/settingup/onap_heat.rst index 833393d33..bdcd212d0 100644 --- a/docs/guides/onap-developer/settingup/onap_heat.rst +++ b/docs/guides/onap-developer/settingup/onap_heat.rst @@ -15,7 +15,7 @@ **Setting Up Full ONAP using Virtual Machines** =============================================== -.. _demo-installing-running-onap: +.. _installing-onap-heat: **Context** =========== diff --git a/docs/guides/onap-developer/settingup/onap_individual.rst b/docs/guides/onap-developer/settingup/onap_individual.rst new file mode 100644 index 000000000..a24f17a23 --- /dev/null +++ b/docs/guides/onap-developer/settingup/onap_individual.rst @@ -0,0 +1,33 @@ +.. 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 ONAP individual components + + +========================================= +**Setting Up ONAP individual components** +========================================= + +.. _installing-onap-individual: + +**Context** +=========== +From a developer perspective, ONAP can be installed component per component. +For details, refer to :ref:`the installation procedure available for each component`. +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 `_. +* The ONAP Source Code is available through Gerrit at https://gerrit.onap.org or Git at https://git.onap.org/. +* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap. + +.. contents:: diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst index d793376fa..a43c600ee 100644 --- a/docs/guides/onap-developer/settingup/onap_oom.rst +++ b/docs/guides/onap-developer/settingup/onap_oom.rst @@ -15,11 +15,39 @@ **Setting Up Full ONAP using Containers** ========================================= +.. _installing-onap-heat: -.. This work is licensed under a Creative Commons Attribution 4.0 -.. International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2018 ONAP +**Context** +=========== + +The recommended installation is based on Kubernetes to deploy ONAP +components using containers. + +You must use the following version for the various sofware components. + + =========== ======= + Software Version + =========== ======= + Kubernetes 1.8.10 + Helm 2.8.2 + kubectl 1.8.10 + Docker 17.03.x + =========== ======= + +Creation of Kubernetes cluster is available here: + ../../../submodules/oom.git/docs/oom_cloud_setup_guide.rst + + +The ONAP full installation requires the following footprint: + - 4 VM + - 32 vCPU + - 128 GB RAM + - 160 GB Storage +ONAP installation is described here: + ../../../submodules/oom.git/docs/oom_quickstart_guide.rst -.. contents:: \ No newline at end of file +.. note:: + 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. diff --git a/docs/release/index.rst b/docs/release/index.rst index a60eac5d0..45cec45d6 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -45,8 +45,8 @@ services, and products: repositories to define/simulate/certify system assets as well as their associated processes and policies. - - A VNF Software Development Kit (VNFSDK) and VNF Validation Program (VVP) with tools for VNF supplier - packaging and validation. + - A VNF Software Development Kit (VNFSDK) and VNF Validation Program (VVP) + with tools for VNF supplier packaging and validation. - Policy Creation (POLICY) deals with conditions, requirements, constraints, attributes, or needs that must be provided, maintained, @@ -55,8 +55,8 @@ services, and products: - Closed Loop Automation Management Platform (CLAMP) provides a method for designing and managing control loops. - - Optimization Framework (OOF) provides a policy-driven and model-driven framework - for creating optimization applications. + - Optimization Framework (OOF) provides a policy-driven and model-driven + framework for creating optimization applications. **Runtime Framework** - The runtime execution framework executes the rules and policies distributed by the design and creation environment @@ -95,14 +95,17 @@ Detect -> Publish -> Respond: VNFs and Network Services. - Common Services - operational services for all ONAP components including - activity logging, reporting, common data layer, access control, resiliency, multisite state coordination, - credential/secret management and software lifecycle management. - -**Microservices Support** + activity logging, reporting, common data layer, access control, resiliency, + multisite state coordination, credential/secret management and + software lifecycle management. - - ONAP Operation Manager (OOM) use kubernetes and Helm to manage ONAP components. +**Microservices Support** + + - ONAP Operation Manager (OOM) use kubernetes and Helm to manage ONAP + components. - Microservices Bus (MSB) provides service registration/discovery, - external API gateway, internal API gateway, client software development kit (SDK), and Swagger SDK. + external API gateway, internal API gateway, client software development kit + (SDK), and Swagger SDK. Project Specific Release Notes ============================== @@ -119,9 +122,9 @@ Download & Install ================== There are 3 approaches to install ONAP: -* Installation using Kubernetes (aka OOM). Recommended method -* Installation using Heat template -* Advanced installation to install individual components +* :ref:`Installation using Kubernetes (aka OOM) `. Recommended method. +* :ref:`Installation using Heat template `. +* :ref:`Advanced installation to install individual components `. Documentation ============= @@ -149,7 +152,8 @@ ONAP has adopted the `CII Best Practice Badge Program `_ - `Badging Status for all ONAP projects `_ -Project specific details are in the :ref:`release notes` for each project. +Project specific details are in the :ref:`release notes` +for each project. Licenses ======== -- 2.16.6