dnscontrol/documentation/providers/oracle.md
Jeffrey Cafferata 7977a7b81c
DOCS: Improve consistency in code examples in language reference (#2439)
Co-authored-by: Tom Limoncelli <tal@whatexit.org>
2023-06-17 08:58:17 -04:00

44 lines
1.1 KiB
Markdown

## Configuration
To use this provider, add an entry to `creds.json` with `TYPE` set to `ORACLE`
along with other authentication parameters.
Create an API key through the Oracle Cloud portal, and provide the user OCID, tenancy OCID, key fingerprint, region, and the contents of the private key.
The OCID of the compartment DNS resources should be put in can also optionally be provided.
Example:
{% code title="creds.json" %}
```json
{
"oracle": {
"TYPE": "ORACLE",
"compartment": "$ORACLE_COMPARTMENT",
"fingerprint": "$ORACLE_FINGERPRINT",
"private_key": "$ORACLE_PRIVATE_KEY",
"region": "$ORACLE_REGION",
"tenancy_ocid": "$ORACLE_TENANCY_OCID",
"user_ocid": "$ORACLE_USER_OCID"
}
}
```
{% endcode %}
## Metadata
This provider does not recognize any special metadata fields unique to Oracle Cloud.
## Usage
An example configuration:
{% code title="dnsconfig.js" %}
```javascript
var REG_NONE = NewRegistrar("none");
var DSP_ORACLE = NewDnsProvider("oracle");
D("example.com", REG_NONE, DnsProvider(DSP_ORACLE),
NAMESERVER_TTL(86400),
A("test", "1.2.3.4")
);
```
{% endcode %}