-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* initial plugin implementation * rename to webhook Signed-off-by: Raffaele Di Fazio <[email protected]> * json encoder changes Signed-off-by: Raffaele Di Fazio <[email protected]> * addressing review comments Signed-off-by: Raffaele Di Fazio <[email protected]> * changes according to ionos review Signed-off-by: Raffaele Di Fazio <[email protected]> * fix to accomodate changes in master Signed-off-by: Raffaele Di Fazio <[email protected]> * fixes to accomodate master changes Signed-off-by: Raffaele Di Fazio <[email protected]> * remove all propertyvaluesequals leftovers Signed-off-by: Raffaele Di Fazio <[email protected]> * readd negotiation to pass the domain filter around Signed-off-by: Raffaele Di Fazio <[email protected]> * fix domain filter passing Signed-off-by: Raffaele Di Fazio <[email protected]> * webhook fixes Signed-off-by: Raffaele Di Fazio <[email protected]> * fix tests Signed-off-by: Raffaele Di Fazio <[email protected]> * fix docs Signed-off-by: Raffaele Di Fazio <[email protected]> * docs fixes Signed-off-by: Raffaele Di Fazio <[email protected]> * code review comments on json unmarshal Signed-off-by: Raffaele Di Fazio <[email protected]> * handle error in adjustendpoints Signed-off-by: Raffaele Di Fazio <[email protected]> * fix a bunch of wrong require Signed-off-by: Raffaele Di Fazio <[email protected]> * tests and docs Signed-off-by: Raffaele Di Fazio <[email protected]> * fix typo Signed-off-by: Raffaele Di Fazio <[email protected]> --------- Signed-off-by: Raffaele Di Fazio <[email protected]>
- Loading branch information
Showing
11 changed files
with
990 additions
and
2 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # Webhook provider | ||
|
|
||
| The "Webhook" provider allows integrating ExternalDNS with DNS providers through an HTTP interface. | ||
| The Webhook provider implements the `Provider` interface. Instead of implementing code specific to a provider, it implements an HTTP client that sends requests to an HTTP API. | ||
| The idea behind it is that providers can be implemented in separate programs: these programs expose an HTTP API that the Webhook provider interacts with. The ideal setup for providers is to run as a sidecar in the same pod of the ExternalDNS container, listening only on localhost. This is not strictly a requirement, but we do not recommend other setups. | ||
|
|
||
| ## Architectural diagram | ||
|
|
||
|  | ||
|
|
||
| ## API guarantees | ||
|
|
||
| Providers implementing the HTTP API have to keep in sync with changes to the JSON serialization of Go types `plan.Changes`, `endpoint.Endpoint`, and `endpoint.DomainFilter`. Given the maturity of the project, we do not expect to make significant changes to those types, but can't exclude the possibility that changes will need to happen. We commit to publishing changes to those in the release notes, to ensure that providers implementing the API can keep providers up to date quickly. | ||
|
|
||
| ## Implementation requirements | ||
|
|
||
| The following table represents the methods to implement mapped to their HTTP method and route. | ||
|
|
||
| | Provider method | HTTP Method | Route | | ||
| | --- | --- | --- | | ||
| | Records | GET | /records | | ||
| | AdjustEndpoints | POST | /adjustendpoints | | ||
| | ApplyChanges | POST | /records | | ||
|
|
||
| ExternalDNS will also make requests to the `/` endpoint for negotiation and for deserialization of the `DomainFilter`. | ||
|
|
||
| The server needs to respond to those requests by reading the `Accept` header and responding with a corresponding `Content-Type` header specifying the supported media type format and version. | ||
|
|
||
| **NOTE**: only `5xx` responses will be retried and only `20x` will be considered as successful. All status codes different from those will be considered a failure on ExternalDNS's side. | ||
|
|
||
| ## Provider registry | ||
|
|
||
| To simplify the discovery of providers, we will accept pull requests that will add links to providers in the [README](../../README.md) file. This list will only serve the purpose of simplifying finding providers and will not constitute an official endorsement of any of the externally implemented providers unless otherwise stated. | ||
|
|
||
| ## Run the AWS provider with the webhook provider. | ||
|
|
||
| To test the Webhook provider and provide a reference implementation, we added the functionality to run the AWS provider as a webhook. To run the AWS provider as a webhook, you need the following flags: | ||
|
|
||
| ```yaml | ||
| - --provider=webhook | ||
| - --run-aws-provider-as-webhook | ||
| ``` | ||
| What will happen behind the scenes is that the AWS provider will be be started as an HTTP server exposed only on localhost and the webhook provider will be configured to talk to it. This is the same setup that we recommend for other providers and a good way to test the Webhook provider. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.