infoblox: fix documentation (#1702)

This commit is contained in:
Ludovic Fernandez 2022-08-24 20:15:27 +02:00 committed by GitHub
parent c45b756237
commit d7b0593eb6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 8 deletions

View file

@ -1168,17 +1168,17 @@ func displayDNSHelp(name string) error {
ew.writeln(`Credentials:`)
ew.writeln(` - "INFOBLOX_HOST": Host URI`)
ew.writeln(` - "INFOBLOX_PASSWORD": Account Password`)
ew.writeln(` - "INFOBLOX_USER": Account Username`)
ew.writeln(` - "INFOBLOX_USERNAME": Account Username`)
ew.writeln()
ew.writeln(`Additional Configuration:`)
ew.writeln(` - "INFOBLOX_DNS_VIEW": The view for the TXT records, default: External`)
ew.writeln(` - "INFOBLOX_HTTP_TIMEOUT": HTTP request timeout`)
ew.writeln(` - "INFOBLOX_POLLING_INTERVAL": Time between DNS propagation check`)
ew.writeln(` - "INFOBLOX_PORT": The port for the infoblox grid manager, default: 443`)
ew.writeln(` - "INFOBLOX_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`)
ew.writeln(` - "INFOBLOX_SSL_VERIFY": Whether or not to verify the TLS certificate, default: true`)
ew.writeln(` - "INFOBLOX_TTL": The TTL of the TXT record used for the DNS challenge`)
ew.writeln(` - "INFOBLOX_VIEW": The view for the TXT records, default: External`)
ew.writeln(` - "INFOBLOX_WAPI_VERSION": The version of WAPI being used, default: 2.11`)
ew.writeln()

View file

@ -41,7 +41,7 @@ lego --email you@example.com --dns infoblox --domains my.example.org run
|-----------------------|-------------|
| `INFOBLOX_HOST` | Host URI |
| `INFOBLOX_PASSWORD` | Account Password |
| `INFOBLOX_USER` | Account Username |
| `INFOBLOX_USERNAME` | Account Username |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
@ -51,13 +51,13 @@ More information [here]({{< ref "dns#configuration-and-credentials" >}}).
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `INFOBLOX_DNS_VIEW` | The view for the TXT records, default: External |
| `INFOBLOX_HTTP_TIMEOUT` | HTTP request timeout |
| `INFOBLOX_POLLING_INTERVAL` | Time between DNS propagation check |
| `INFOBLOX_PORT` | The port for the infoblox grid manager, default: 443 |
| `INFOBLOX_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `INFOBLOX_SSL_VERIFY` | Whether or not to verify the TLS certificate, default: true |
| `INFOBLOX_TTL` | The TTL of the TXT record used for the DNS challenge |
| `INFOBLOX_VIEW` | The view for the TXT records, default: External |
| `INFOBLOX_WAPI_VERSION` | The version of WAPI being used, default: 2.11 |
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.

View file

@ -89,9 +89,9 @@ type DNSProvider struct {
// NewDNSProvider returns a DNSProvider instance configured for Infoblox.
// Credentials must be passed in the environment variables:
// INFOBLOX_USER, INFOBLOX_PASSWORD
// INFOBLOX_USERNAME, INFOBLOX_PASSWORD
// INFOBLOX_HOST, INFOBLOX_PORT
// INFOBLOX_VIEW, INFOBLOX_WAPI_VERSION
// INFOBLOX_DNS_VIEW, INFOBLOX_WAPI_VERSION
// INFOBLOX_SSL_VERIFY.
func NewDNSProvider() (*DNSProvider, error) {
values, err := env.Get(EnvHost, EnvUsername, EnvPassword)

View file

@ -17,11 +17,11 @@ When creating an API's user ensure it has the proper permissions for the view yo
[Configuration]
[Configuration.Credentials]
INFOBLOX_USER = "Account Username"
INFOBLOX_USERNAME = "Account Username"
INFOBLOX_PASSWORD = "Account Password"
INFOBLOX_HOST = "Host URI"
[Configuration.Additional]
INFOBLOX_VIEW = "The view for the TXT records, default: External"
INFOBLOX_DNS_VIEW = "The view for the TXT records, default: External"
INFOBLOX_WAPI_VERSION = "The version of WAPI being used, default: 2.11"
INFOBLOX_PORT = "The port for the infoblox grid manager, default: 443"
INFOBLOX_SSL_VERIFY = "Whether or not to verify the TLS certificate, default: true"