Marketplace Platform Integration Agent

Owned by Preston Lee
Last updated: Jun 03, 2021
1 min read

The Marketplace Platform Integration Agent – aka “Health Services Platform Agent”, “HSP Agent” or "Agent" – connects a https://logica.atlassian.net/wiki/spaces/GM/pages/2334916612 instance to https://logica.atlassian.net/wiki/pages/createpage.action?spaceKey=GM&title=Graphite%20Marketplace.

Functional Requirements

The Agent is run once per https://logica.atlassian.net/wiki/spaces/GM/pages/2334916612 instance. Functionally, it:

  1. MUST maintains a stateful SSE connection to https://logica.atlassian.net/wiki/pages/createpage.action?spaceKey=GM&title=Graphite%20Marketplace to receive realtime push events.

  2. MUST integrate with the local Platform’s container orchestration controller to request deployment and undeployment events, e.g. Swarm, Kubernetes, OpenShift etc

  3. MUST validate product licensing against https://logica.atlassian.net/wiki/pages/createpage.action?spaceKey=GM&title=Graphite%20Marketplace's licensing API.

  4. MUST receive whitelisted analytics events from deployed products.

  5. MUST relay received whitelisted analytics and logging events to the https://logica.atlassian.net/wiki/pages/createpage.action?spaceKey=GM&title=Graphite%20Marketplace metering API.

  6. MUST report provisioning changes outcomes and usage metrics to https://logica.atlassian.net/wiki/pages/createpage.action?spaceKey=GM&title=Graphite%20Marketplace so the Marketplace can compute dependency and billing targets correctly.

  7. SHOULD relay received whitelisted analytics and logging events to any local, member-specific log aggregation systems.

  8. SHOULD temporarily store message to retry in the event of failure.

The Agent is thus a lightweight component designed mostly as an event dispatcher between https://logica.atlassian.net/wiki/pages/createpage.action?spaceKey=GM&title=Graphite%20Marketplace, https://logica.atlassian.net/wiki/spaces/GM/pages/2334916612 and local logging systems. The Agent:

  1. MUST NOT support intentional transmission of PHI to https://logica.atlassian.net/wiki/pages/createpage.action?spaceKey=GM&title=Graphite%20Marketplace

  2. MUST support direct integration with the market leading container orchestration controllers.

local HIT infrastructure to one or more trusted HSP Marketplace instances, receiving deployment commands from the marketplace(s) and issuing platform-specific commands to the local devops platform.