diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/index.rst | 181 | ||||
| -rw-r--r-- | docs/release/release-manifest.rst | 2 | ||||
| -rw-r--r-- | docs/release/releaserepos.rst | 43 | ||||
| -rw-r--r-- | docs/release/repolist.rst | 18 |
4 files changed, 166 insertions, 78 deletions
diff --git a/docs/release/index.rst b/docs/release/index.rst index 8ef20ea0e..1e4804167 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,84 +1,193 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. http://creativecommons.org/licenses/by/4.0 +.. index:: Release Notes + Releases ======== -ONAP is developed and released around 6 month cycles. After an initial -major release, additional stable point releases may be created. The first -release is Amsterdam and subsequent major release will be named using city -names. +This page is the ONAP Amsterdam Release Notes. The first release is +Amsterdam and subsequent major release will be named using city names. + +* Release Name: Amsterdam +* Release Version: 1.0.0 +* Release Date: November 16, 2017 -Amsterdam Release ------------------ +Getting Started With Amsterdam +------------------------------ 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 timer +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, +services, and products: + + - 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) 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. + +**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, + and software lifecycle management. Project Specific Release Notes ++++++++++++++++++++++++++++++ -Major and stable point releases are specified by a list of project artifact +ONAP releases are specified by a list of project artifact versions in a :ref:`manifest<doc-release-manifest>`. 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. +Platforms Requirements +++++++++++++++++++++++ +ONAP Amsterdam Release has been tested on Linux OSs. Details are :ref:`available here <demo-installing-running-onap-requirements>`. -Supported Platforms -+++++++++++++++++++ +.. index:: Download + +Download & Install +++++++++++++++++++ +There are 3 approaches to install ONAP: + +* Full ONAP installation using Heat template +* Advanced installation to install individual components +* Experimental installation using Kubernetes + +Full ONAP installation using Heat template +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +From a complete demo solution perspective. This installs the whole ONAP, refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`. + +Advanced installation to install individual components +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +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. + +Experimental installation using Kubernetes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +From a complete demo solution perspective using Kubernetes. This installs the whole ONAP, refer to :ref:`ONAP Operations Manager - Quick Start Guide <onap-operations-manager-project>`. Documentation +++++++++++++ -Release controlled documentation is available :ref:`here <master_index>`. +ONAP Amsterdam Release documentation is available :ref:`here <master_index>`. For Amsterdam this includes: -* A high level :ref:`architecture view<doc-architecture>` of how components - relate to each other. + * A high level :ref:`architecture view<doc-architecture>` of how components + relate to each other. -* A collection of documentation provided - by :ref:`each project <doc_onap-developer_guide_projects>`. + * A collection of documentation provided + by :ref:`each project <doc_onap-developer_guide_projects>`. -* Application Programming Interface Reference :ref:`available here <doc-apiref>` + * 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, - community events and general, release independent information about - ONAP. Release dependent information is being migrated from the wiki to - gerrit source control. See the doc - project :ref:`release notes <doc-release-notes>` for current status. + * 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. +Usage ++++++ +This section is intended to provide users on the usage of ONAP components. + +Instructions on using the ONAP deployment including Robot, Portal, SDC and VID +in the context of running (Onboarding, service creation, service deployment, +VNF creation, VNF preload, VF Module creation and closed loop operations) +the vFirewall sanity use case is documented +in `Running the ONAP Demos <https://wiki.onap.org/display/DW/Running+the+ONAP+Demos>`_. + +.. index:: Licensing + +Licenses +++++++++ +ONAP Amsterdam Source Code is licensed under the `Apache Version 2 License <http://www.apache.org/licenses/LICENSE-2.0>`_. +ONAP Amsterdam Documentation is licensed under the `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0>`_. Known Issues and Limitations ++++++++++++++++++++++++++++ -TBP overall / general statement -See :ref:`release notes <doc-releaserepos>` for each project. - -License -+++++++ +Known Issues and limitations are documented in each :ref:`project Release Notes <doc-releaserepos>`. +.. index:: Reporting Bugs How to Report a Bug +++++++++++++++++++ There are 2 ways to report a bug in ONAP. -In case you are familiar within ONAP, you can directly report a bug by creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_. - -If you don't know you are facing a bug or have a question, email the ONAP Discuss mailing list at onap-discuss@lists.onap.org . - -You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing and this `guideline <https://wiki.onap.org/display/DW/Mailing+Lists>`_ to register into the ONAP Discuss mailing list. + * In case you are familiar within ONAP, you can directly report a bug by creating a Jira issue at `ONAP Jira <https://jira.onap.org>`_. + * If you don't know you are facing a bug or have a question, post your question into the `Ask question <https://wiki.onap.org/display/DW/questions/all>`_. + You will need a Linux Foundation ID to login and post your question. Get a Linux Foundation Identity using this `quick procedure <https://wiki.onap.org/display/DW/Joining+the+Community>`_. -Download and Use -++++++++++++++++ +You may consider these `recommendations <https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA#TrackingIssueswithJIRA-RecommendationsforwrittingProperJIRAIssue>`_ to elaborate the issue you are facing. -* Source Code in Gerrit https://gerrit.onap.org -* Artifacts in Nexus / Docker Hub +.. Include files referenced by link in the toctree as hidden -* Platform :ref:`Demo <demo-installing-running-onap>`. +.. toctree:: + :hidden: + release-manifest.rst + releaserepos.rst + repolist.rst diff --git a/docs/release/release-manifest.rst b/docs/release/release-manifest.rst index a74fc721d..97838745b 100644 --- a/docs/release/release-manifest.rst +++ b/docs/release/release-manifest.rst @@ -2,6 +2,8 @@ International License. http://creativecommons.org/licenses/by/4.0 Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Release Manifest + .. _doc-release-manifest: Release Manifest diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 55852ba21..2b0d5c607 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -17,9 +17,6 @@ Active and Available Inventory :titlesonly: aai/aai-common<../submodules/aai/aai-common.git/docs/release-notes.rst> - aai/esr-gui<../submodules/aai/esr-gui.git/docs/release-notes.rst> - aai/esr-server<../submodules/aai/esr-server.git/docs/release-notes.rst> - aai/sparky-be<../submodules/aai/sparky-be.git/docs/release-notes.rst> Application Controller ---------------------- @@ -28,7 +25,6 @@ Application Controller :maxdepth: 1 :titlesonly: - appc/deployment<../submodules/appc/deployment.git/docs/release-notes.rst> appc<../submodules/appc.git/docs/release-notes.rst> Common Controller Software Development Kit @@ -39,8 +35,6 @@ Common Controller Software Development Kit :titlesonly: ccsdk/distribution<../submodules/ccsdk/distribution.git/docs/release-notes.rst> - ccsdk/dashboard<../submodules/ccsdk/dashboard.git/docs/release-notes.rst> - ccsdk/platform/blueprints<../submodules/ccsdk/platform/blueprints.git/docs/release-notes.rst> Closed Loop Automation Platform ------------------------------- @@ -94,19 +88,8 @@ Holmes :maxdepth: 1 :titlesonly: - holmes/engine-management<../submodules/holmes/engine-management.git/docs/release-notes.rst> holmes/rule-management<../submodules/holmes/rule-management.git/docs/release-notes.rst> -Integration ------------ - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - integration<../submodules/integration.git/docs/release-notes.rst> - - Logging Enhancements Project ---------------------------- @@ -114,7 +97,7 @@ Logging Enhancements Project :maxdepth: 1 :titlesonly: - logging-analytics<../submodules/logging-analytics.git/docs/release-notes.rst + logging-analytics<../submodules/logging-analytics.git/docs/release-notes.rst> Modeling -------- @@ -123,8 +106,8 @@ Modeling :maxdepth: 1 :titlesonly: - modeling/modelspec<../submodules/modeling/modelspec.git/docs/release-notes.rst> - modeling/toscaparsers<../submodules/modeling/toscaparsers.git/docs/release-notes.rst> + modeling/modelspec<../submodules/modeling/toscaparsers.git/docs/javatoscachecker/release-notes/release-notes.rst> + modeling/toscaparsers<../submodules/modeling/toscaparsers.git/docs/nfvparser/release-notes/release-notes.rst> Micro Services Bus ------------------ @@ -134,9 +117,6 @@ Micro Services Bus :titlesonly: msb/apigateway<../submodules/msb/apigateway.git/docs/release-notes.rst> - msb/discovery<../submodules/msb/discovery.git/docs/release-notes.rst> - msb/java-sdk<../submodules/msb/java-sdk.git/docs/release-notes.rst> - msb/swagger-sdk<../submodules/msb/swagger-sdk.git/docs/release-notes.rst> MultiVIM Cloud -------------- @@ -147,6 +127,15 @@ MultiVIM Cloud multicloud/framework<../submodules/multicloud/framework.git/docs/Release Notes.rst> +ONAP Operations Manager (experimental) +-------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + OOM<../submodules/oom.git/docs/release-notes.rst> + Policy Framework ---------------- @@ -173,11 +162,6 @@ Service Design & Creation :titlesonly: sdc<../submodules/sdc.git/docs/release-notes.rst> - sdc/jtosca<../submodules/sdc/jtosca.git/docs/release-notes.rst> - sdc/sdc-distribution-client<../submodules/sdc/sdc-distribution-client.git/docs/release-notes.rst> - sdc/sdc-docker-base<../submodules/sdc/sdc-docker-base.git/docs/release-notes.rst> - sdc/sdc-titan-cassandra<../submodules/sdc/sdc-titan-cassandra.git/docs/release-notes.rst> - sdc/sdc-tosca<../submodules/sdc/sdc-tosca.git/docs/release-notes.rst> sdc/sdc-workflow-designer<../submodules/sdc/sdc-workflow-designer.git/docs/release-notes.rst> Software Defined Network Controller @@ -215,7 +199,6 @@ Virtual Function Controller :maxdepth: 1 :titlesonly: - vfc/lcm<../submodules/vfc/lcm.git/docs/release-notes.rst> vfc/nfvo/lcm<../submodules/vfc/nfvo/lcm.git/docs/release-notes.rst> Virtual Infrastructure Deployment @@ -225,7 +208,6 @@ Virtual Infrastructure Deployment :maxdepth: 1 :titlesonly: - vid/asdcclient<../submodules/vid/asdcclient.git/docs/release-notes.rst> vid<../submodules/vid.git/docs/release-notes.rst> VNF Requirements @@ -235,7 +217,6 @@ VNF Requirements :maxdepth: 1 :titlesonly: - vnfrqts/guidelines<../submodules/vnfrqts/guidelines.git/docs/release-notes.rst> vnfrqts/requirements<../submodules/vnfrqts/requirements.git/docs/release-notes.rst> VNF Software Development Kit diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst index 3c40dd6df..d29aa8354 100644 --- a/docs/release/repolist.rst +++ b/docs/release/repolist.rst @@ -3,6 +3,8 @@ Copyright 2017 AT&T Intellectual Property. All rights reserved. +.. index:: Projects Providing Documentation + .. _doc-repolist: Project/Components @@ -25,10 +27,6 @@ Project/Components ccsdk/platform/blueprints <../submodules/ccsdk/platform/blueprints.git/docs/index> ccsdk/platform/nbapi <../submodules/ccsdk/platform/nbapi.git/docs/index> CCSDK Orchestrator Plugins <../submodules/ccsdk/platform/plugins.git/docs/index> - ../submodules/ccsdk/sli/adaptors.git/docs/index - ../submodules/ccsdk/sli/core.git/docs/index - ../submodules/ccsdk/sli/northbound.git/docs/index - ../submodules/ccsdk/sli/plugins.git/docs/index ccsdk/storage/esaas <../submodules/ccsdk/storage/esaas.git/docs/index> ccsdk/storage/pgaas <../submodules/ccsdk/storage/pgaas.git/docs/index> ccsdk/utils <../submodules/ccsdk/utils.git/docs/index> @@ -58,14 +56,7 @@ Project/Components sdc/sdc-titan-cassandra <../submodules/sdc/sdc-titan-cassandra.git/docs/index> sdc/sdc-tosca <../submodules/sdc/sdc-tosca.git/docs/index> sdc/sdc-workflow-designer <../submodules/sdc/sdc-workflow-designer.git/docs/index> - sdnc/adaptors <../submodules/sdnc/adaptors.git/docs/index> - sdnc/architecture <../submodules/sdnc/architecture.git/docs/index> - sdnc/core <../submodules/sdnc/core.git/docs/index> - sdnc/features <../submodules/sdnc/features.git/docs/index> - sdnc/northbound <../submodules/sdnc/northbound.git/docs/index> sdnc/oam <../submodules/sdnc/oam.git/docs/index> - sdnc/parent <../submodules/sdnc/parent.git/docs/index> - sdnc/plugins <../submodules/sdnc/plugins.git/docs/index> Service Orchestrator <../submodules/so.git/docs/index> so/libs <../submodules/so/libs.git/docs/index> Use Case User Interface <../submodules/usecase-ui.git/docs/index> @@ -75,3 +66,8 @@ Project/Components ../submodules/vnfrqts/guidelines.git/docs/index ../submodules/vnfrqts/requirements.git/docs/index VNF Software Development Kit <../submodules/vnfsdk/model.git/docs/index> + vvp/documentation <../submodules/vvp/documentation.git/docs/index> + aai/event-client <../submodules/aai/event-client.git/docs/index> + optf/osdf <../submodules/optf/osdf.git/docs/index> + dmaap/datarouter <../submodules/dmaap/datarouter.git/docs/index> + dmaap/dbcapi <../submodules/dmaap/dbcapi.git/docs/index> |