feat(ovh): major rewriting of the provider (#5143)

* feat: ovh: improve cache invalidation on errors + dry-run mode + relative CNAME handling + optimization

Signed-off-by: Romain Beuque <[email protected]>

* chore: add more tests

Signed-off-by: Romain Beuque <[email protected]>

* fix: align cache expiration with Default value

* chore: address comments from review + updated documentation

* chore: address comments from review

---------

Signed-off-by: Romain Beuque <[email protected]>

Author: rbeuque74

README.md

@@ -57,7 +57,7 @@ ExternalDNS allows you to keep selected zones (via `--domain-filter`) synchroniz
 - [RFC2136](https://tools.ietf.org/html/rfc2136)
 - [NS1](https://ns1.com/)
 - [TransIP](https://www.transip.eu/domain-name/)
-- [OVH](https://www.ovh.com)
+- [OVHcloud](https://www.ovhcloud.com)
 - [Scaleway](https://www.scaleway.com)
 - [Akamai Edge DNS](https://learn.akamai.com/en-us/products/cloud_security/edge_dns.html)
 - [GoDaddy](https://www.godaddy.com)
@@ -85,7 +85,7 @@ See PR #3063 for all the discussions about it.
 Known providers using webhooks:
 
 | Provider              | Repo                                                                 |
-|-----------------------|----------------------------------------------------------------------|
+| --------------------- | -------------------------------------------------------------------- |
 | Abion                 | https://github.com/abiondevelopment/external-dns-webhook-abion       |
 | Adguard Home Provider | https://github.com/muhlba91/external-dns-provider-adguard            |
 | Anexia                | https://github.com/ProbstenHias/external-dns-anexia-webhook          |
@@ -145,7 +145,7 @@ The following table clarifies the current status of the providers according to t
 | RFC2136 | Alpha | |
 | NS1 | Alpha | |
 | TransIP | Alpha | |
-| OVH | Alpha | |
+| OVHcloud | Beta | @rbeuque74 |
 | Scaleway DNS | Alpha | @Sh4d1 |
 | UltraDNS | Alpha | |
 | GoDaddy | Alpha | |
@@ -207,7 +207,7 @@ The following tutorials are provided:
 - [PowerDNS](docs/tutorials/pdns.md)
 - [RFC2136](docs/tutorials/rfc2136.md)
 - [TransIP](docs/tutorials/transip.md)
-- [OVH](docs/tutorials/ovh.md)
+- [OVHcloud](docs/tutorials/ovh.md)
 - [Scaleway](docs/tutorials/scaleway.md)
 - [UltraDNS](docs/tutorials/ultradns.md)
 - [GoDaddy](docs/tutorials/godaddy.md)

docs/flags.md

@@ -107,6 +107,7 @@
 | `--inmemory-zone=` | Provide a list of pre-configured zones for the inmemory provider; specify multiple times for multiple zones (optional) |
 | `--ovh-endpoint="ovh-eu"` | When using the OVH provider, specify the endpoint (default: ovh-eu) |
 | `--ovh-api-rate-limit=20` | When using the OVH provider, specify the API request rate limit, X operations by seconds (default: 20) |
+| `--[no-]ovh-enable-cname-relative` | When using the OVH provider, specify if CNAME should be treated as relative on target without final dot (default: false) |
 | `--pdns-server="http://localhost:8081"` | When using the PowerDNS/PDNS provider, specify the URL to the pdns server (required when --provider=pdns) |
 | `--pdns-server-id="localhost"` | When using the PowerDNS/PDNS provider, specify the id of the server to retrieve. Should be `localhost` except when the server is behind a proxy (optional when --provider=pdns) (default: localhost) |
 | `--pdns-api-key=""` | When using the PowerDNS/PDNS provider, specify the API key to use to authorize requests (required when --provider=pdns) |

docs/tutorials/ovh.md

@@ -1,30 +1,31 @@
 # OVHcloud
 
 This tutorial describes how to setup ExternalDNS for use within a
-Kubernetes cluster using OVH DNS.
+Kubernetes cluster using OVHcloud DNS.
 
 Make sure to use **>=0.6** version of ExternalDNS for this tutorial.
 
-## Creating a zone with OVH DNS
+## Creating a zone with OVHcloud DNS
 
-If you are new to OVH, we recommend you first read the following
+If you are new to OVHcloud, we recommend you first read the following
 instructions for creating a zone.
 
-[Creating a zone using the OVH manager](https://docs.ovh.com/gb/en/domains/create_a_dns_zone_for_a_domain_which_is_not_registered_at_ovh/)
+[Creating a zone using the OVHcloud Manager](https://help.ovhcloud.com/csm/en-gb-dns-create-dns-zone?id=kb_article_view&sysparm_article=KB0051667/)
 
-[Creating a zone using the OVH API](https://api.ovh.com/console/)
+[Creating a zone using the OVHcloud API](https://api.ovh.com/console/)
 
-## Creating OVH Credentials
+## Creating OVHcloud Credentials
 
-You first need to create an OVH application.
-
-Using the [OVH documentation](https://docs.ovh.com/gb/en/api/first-steps-with-ovh-api/#advanced-usage-pair-ovhcloud-apis-with-an-application_2) you will have your `Application key` and `Application secret`
+You first need to create an OVHcloud application: follow the
+[OVHcloud documentation](https://help.ovhcloud.com/csm/en-gb-api-getting-started-ovhcloud-api?id=kb_article_view&sysparm_article=KB0042784#advanced-usage-pair-ovhcloud-apis-with-an-application)
+ you will have your `Application key` and `Application secret`
 
 And you will need to generate your consumer key, here the permissions needed :
 
 - GET on `/domain/zone`
 - GET on `/domain/zone/*/record`
 - GET on `/domain/zone/*/record/*`
+- PUT on `/domain/zone/*/record/*`
 - POST on `/domain/zone/*/record`
 - DELETE on `/domain/zone/*/record/*`
 - GET on `/domain/zone/*/soa`
@@ -51,6 +52,10 @@ curl -XPOST -H "X-Ovh-Application: <ApplicationKey>" -H "Content-type: applicati
       "method": "GET",
       "path": "/domain/zone/*/record/*"
     },
+    {
+      "method": "PUT",
+      "path": "/domain/zone/*/record/*"
+    },
     {
       "method": "POST",
       "path": "/domain/zone/*/record"
@@ -223,7 +228,7 @@ spec:
 
 **A note about annotations**
 
-Verify that the annotation on the service uses the same hostname as the OVH DNS zone created above. The annotation may also be a subdomain of the DNS zone (e.g. 'www.example.com').
+Verify that the annotation on the service uses the same hostname as the OVHcloud DNS zone created above. The annotation may also be a subdomain of the DNS zone (e.g. 'www.example.com').
 
 The TTL annotation can be used to configure the TTL on DNS records managed by ExternalDNS and is optional. If this annotation is not set, the TTL on records managed by ExternalDNS will default to 10.
 
@@ -235,11 +240,11 @@ ExternalDNS uses the hostname annotation to determine which services should be r
 kubectl create -f nginx.yaml
 ```
 
-Depending on where you run your service, it may take some time for your cloud provider to create an external IP for the service. Once an external IP is assigned, ExternalDNS detects the new service IP address and synchronizes the OVH DNS records.
+Depending on where you run your service, it may take some time for your cloud provider to create an external IP for the service. Once an external IP is assigned, ExternalDNS detects the new service IP address and synchronizes the OVHcloud DNS records.
 
-## Verifying OVH DNS records
+## Verifying OVHcloud DNS records
 
-Use the OVH manager or API to verify that the A record for your domain shows the external IP address of the services.
+Use the OVHcloud manager or API to verify that the A record for your domain shows the external IP address of the services.
 
 ## Cleanup
 

internal/gen/docs/flags/main.go

@@ -46,7 +46,7 @@ func (f *Flags) addFlag(name, description string) {
 
 // It generates a markdown file
 // with the supported flags and writes it to the 'docs/flags.md' file.
-// to re-generate `docs/flags.md` execute 'go run internal/gen/main.go'
+// to re-generate `docs/flags.md` execute 'go run internal/gen/docs/flags/main.go'
 func main() {
 	testPath, _ := os.Getwd()
 	path := fmt.Sprintf("%s/docs/flags.md", testPath)

main.go

@@ -267,7 +267,7 @@ func main() {
 	case "digitalocean":
 		p, err = digitalocean.NewDigitalOceanProvider(ctx, domainFilter, cfg.DryRun, cfg.DigitalOceanAPIPageSize)
 	case "ovh":
-		p, err = ovh.NewOVHProvider(ctx, domainFilter, cfg.OVHEndpoint, cfg.OVHApiRateLimit, cfg.DryRun)
+		p, err = ovh.NewOVHProvider(ctx, domainFilter, cfg.OVHEndpoint, cfg.OVHApiRateLimit, cfg.OVHEnableCNAMERelative, cfg.DryRun)
 	case "linode":
 		p, err = linode.NewLinodeProvider(domainFilter, cfg.DryRun, externaldns.Version)
 	case "dnsimple":

pkg/apis/externaldns/types.go

@@ -131,6 +131,7 @@ type Config struct {
 	InMemoryZones                                 []string
 	OVHEndpoint                                   string
 	OVHApiRateLimit                               int
+	OVHEnableCNAMERelative                        bool
 	PDNSServer                                    string
 	PDNSServerID                                  string
 	PDNSAPIKey                                    string `secure:"yes"`
@@ -295,6 +296,7 @@ var defaultConfig = &Config{
 	InMemoryZones:                                 []string{},
 	OVHEndpoint:                                   "ovh-eu",
 	OVHApiRateLimit:                               20,
+	OVHEnableCNAMERelative:                        false,
 	PDNSServer:                                    "http://localhost:8081",
 	PDNSServerID:                                  "localhost",
 	PDNSAPIKey:                                    "",
@@ -544,6 +546,7 @@ func App(cfg *Config) *kingpin.Application {
 	app.Flag("inmemory-zone", "Provide a list of pre-configured zones for the inmemory provider; specify multiple times for multiple zones (optional)").Default("").StringsVar(&cfg.InMemoryZones)
 	app.Flag("ovh-endpoint", "When using the OVH provider, specify the endpoint (default: ovh-eu)").Default(defaultConfig.OVHEndpoint).StringVar(&cfg.OVHEndpoint)
 	app.Flag("ovh-api-rate-limit", "When using the OVH provider, specify the API request rate limit, X operations by seconds (default: 20)").Default(strconv.Itoa(defaultConfig.OVHApiRateLimit)).IntVar(&cfg.OVHApiRateLimit)
+	app.Flag("ovh-enable-cname-relative", "When using the OVH provider, specify if CNAME should be treated as relative on target without final dot (default: false)").Default(strconv.FormatBool(defaultConfig.OVHEnableCNAMERelative)).BoolVar(&cfg.OVHEnableCNAMERelative)
 	app.Flag("pdns-server", "When using the PowerDNS/PDNS provider, specify the URL to the pdns server (required when --provider=pdns)").Default(defaultConfig.PDNSServer).StringVar(&cfg.PDNSServer)
 	app.Flag("pdns-server-id", "When using the PowerDNS/PDNS provider, specify the id of the server to retrieve. Should be `localhost` except when the server is behind a proxy (optional when --provider=pdns) (default: localhost)").Default(defaultConfig.PDNSServerID).StringVar(&cfg.PDNSServerID)
 	app.Flag("pdns-api-key", "When using the PowerDNS/PDNS provider, specify the API key to use to authorize requests (required when --provider=pdns)").Default(defaultConfig.PDNSAPIKey).StringVar(&cfg.PDNSAPIKey)