<Please fill out the above fields, and the Overview, Design and User Experience sections below for an initial review of the proposed feature.>
Scope and Signoff:(to be filled out by Chair)
Overview
<Briefly describe the problem being solved, not how the problem is solved, just focus on the problem. Think about why the feature is needed, and what is the relevant context to understand the problem.>
Enable code to be called by anax on a target edge node before and/or after deploying a workload, and before and/or after removing a workload. Allow optional implicit and explicit configuration to be passed to the code from a workload's Service Definition or Deployment Policy. Determine if there should also be node restart and workload upgrade and rollback events.
Design
<Describe how the problem is fixed. Include all affected components. Include diagrams for clarity. This should be the longest section in the document. Use the sections below to call out specifics related to each aspect of the overall system, and refer back to this section for context. Provide links to any relevant external information.>
User Experience
As a solution architect, I want to be able to call third party components before or after specific workload lifecycle events, and have the lifecycle pause while the third-party component(s) take(s) action. I expect Open Horizon to pass information along with the event so that the third-party component understands the workload and deployment target. I expect documentation to be provided describing the structure and contents of an event payload. I expect documentation to list all of the interesting moments when events can be thrown. And I expect examples showing how to subscribe to events and use the provided payloads.
As a system administrator integrating the deployed workload with a third-party solution, I expect to be able to subscribe to one or more events using a common and secure eventing standard. I expect the event to include a payload in a common format (JSON?). I expect the payload to include information about the workload, workload configuration, host, node configuration, and optionally information about the third-party solution's desired configuration. And I expect to be able to subscribe (and unsubscribe) to events without code.
Command Line Interface
<Describe any changes to the hzn CLI, including before and after command examples for clarity. Include which users will use thechanged CLI. This section should flow very naturally from the User Experience section.>
External Components
<Describe any new or changed interactions with components that are not the agent or the management hub.>
Affected Components
<List all of theinternalcomponents (agent, MMS, Exchange, etc) which need to be updated to support the proposed feature. Include a link to the github epic for this feature (and the epic should contain the github issues for each component).>
Security
<Describe any related security aspects of the solution. Think about security of components interacting with each other, users interacting with the system, components interacting with external systems, permissions of users or components>
APIs
<Describe and new/changed/deprecated APIs, including before and after snippets for clarity. Include which components or users will use the APIs.>
Build, Install, Packaging
<Describe any changes to the way any component of the system is built (e.g. agent packages, containers, etc), installed (operators, manual install, batch install, SDO), configured, and deployed (consider the hub and edge nodes).>
Documentation Notes
<Describe the aspects of documentation that will be new/changed/updated. Be sure to indicate if this is new or changed doc, the impacted artifacts (e.g. technical doc, website, etc) and links to the related doc issue(s) in github.>
Test
<Summarize new automated tests that need to be added in support of this feature, and describe any special test requirements that you can foresee.>