Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide capability to push events to Event Grid Topic #24

Closed
1 of 2 tasks
tomkerkhove opened this issue Jan 4, 2019 · 0 comments
Closed
1 of 2 tasks

Provide capability to push events to Event Grid Topic #24

tomkerkhove opened this issue Jan 4, 2019 · 0 comments
Assignees
Labels
feature All issues related to new features runtime All issues related to our runtime specs-defined All issues where the specifications are defined and ready to be implemented
Milestone

Comments

@tomkerkhove
Copy link
Contributor

tomkerkhove commented Jan 4, 2019

Provide capability to push events to Event Grid Topic via an HTTP POST.

The only required aspect is an event type & body; but they can opt-in to specify the following:

  • Event stamp (defaults to utc)
  • Event subject (no default)
  • Data version (defaults to 1)
  • Event id (defaults to new guid)

Event Grid Configuration

The container is in charge of determining what Event Grid Topic it should forward the events to and how to authenticate.

This is done via environment variables on the container itself:

  • ARCUS_EVENTGRID_TOPICENDPOINT - Endpoint of the topic
  • ARCUS_EVENTGRID_AUTHKEY - Authentication key for the topic

This means that one container can only forward events to a single topic.

Configuration should be:

  • Validated at startup
  • Documented how to configure and what it represents

API Specification

  • Verb: POST
  • Path: api/v1/events/{event-type}
  • Query parameters:
    • Event Id (optional, generated guid)
    • Event Stamp (optional, utc)
    • Subject (optional, empty by default)
    • Data version (optional, 1 by default)
  • Reponse Body: None
  • Response Headers:
    • X-Event-Id: Event-Id of emitted event
  • Reponse Codes:
    • 200: Healthy
    • 503: Unhealthy

Depends on arcus-azure/arcus.eventgrid#57

@tomkerkhove tomkerkhove added feature All issues related to new features specs-defined All issues where the specifications are defined and ready to be implemented runtime All issues related to our runtime labels Jan 4, 2019
@tomkerkhove tomkerkhove added this to the v0.1 milestone Jan 4, 2019
@tomkerkhove tomkerkhove self-assigned this Jan 4, 2019
tomkerkhove added a commit that referenced this issue Jan 4, 2019
Provide basic HTTP endpoint for emitting events with docs, but without implementation for now.

Relates to #24
tomkerkhove added a commit that referenced this issue Jan 28, 2019
- Provide capability to push events to Azure Event Grid via API
- Provide unit tests
- Provide integration tests
- Validation for configuration

Relates to #24 	and running integration tests in CI will be done via #28 	.

This PR depends on arcus-azure/arcus.eventgrid#65 as it's now using the preview package on MyGet and should be the official one instead.
tomkerkhove added a commit that referenced this issue Jan 28, 2019
Provide documentation for pushing events.

Closes #24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature All issues related to new features runtime All issues related to our runtime specs-defined All issues where the specifications are defined and ready to be implemented
Projects
None yet
Development

No branches or pull requests

1 participant