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

Fixes #18443: Introduce Webhook realm provider #509

Closed
wants to merge 1 commit into from
Closed

Fixes #18443: Introduce Webhook realm provider #509

wants to merge 1 commit into from

Conversation

joshmue
Copy link

@joshmue joshmue commented Feb 9, 2017

Generic realm provider notifying other services/realms about the creation or deletion of hosts via HTTP Webhooks. (See redmine ticket, too)

This provider is able to send custumizable HTTP POST-requests ("Webhook") to a HTTP-Server. E.g.

{"operation":"create","hostname":"host.lan","params":{"userclass":"User class",...}}

The HTTP-Server should respond with JSON, too. E.g. on creation:

{"randompassword": "foo"}

As Webhooks are not a strict standard, the HTTP headers can be extended and the JSON keys in the body are also customizable.

There is opt-in support for a request signing procedure described in https://developer.github.com/webhooks/securing/

Generic realm provider notifying other services/realms about the
creation or deletion of hosts via HTTP Webhooks
@dmitri-d
Copy link
Member

Thanks for your PR!

Recent changes in smart-proxy's realm module were implemented (in part) to allow to keep realm providers separate from the core code. I would suggest creating a dedicated repository for webhooks realm provider and packaging the code as a gem. This wouldn't require significant changes, mostly things to support gem packaging. You can find a bit more information at http://projects.theforeman.org/projects/foreman/wiki/How_to_Create_a_Smart-Proxy_Plugin#Bundler-Configuration and http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Smart-Proxy_Plugin.

Additionally, it might be useful to include in README docs links to projects, repositories, or example setups that use webhooks api to provide interface for realm services.

@joshmue
Copy link
Author

joshmue commented Feb 13, 2017

Thank you for the reply,

I will start working on this 👍

Closing this PR in favor of the gem approach...

@joshmue joshmue closed this Feb 13, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants