diff options
Diffstat (limited to 'docs/release')
| -rw-r--r-- | docs/release/index.rst | 182 | ||||
| -rw-r--r-- | docs/release/release-manifest.rst | 2 | ||||
| -rw-r--r-- | docs/release/releaserepos.rst | 205 | ||||
| -rw-r--r-- | docs/release/repolist.rst | 4 |
4 files changed, 356 insertions, 37 deletions
diff --git a/docs/release/index.rst b/docs/release/index.rst index c7dd5bb0c..bc4ee5674 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -1,12 +1,16 @@ .. 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 @@ -14,65 +18,179 @@ Amsterdam Release Summary +++++++ +ONAP provides a comprehensive platform for real-time, policy-driven +orchestration and automation of physical and virtual network functions +that 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 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. + - Software Defined Network Controller (SDNC) network configuration of + cloud computing resources. + + - Application Controller (APPC) Application resources. + + - Virtual Function Controller (VF-C) provides an ETSI NFV compliant NFV-O + functions, and is responsible for life cycle management of virtual services + and the associated physical COTS server infrastructure. + + - 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 performance, + usage, and configuration data and publishes information to policy, + orchestration, and the data lake. + + - “Holmes” provides alarm correlation and analysis for Telecom cloud + infrastructure and services, including hosts, vims, VNFs and NSs + + - 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 -versions in a :ref:`manifest here<doc-release-manifest>`. -Each project provides detailed :ref:`release notes here <doc-releaserepos>` -and prepends to these if/when any updated versions, the project team believes -are compatible with major release, are made available. +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. Supported Platforms +++++++++++++++++++ - +ONAP Amsterdam Release has been tested on Ubuntu 16.04 and thus is +the only OS supported. 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 architecture view of how components delivered by all projects - relate to each other are :ref:`available here <doc-architecture>`. + * A high level :ref:`architecture view<doc-architecture>` of how components + relate to each other. -* A collection of documentation provided by each project and for some projects - several components / repositories within the project - are :ref:`available here <doc-repolist>`. + * 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. Known Issues and Limitations ++++++++++++++++++++++++++++ -TBP overall / general statement -See :ref:`release notes <doc-releaserepos>` for each project. +Known Issues and limitations are documented in each project Release Notes. -License -+++++++ +Refer to :ref:`release notes <doc-releaserepos>` for each project. +.. 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>`_. + +.. 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. + +.. index:: Download + +Download +++++++++ + +* 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 . + + +.. index:: Installation + + +Install ++++++++ +There are 2 approaches to install ONAP. + +* From a complete demo solution perspective. This installs the whole ONAP, + refer to :ref:`Setting Up ONAP <demo-installing-running-onap>`. + +* From a developer perspective. ONAP is installed component per component. + Each + component :ref:`installation is listed in<doc_onap-developer_guide_projects>`. + The list of ports used by default within ONAP is documented + in `ONAP Service List <https://wiki.onap.org/display/DW/ONAP+Services+List>`_. +Usage ++++++ +This section is intended to provide users on the usage of ONAP components. -Download and Use -++++++++++++++++ +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>`_. -* 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 7d445f922..2f736f978 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -6,6 +6,10 @@ .. _doc-releaserepos: Project Specific Release Notes +++++++++++++++++++++++++++++++ +Each project is listed below followed by the Gerrit repositories in which there are release notes. + +Active and Available Inventory ------------------------------ .. toctree:: @@ -16,29 +20,167 @@ Project Specific Release Notes 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 +---------------------- + +.. toctree:: + :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 +------------------------------------------ + +.. toctree:: + :maxdepth: 1 + :titlesonly: + ccsdk/distribution<../submodules/ccsdk/distribution.git/docs/release-notes.rst> ccsdk/dashboard<../submodules/ccsdk/dashboard.git/docs/release-notes.rst> - ccsdk/platform/plugins<../submodules/ccsdk/platform/plugins.git/docs/release-notes.rst> ccsdk/platform/blueprints<../submodules/ccsdk/platform/blueprints.git/docs/release-notes.rst> +Closed Loop Automation Platform +------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + clamp<../submodules/clamp.git/docs/release-notes.rst> + +ONAP Command Line Interface +--------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + cli<../submodules/cli.git/docs/release-notes.rst> + +Data Collection, Analysis, and Events +------------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + dcaegen2<../submodules/dcaegen2.git/docs/sections/release-notes.rst> + +Documentation +------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + doc <../release-notes.rst> + +Data Management as a Platform Message Router +-------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + dmaap/messagerouter/messageservice<../submodules/dmaap/messagerouter/messageservice.git/docs/release-notes.rst> + +Holmes +------ + +.. toctree:: + :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 +---------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + logging-analytics<../submodules/logging-analytics.git/docs/release-notes.rst + +Modeling +-------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + modeling/modelspec<../submodules/modeling/modelspec.git/docs/release-notes.rst> + modeling/toscaparsers<../submodules/modeling/toscaparsers.git/docs/nfvparser/release-notes/release-notes.rst> + +Micro Services Bus +------------------ + +.. toctree:: + :maxdepth: 1 + :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> - optf/has<../submodules/optf/has.git/docs/release-notes.rst> + +MultiVIM Cloud +-------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + multicloud/framework<../submodules/multicloud/framework.git/docs/Release Notes.rst> + +ONAP Operations Manager (experimental) +-------------------------------------- + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../../../submodules/oom.git/docs/index/release-notes.rst + +Policy Framework +---------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + policy/engine<../submodules/policy/engine.git/docs/release-notes.rst> + +Portal Platform +--------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + portal<../submodules/portal.git/docs/release-notes.rst> + +Service Design & Creation +------------------------- + +.. toctree:: + :maxdepth: 1 + :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> @@ -46,20 +188,76 @@ Project Specific Release Notes 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 +----------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + sdnc/oam<../submodules/sdnc/oam.git/docs/release-notes.rst> + +Service Orchestration +--------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + so<../submodules/so.git/docs/release-notes.rst> so/libs<../submodules/so/libs.git/docs/release-notes.rst> + +ONAP Use Case User Interface +---------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + usecase-ui<../submodules/usecase-ui.git/docs/release-notes.rst> + +Virtual Function Controller +--------------------------- + +.. toctree:: + :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 +--------------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + vid/asdcclient<../submodules/vid/asdcclient.git/docs/release-notes.rst> vid<../submodules/vid.git/docs/release-notes.rst> + +VNF Requirements +---------------- + +.. toctree:: + :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 +---------------------------- + +.. toctree:: + :maxdepth: 1 + :titlesonly: + vnfsdk/model<../submodules/vnfsdk/model.git/docs/release-notes.rst> -.. Empty folders for this release +.. Not in / not used this release ccsdk/parent<../submodules/ccsdk/parent.git/docs/release-notes.rst> ccsdk/platform/nbapi<../submodules/ccsdk/platform/nbapi.git/docs/release-notes.rst> ccsdk/sli/adaptors<../submodules/ccsdk/sli/adaptors.git/docs/release-notes.rst> @@ -77,5 +275,4 @@ Project Specific Release Notes sdnc/parent<../submodules/sdnc/parent.git/docs/release-notes.rst> sdnc/plugins<../submodules/sdnc/plugins.git/docs/release-notes.rst> oom<../submodules/oom.git/docs/release-notes.rst> - multicloud/framework<../submodules/multicloud/framework.git/docs/release-notes.rst> aaf/authz<../submodules/aaf/authz.git/docs/release-notes.rst> diff --git a/docs/release/repolist.rst b/docs/release/repolist.rst index a4fdebc59..ae8adcdec 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 @@ -17,7 +19,6 @@ Project/Components AAI External System Registration UI <../submodules/aai/esr-gui.git/docs/index> AAI External System Registration Server <../submodules/aai/esr-server.git/docs/index> AAI Sparky Inventory UI <../submodules/aai/sparky-be.git/docs/index> - AAI Sparky Inventory Service <../submodules/aai/sparky-fe.git/docs/index> ../submodules/appc/deployment.git/docs/index ../submodules/appc.git/docs/index CCSDK Dashboard <../submodules/ccsdk/dashboard.git/docs/index> @@ -76,3 +77,4 @@ 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> |