summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/onap-developer/apiref/index.rst14
-rw-r--r--docs/guides/onap-developer/developing/index.rst49
-rw-r--r--docs/guides/onap-developer/settingup/index.rst23
-rw-r--r--docs/guides/onap-developer/settingup/onap_heat.rst2
-rw-r--r--docs/guides/onap-developer/settingup/onap_individual.rst28
-rw-r--r--docs/guides/onap-developer/settingup/onap_oom.rst54
-rw-r--r--docs/release/index.rst38
-rw-r--r--docs/release/releaserepos.rst61
m---------docs/submodules/clamp.git0
m---------docs/submodules/integration.git0
m---------docs/submodules/modeling/modelspec.git0
m---------docs/submodules/sdc.git0
12 files changed, 178 insertions, 91 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index 8ae5aab45..53b075b8f 100644
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -35,9 +35,9 @@ Platform Components
DCAE - Data Collection, Analytics, and Events <../../../submodules/dcaegen2.git/docs/sections/offeredapis.rst>
Holmes - Alarm Correlation <../../../submodules/holmes/rule-management.git/docs/platform/offeredapis.rst>
Policy <../../../submodules/policy/engine.git/docs/platform/offeredapis.rst>
+ SDNC - SDN Controller OAM <../../../submodules/sdnc/oam.git/docs/offeredapis.html>
SO - Service Orchestration <../../../submodules/so.git/docs/offered_consumed_apis.rst>
VFC - Virtual Function Controller <../../../submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.rst>
- NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst>
Common Services
---------------
@@ -46,13 +46,15 @@ Common Services
:maxdepth: 1
:titlesonly:
- AAI - Active and Available Inventory Common <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
- AAI - Active and Available Inventory ESR <../../../submodules/submodules/aai/esr-server.git/docs/offeredapis.rst>
- DMaaP - Data Management as a Platform Message Router <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
+ AAI - Active and Available Inventory <../../../submodules/aai/aai-common.git/docs/AAI REST API Documentation/AAIRESTAPI_AMSTERDAM.rst>
+ AAI ESR <../../../submodules/submodules/aai/esr-server.git/docs/offeredapis.rst>
+ DMAAP MR - Data Management as a Platform (Message Router) <../../../submodules/dmaap/messagerouter/messageservice.git/docs/offeredapis/offeredapis.rst>
+ ExtAPI- External API/NBI - NorthBound API <../../../submodules/externalapi/nbi.git/docs/offeredapis/index.rst>
Modeling Parsers <../../../submodules/modeling/toscaparsers.git/docs/offeredapis.rst>
MSB - Micro Services Bus <../../../submodules/msb/apigateway.git/docs/platform/offeredapis.rst>
- MultiVIM Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
- Music <../../../submodules/music.git/docs/offeredapis.rst>
+ Multi Cloud <../../../submodules/multicloud/framework.git/docs/MultiCloud-API-Specification-V1.rst>
+ MUSIC - Multi-site State Coordination Service <../../../submodules/music.git/docs/offeredapis.rst>
+ OPTF - Optimization Framework <../../../submodules/optf/osdf.git/docs/sections/offeredapis.rst>
VVP - VNF Validation Project <../../../submodules/vvp/documentation.git/docs/offeredapis.rst>
SDK
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index 331248c2f..d856ee4a1 100644
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/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.
@@ -33,6 +34,16 @@ Application Controller
../../../submodules/appc/deployment.git/docs/index
../../../submodules/appc.git/docs/index
+Command Line Interface
+----------------------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+ ../../../submodules/cli.git/docs/index
+
+
Closed Loop Automation Platform
-------------------------------
@@ -119,8 +130,8 @@ Integration
* ONAP Amsterdam release content is specified within a list of project artifact versions available in the form of a :ref:`manifest<doc-release-manifest>`.
* To install the whole ONAP (from a complete demo solution perspective) refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`.
-Logging Enhancements Project
-----------------------------
+Logging Analytics
+-----------------
.. toctree::
:maxdepth: 2
@@ -171,18 +182,8 @@ Music
../../../submodules/music.git/docs/index
-
-ONAP Command Line Interface
----------------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/cli.git/docs/index
-
-ONAP Operations Manager (experimental)
---------------------------------------
+ONAP Operations Manager
+-----------------------
.. toctree::
:maxdepth: 2
@@ -190,15 +191,6 @@ ONAP Operations Manager (experimental)
../../../submodules/oom.git/docs/index
-ONAP Use Case User Interface
-----------------------------
-
-.. toctree::
- :maxdepth: 2
- :titlesonly:
-
- ../../../submodules/usecase-ui.git/docs/index
-
Policy Framework
----------------
@@ -262,6 +254,15 @@ Software Defined Network Controller
../../../submodules/sdnc/parent.git/docs/index
../../../submodules/sdnc/plugins.git/docs/index
+Use Case User Interface
+-----------------------
+
+.. toctree::
+ :maxdepth: 2
+ :titlesonly:
+
+ ../../../submodules/usecase-ui.git/docs/index
+
User Interface Applications
---------------------------
diff --git a/docs/guides/onap-developer/settingup/index.rst b/docs/guides/onap-developer/settingup/index.rst
index f9b4881fe..d905a79c8 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.
+
+The various installations can be found here:
.. toctree::
:maxdepth: 1
:titlesonly:
- onap_heat.rst
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..a3a1b5bc7
--- /dev/null
+++ b/docs/guides/onap-developer/settingup/onap_individual.rst
@@ -0,0 +1,28 @@
+.. This work is licensed undera Creative Commons Attribution 4.0
+.. International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2017-2018 ONAP
+
+
+.. 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<index-setting-individual-components>`.
+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/.
+* ONAP is packaged within Docker and can be dowloaded from Docker Hub at https://hub.docker.com/r/onap.
+
diff --git a/docs/guides/onap-developer/settingup/onap_oom.rst b/docs/guides/onap-developer/settingup/onap_oom.rst
index d793376fa..7cb0d93a8 100644
--- a/docs/guides/onap-developer/settingup/onap_oom.rst
+++ b/docs/guides/onap-developer/settingup/onap_oom.rst
@@ -3,23 +3,55 @@
.. 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**
=========================================
+.. _installing-onap-k8s:
-.. 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 described here:
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ ../../../../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:
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+ ../../../../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..b4190ad8a 100644
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -17,7 +17,7 @@ Amsterdam and subsequent major release will be named using city names.
Getting Started With ONAP
-==========================
+=========================
Summary
-------
@@ -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
==============================
@@ -115,13 +118,13 @@ are compatible with a major release are made available.
.. index:: Download
-Download & Install
-==================
+Installation
+============
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) <installing-onap-k8s>`. Recommended method.
+* :ref:`Installation using Heat template <installing-onap-heat>`.
+* :ref:`Advanced installation to install individual components <installing-onap-individual>`.
Documentation
=============
@@ -149,7 +152,8 @@ ONAP has adopted the `CII Best Practice Badge Program <https://bestpractices.cor
- `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge#core-infrastructure-initiative-best-practices-badge>`_
- `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
-Project specific details are in the :ref:`release notes<doc-releaserepos>` for each project.
+Project specific details are in the :ref:`release notes<doc-releaserepos>`
+for each project.
Licenses
========
diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst
index 7c5efec0e..9127314b0 100644
--- a/docs/release/releaserepos.rst
+++ b/docs/release/releaserepos.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.
@@ -7,7 +8,8 @@
Project Specific Release Notes
++++++++++++++++++++++++++++++
-Each project is listed below followed by the Gerrit repositories in which there are release notes.
+Each project is listed below followed by the Gerrit repositories in which
+there are release notes.
Active and Available Inventory
------------------------------
@@ -45,6 +47,15 @@ Common Controller Software Development Kit
ccsdk<../submodules/ccsdk/distribution.git/docs/release-notes.rst>
+Command Line Interface
+----------------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ cli<../submodules/cli.git/docs/release-notes.rst>
+
Closed Loop Automation Platform
-------------------------------
@@ -83,7 +94,7 @@ Data Management as a Platform Message Router
dmaap<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes/release-notes.rst>
External API / NBI
-------
+------------------
.. toctree::
:maxdepth: 1
@@ -100,8 +111,8 @@ Holmes
holmes<../submodules/holmes/rule-management.git/docs/release-notes.rst>
-Logging Enhancements Project
-----------------------------
+Logging Analytics
+-----------------
.. toctree::
:maxdepth: 1
@@ -146,16 +157,6 @@ Music
music<../submodules/music.git/docs/release-notes.rst>
-
-ONAP Command Line Interface
----------------------------
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- cli<../submodules/cli.git/docs/release-notes.rst>
-
ONAP Operations Manager
-----------------------
@@ -165,23 +166,14 @@ ONAP Operations Manager
oom<../submodules/oom.git/docs/release-notes.rst>
-ONAP Optimization Framework
----------------------------
-
-.. toctree::
- :maxdepth: 1
- :titlesonly:
-
- oof<../submodules/optf/osdf.git/docs/sections/release-notes.rst>
-
-ONAP Use Case User Interface
-----------------------------
+Optimization Framework
+----------------------
.. toctree::
:maxdepth: 1
:titlesonly:
- usecase-ui<../submodules/usecase-ui.git/docs/release-notes.rst>
+ optf<../submodules/optf/osdf.git/docs/sections/release-notes.rst>
Policy Framework
----------------
@@ -210,6 +202,15 @@ Service Design & Creation
sdc<../submodules/sdc.git/docs/release-notes.rst>
+Service Orchestration
+---------------------
+
+.. toctree::
+ :maxdepth: 1
+ :titlesonly:
+
+ so<../submodules/so.git/docs/release-notes.rst>
+
Software Defined Network Controller
-----------------------------------
@@ -219,14 +220,14 @@ Software Defined Network Controller
sdnc<../submodules/sdnc/oam.git/docs/release-notes.rst>
-Service Orchestration
----------------------
+Use Case User Interface
+-----------------------
.. toctree::
:maxdepth: 1
:titlesonly:
- so<../submodules/so.git/docs/release-notes.rst>
+ usecase-ui<../submodules/usecase-ui.git/docs/release-notes.rst>
Virtual Function Controller
---------------------------
diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git
-Subproject 6b6521b5824f61dea05f400dba41092f3aaa069
+Subproject 64988b2f51acc927c01d0cc3b3985b521d2726a
diff --git a/docs/submodules/integration.git b/docs/submodules/integration.git
-Subproject 4c7d20e30fb2e5165b0d155c8d6de787662d467
+Subproject 0e0d76943af80fbe548ad2642b8a92d166d2423
diff --git a/docs/submodules/modeling/modelspec.git b/docs/submodules/modeling/modelspec.git
-Subproject 02a011c6f881ab7e64ad8136ce86dc6b200cad7
+Subproject 709de031ede9d9407a4830317b2c6c5f8969025
diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git
-Subproject e2268112ff8d8f482bfdde26457897eea0eb103
+Subproject 7fbbb01c091682ebd218b95104ddb806c8a0c29