From d7b0593eb6b5be85b90c43d76c6df0a353e2b2d3 Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Wed, 24 Aug 2022 20:15:27 +0200 Subject: [PATCH] infoblox: fix documentation (#1702) --- cmd/zz_gen_cmd_dnshelp.go | 4 ++-- docs/content/dns/zz_gen_infoblox.md | 4 ++-- providers/dns/infoblox/infoblox.go | 4 ++-- providers/dns/infoblox/infoblox.toml | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index d828d904..2c083c1f 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -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() diff --git a/docs/content/dns/zz_gen_infoblox.md b/docs/content/dns/zz_gen_infoblox.md index 4f8a6308..5061f1fa 100644 --- a/docs/content/dns/zz_gen_infoblox.md +++ b/docs/content/dns/zz_gen_infoblox.md @@ -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. diff --git a/providers/dns/infoblox/infoblox.go b/providers/dns/infoblox/infoblox.go index 4572ff4c..a61b6c42 100644 --- a/providers/dns/infoblox/infoblox.go +++ b/providers/dns/infoblox/infoblox.go @@ -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) diff --git a/providers/dns/infoblox/infoblox.toml b/providers/dns/infoblox/infoblox.toml index 40e5f908..e8d6d0d7 100644 --- a/providers/dns/infoblox/infoblox.toml +++ b/providers/dns/infoblox/infoblox.toml @@ -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"