diff options
Diffstat (limited to 'docs')
30 files changed, 29 insertions, 127 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index 896c23170..89959914c 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -58,6 +58,12 @@ The following sequence will do this over ssh. If your access network restricts ssh, you will need to use equivalent git commands and HTTP Passwords as described `here <http://wiki.onap.org/x/X4AP>`_. +.. caution:: + + Don't replace ../ in *git submodule add* with any relative path on + your local file system. It refers to the location of your repository + on the server. + .. code-block:: bash git clone ssh://$lfid@gerrit.onap.org:29418/doc @@ -507,4 +513,3 @@ scan for output that applies to the files you are validating. tox -espellcheck more < docs/_build/spellcheck/output.txt - diff --git a/docs/guides/onap-user/design/pre-onboarding/index.rst b/docs/guides/onap-user/design/pre-onboarding/index.rst index 155ec56fb..7a09f0db5 100644 --- a/docs/guides/onap-user/design/pre-onboarding/index.rst +++ b/docs/guides/onap-user/design/pre-onboarding/index.rst @@ -2,6 +2,8 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Contributors. All rights reserved. +.. _doc_guide_user_des_pre-onb: + Pre-Onboarding ============== diff --git a/docs/guides/onap-user/design/resource-onboarding/index.rst b/docs/guides/onap-user/design/resource-onboarding/index.rst index 4a3cbc1e3..592651ee2 100644 --- a/docs/guides/onap-user/design/resource-onboarding/index.rst +++ b/docs/guides/onap-user/design/resource-onboarding/index.rst @@ -2,6 +2,8 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Contributors. All rights reserved. +.. _doc_guide_user_des_res-onb: + Resource Onboarding =================== **Goal:** Add models and other artifacts required to create, configure, instantiate, and manage a VF and, optionally, a VFC. diff --git a/docs/guides/onap-user/design/service-design/index.rst b/docs/guides/onap-user/design/service-design/index.rst index dcc6b9c62..83217bdcc 100644 --- a/docs/guides/onap-user/design/service-design/index.rst +++ b/docs/guides/onap-user/design/service-design/index.rst @@ -2,6 +2,8 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Contributors. All rights reserved. +.. _doc_guide_user_des_ser-des: + Service Design ============== @@ -30,7 +32,7 @@ instantiate, and manage services. Validate and certify the services. Create a Service ---------------- -**Prerequisites:** Create VFs required for this service (see :ref:`vfcreation-and-testing`). +**Prerequisites:** Create VFs required for this service (see :ref:`doc_guide_user_des_vf-cre`). #. From the SDC HOME page, hover over Add and select Add Service. #. In the General section, complete all fields. diff --git a/docs/guides/onap-user/design/service-distribution/index.rst b/docs/guides/onap-user/design/service-distribution/index.rst index 4ed231047..8de0e9232 100644 --- a/docs/guides/onap-user/design/service-distribution/index.rst +++ b/docs/guides/onap-user/design/service-distribution/index.rst @@ -2,6 +2,8 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Contributors. All rights reserved. +.. _doc_guide_user_des_ser-dis: + Governance Approval and Service Distribution ============================================ diff --git a/docs/guides/onap-user/design/vfcreation/index.rst b/docs/guides/onap-user/design/vfcreation/index.rst index 39130665a..0b49b994d 100644 --- a/docs/guides/onap-user/design/vfcreation/index.rst +++ b/docs/guides/onap-user/design/vfcreation/index.rst @@ -2,7 +2,7 @@ .. International License. http://creativecommons.org/licenses/by/4.0 .. Copyright 2019 ONAP Doc Team. All rights reserved. -.. _vfcreation-and-testing: +.. _doc_guide_user_des_vf-cre: VF Creation and Testing ======================= diff --git a/docs/guides/overview/overview.rst b/docs/guides/overview/overview.rst index 83c7e9de8..fc4570532 100644 --- a/docs/guides/overview/overview.rst +++ b/docs/guides/overview/overview.rst @@ -152,7 +152,9 @@ is named after a city. +----------------------+----------------+----------------------+-----------------------------------------------------------+ |Release Name |Release version |Release Date |Features delivered | +======================+================+======================+===========================================================+ -|Casablanca |* 3.0.2 |* 31 January 2019 | :ref:`Casablanca Release Notes <casablancarelease-notes>` | +|Dublin |4.0.0 |2019 | :ref:`Dublin Release Notes <dublinrelease-notes>` | ++----------------------+----------------+----------------------+-----------------------------------------------------------+ +|Casablanca |* 3.0.2 |* 31 January 2019 | | | |* 3.0.1 |* 30 November 2018 | | | |* 3.0.0 |* 15 April 2019 | | +----------------------+----------------+----------------------+-----------------------------------------------------------+ diff --git a/docs/index.rst b/docs/index.rst index 9902db952..fc772b8bb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,6 +23,9 @@ Please find some guidance here on the content of ONAP documentation: +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | Main documentation areas | Description | +=================================================================================+===============================================================================================+ + | :ref:`Release Notes <dublinrelease-notes>` | The Release Notes besides providing the basic information on the main release, also | + | | presents link to the release information of each, specific ONAP component. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`ONAP Overview <overview>` | ONAP Overview provides generic and high-level guidance on the mission and main | | | functionalities of ONAP. Basic guidelines on license details, limitations and | | | security references support understanding the solution. | @@ -62,8 +65,8 @@ Please find some guidance here on the content of ONAP documentation: :hidden: Home <self> - guides/overview/index release/index + guides/overview/index guides/onap-developer/architecture/index guides/onap-developer/developing/index guides/onap-developer/settingup/index diff --git a/docs/release/index.rst b/docs/release/index.rst index c3bcba2f4..99b1400ff 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -2,7 +2,7 @@ International License. http://creativecommons.org/licenses/by/4.0 -.. _casablancarelease-notes: +.. _dublinrelease-notes: Dublin Release Notes ^^^^^^^^^^^^^^^^^^^^ @@ -11,8 +11,7 @@ This page provides the release notes for the ONAP Dublin release. This includes outstanding trouble reports. Release notes are cumulative for the release, meaning this release note for the Dublin release will have an entry for each Major, Minor, and Maintenance -release, if applicable. Information that is applicable regardless of release is included in the `Getting Started With ONAP`_ section of this -document. +release, if applicable. Each component within the ONAP solution maintains their own component level release notes and links to those release notes are provided below. Details on the specific items delivered in each releaese by each component is maintained in the component specific release notes. @@ -26,98 +25,6 @@ Dublin Major Release 4.0.0 The Dublin 4.0.0 is the first release for Dublin. -.. _getting-started: - -Getting Started With ONAP -========================= - -Summary -------- -ONAP provides a comprehensive platform for real-time, policy-driven -service orchestration and automation including virtual network functions and -applications instantiation and configuration, but also physical network -functions configuration. -ONAP will enable software, network, IT and cloud providers and developers -to rapidly automate new services and support complete life cycle management. -By unifying member resources, ONAP will accelerate the development of a -vibrant ecosystem around a globally shared architecture and implementation -for network automation-with an open standards focus-faster than any one -product could on its own. - -Functionality -------------- -**Portal** - a single, consistent user experience for both design time -and run time environments, based on the user’s role. - -**Design Time Framework** - a comprehensive development environment with -tools, techniques, and repositories for defining/describing resources, -and services: - - - Service Design and Creation (SDC) provides tools, techniques, and - 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. - - - Policy Creation (POLICY) deals with conditions, requirements, - constraints, attributes, or needs that must be provided, maintained, - and/or enforced. - - - 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. - -**Runtime Framework** - The runtime execution framework executes the -rules and policies distributed by the design and creation environment -and Controllers that manage resources corresponding to their assigned -controlled domain: - - - Service Orchestrator (SO) executes the specified BPMN processes and - automates sequences of activities, tasks, rules and policies needed for - on-demand creation, modification or removal of network, application or - infrastructure services and resources. SO is especially able to drive - any OpenStack-based cloud platform. - - - Software Defined Network Controller (SDNC) executes network configuration - for cloud computing resources and network. - - - Application Controller (APPC) executes Virtual Network Functions (VNF) - configurations and lifecycle management operations. - - - Virtual Function Controller (VF-C) is responsible for lifecycle management - of virtual network functions and network services based on VNF using - VNF Manager. - - - Active and Available Inventory (A&AI) provides real-time views of a - system’s resources, services, products and their relationships with each - other. - -**Closed-Loop Automation** -- Design -> Create -> Collect -> Analyze > -Detect -> Publish -> Respond: - - - Data Collection, Analytics and Events (DCAE) collects events, performance, - usage and publishes information to policy that executes the rules to perform - closed loop actions. - - - Holmes provides alarm correlation and analysis for Telecom cloud - infrastructure and services, including servers, cloud infrastructure, - 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** - - - 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. - Project Specific Release Notes ============================== ONAP releases are specified by a list of project artifact versions in a :ref:`manifest artifacts <doc-release-manifest-artifacts>` @@ -133,30 +40,13 @@ Each project provides detailed :ref:`release notes<doc-releaserepos>` and prepends to these if/when any updated versions the project team believes are compatible with a major release are made available. -.. index:: Download - -Installation -============ -ONAP is installed using :ref:`ONAP Operations Manager (OOM) over Kubernetes<installing-onap>` - Documentation ============= -ONAP Dublin Release provides multiple documents including the following: - - * A high level :ref:`architecture view<doc-architecture>` of how component - relate to each other. - - * A collection of documentation provided - by :ref:`each project <doc_onap-developer_guide_projects>`. +ONAP Dublin Release provides multiple documents, see :ref:`ONAP Home<master_index>`. - * Application Programming Interface - Reference :ref:`available here <doc-apiref>`. - - * The `developer wiki <http://wiki.onap.org>`_ remains a good source of - information on meeting plans and notes from committees, project teams and - community events. - -.. index:: Licensing +The `developer wiki <http://wiki.onap.org>`_ remains a good source of +information on meeting plans and notes from committees, project teams and +community events. Security Notes ============== @@ -176,12 +66,6 @@ For the Casablanca release, ONAP continues to improve in multiple areas of Scal The Integration team ran the 72 hours stability testing (100% passing rate) and full resilience testing (96.9% passing rate) at ONAP OpenLabs. More details in :ref:`ONAP Maturity Testing Notes <integration-s3p>` -Licenses -======== -ONAP Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_. -ONAP Documentation is licensed under the `Creative Commons Attribution 4.0 -International License <http://creativecommons.org/licenses/by/4.0>`_. - Known Issues and Limitations ============================ Known Issues and limitations are documented in each :ref:`project Release Notes <doc-releaserepos>`. diff --git a/docs/submodules/aai/aai-common.git b/docs/submodules/aai/aai-common.git -Subproject b0a32518159592219decbd34de1b51ee1e7a9bb +Subproject d480c91b08889c62f007d95a636f952e56acbbd diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git -Subproject 6919392881a94fa9823e5ebf8748682a4c499e9 +Subproject 23299c969a313f8e3740bceb070655810f5e3ef diff --git a/docs/submodules/ccsdk/cds.git b/docs/submodules/ccsdk/cds.git -Subproject b86fe0e27bc66ecae386007c1d751f82cbf920c +Subproject 32d132a78288521798d302cafbd9a7eac9121ca diff --git a/docs/submodules/ccsdk/dashboard.git b/docs/submodules/ccsdk/dashboard.git -Subproject fd5048d6050207cc60ac5155a9a6c87a182fb52 +Subproject c0d9bbcaa3a1b9d990f6658953523b177c488ad diff --git a/docs/submodules/ccsdk/distribution.git b/docs/submodules/ccsdk/distribution.git -Subproject 8d4467847a7992c1525555a3f43599b195a0bf0 +Subproject ae06c07ad483e1276a09eff4b26f088e75301a5 diff --git a/docs/submodules/ccsdk/utils.git b/docs/submodules/ccsdk/utils.git -Subproject 950f9e1ca067c45ba74933030ebf715206bb601 +Subproject e50b344c0491e313c0fff96b37f673388d87cad diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject ee36182e63efee33a140f0a132bd0c75889d6e1 +Subproject 943d7b2c32d7527cd018cd27f97f1b12a21b898 diff --git a/docs/submodules/dcaegen2.git b/docs/submodules/dcaegen2.git -Subproject d20ca31bb588ac665566df77736397325721881 +Subproject bb8dea8255097e9cd306d8f02f945bfb684e469 diff --git a/docs/submodules/oom.git b/docs/submodules/oom.git -Subproject e0375cee11a33922822bc9b92bcd4bdf3c6d5bc +Subproject 0b904977dde761d189874d6dc6c527cd45928d9 diff --git a/docs/submodules/oom/offline-installer.git b/docs/submodules/oom/offline-installer.git -Subproject 6fdcd7d9bd8b4395180d8cbd6c6aa936e50dba7 +Subproject f45f73f749fffb301d825ec53fae2878c505980 diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git -Subproject 2c533a581179c1c06c8811b6dda57e8a6d0fbd2 +Subproject 6bc4e95261ed8ec8bc931696e3674ee5ec54d54 diff --git a/docs/submodules/policy/parent.git b/docs/submodules/policy/parent.git -Subproject 541f83b8b97f1d3c33401e1cbe9436aa31d7fa7 +Subproject d0055e3089d11d1667fea55d615bfcabfd5e401 diff --git a/docs/submodules/portal.git b/docs/submodules/portal.git -Subproject ba546e970d779a5e87a07b3058a85e1446c3912 +Subproject 40c8f073970f3664786d1bb4d4c69ed3f57b8b4 diff --git a/docs/submodules/sdc.git b/docs/submodules/sdc.git -Subproject ddb67dc3cbb04f4857f2cf24221b306fa2bab05 +Subproject 7c62480edb52c829102cddd030384176bf16780 diff --git a/docs/submodules/sdnc/oam.git b/docs/submodules/sdnc/oam.git -Subproject 6290f3775cdf1aa1eb2fc34f04cec10a8b1358a +Subproject b0aa3b3bcc3c269bbc62a2e9690830a959e37e5 diff --git a/docs/submodules/so.git b/docs/submodules/so.git -Subproject 4b7ebd265366542ec872869e9ec0016a88e879b +Subproject 2036dd3cc3fc3c73639353622bc8e6b297b991a diff --git a/docs/submodules/usecase-ui.git b/docs/submodules/usecase-ui.git -Subproject 4fa6adb91b4a31cd26d24d834477a1fa94d2a83 +Subproject de16e84e7119f4f414306fea6c84f8f0d86520a diff --git a/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git b/docs/submodules/vfc/nfvo/driver/vnfm/svnfm.git -Subproject 045656e9d2178f5dfbc14061f4b3edd8e6d7fe1 +Subproject 451e015794a0f3957c9d02685f622817914b412 diff --git a/docs/submodules/vfc/nfvo/lcm.git b/docs/submodules/vfc/nfvo/lcm.git -Subproject 83f5eaad87d82ecc398653f0fd8335ce8d1dbfe +Subproject b8546fe945ca287d9095b5513fe1f1f5fbb481b diff --git a/docs/submodules/vid.git b/docs/submodules/vid.git -Subproject e3c3ba0dc33afe638cd1cade06331b1c5d37929 +Subproject ba76048291feeb83a3596ebf04c9c0f384706d7 diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git -Subproject 6441ccbf69a50f6ea5eff890962215c00b0eefd +Subproject ad0e89a88920277386971e7945ede8bab050396 |