mirror of
https://github.com/StackExchange/dnscontrol.git
synced 2024-11-15 20:55:34 +08:00
e44dde52e2
* OVH DNS Provider (#143) This adds the OVH Provider along with its documentation. Unfortunately we can't set this DNS provider to support `CanUsePTR`, because OVH only supports setting PTR target on the Arpa zone. * OVH Registrar provider (#143) This implements OVH as a registrar provider. Note that NS modifications are done in a "best effort" mode, as the provider doesn't wait for the modifications to be fully applied (the operation that can take a long time). * Allow support for dual providers scenarios Since OVH released their APIv6, it is now possible to update zone apex NS records, opening the door to complete dual providers scenarii. This change implements apex NS management in an OVH zone.
135 lines
3.3 KiB
Markdown
135 lines
3.3 KiB
Markdown
---
|
|
name: Ovh
|
|
layout: default
|
|
jsId: OVH
|
|
---
|
|
# OVH Provider
|
|
|
|
## Configuration
|
|
|
|
In your providers config json file you must provide a OVH app-key, app-secret-key and consumer-key:
|
|
|
|
{% highlight json %}
|
|
{
|
|
"ovh":{
|
|
"app-key": "your app key",
|
|
"app-secret-key": "your app secret key",
|
|
"consumer-key": "your consumer key"
|
|
}
|
|
}
|
|
{% endhighlight %}
|
|
|
|
See [the Activation section](#activation) for details on obtaining these credentials.
|
|
|
|
## Metadata
|
|
|
|
This provider does not recognize any special metadata fields unique to OVH.
|
|
|
|
## Usage
|
|
|
|
Example javascript:
|
|
|
|
Example javascript (DNS hosted with OVH):
|
|
{% highlight js %}
|
|
var REG_OVH = NewRegistrar("ovh", "OVH");
|
|
var OVH = NewDnsProvider("ovh", "OVH");
|
|
|
|
D("example.tld", REG_OVH, DnsProvider(OVH),
|
|
A("test","1.2.3.4")
|
|
);
|
|
{% endhighlight %}
|
|
|
|
Example javascript (Registrar only. DNS hosted elsewhere):
|
|
|
|
{% highlight js %}
|
|
var REG_OVH = NewRegistrar("ovh", "OVH");
|
|
var R53 = NewDnsProvider("r53", "ROUTE53");
|
|
|
|
D("example.tld", REG_OVH, DnsProvider(R53),
|
|
A("test","1.2.3.4")
|
|
);
|
|
{%endhighlight%}
|
|
|
|
|
|
## Activation
|
|
|
|
To obtain the OVH keys, one need to register an app at OVH by following the
|
|
[OVH API Getting Started](https://api.ovh.com/g934.first_step_with_api)
|
|
|
|
It consist in declaring the app at https://eu.api.ovh.com/createApp/
|
|
which gives the `app-key` and `app-secret-key`.
|
|
|
|
Once done, to obtain the `consumer-key` it is necessary to authorize the just created app
|
|
to access the data in a specific account:
|
|
|
|
{% highlight bash %}
|
|
curl -XPOST -H"X-Ovh-Application: <you-app-key>" -H "Content-type: application/json" https://eu.api.ovh.com/1.0/auth/credential -d'{
|
|
"accessRules": [
|
|
{
|
|
"method": "DELETE",
|
|
"path": "/domain/zone/*"
|
|
},
|
|
{
|
|
"method": "GET",
|
|
"path": "/domain/zone/*"
|
|
},
|
|
{
|
|
"method": "POST",
|
|
"path": "/domain/zone/*"
|
|
},
|
|
{
|
|
"method": "PUT",
|
|
"path": "/domain/zone/*"
|
|
},
|
|
{
|
|
"method": "GET",
|
|
"path": "/domain/*"
|
|
},
|
|
{
|
|
"method": "PUT",
|
|
"path": "/domain/*"
|
|
},
|
|
{
|
|
"method": "POST",
|
|
"path": "/domain/*/nameServers/update"
|
|
}
|
|
]
|
|
}'
|
|
{% endhighlight %}
|
|
|
|
It should return something akin to:
|
|
{% highlight json %}
|
|
{
|
|
"validationUrl": "https://eu.api.ovh.com/auth/?credentialToken=<long-token>",
|
|
"consumerKey": "<your-consumer-key>",
|
|
"state": "pendingValidation"
|
|
}
|
|
{% endhighlight %}
|
|
|
|
Open the "validationUrl" in a brower and log in with your OVH account. This will link the app with your account,
|
|
authorizing it to access your zones and domains.
|
|
|
|
Do not forget to fill the `consumer-key` of your `creds.json`.
|
|
|
|
## New domains
|
|
|
|
If a domain does not exist in your OVH account, DNSControl
|
|
will *not* automatically add it. You'll need to do that via the
|
|
control panel manually.
|
|
|
|
## Dual providers scenario
|
|
|
|
Since OVH doesn't allow to host DNS for a domain that is not registered in their registrar, some dual providers
|
|
scenario are not possible:
|
|
|
|
| registrar | zone | working? |
|
|
|:---------:|:-----------:|:--------:|
|
|
| OVH | other | √ |
|
|
| OVH | OVH + other | √ |
|
|
| other | OVH | X |
|
|
|
|
## Caveat
|
|
|
|
OVH doesn't allow resetting the zone to the OVH DNS through the API. If for any reasons OVH NS entries were
|
|
removed the only way to add them back is by using the OVH Control Panel (in the DNS Servers tab, click on the "Reset the
|
|
DNS servers" button.
|