https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/NETCONF-679 netconf <p>Currently RESTCONF notifications are delivered only over Websocket. According to RFC8040<span class="error">&#91;1&#93;</span> notifications must be sent over Server-Sent Events<span class="error">&#91;2&#93;</span></p> <p><span class="error">&#91;1&#93;</span> <a href="https://tools.ietf.org/html/rfc8040#section-3.8" class="external-link" target="_blank" rel="nofollow noopener">https://tools.ietf.org/html/rfc8040#section-3.8</a><br/> <span class="error">&#91;2&#93;</span> <a href="https://www.w3.org/TR/2015/REC-eventsource-20150203/" class="external-link" target="_blank" rel="nofollow noopener">https://www.w3.org/TR/2015/REC-eventsource-20150203/</a></p> <p> </p> <p> </p> <p>how to test this:</p> <p>1)./target/assembly/bin/client "feature:install odl-mdsal-model-inventory odl-netconf-mdsal odl-restconf odl-netconf-topology odl-netconf-connector-all odl-restconf-nb-rfc8040"</p> <p>2)from postman collection call "1. create" and "2.get"</p> <p>3)connect to url for example with curl :</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> curl -v -X GET http:<span class="code-comment">//127.0.0.1:8181/rests/notif/data-change-event-subscription/opendaylight-inventory:nodes/datastore=CONFIGURATION/scope=BASE -H <span class="code-quote">"Content-Type: text/event-stream"</span> -H <span class="code-quote">"Authorization: Basic YWRtaW46YWRtaW4="</span></span></pre> </div></div> <p>4) 3.update and 4. delete configuration and you must see data in SSE channel</p> <p> </p> <p> </p> NETCONF-679

RESTCONF RFC8040 compliance: SSE support

Improvement High Resolved Done Lukas Baca Valentin Mayamsin restconf Wed, 29 Apr 2020 17:41:15 +0000 Mon, 3 Aug 2020 16:58:24 +0000 Mon, 3 Aug 2020 16:58:24 +0000 Aluminium restconf-nb 0 5 <p>Hi <a href="https://jira.opendaylight.org/secure/ViewProfile.jspa?name=hjslgfsd7" class="user-hover" rel="hjslgfsd7">hjslgfsd7</a>, do you know of any person/team committed to working on this ticket for the Aluminium release?</p> <p>As commented in the Kernel call, we need to make sure SSE implementation conforms RFC8650 (<a href="https://tools.ietf.org/html/rfc8650" class="external-link" target="_blank" rel="nofollow noopener">https://tools.ietf.org/html/rfc8650</a>). This should not be much of concern because this newer RFC already says: "The streaming of notifications that encapsulate the resulting information push is done via the mechanism described in Section 6.3 of <span class="error">&#91;RFC8040&#93;</span>."</p> <p>There is one additional possibility sending ping as event(now is sending as data) but in RFC8040 is:</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> The SSE specification supports the following additional fields: <span class="code-quote">"event"</span>, <span class="code-quote">"id"</span>, and <span class="code-quote">"retry"</span>. A RESTCONF server MAY send the <span class="code-quote">"retry"</span> field, and <span class="code-keyword">if</span> it does, RESTCONF clients SHOULD use it. A RESTCONF server SHOULD NOT send the <span class="code-quote">"event"</span> or <span class="code-quote">"id"</span> fields, as there are no meaningful values that could be used <span class="code-keyword">for</span> them that would not be redundant to the contents of the notification itself. </pre> </div></div> <p> </p> <p> </p> <p>But probably will be nicer send it as event to split data part and keep-alive part</p> <p><a href="https://jira.opendaylight.org/secure/ViewProfile.jspa?name=tcere" class="user-hover" rel="tcere">tcere</a>, <a href="https://jira.opendaylight.org/secure/ViewProfile.jspa?name=rovarga" class="user-hover" rel="rovarga">rovarga</a>, any chance we can get a little progress on this? I think the patch was updated to keep<br/> both websocket as well as SSE (for backward compatibility). The netconf patch also depends on a AAA patch:<br/> <a href="https://git.opendaylight.org/gerrit/c/aaa/+/89860" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/c/aaa/+/89860</a></p> <p><a href="https://jira.opendaylight.org/secure/ViewProfile.jspa?name=blukas" class="user-hover" rel="blukas">blukas</a> I have tested the build from your patch ([gerrit patch|<a href="https://git.opendaylight.org/gerrit/c/netconf/+/90229" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/c/netconf/+/90229</a>]) The SSE support looks like its working. Can you confirm my results when subscribing to the event-stream:</p> <p> </p> <p> </p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java"> [jenkins@ip-10-1-97-74 ~]$ curl -v -X GET http:<span class="code-comment">//127.0.0.1:8181/rests/notif/data-change-event-subscription/opendaylight-inventory:nodes/datastore=CONFIGURATION/scope=BASE -H <span class="code-quote">"Content-Type: text/event-stream"</span> -H <span class="code-quote">"Authorization: Basic YWRtaW46YWRtaW4="</span> </span>* About to connect() to 127.0.0.1 port 8181 (#0) * Trying 127.0.0.1... * Connected to 127.0.0.1 (127.0.0.1) port 8181 (#0) &gt; GET /rests/notif/data-change-event-subscription/opendaylight-inventory:nodes/datastore=CONFIGURATION/scope=BASE HTTP/1.1 &gt; User-Agent: curl/7.29.0 &gt; Host: 127.0.0.1:8181 &gt; Accept: */* &gt; Content-Type: text/event-stream &gt; Authorization: Basic YWRtaW46YWRtaW4= &gt; &lt; HTTP/1.1 200 OK &lt; Set-Cookie: JSESSIONID=node0remdbub5qc81g4ikedstbyu53.node0; Path=/; HttpOnly &lt; Expires: Thu, 01 Jan 1970 00:00:00 GMT &lt; Set-Cookie: rememberMe=deleteMe; Path=/; Max-Age=0; Expires=Tue, 14-Jul-2020 23:15:31 GMT &lt; Content-Type: text/event-stream &lt; Transfer-Encoding: chunked &lt; : ping : ping : ping : ping : ping : ping : ping : ping data: &lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span> standalone=<span class="code-quote">"no"</span>?&gt; data: &lt;notification xmlns=<span class="code-quote">"urn:ietf:params:xml:ns:netconf:notification:1.0"</span>&gt; data: &lt;eventTime&gt;2020-07-15T23:17:06.438654Z&lt;/eventTime&gt; data: &lt;data-changed-notification xmlns=<span class="code-quote">"urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote"</span>&gt; data: &lt;data-change-event&gt; data: &lt;path&gt;/opendaylight-inventory:nodes&lt;/path&gt; data: &lt;operation&gt;created&lt;/operation&gt; data: &lt;data&gt; data: &lt;nodes xmlns=<span class="code-quote">"urn:opendaylight:inventory"</span>&gt; data: &lt;node&gt; data: &lt;id&gt;agent-007dd&lt;/id&gt; data: &lt;/node&gt; data: &lt;/nodes&gt; data: &lt;/data&gt; data: &lt;/data-change-event&gt; data: &lt;data-change-event&gt; data: &lt;path&gt;/opendaylight-inventory:nodes/opendaylight-inventory:node/opendaylight-inventory:node[opendaylight-inventory:id=<span class="code-quote">'agent-007dd'</span>]&lt;/path&gt; data: &lt;operation&gt;created&lt;/operation&gt; data: &lt;data&gt; data: &lt;node xmlns=<span class="code-quote">"urn:opendaylight:inventory"</span>&gt; data: &lt;id&gt;agent-007dd&lt;/id&gt; data: &lt;/node&gt; data: &lt;/data&gt; data: &lt;/data-change-event&gt; data: &lt;data-change-event&gt; data: &lt;path&gt;/opendaylight-inventory:nodes/opendaylight-inventory:node/opendaylight-inventory:node[opendaylight-inventory:id=<span class="code-quote">'agent-007dd'</span>]/opendaylight-inventory:id&lt;/path&gt; data: &lt;operation&gt;created&lt;/operation&gt; data: &lt;data&gt; data: &lt;id xmlns=<span class="code-quote">"urn:opendaylight:inventory"</span>&gt;agent-007dd&lt;/id&gt; data: &lt;/data&gt; data: &lt;/data-change-event&gt; data: &lt;/data-changed-notification&gt; data: &lt;/notification&gt; data: : ping : ping : ping : ping : ping : ping : ping : ping : ping : ping : ping : ping : ping : ping data: &lt;?xml version=<span class="code-quote">"1.0"</span> encoding=<span class="code-quote">"UTF-8"</span> standalone=<span class="code-quote">"no"</span>?&gt; data: &lt;notification xmlns=<span class="code-quote">"urn:ietf:params:xml:ns:netconf:notification:1.0"</span>&gt; data: &lt;eventTime&gt;2020-07-15T23:19:22.668968Z&lt;/eventTime&gt; data: &lt;data-changed-notification xmlns=<span class="code-quote">"urn:opendaylight:params:xml:ns:yang:controller:md:sal:remote"</span>&gt; data: &lt;data-change-event&gt; data: &lt;path&gt;/opendaylight-inventory:nodes&lt;/path&gt; data: &lt;operation&gt;deleted&lt;/operation&gt; data: &lt;/data-change-event&gt; data: &lt;data-change-event&gt; data: &lt;path&gt;/opendaylight-inventory:nodes/opendaylight-inventory:node/opendaylight-inventory:node[opendaylight-inventory:id=<span class="code-quote">'agent-007dd'</span>]&lt;/path&gt; data: &lt;operation&gt;deleted&lt;/operation&gt; data: &lt;/data-change-event&gt; data: &lt;data-change-event&gt; data: &lt;path&gt;/opendaylight-inventory:nodes/opendaylight-inventory:node/opendaylight-inventory:node[opendaylight-inventory:id=<span class="code-quote">'agent-007dd'</span>]/opendaylight-inventory:id&lt;/path&gt; data: &lt;operation&gt;deleted&lt;/operation&gt; data: &lt;/data-change-event&gt; data: &lt;/data-changed-notification&gt; data: &lt;/notification&gt; data: </pre> </div></div> <p> </p> <p> </p> <p>yes this looks good. We can see ping message as comment. And in same time data messages</p> Blocks AAA-199 Development Rank 0|i03s8n: