<html><head><meta http-equiv="Content-Type" content="text/html charset=windows-1252"></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;">Ok, here is what I think...<div><br></div><div>I totally support the first option for its easiness in terms of understanding how it all should work (no need to figure out if some additional objects must be deleted if a workflow has been removed etc. etc.). We actually have two BPS [0] and [1] where the idea was similar to your option #2. But I admit that they’ve been around for a while and I think are obsolete (even though having eventually the same goal of notifying the outside world about executions/tasks events).</div><div><br></div><div>The only thing I would like to suggest is how we define a callback (keeping in mind it should be a valid JSON in reality):</div><div><br></div><div><div>POST /executions<br> workflow_name=flow<br> callbacks=[{</div><div> events: [[on-task-complete, on-execution-complete]</div><div><span class="Apple-tab-span" style="white-space:pre"> </span>action: std.http url=‘<a href="http://foo.bar.com'">http://foo.bar.com'</a> method=POST headers=‘{}' ##</div><div> },</div><div> {# another callback}</div><div> ]<br><br></div><div>and/or</div><div><br></div><div>POST /executions<br> workflow_name=flow<br> callbacks=[{</div><div> events: [[on-task-complete, on-execution-complete]</div><div><span class="Apple-tab-span" style="white-space: pre;"> </span>action: std.http</div><div><span class="Apple-tab-span" style="white-space:pre"> </span>parameters: {</div><div><span class="Apple-tab-span" style="white-space:pre"> </span>url: <a href="http://foo.bar.com">http://foo.bar.com</a>,</div><div><span class="Apple-tab-span" style="white-space:pre"> </span>method: POST</div><div><span class="Apple-tab-span" style="white-space:pre"> </span>headers: {</div><div><span class="Apple-tab-span" style="white-space:pre"> </span># Whatever headers we need.</div><div><span class="Apple-tab-span" style="white-space:pre"> </span>} </div><div><span class="Apple-tab-span" style="white-space:pre"> </span>}</div><div> },</div><div> {# another callback} </div><div> ]</div></div><div><br></div><div>In other word we can trivially generalise this so that:</div><div><ul class="MailOutline"><li>we can use not only webhooks but any action accessible in Mistral (e.g. it may be other transport)</li><li>it is consistent with our DSL</li></ul></div><div><br></div><div>We might even want to allow “workflow” as well as “action” but not sure if we need to get that far for now.</div><div><br></div><div>Thoughts?</div><div><br></div><div>[0] <a href="https://blueprints.launchpad.net/mistral/+spec/mistral-event-listeners-amqp">https://blueprints.launchpad.net/mistral/+spec/mistral-event-listeners-amqp</a></div><div>[1] <a href="https://blueprints.launchpad.net/mistral/+spec/mistral-event-listeners-http">https://blueprints.launchpad.net/mistral/+spec/mistral-event-listeners-http</a></div><div><br><div>
<div>Renat Akhmerov</div><div>@ Mirantis Inc.</div><div><br></div><br class="Apple-interchange-newline">
</div>
<br><div><div>On 17 Sep 2014, at 10:36, Dmitri Zimine <<a href="mailto:dzimine@stackstorm.com">dzimine@stackstorm.com</a>> wrote:</div><br class="Apple-interchange-newline"><blockquote type="cite"><meta http-equiv="Content-Type" content="text/html charset=windows-1252"><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;"><div><b>Use case: </b><br>The client software fires the workflow execution and needs to be know when the workflow is complete. There is no good pool strategy as workflow can take arbitrary time from ms to days. Callback notification is needed. <br><font color="#007316"><br></font>Solution is a webhook<br><font color="#007316"><br></font><b>Option 1: pass callback URL as part of starting workflow execution:</b><br>POST /executions<br> workflow_name=flow<br> callback= {</div><div> events: [[on-task-complete, on-execution-complete]</div><div> url: <a href="http://bla.com/">http://bla.com</a><br> method:POST<br> headers: {}<br> … other stuff to form proper HTTP call, like API tokens, etc ...<br> }<br> …..<br><font color="#007316"><br><br></font><b>Option 2: webhook endpoint</b><br>Mistral exposes /webhook controller <br>Client creates a webhook and receives events for all executions for selected workflows. <br>{ <br> "name": "web",<br> "active": true,<br> "events": [ ]<br> “workflows”: [wf1, wf2] <br> "url": "<a href="http://example.com/webhook">http://example.com/webhook</a>", <br>}<br><font color="#007316"><br></font><b>Opinions: </b><br><br></div><div>DZ: my opinion: <br>Option 1 for it is simple and convenient for a client. <br>It seems like an optimal solution for “tracking executions and tasks” use case.<br><font color="#007316"><br></font>Option 2 is an overkill: makes it harder for a client (post workflow, post webhook, post execution, delete workflow, delete webhook) introduces lifecycle management problems (e.g., workflow deleted -> webhook orphaned).<br><font color="#007316"><br></font><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;"><div style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;"><div>I vaguely recall someone from Heat compared these options and regretted one of them for security reasons, but can’t remember details.</div><div><br></div></div></div></div><br></div>_______________________________________________<br>OpenStack-dev mailing list<br><a href="mailto:OpenStack-dev@lists.openstack.org">OpenStack-dev@lists.openstack.org</a><br>http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev<br></blockquote></div><br></div></body></html>