mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

Improve softlayer documentation (#235)

Browse Source 
- Add note that using the creds.json file is the preferred method of authentication
- Improve formatting
This commit is contained in:
Patrick G
2017-10-11 12:06:04 -04:00
committed by Tom Limoncelli
parent 7d3e3b6279
commit 8d0576ac7f
1 changed files with 4 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/_providers/softlayer.md
View File

@@ -8,10 +8,9 @@ jsId: SOFTLAYER
# SoftLayer DNS Provider # SoftLayer DNS Provider
## Configuration ## Configuration
To authenticate with SoftLayer requires at least a `username` and `api_key` for authentication. It can also optionally take a `timeout` and `endpoint_url` parameter however these are optional and will use standard defaults if not provided.
To authenticate with SoftLayer requires at least a `username` and `api_key` for authentication. These can be supplied in the `creds.json` file:
It can also optionally take a `timeout` and `endpoint_url` parameter however these are optional and will use standard defaults if not provided.
These can be supplied via the standard 'creds.json' like so:
{% highlight json %} {% highlight json %}
{ {
"softlayer": { "softlayer": {
@@ -21,11 +20,9 @@ These can be supplied via the standard 'creds.json' like so:
} }
{% endhighlight %} {% endhighlight %}
To maintain compatibility with existing softlayer CLI services these can also be provided by the `SL_USERNAME` and `SL_API_KEY` environment variables or specified in the ~/.softlayer. To maintain compatibility with existing softlayer CLI services these can also be provided by the `SL_USERNAME` and `SL_API_KEY` environment variables or specified in the `~/.softlayer`, but this is discouraged. More information about these methods can be found at [the softlayer-go library documentation](https://github.com/softlayer/softlayer-go#sessions).
More information about these methods can be found at [the softlayer-go library documentation](https://github.com/softlayer/softlayer-go#sessions).
## Usage ## Usage
Use this provider like any other DNS Provider: Use this provider like any other DNS Provider:
{% highlight js %} {% highlight js %}
@@ -38,7 +35,6 @@ D("example.tld", registrary, DnsProvider(SOFTLAYER),
{%endhighlight%} {%endhighlight%}
## Metadata ## Metadata
This provider does not recognize any special metadata fields unique to SoftLayer dns. This provider does not recognize any special metadata fields unique to SoftLayer dns.
For compatibility with the pre-generated NAMESERVER fields it's recommended to set the NS TTL to 86400 such as: For compatibility with the pre-generated NAMESERVER fields it's recommended to set the NS TTL to 86400 such as:
@@ -50,4 +46,4 @@ D("example.tld", REG_NONE, DnsProvider(SOFTLAYER),
); );
{%endhighlight%} {%endhighlight%}
`ns_ttl` is a standard metadata field that applies to all providers. `ns_ttl` is a standard metadata field that applies to all providers.