From 497673c7af9e704f9bca84cbabd4716713a60e52 Mon Sep 17 00:00:00 2001 From: "Timoney, Dan (dt5972)" Date: Wed, 16 May 2018 19:38:36 -0400 Subject: [PATCH] Update release notes Update release notes for Beijing release Change-Id: I7baba6ef6285bf3fcf037c0efdf3ceed48cfeff3 Issue-ID: CCSDK-278 Signed-off-by: Timoney, Dan (dt5972) --- docs/release-notes.rst | 200 ++++- docs/sli/adaptors/docs/architecture.rst | 27 - docs/sli/adaptors/docs/build.rst | 18 - docs/sli/adaptors/docs/index.rst | 12 - docs/sli/adaptors/docs/logging.rst | 14 - docs/sli/adaptors/docs/offeredapis.rst | 6 - docs/sli/adaptors/docs/release-notes.rst | 46 -- docs/sli/northbound/docs/apis/asdcApi.rst | 15 - docs/sli/northbound/docs/apis/dataChange.rst | 15 - docs/sli/northbound/docs/architecture.rst | 12 - docs/sli/northbound/docs/build.rst | 18 - docs/sli/northbound/docs/index.rst | 13 - docs/sli/northbound/docs/logging.rst | 14 - docs/sli/northbound/docs/nodes.rst | 1031 -------------------------- docs/sli/northbound/docs/offeredapis.rst | 13 - docs/sli/northbound/docs/release-notes.rst | 45 -- 16 files changed, 183 insertions(+), 1316 deletions(-) delete mode 100644 docs/sli/adaptors/docs/architecture.rst delete mode 100644 docs/sli/adaptors/docs/build.rst delete mode 100644 docs/sli/adaptors/docs/index.rst delete mode 100644 docs/sli/adaptors/docs/logging.rst delete mode 100644 docs/sli/adaptors/docs/offeredapis.rst delete mode 100644 docs/sli/adaptors/docs/release-notes.rst delete mode 100644 docs/sli/northbound/docs/apis/asdcApi.rst delete mode 100644 docs/sli/northbound/docs/apis/dataChange.rst delete mode 100644 docs/sli/northbound/docs/architecture.rst delete mode 100644 docs/sli/northbound/docs/build.rst delete mode 100644 docs/sli/northbound/docs/index.rst delete mode 100644 docs/sli/northbound/docs/logging.rst delete mode 100644 docs/sli/northbound/docs/nodes.rst delete mode 100644 docs/sli/northbound/docs/offeredapis.rst delete mode 100644 docs/sli/northbound/docs/release-notes.rst diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 94b4fc62..fb9b8128 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -3,34 +3,201 @@ Release Notes ============= -Version: 0.1.0 +Version: 0.2.2 -------------- -:Release Date: 2017-11-16 +:Release Date: 2018-05-24 **New Features** -The Common Controller SDK provides the following functionality : - - Service Logic Interpreter - - Database access library (dblib) - - Service Logic test api (sliapi) - - MD-SAL data query adaptor - - SQL query adaptor - - Resource allocator - - SDC interface - - DMAAP interface - - REST API adaptor - ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| Jira # | Abstract | ++=============+=====================================================================================================================+ +| [CCSDK-265] | SetNodeExecutor nulling feature enhancement | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-238] | DGBuilder uploadXML displaying processing gif even after successful upload | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-231] | remove most of pgaas repo | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-227] | Simplify enumeration handling | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-222] | Ansible server support | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-214] | support enumerations containing whitespace | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-211] | change reference of sdnc to ccsdk in dgbuilder-docker files | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-210] | allow request body to be passed into rest api call node | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-209] | read properties file using system property | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-204] | svclogic loader improvements | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-203] | restore previous behavior | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-202] | additional logging and loading related changes | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-193] | add timestamps to install log | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-191] | enable fast loading of graphs | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-190] | fix setnode null feature | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-189] | favor interfaces over concrete classes | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-187] | reset MDC after executing certain nodes | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-181] | Want to use the dnsdesig plugin with recent OpenStack versions | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-179] | Upgrade CCSDK ODL containers to Nitrogen | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-177] | Upgrade sli/northbound to Nitrogen | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-176] | Upgrade sli/adaptors to Nitrogen | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-175] | Upgrade sli/core to Nitrogen | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-174] | Update ccsdk parent to support Nitrogen parent poms | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-172] | Ability to call Ansible playbook from directed graph | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-158] | sliPluginUtils enhancements | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-157] | Healthcheck enhancements | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-156] | Fixes to logging filters package | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-155] | Service Logic Interpreter improvements | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-152] | Service Logic Compiler improvements | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-151] | Address issues identified by sonar | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-124] | minor pom changes | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-123] | number of small improvements made in SLI | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-122] | Modifying restapicallnode to support mocking and minor refactoring | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-121] | Modifying sdnc-core to support mocking and minor refactoring | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-111] | Refactor CCSDK/Dashboard project | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-109] | Documentation for ccsdk/dashboard | ++-------------+---------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-63]  | Migrate all feature bundle to features-parent | ++-------------+---------------------------------------------------------------------------------------------------------------------+ **Bug Fixes** ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| Jira # | Abstract | ++=============+==========================================================================================================================+ +| [CCSDK-277] | restapicallnode OSGI lookup fails | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-276] | Ccsdk components not installing in odlsli docker image | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-273] | Missing ansible-adapter.properties file causes NullPointerException | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-272] | LCM API expects wrong names for DGs | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-270] | Remove AT&T license from csar sample | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-269] | Remove erroneous license header | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-268] | SDNC Error on loading Preload in karaf.log | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-264] | Missing EELF dependency in ansible-bundle | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-261] | SO build failure because of artifact not available in ccsdk pom | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-254] | UEB Listener failing | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-252] | LCM returns rpc not registered | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-251] | ansible-adapter install fails | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-250] | update aaiclient properties in ccsdk/distribution | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-248] | sli/adaptors release build fails | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-247] | APPC receiving the trustAnchors parameter must be non-empty error in aai client | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-246] | Add support for primary identifier of type int in XSD generated model | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-244] | Remove unnecessary cast in SqlResource decryptColumn() | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-243] | Precedence incorrect for properties search | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-241] | Install karaf host key in ODL container | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-237] | Directed graphs not installed in odlsli container | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-236] | SvcLogicService does not recognize any DG node types | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-235] | CCSDK container fails due to missing logback package | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-234] | ccsdk docker container doesnt have correct version of logback | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-230] | Code Coverage for sli-northbound | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-229] | AAI-Service methods were removed that are still being used | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-225] | Add Junits for Adaptors | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-224] | Update oparent version | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-220] | Add default constructor for SqlResource | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-217] | CCSDK health check responds 501 | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-216] | filters feature does not install | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-215] | resource-assignment feature not installing | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-213] | Code coverage on sli/core below 50% | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-208] | Restart fails on odlsli container initialization | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-207] | Incorrect spring version | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-205] | update vnfapi provider class to support soft-delete | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-200] | Enhance vnfapi yang model to include subnet-role and network-role-tag | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-198] | platform/nbapi merge fails | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-197] | Fix parent release build | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-196] | CCSDK dashboard still using code from locked repos ecompsdkos | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-192] | Update master detection for master/slave database configuration | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-184] | Use cryptographically secure random number generation | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-182] | Passwords stored in clear text in properties files | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-171] | Convert aai-service provider to blueprint | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-170] | Null pointer exception while executing test case after sonar issue fix. | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-168] | Generalize sli-core/utils FileResolver dblib package | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-154] | ccsdk/sli/northbound/dmaap-listener module compilation failure | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ +| [CCSDK-137] | isolate deprecated methods | ++-------------+--------------------------------------------------------------------------------------------------------------------------+ + **Known Issues** - - `CCSDK-110 `_ Resolve license issues in dashboard project - - `CCSDK-136 `_ pgaas is dependent on location_prefix being all lowercase - - `CCSDK-137 `_ isolate deprecated methods + ++-------------+-----------------------------------------------------------------------------------------------------+ +| Jira # | Abstract | ++=============+=====================================================================================================+ +| [CCSDK-136] | pgaas is dependent on location\_prefix being all lowercase | ++-------------+-----------------------------------------------------------------------------------------------------+ **Security Issues** You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ @@ -42,4 +209,3 @@ The Common Controller SDK provides the following functionality : **Other** -=========== diff --git a/docs/sli/adaptors/docs/architecture.rst b/docs/sli/adaptors/docs/architecture.rst deleted file mode 100644 index 8daa0d3b..00000000 --- a/docs/sli/adaptors/docs/architecture.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Architecture -============ - -.. note:: - * This section is used to describe a software component from a high level - view of capability, common usage scenarios, and interactions with other - components required in the usage scenarios. - - * The architecture section is typically: provided in a platform-component - and sdk collections; and referenced from developer and user guides. - - * This note must be removed after content has been added. - - -Capabilities ------------- - - -Usage Scenarios ---------------- - - -Interactions ------------- diff --git a/docs/sli/adaptors/docs/build.rst b/docs/sli/adaptors/docs/build.rst deleted file mode 100644 index 0a4c308e..00000000 --- a/docs/sli/adaptors/docs/build.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Build -===== - - -Environment ------------ -Requires maven release 3.3 or greater - -Steps ------ -To compile this code: - -1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories. - -2. To compile, run "mvn clean install". \ No newline at end of file diff --git a/docs/sli/adaptors/docs/index.rst b/docs/sli/adaptors/docs/index.rst deleted file mode 100644 index 3156c8ab..00000000 --- a/docs/sli/adaptors/docs/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -CCSDK Service Logic Interpretor Adaptors ----------------------------------------- -.. toctree:: - :maxdepth: 1 - - architecture.rst - offeredapis.rst - logging.rst - build.rst - release-notes.rst diff --git a/docs/sli/adaptors/docs/logging.rst b/docs/sli/adaptors/docs/logging.rst deleted file mode 100644 index 187eb03b..00000000 --- a/docs/sli/adaptors/docs/logging.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Logging -======= -CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log -log file. - -Where to Access Information ---------------------------- -Logs are found within the SDNC docker container, in the directory -/opt/opendaylight/current/data/logs. - - diff --git a/docs/sli/adaptors/docs/offeredapis.rst b/docs/sli/adaptors/docs/offeredapis.rst deleted file mode 100644 index e20c786c..00000000 --- a/docs/sli/adaptors/docs/offeredapis.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Offered APIs -============ - diff --git a/docs/sli/adaptors/docs/release-notes.rst b/docs/sli/adaptors/docs/release-notes.rst deleted file mode 100644 index b4516570..00000000 --- a/docs/sli/adaptors/docs/release-notes.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Release Notes -============= - -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. - - -Version: x.y.z --------------- - - -:Release Date: yyyy-mm-dd - - - -**New Features** - -One or two sentences explaining the purpose of this Release. - -**Bug Fixes** - - `CIMAN-65 `_ and a sentence explaining what this defect is addressing. -**Known Issues** - - `CIMAN-65 `_ and two, three sentences. - One sentences explaining what is the issue. - - Another sentence explaining the impact of the issue. - - And an optional sentence providing a workaround. - -**Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ - - -**Upgrade Notes** - -**Deprecation Notes** - -**Other** - -=========== \ No newline at end of file diff --git a/docs/sli/northbound/docs/apis/asdcApi.rst b/docs/sli/northbound/docs/apis/asdcApi.rst deleted file mode 100644 index c9091401..00000000 --- a/docs/sli/northbound/docs/apis/asdcApi.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -ASDC-API (2017-02-01) -===================== - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - - -.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=ccsdk/sli/northbound.git;a=blob_plain;f=asdcApi/model/src/main/resources/asdc-api.20170201.json - - diff --git a/docs/sli/northbound/docs/apis/dataChange.rst b/docs/sli/northbound/docs/apis/dataChange.rst deleted file mode 100644 index 9a9dc044..00000000 --- a/docs/sli/northbound/docs/apis/dataChange.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -dataChange(2015-05-19) -====================== - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - - -.. swaggerv2doc:: https://gerrit.onap.org/r/gitweb?p=ccsdk/sli/northbound.git;a=blob_plain;f=dataChange/model/src/main/resources/dataChange.20150519.json - - diff --git a/docs/sli/northbound/docs/architecture.rst b/docs/sli/northbound/docs/architecture.rst deleted file mode 100644 index f2648df3..00000000 --- a/docs/sli/northbound/docs/architecture.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Architecture -============ - - -Capabilities ------------- -This repository contains source code and Yang models for the northbound interfaces -used to process updates from SDC (ASDC-API) and for processing data change notifications -from A&AI (dataChange). diff --git a/docs/sli/northbound/docs/build.rst b/docs/sli/northbound/docs/build.rst deleted file mode 100644 index 0a4c308e..00000000 --- a/docs/sli/northbound/docs/build.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Build -===== - - -Environment ------------ -Requires maven release 3.3 or greater - -Steps ------ -To compile this code: - -1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories. - -2. To compile, run "mvn clean install". \ No newline at end of file diff --git a/docs/sli/northbound/docs/index.rst b/docs/sli/northbound/docs/index.rst deleted file mode 100644 index 9be06c84..00000000 --- a/docs/sli/northbound/docs/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -CCSDK SLI Northbound API ------------------------- -.. toctree:: - :maxdepth: 1 - - architecture.rst - offeredapis.rst - logging.rst - build.rst - release-notes.rst - diff --git a/docs/sli/northbound/docs/logging.rst b/docs/sli/northbound/docs/logging.rst deleted file mode 100644 index 187eb03b..00000000 --- a/docs/sli/northbound/docs/logging.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Logging -======= -CCSDK uses slf4j to log messages to the standard OpenDaylight karaf.log -log file. - -Where to Access Information ---------------------------- -Logs are found within the SDNC docker container, in the directory -/opt/opendaylight/current/data/logs. - - diff --git a/docs/sli/northbound/docs/nodes.rst b/docs/sli/northbound/docs/nodes.rst deleted file mode 100644 index 3bdeabcf..00000000 --- a/docs/sli/northbound/docs/nodes.rst +++ /dev/null @@ -1,1031 +0,0 @@ ---- Service Logic Interpreter --- Dan Timoney --- 2014-11-12 --- - -Supported node types -==================== - -The following built-in node types are currently supported: - -- Flow Control - - - `**block** <#Block_node>`__ - - - `**call** <#Call_node>`__ - - - `**for** <#For_node>`__ - - - `**return** <#Return_node>`__ - - - `**set** <#Set_node>`__ - - - `**switch** <#Switch_node>`__ - -- Device Management - - - `**configure** <#Configure_node>`__ - -- Java Plugin Support - - - `**execute** <#Execute_node>`__ - -- Recording - - - `**record** <#Record_node>`__ - -- Resource Management - - - `**delete** <#Delete_node>`__ - - - `**exists** <#Exists_node>`__ - - - `**get-resource** <#Get-resource_node>`__ - - - `**is-available** <#Is-available_node>`__ - - - `**notify** <#Notify_node>`__ - - - `**release** <#Release_node>`__ - - - `**reserve** <#Reserve_node>`__ - - - `**save** <#Save_node>`__ - - - `**update** <#Update_node>`__ - -Flow Control ------------- - -Block node -~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **block** node is used to executes a set of nodes. - -Attributes -^^^^^^^^^^ - -+--------------+-----------------------------------------------------------------------------------------------------------------------------------+ -| **atomic** | if *true*, then if a node returns failure, subsequent nodes will not be executed and nodes already executed will be backed out. | -+--------------+-----------------------------------------------------------------------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -None - -Outcomes -^^^^^^^^ - -None - -Example -^^^^^^^ - -:: - - - - - - - - - - - - - -Call node -~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **call** node is used to call another graph - -Attributes -^^^^^^^^^^ - -+---------------+------------------------------------------------------------------------------------+ -| **module** | Module of directed graph to call. If unset, defaults to that of calling graph | -+---------------+------------------------------------------------------------------------------------+ -| **rpc** | rpc of directed graph to call. | -+---------------+------------------------------------------------------------------------------------+ -| **version** | version of graph to call, If unset, uses active version. | -+---------------+------------------------------------------------------------------------------------+ -| **mode** | mode (sync/async) of graph to call. If unset, defaults to that of calling graph. | -+---------------+------------------------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -Not applicable - -Outcomes -^^^^^^^^ - -+-----------------+------------------------------+ -| **success** | Sub graph returned success | -+-----------------+------------------------------+ -| **not-found** | Graph not found | -+-----------------+------------------------------+ -| **failure** | Subgraph returned success | -+-----------------+------------------------------+ - -Table: . - -Example -^^^^^^^ - -:: - - - -For node -~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **for** node provides a fixed iteration looping mechanism, similar to -the Java for loop - -Attributes -^^^^^^^^^^ - -+-------------+------------------+ -| **index** | index variable | -+-------------+------------------+ -| **start** | initial value | -+-------------+------------------+ -| **end** | maximum value | -+-------------+------------------+ - -Parameters -^^^^^^^^^^ - -Not applicable. - -Outcomes -^^^^^^^^ - -Not applicable. The **status** node has no outcomes. - -Example -^^^^^^^ - -:: - - - - - - - - - -Return node -~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **return** node is used to return a status to the invoking MD-SAL -application - -Attributes -^^^^^^^^^^ - -+--------------+---------------------------------------------------+ -| **status** | Status value to return (*success* or *failure*) | -+--------------+---------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -The following optional parameters may be passed to convey more detailed -status information. - -+---------------------+-----------------------------------------------------------------+ -| **error-code** | A brief, usually numeric, code indicating the error condition | -+---------------------+-----------------------------------------------------------------+ -| **error-message** | A more detailed error message | -+---------------------+-----------------------------------------------------------------+ - -Outcomes -^^^^^^^^ - -Not applicable. The **status** node has no outcomes. - -Example -^^^^^^^ - -:: - - - - - - -Set node -~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **set** node is used to set one or more values in the execution -context - -Attributes -^^^^^^^^^^ - -+---------------------+-------------------------------------------------------------------------------------+ -| **only-if-unset** | If true the set node will only execute if the current value of the target is null | -+---------------------+-------------------------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -Values to be set are passed as parameters - -Outcomes -^^^^^^^^ - -Not applicable. The **set** node has no outcomes. - -Example -^^^^^^^ - -:: - - - - - -Switch node -~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **switch** node is used to make a decision based on its **test** -attribute. - -Attributes -^^^^^^^^^^ - -+------------+---------------------+ -| **test** | Condition to test | -+------------+---------------------+ - -Parameters -^^^^^^^^^^ - -None - -Outcomes -^^^^^^^^ - -Depends on the **test** condition - -Example -^^^^^^^ - -:: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Device Management ------------------ - -Configure node -~~~~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **configure** node is used to configure a device. - -Attributes -^^^^^^^^^^ - -+----------------+-----------------------------------------------------------------------------------+ -| **adaptor** | Fully qualified Java class of resource adaptor to be used | -+----------------+-----------------------------------------------------------------------------------+ -| **activate** | Activate device/interface, for devices that support a separate activation step. | -+----------------+-----------------------------------------------------------------------------------+ -| **key** | SQL-like string specifying criteria for item to configure | -+----------------+-----------------------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -Specific to device adaptor. - -Outcomes -^^^^^^^^ - -+----------------------+------------------------------------------------------------------+ -| **success** | Device successfully configured | -+----------------------+------------------------------------------------------------------+ -| **not-found** | Element to be configured does not exist. | -+----------------------+------------------------------------------------------------------+ -| **not-ready** | Element is not in a state where it can be configured/activated | -+----------------------+------------------------------------------------------------------+ -| **already-active** | Attempt to activate element that is already active | -+----------------------+------------------------------------------------------------------+ -| **failure** | Configure failed for some other reason | -+----------------------+------------------------------------------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Java Plugin Support -------------------- - -Execute node -~~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -An **execute** node is used to execute Java code supplied as a plugin - -Attributes -^^^^^^^^^^ - -+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **plugin** | Fully qualified Java class of plugin to be used | -+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **method** | Name of method in the plugin class to execute. Method must return void, and take 2 arguments: a Map (for parameters) and a SvcLogicContext (to allow plugin read/write access to context memory) | -+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -Specific to plugin / method - -Outcomes -^^^^^^^^ - -+--------------------------+-----------------------------------------------------------------+ -| **success** | Device successfully configured | -+--------------------------+-----------------------------------------------------------------+ -| **not-found** | Plugin class could not be loaded | -+--------------------------+-----------------------------------------------------------------+ -| **unsupported-method** | Named method taking (Map, SvcLogicContext) could not be found | -+--------------------------+-----------------------------------------------------------------+ -| **failure** | Configure failed for some other reason | -+--------------------------+-----------------------------------------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - - - - - - - - - - - - -Recording ---------- - -Record node -~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **record** node is used to record an event. For example, this might be -used to log provisioning events. - -Attributes -^^^^^^^^^^ - -+--------------+---------------------------------------------------+ -| **plugin** | Fully qualified Java class to handle recording. | -+--------------+---------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -Parameters will depend on the plugin being used. For the FileRecorder -class, the parameters are as follows - -+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **file** | The file to which the record should be written | -+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| **field1** | First field to write. There will be **field** parameters for each field to write, from **field1** through **fieldN**. A special value \_\_TIMESTAMP\_\_ may be assigned to a field to insert the current timestamp | -+--------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Outcomes -^^^^^^^^ - -+---------------+--------------------------------------------+ -| **success** | Record successfully written | -+---------------+--------------------------------------------+ -| **failure** | Record could not be successfully written | -+---------------+--------------------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - -Resource Management -------------------- - -Delete node -~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **delete** node is used to delete a resource from the local resource -inventory. - -Attributes -^^^^^^^^^^ - -+----------------+-------------------------------------------------------------+ -| **plugin** | Fully qualified Java class of resource adaptor to be used | -+----------------+-------------------------------------------------------------+ -| **resource** | Type of resource to delete | -+----------------+-------------------------------------------------------------+ -| **key** | SQL-like string specifying key to delete | -+----------------+-------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -None - -Outcomes -^^^^^^^^ - -+---------------+--------------------------------------------+ -| **success** | Resource specified deleted successfully. | -+---------------+--------------------------------------------+ -| *failure*> | Resource specified was not deleted | -+---------------+--------------------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - - -Exists node -~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -An **exists** node is used to determine whether a particular instance of -a resource exists. For example, this might be used to test whether a -particular switch CLLI is provisioned. - -Attributes -^^^^^^^^^^ - -+----------------+-------------------------------------------------------------+ -| **plugin** | Fully qualified Java class of resource adaptor to be used | -+----------------+-------------------------------------------------------------+ -| **resource** | Type of resource to check | -+----------------+-------------------------------------------------------------+ -| **key** | SQL-like string specifying key to check for | -+----------------+-------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -None - -Outcomes -^^^^^^^^ - -+-------------+---------------------------------+ -| **true** | Resource specified exists. | -+-------------+---------------------------------+ -| **false** | Resource specified is unknown | -+-------------+---------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - - -Get-resource node -~~~~~~~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **get-resource** node is used to retrieve information about a -particular resource and make it available to other nodes in the service -logic tree. For example, this might be used to retrieve information -about a particular uni-port. - -Attributes -^^^^^^^^^^ - -+----------------+------------------------------------------------------------------------------------------+ -| **plugin** | Fully qualified Java class of resource adaptor to be used | -+----------------+------------------------------------------------------------------------------------------+ -| **resource** | Type of resource to retrieve | -+----------------+------------------------------------------------------------------------------------------+ -| **key** | SQL-like string specifying criteria for retrieval | -+----------------+------------------------------------------------------------------------------------------+ -| **pfx** | Prefix to add to context variable names set for data retrieved | -+----------------+------------------------------------------------------------------------------------------+ -| **select** | String to specify, if key matches multiple entries, which entry should take precedence | -+----------------+------------------------------------------------------------------------------------------+ -| **order-by** | Prefix to add to context variable names set for data retrieved | -+----------------+------------------------------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -None - -Outcomes -^^^^^^^^ - -+-----------------+--------------------------------------------------+ -| **success** | Resource successfully retrieved | -+-----------------+--------------------------------------------------+ -| **not-found** | Resource referenced does not exist | -+-----------------+--------------------------------------------------+ -| **failure** | Resource retrieve failed for some other reason | -+-----------------+--------------------------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - - - - - -Is-available node -~~~~~~~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -An **is-available** node is used to determine whether a particular type -of resource is available. For example, this might be used to test -whether any ports are available for assignment on a particular switch. - -Attributes -^^^^^^^^^^ - -+----------------+------------------------------------------------------------------+ -| **plugin** | Fully qualified Java class of resource adaptor to be used | -+----------------+------------------------------------------------------------------+ -| **resource** | Type of resource to check | -+----------------+------------------------------------------------------------------+ -| **key** | SQL-like string specifying key to check for | -+----------------+------------------------------------------------------------------+ -| **pfx** | Prefix to add to context variable names set for data retrieved | -+----------------+------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -None - -Outcomes -^^^^^^^^ - -+-------------+---------------------------------------+ -| **true** | Resource requested is available | -+-------------+---------------------------------------+ -| **false** | Resource requested is not available | -+-------------+---------------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - - -Notify node -~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **notify** node is used to inform an external application (e.g. A&AI) -that a resource was updated. - -Attributes -^^^^^^^^^^ - -+----------------+---------------------------------------------------------------------+ -| **plugin** | Fully qualified Java class of resource adaptor to be used | -+----------------+---------------------------------------------------------------------+ -| **resource** | Identifies resource that was updated | -+----------------+---------------------------------------------------------------------+ -| **action** | Action that triggered notification to be sent (ADD/UPDATE/DELETE) | -+----------------+---------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -None - -Outcomes -^^^^^^^^ - -+---------------+----------------------------------------+ -| **success** | Notification was successful | -+---------------+----------------------------------------+ -| **failure** | Notification failed is not available | -+---------------+----------------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - - -Release node -~~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **release** node is used to mark a resource as no longer in use, and -thus available for assignment. - -Attributes -^^^^^^^^^^ - -+----------------+------------------------------------------------------------------+ -| **plugin** | Fully qualified Java class of resource adaptor to be used | -+----------------+------------------------------------------------------------------+ -| **resource** | Type of resource to release | -+----------------+------------------------------------------------------------------+ -| **key** | SQL-like string specifying key to check of resource to release | -+----------------+------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -None - -Outcomes -^^^^^^^^ - -+-----------------+-------------------------------------------------+ -| **success** | Resource successfully released | -+-----------------+-------------------------------------------------+ -| **not-found** | Resource referenced does not exist | -+-----------------+-------------------------------------------------+ -| **failure** | Resource release failed for some other reason | -+-----------------+-------------------------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - - - - - -Reserve node -~~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **reserve** node is used to reserve a particular type of resource.. -For example, this might be used to reserve a port on a particular -switch. - -Attributes -^^^^^^^^^^ - -+----------------+----------------------------------------------------------------------------------------------+ -| **plugin** | Fully qualified Java class of resource adaptor to be used | -+----------------+----------------------------------------------------------------------------------------------+ -| **resource** | Type of resource to reserve | -+----------------+----------------------------------------------------------------------------------------------+ -| **key** | SQL-like string specifying criteria for reservation | -+----------------+----------------------------------------------------------------------------------------------+ -| **select** | String to specify, if **key** matches multiple entries, which entry should take precedence | -+----------------+----------------------------------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -None - -Outcomes -^^^^^^^^ - -+---------------+----------------------------------------------------+ -| **success** | Resource requested was successfully reserved | -+---------------+----------------------------------------------------+ -| **failure** | Resource requested was not successfully reserved | -+---------------+----------------------------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - - -Save node -~~~~~~~~~ - -Description -^^^^^^^^^^^ - -A **save** node is used to save information about a particular resource -to persistent storage. For example, this might be used to save -information about a particular uni-port. - -Attributes -^^^^^^^^^^ - -+----------------+------------------------------------------------------------------------------------------+ -| **plugin** | Fully qualified Java class of resource adaptor to be used | -+----------------+------------------------------------------------------------------------------------------+ -| **resource** | Type of resource to save | -+----------------+------------------------------------------------------------------------------------------+ -| **key** | SQL-like string specifying criteria for retrieval | -+----------------+------------------------------------------------------------------------------------------+ -| **force** | If "true", save resource even if this resource is already stored in persistent storage | -+----------------+------------------------------------------------------------------------------------------+ -| **pfx** | Prefix to be prepended to variable names, when attributes are set in SvcLogicContext | -+----------------+------------------------------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -Values to save (columns) are specified as parameters, with each name -corresponding to a column name and each value corresponding to the value -to set. - -Outcomes -^^^^^^^^ - -+---------------+-------------------------------+ -| **success** | Resource successfully saved | -+---------------+-------------------------------+ -| **failure** | Resource save failed | -+---------------+-------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - - -Update node -~~~~~~~~~~~ - -Description -^^^^^^^^^^^ - -An **update** node is used to update information about a particular -resource to persistent storage. - -Attributes -^^^^^^^^^^ - -+----------------+----------------------------------------------------------------------------------------+ -| **plugin** | Fully qualified Java class of resource adaptor to be used | -+----------------+----------------------------------------------------------------------------------------+ -| **resource** | Type of resource to update | -+----------------+----------------------------------------------------------------------------------------+ -| **key** | SQL-like string specifying criteria for retrieval | -+----------------+----------------------------------------------------------------------------------------+ -| **pfx** | Prefix to be prepended to variable names, when attributes are set in SvcLogicContext | -+----------------+----------------------------------------------------------------------------------------+ - -Parameters -^^^^^^^^^^ - -Values to save (columns) are specified as parameters, with each name -corresponding to a column name and each value corresponding to the value -to set. - -Outcomes -^^^^^^^^ - -+---------------+-------------------------------+ -| **success** | Resource successfully saved | -+---------------+-------------------------------+ -| **failure** | Resource save failed | -+---------------+-------------------------------+ - -Example -^^^^^^^ - -:: - - - - - - - - - diff --git a/docs/sli/northbound/docs/offeredapis.rst b/docs/sli/northbound/docs/offeredapis.rst deleted file mode 100644 index 2eebdec9..00000000 --- a/docs/sli/northbound/docs/offeredapis.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Offered APIs -============ - -.. toctree:: - :maxdepth: 1 - :titlesonly: - - apis/asdcApi.rst - apis/dataChange.rst - diff --git a/docs/sli/northbound/docs/release-notes.rst b/docs/sli/northbound/docs/release-notes.rst deleted file mode 100644 index 21ff338c..00000000 --- a/docs/sli/northbound/docs/release-notes.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. - -Release Notes -============= - -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. - - -Version: x.y.z --------------- - - -:Release Date: yyyy-mm-dd - - - -**New Features** - -One or two sentences explaining the purpose of this Release. - -**Bug Fixes** - - `CIMAN-65 `_ and a sentence explaining what this defect is addressing. -**Known Issues** - - `CIMAN-65 `_ and two, three sentences. - One sentences explaining what is the issue. - - Another sentence explaining the impact of the issue. - - And an optional sentence providing a workaround. - -**Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ - - -**Upgrade Notes** - -**Deprecation Notes** - -**Other** - -- 2.16.6