From bfa4e0620d045fbaa708d4660b7cce620284c11b Mon Sep 17 00:00:00 2001 From: Raffaele Di Fazio Date: Fri, 24 May 2024 17:31:44 +0200 Subject: [PATCH] custom metrics docs --- docs/tutorials/webhook-provider.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/tutorials/webhook-provider.md b/docs/tutorials/webhook-provider.md index dd07e727f..c956ce325 100644 --- a/docs/tutorials/webhook-provider.md +++ b/docs/tutorials/webhook-provider.md @@ -31,11 +31,16 @@ The default recommended port is 8888, and should listen only on localhost (ie: o **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. - ## Metrics support The metrics should listen ":8080" on `/metrics` following [Open Metrics](https://github.com/OpenObservability/OpenMetrics) format. +## Custom Annotations + +The Webhook provider supports custom annotations for DNS records. This feature allows users to define additional configuration options for DNS records managed by the Webhook provider. Custom annotations are defined using the annotation format `external-dns.alpha.kubernetes.io/webhook-`. + +Custom annotations can be used to influence DNS record creation and updates. Providers implementing the Webhook API should document the custom annotations they support and how they affect DNS record management. + ## 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.