summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer
diff options
context:
space:
mode:
Diffstat (limited to 'docs/guides/onap-developer')
-rw-r--r--docs/guides/onap-developer/apiref/index.rst3
-rw-r--r--docs/guides/onap-developer/architecture/media/ONAP-architecture.pngbin130630 -> 133346 bytes
-rwxr-xr-x[-rw-r--r--]docs/guides/onap-developer/architecture/media/ONAP-fncview.pngbin185554 -> 441038 bytes
-rw-r--r--docs/guides/onap-developer/architecture/onap-architecture.rst42
-rw-r--r--docs/guides/onap-developer/architecture/references.rst3
-rw-r--r--docs/guides/onap-developer/developing/index.rst59
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/addendum.rst158
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/index.rst1
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/introduction.rst16
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/setting-up.rst137
10 files changed, 221 insertions, 198 deletions
diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index 9a8970eca..c251416f4 100644
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -20,7 +20,7 @@ User Interfaces
:maxdepth: 1
:titlesonly:
-* :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:master_index>`
+* :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-clamp:master_index>`
* :ref:`Portal<onap-portal:offeredapis>`
* :ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>`
* :ref:`VID - Virtual Infrastructure Deployment<onap-vid:offeredapis>`
@@ -51,6 +51,7 @@ Common Services
* :ref:`AAF - Application Authorization Framework<onap-aaf-sms:offeredapis>`
* :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>`
* :ref:`AAI ESR - AAI External System Register<onap-aai-esr-server:offeredapis>`
+* :ref:`CPS - Configuration Persistence Service<onap-cps:design>`
* :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-dbcapi:offeredapis>`
* :ref:`DMAAP DR - Data Management as a Platform (Data Router)<onap-dmaap-datarouter:master_index>`
* :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:offeredapis>`
diff --git a/docs/guides/onap-developer/architecture/media/ONAP-architecture.png b/docs/guides/onap-developer/architecture/media/ONAP-architecture.png
index a390fae79..82a8a1b3e 100644
--- a/docs/guides/onap-developer/architecture/media/ONAP-architecture.png
+++ b/docs/guides/onap-developer/architecture/media/ONAP-architecture.png
Binary files differ
diff --git a/docs/guides/onap-developer/architecture/media/ONAP-fncview.png b/docs/guides/onap-developer/architecture/media/ONAP-fncview.png
index 570629d07..5497edb30 100644..100755
--- a/docs/guides/onap-developer/architecture/media/ONAP-fncview.png
+++ b/docs/guides/onap-developer/architecture/media/ONAP-fncview.png
Binary files differ
diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst
index d94e42890..6ced443f7 100644
--- a/docs/guides/onap-developer/architecture/onap-architecture.rst
+++ b/docs/guides/onap-developer/architecture/onap-architecture.rst
@@ -114,22 +114,27 @@ microservices-based platform components.**
Figure 2 below, provides a simplified functional view of the architecture,
which highlights the role of a few key components:
-#. Design time environment for onboarding services and resources into ONAP and
- designing required services.
-#. External API provides northbound interoperability for the ONAP Platform and
- Multi-VIM/Cloud provides cloud interoperability for the ONAP workloads.
+#. ONAP Design time environment provides onboarding services and resources
+ into ONAP and designing required services.
+#. External API provides northbound interoperability for the ONAP Platform.
+#. ONAP Runtime environment provides a model- and policy-driven orchestration
+ and conrol framework for an automated instantiation and configuration of
+ services and resources. Multi-VIM/Cloud provides cloud interoperability for
+ the ONAP workloads. Analytic framework that closely monitors the service
+ behavior handles close loop management for handling healing, scaling and
+ update dynamically.
#. OOM provides the ability to manage cloud-native installation and deployments
to Kubernetes-managed cloud environments.
#. ONAP Shared Services provides shared capabilities for ONAP modules. The ONAP
Optimization Framework (OOF) provides a declarative, policy-driven approach
for creating and running optimization applications like Homing/Placement,
- and Change Management Scheduling Optimization.
-#. ONAP shared utilities provide utilities for the support of the ONAP
- components.
-#. Information Model and framework utilities continue to evolve to harmonize
- the topology, workflow, and policy models from a number of SDOs including
- ETSI NFV MANO, ETSI/3GPP, O-RAN, TM Forum SID, ONF Core, OASIS TOSCA, IETF,
- and MEF.
+ and Change Management Scheduling Optimization. ONAP shared utilities provide
+ utilities for the support of the ONAP components.
+
+Information Model and framework utilities continue to evolve to harmonize
+the topology, workflow, and policy models from a number of SDOs including
+ETSI NFV MANO, ETSI/3GPP, O-RAN, TM Forum SID, ONF Core, OASIS TOSCA, IETF,
+and MEF.
|image2|
@@ -414,18 +419,25 @@ capabilities with the introduction of adaptive policy execution.
Shared Services
===============
ONAP provides a set of operational services for all ONAP components including
-activity logging, reporting, common data layer, access control, secret and
-credential management, resiliency, and software lifecycle management.
+activity logging, reporting, common data layer, configuration, persistence, access control,
+secret and credential management, resiliency, and software lifecycle management.
These services provide access management and security enforcement, data backup,
-restoration and recovery. They support standardized VNF interfaces and
-guidelines.
+configuration persistence, restoration and recovery. They support standardized
+VNF interfaces and guidelines.
Operating in a virtualized environment introduces new security challenges and
opportunities. ONAP provides increased security by embedding access controls in
each ONAP platform component, augmented by analytics and policy components
specifically designed for the detection and mitigation of security violations.
+Configuration Persistence Service (CPS)
+---------------------------------------
+The Configuration Persistence Service (CPS) provides storage for real-time run-time configuration
+and operational parameters that need to be used by ONAP.
+In R8, Honolulu, the CPS is a stand-alone component, and its details in
+:ref:`CPS - Configuration Persistence Service<onap-cps:architecture>`.
+
ONAP Modeling
=============
ONAP provides models to assist with service design, the development of ONAP
diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst
index 93b4dc68a..8b22da02f 100644
--- a/docs/guides/onap-developer/architecture/references.rst
+++ b/docs/guides/onap-developer/architecture/references.rst
@@ -30,7 +30,7 @@ User Interfaces
:titlesonly:
| :ref:`APPC CDT Application Controller Design Tool<onap-appc:appc_lcm_api_guide>`
-| :ref:`CLAMP - Closed Loop Automation Platform<onap-clamp:architecture>`
+| :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-clamp:architecture>`
| :ref:`CLI - Command Line Interface<onap-cli:architecture>`
| :ref:`PORTAL<onap-portal:architecture>`
| :ref:`SDC - Service Design and Creation<onap-sdc:architecture>`
@@ -62,6 +62,7 @@ Common Services
| :ref:`AAF - Application Authorization Framework<onap-aaf-authz:master_index>`
| :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:architecture>`
| :ref:`AAI ESR<onap-aai-esr-gui:architecture>`
+| :ref:`CPS - Configuration Persistence Service<onap-cps:architecture>`
| :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:architecture>`
| :ref:`ExtAPI - External API NBI<onap-externalapi-nbi:architecture>`
| :ref:`Logging Framework -<onap-logging-analytics:logging_user_guide>`
diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst
index f0136dc5e..99fbb66cd 100644
--- a/docs/guides/onap-developer/developing/index.rst
+++ b/docs/guides/onap-developer/developing/index.rst
@@ -48,8 +48,8 @@ AAF - Application Authorization Framework
* - Document
- Description
- * - (in Maintenance) `AAF (Frankfurt) <https://docs.onap.org/projects/onap-aaf-authz/en/frankfurt/>`_
- - AAF Architecture, APIs and Guides
+ * - :ref:`AAF (Latest)<onap-aaf-authz:master_index>`
+ - (unmaintained) AAF Architecture, APIs and Guides
AAI - Active and Available Inventory
------------------------------------
@@ -62,11 +62,11 @@ AAI - Active and Available Inventory
- Description
* - :ref:`AAI<onap-aai-aai-common:master_index>`
- AAI Architecture, APIs and Guides
- * - (in Maintenance) `ESR GUI (Latest) <https://docs.onap.org/projects/onap-aai-esr-gui/en/latest/>`_
- - External System Registry GUI Documentation
- * - (in Maintenance) `ESR Server (Latest) <https://docs.onap.org/projects/onap-aai-esr-server/en/latest/>`_
- - External System Registry Server Documentation
- * - (in Maintenance) :ref:`AAI UI<onap-aai-sparky-be:master_index>`
+ * - :ref:`ESR GUI (Latest)<onap-aai-esr-gui:master_index>`
+ - (unmaintained) External System Registry GUI Documentation
+ * - :ref:`ESR Server (Latest)<onap-aai-esr-server:master_index>`
+ - (unmaintained) External System Registry Server Documentation
+ * - :ref:`AAI UI<onap-aai-sparky-be:master_index>`
- Sparky - AAI Inventory UI Documentation
APPC - Application Controller
@@ -78,10 +78,10 @@ APPC - Application Controller
* - Document
- Description
- * - (in Maintenance) `APPC (Frankfurt) <https://docs.onap.org/projects/onap-appc/en/frankfurt/>`_
- - APPC Architecture, APIs and Guides
- * - (in Maintenance) `APPC Deployment (Frankfurt) <https://docs.onap.org/projects/onap-appc-deployment/en/frankfurt/>`_
- - APPC Deployment Documentation
+ * - :ref:`APPC (Frankfurt)<onap-appc:master_index>`
+ - (unmaintained) APPC Architecture, APIs and Guides
+ * - :ref:`APPC Deployment (Frankfurt)<onap-appc-deployment:master_index>`
+ - (unmaintained) APPC Deployment Documentation
CCSDK - Common Controller Software Development Kit
--------------------------------------------------
@@ -116,7 +116,7 @@ CLAMP - Control Loop Automation Management Platform
* - Document
- Description
- * - :ref:`CLAMP <onap-clamp:master_index>`
+ * - :ref:`CLAMP <onap-policy-clamp:master_index>`
- CLAMP Architecture and Guides
CLI - Command Line Interface
@@ -131,6 +131,18 @@ CLI - Command Line Interface
* - :ref:`CLI <onap-cli:master_index>`
- CLI Documentation
+CPS - Configuration Persistence Service
+---------------------------------------
+
+.. list-table::
+ :widths: 20 80
+ :header-rows: 1
+
+ * - Document
+ - Description
+ * - :ref:`CPS <onap-cps:master_index>`
+ - CPS Documentation
+
DCAE - Data Collection, Analysis and Events
-------------------------------------------
@@ -143,8 +155,8 @@ DCAE - Data Collection, Analysis and Events
* - :ref:`DCAE<onap-dcaegen2:master_index>`
- DCAE Architecture and Guides
-DMAAP - Data Management as a Platform
--------------------------------------
+DMAAP - Data Movement as a Platform
+-----------------------------------
.. list-table::
:widths: 20 80
@@ -194,8 +206,8 @@ LOGGING - Centralized Logging
* - Document
- Description
- * - (in Maintenance) `LOGGING (Latest) <https://docs.onap.org/projects/onap-logging-analytics/en/latest/>`_
- - ONAP Centralized Logging Documentation
+ * - :ref:`LOGGING (Latest)<onap-logging-analytics:master_index>`
+ - (unmaintained) ONAP Centralized Logging Documentation
MSB - Microservices Bus
-----------------------
@@ -230,10 +242,10 @@ MUSIC - ONAP Multi-Site Integration
* - Document
- Description
- * - (in Maintenance) `MUSIC (Frankfurt) <https://docs.onap.org/projects/onap-music/en/frankfurt/>`_
- - MUSIC Architecture and Guides
- * - (in Maintenance) `MUSIC KV (Latest) <https://docs.onap.org/projects/onap-music-distributed-kv-store/en/latest/>`_
- - MUSIC Distribute KV Store Documents
+ * - :ref:`MUSIC (Frankfurt)<onap-music:master_index>`
+ - (unmaintained) MUSIC Architecture and Guides
+ * - :ref:`MUSIC KV (Latest)<onap-music-distributed-kv-store:master_index>`
+ - (unmaintained) MUSIC Distribute KV Store Documents
OOF - Optimization Framework
----------------------------
@@ -264,6 +276,9 @@ OOM - ONAP Operations Manager
- ONAP Operations Manager Documentation
* - :ref:`OOM Certification Service<onap-oom-platform-cert-service:master_index>`
- ONAP CMPv2 certification support
+ * - :ref:`OOM Offline Installer<onap-oom-offline-installer:master_index>`
+ - OOM Offline Installer
+
ORAN - Open-RAN Support in ONAP
-------------------------------
@@ -298,8 +313,8 @@ PORTAL - Portal Platform
* - Document
- Description
- * - :ref:`Portal<onap-portal:master_index>`
- - ONAP Portal Platform Documentation
+ * - :ref:`Portal (Guilin)<onap-portal:master_index>`
+ - (unmaintained) ONAP Portal Platform Documentation
SDC - Service Design & Creation
-------------------------------
diff --git a/docs/guides/onap-developer/how-to-use-docs/addendum.rst b/docs/guides/onap-developer/how-to-use-docs/addendum.rst
deleted file mode 100644
index e3b209cbe..000000000
--- a/docs/guides/onap-developer/how-to-use-docs/addendum.rst
+++ /dev/null
@@ -1,158 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0
-.. International License. http://creativecommons.org/licenses/by/4.0
-
-Addendum
-========
-
-Index File
-----------
-
-The index file must relatively reference your other rst files in that directory.
-
-Here is an example index.rst :
-
-.. code-block:: bash
-
- *******************
- Documentation Title
- *******************
-
- .. toctree::
- :numbered:
- :maxdepth: 2
-
- documentation-example
-
-Source Files
-------------
-
-Document source files have to be written in reStructuredText format (rst).
-Each file would be built as an html page.
-
-Here is an example source rst file :
-
-.. code-block:: bash
-
- =============
- Chapter Title
- =============
-
- Section Title
- =============
-
- Subsection Title
- ----------------
-
- Hello!
-
-Writing RST Markdown
---------------------
-
-See http://sphinx-doc.org/rest.html .
-
-**Hint:**
-You can add html content that only appears in html output by using the
-'only' directive with build type
-('html' and 'singlehtml') for an ONAP document. But, this is not encouraged.
-
-.. code-block:: bash
-
- .. only:: html
- This line will be shown only in html version.
-
-
-Creating Indices
-----------------
-
-Building an index for your Sphinx project is relatively simple. First, tell Sphinx that
-you want it to build an index by adding something like this after your TOC tree:
-
-.. code-block:: rst
-
- Indices and Search
- ==================
-
- * :ref:`genindex`
- * :ref:`search`
-
-**Hint:**
-Note that search was included here. It works out of the box with any Sphinx project, so you
-don't need to do anything except include a reference to it in your :code:`index.rst` file.
-
-Now, to generate a index entry in your RST, do one of the following:
-
-.. code-block:: rst
-
- Some content that requires an :index:`index`.
-
-or
-
-.. code-block:: rst
-
- .. index::
- single: myterm
-
- Some header containing myterm
- =============================
-
-In the second case, Sphinx will create a link in the index to the paragraph that follows
-the index entry declaration.
-
-When your project is built, Sphinx will generate an index page populated with the entries
-you created in the source RST.
-
-These are simple cases with simple options. For more information about indexing with Sphinx,
-please see the `official Sphinx documentation <http://www.sphinx-doc.org/en/stable/markup/misc.html>`_.
-
-
-Jenkins Jobs
-------------
-
-Verify Job
-++++++++++
-
-The verify job name is **doc-{stream}-verify-rtd**
-
-Proposed changes in files in any repository with top level docs folder
-in the repository and RST files in below this folder
-will be verified by this job as part of a gerrit code review.
-
-.. Important::
- The contributing author and every reviewer on a gerrit code review
- should always review the Jenkins log before approving and merging a
- change. The log review should include:
-
- * Using a browser or other editor to search for a pattern in the
- *console log* that matches files in the patch set. This will quickly
- identify errors and warnings that are related to the patch set and
- repository being changed.
-
- * Using a browser to click on the *html* folder included in the log
- and preview how the proposed changes will look when published at
- Read The Docs. Small changes can be easily made in the patch set.
-
-Merge Job
-+++++++++
-
-The merge job name is **doc-{stream}-merge-rtd**.
-
-When a committer merges a patch that includes files matching the
-path described above, the doc project merge job will trigger an
-update at readthedocs. There may be some delay after the merge job
-completes until new version appears at Read The Docs.
-
-Read The Docs URLs
-------------------
-
-When referencing versions of documentation a Read The Docs the following
-URL conventions should be used
-
- +----------------------------------+----------------------------------------+
- | URL | To Refer to |
- +==================================+========================================+
- | docs.onap.org | Most recent approved named release |
- +----------------------------------+----------------------------------------+
- | docs.onap.org/en/latest | Latest master branch all projects |
- +----------------------------------+----------------------------------------+
- | docs.onap.org/en/*named release* | An approved name release eg. amsterdam |
- +----------------------------------+----------------------------------------+
diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst
index 2e7e47acf..3c65f331a 100644
--- a/docs/guides/onap-developer/how-to-use-docs/index.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/index.rst
@@ -14,7 +14,6 @@ Creating Documentation
api-swagger-guide
templates
converting-to-rst
- addendum
.. toctree::
:hidden:
diff --git a/docs/guides/onap-developer/how-to-use-docs/introduction.rst b/docs/guides/onap-developer/how-to-use-docs/introduction.rst
index 250313fc4..242a2d239 100644
--- a/docs/guides/onap-developer/how-to-use-docs/introduction.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/introduction.rst
@@ -208,3 +208,19 @@ files:
When there are subsequent, significant contributions to a source file
from a different contributor, a new copyright line may be appended
after the last existing copyright line.
+
+Read The Docs URLs
+------------------
+
+When referencing versions of documentation a Read The Docs the following
+URL conventions should be used
+
+ +----------------------------------+----------------------------------------+
+ | URL | To Refer to |
+ +==================================+========================================+
+ | docs.onap.org | Most recent approved named release |
+ +----------------------------------+----------------------------------------+
+ | docs.onap.org/en/latest | Latest master branch all projects |
+ +----------------------------------+----------------------------------------+
+ | docs.onap.org/en/*named release* | An approved name release eg. amsterdam |
+ +----------------------------------+----------------------------------------+
diff --git a/docs/guides/onap-developer/how-to-use-docs/setting-up.rst b/docs/guides/onap-developer/how-to-use-docs/setting-up.rst
index 509e7aff1..789cf0b9d 100644
--- a/docs/guides/onap-developer/how-to-use-docs/setting-up.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/setting-up.rst
@@ -409,6 +409,143 @@ Because the labels have to be unique, it usually makes sense to prefix
the labels with the project name to help share the label space, e.g.,
``sfc-user-guide`` instead of just ``user-guide``.
+Index File
+----------
+
+The index file must relatively reference your other rst files in that directory.
+
+Here is an example index.rst :
+
+.. code-block:: bash
+
+ *******************
+ Documentation Title
+ *******************
+
+ .. toctree::
+ :numbered:
+ :maxdepth: 2
+
+ documentation-example
+
+Source Files
+------------
+
+Document source files have to be written in reStructuredText format (rst).
+Each file would be built as an html page.
+
+Here is an example source rst file :
+
+.. code-block:: bash
+
+ =============
+ Chapter Title
+ =============
+
+ Section Title
+ =============
+
+ Subsection Title
+ ----------------
+
+ Hello!
+
+Writing RST Markdown
+--------------------
+
+See http://sphinx-doc.org/rest.html .
+
+**Hint:**
+You can add html content that only appears in html output by using the
+'only' directive with build type
+('html' and 'singlehtml') for an ONAP document. But, this is not encouraged.
+
+.. code-block:: bash
+
+ .. only:: html
+ This line will be shown only in html version.
+
+
+Creating Indices
+----------------
+
+Building an index for your Sphinx project is relatively simple. First, tell Sphinx that
+you want it to build an index by adding something like this after your TOC tree:
+
+.. code-block:: rst
+
+ Indices and Search
+ ==================
+
+ * :ref:`genindex`
+ * :ref:`search`
+
+**Hint:**
+Note that search was included here. It works out of the box with any Sphinx project, so you
+don't need to do anything except include a reference to it in your :code:`index.rst` file.
+
+Now, to generate a index entry in your RST, do one of the following:
+
+.. code-block:: rst
+
+ Some content that requires an :index:`index`.
+
+or
+
+.. code-block:: rst
+
+ .. index::
+ single: myterm
+
+ Some header containing myterm
+ =============================
+
+In the second case, Sphinx will create a link in the index to the paragraph that follows
+the index entry declaration.
+
+When your project is built, Sphinx will generate an index page populated with the entries
+you created in the source RST.
+
+These are simple cases with simple options. For more information about indexing with Sphinx,
+please see the `official Sphinx documentation <http://www.sphinx-doc.org/en/stable/markup/misc.html>`_.
+
+
+Jenkins Jobs
+------------
+
+Verify Job
+++++++++++
+
+The verify job name is **doc-{stream}-verify-rtd**
+
+Proposed changes in files in any repository with top level docs folder
+in the repository and RST files in below this folder
+will be verified by this job as part of a gerrit code review.
+
+.. Important::
+ The contributing author and every reviewer on a gerrit code review
+ should always review the Jenkins log before approving and merging a
+ change. The log review should include:
+
+ * Using a browser or other editor to search for a pattern in the
+ *console log* that matches files in the patch set. This will quickly
+ identify errors and warnings that are related to the patch set and
+ repository being changed.
+
+ * Using a browser to click on the *html* folder included in the log
+ and preview how the proposed changes will look when published at
+ Read The Docs. Small changes can be easily made in the patch set.
+
+Merge Job
++++++++++
+
+The merge job name is **doc-{stream}-merge-rtd**.
+
+When a committer merges a patch that includes files matching the
+path described above, the doc project merge job will trigger an
+update at readthedocs. There may be some delay after the merge job
+completes until new version appears at Read The Docs.
+
Testing
=======