summaryrefslogtreecommitdiffstats
path: root/release-notes
diff options
context:
space:
mode:
authorJan Srnicek <jsrnicek@cisco.com>2017-08-15 11:44:09 +0200
committerJan Srnicek <jsrnicek@cisco.com>2017-08-15 11:44:09 +0200
commitc643983450d5fd56db40ad2718877ec2289e6e6f (patch)
treea48c1b45c71bdc3852a6b20fb60e596fa92dc5d8 /release-notes
parent6923420946f05308af6a073d270df41d069dd532 (diff)
Honeycomb docs update
Change-Id: I3f65dffad169634e5cf273d8568066b7f15bda37 Signed-off-by: Jan Srnicek <jsrnicek@cisco.com>
Diffstat (limited to 'release-notes')
-rw-r--r--release-notes/src/main/asciidoc/devel_guide/devel_plugin_overview.adoc4
-rw-r--r--release-notes/src/main/asciidoc/release_notes.adoc5
2 files changed, 7 insertions, 2 deletions
diff --git a/release-notes/src/main/asciidoc/devel_guide/devel_plugin_overview.adoc b/release-notes/src/main/asciidoc/devel_guide/devel_plugin_overview.adoc
index 876e3ec..9c730be 100644
--- a/release-notes/src/main/asciidoc/devel_guide/devel_plugin_overview.adoc
+++ b/release-notes/src/main/asciidoc/devel_guide/devel_plugin_overview.adoc
@@ -11,9 +11,9 @@ Honeycomb provides a framework for plugins to participate in the data handling.
A plugin usually consists of:
* *YANG models* - These models contain data and notification definitions that are implemented by the plugin. ODL's Yangtools project is used to generate Java APIs from those models (called Binding Aware APIs in ODL) and are later used in the translation code.
-* *Set of readers* - Readers provide operational/state data from plugin or its underlying layer. This means that operational/state data is current state of the plugin or its underlying layer. Readers return these operational data by e.g. reading from underlying layer and transforming it into YANG modeled data.
+* *Set of readers/initializing readers* - Readers provide operational/state data from plugin or its underlying layer. This means that operational/state data is current state of the plugin or its underlying layer. Readers return these operational data by e.g. reading from underlying layer and transforming it into YANG modeled data.
+Its also reader's responsibility to initialize configuration data from what was read from operational data storage. Initializers are invoked right after Honeycomb starts. The goal here is to read current operational/state data of the plugin or its underlying layer and then transform the operational data into configuration data. This enables reconciliation in cases when Honeycomb looses it's persisted data, or is started fresh while the underlying layer already contains some configuration that is manifested as operational/state data
* *Set of writers* - Writers handle configuration data for the plugin or its underlying layer This means that configuration data is the intent being sent to Honeycomb, that should be passed to plugins or their underlying layers. Writers handle these configuration data by transforming YANG modeled data into e.g. underlying layer calls.
-* *Set of initializers* - Initializers are invoked right after Honeycomb starts. The gould here is to read current operational/state data of the plugin or its underlying layer and then transform the operational data into configuration data. This enables reconciliation in cases when Honeycomb looses it's persisted data, or is started fresh while the underlying layer already contains some configuration that is manifested as operational/state data
* *Plugin configuration* - Usually configuration in json format + it's Java equivalent.
* *Set of notification producers* - If there are any notifications, the producers transform the data into YANG model notifications and emit them.
* *Module* - Small class instantiating & exposing plugin's components
diff --git a/release-notes/src/main/asciidoc/release_notes.adoc b/release-notes/src/main/asciidoc/release_notes.adoc
index 1250e5e..8d687df 100644
--- a/release-notes/src/main/asciidoc/release_notes.adoc
+++ b/release-notes/src/main/asciidoc/release_notes.adoc
@@ -20,6 +20,11 @@ https://wiki.fd.io/view/Honeycomb/Release_Plans/Release_Plan_{project-public-ver
Adding to the list of existing features: https://docs.fd.io/honeycomb/1.17.07/release-notes-aggregator/release_notes.html#_features[1707 feature list]
=== New features
+* https://jira.fd.io/browse/HONEYCOMB-381[Shutdown handler] - Serves as an utility to properly close shutdown closeable resources(Everything that implements AutoCloseable).
+To use just @Inject ShutdownHandler and register resources with method *register()*
+* https://jira.fd.io/browse/HONEYCOMB-362[ODL carbon] - Honeycomb infrastracture has been updated to use ODL dependencies from Carbon version.
+* https://jira.fd.io/browse/HONEYCOMB-360[Separated Northbound Interfaces] - Every northbound interface now lives under separate module, which brings optimization
+improvement, as every interface uses different subset of YANG modules.
=== Removed features