From 26920e75f7fc5cc49a217fd58329847bed6d5788 Mon Sep 17 00:00:00 2001 From: bartjanssens92 Date: Tue, 23 Sep 2025 16:36:13 +0200 Subject: [PATCH] otc: add example (#2655) Co-authored-by: Fernandez Ludovic --- cmd/zz_gen_cmd_dnshelp.go | 2 +- docs/content/dns/zz_gen_otc.md | 14 ++++++++++---- providers/dns/otc/otc.toml | 10 ++++++++-- 3 files changed, 19 insertions(+), 7 deletions(-) diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index 573c355df..bffb0696f 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -2600,7 +2600,7 @@ func displayDNSHelp(w io.Writer, name string) error { ew.writeln(`Additional Configuration:`) ew.writeln(` - "OTC_HTTP_TIMEOUT": API request timeout in seconds (Default: 10)`) - ew.writeln(` - "OTC_IDENTITY_ENDPOINT": Identity endpoint URL`) + ew.writeln(` - "OTC_IDENTITY_ENDPOINT": Identity endpoint URL (default: https://iam.eu-de.otc.t-systems.com:443/v3/auth/tokens)`) ew.writeln(` - "OTC_POLLING_INTERVAL": Time between DNS propagation check in seconds (Default: 2)`) ew.writeln(` - "OTC_PRIVATE_ZONE": Set to true to use private zones only (default: use public zones only)`) ew.writeln(` - "OTC_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation in seconds (Default: 60)`) diff --git a/docs/content/dns/zz_gen_otc.md b/docs/content/dns/zz_gen_otc.md index e85850829..4f3679fa2 100644 --- a/docs/content/dns/zz_gen_otc.md +++ b/docs/content/dns/zz_gen_otc.md @@ -23,9 +23,15 @@ Configuration for [Open Telekom Cloud](https://cloud.telekom.de/en). - Since: v0.4.1 -{{% notice note %}} -_Please contribute by adding a CLI example._ -{{% /notice %}} +Here is an example bash command using the Open Telekom Cloud provider: + +```bash +OTC_DOMAIN_NAME=domain_name \ +OTC_USER_NAME=user_name \ +OTC_PASSWORD=password \ +OTC_PROJECT_NAME=project_name \ +lego --email you@example.com --dns otc -d '*.example.com' -d example.com run +``` @@ -48,7 +54,7 @@ More information [here]({{% ref "dns#configuration-and-credentials" %}}). | Environment Variable Name | Description | |--------------------------------|-------------| | `OTC_HTTP_TIMEOUT` | API request timeout in seconds (Default: 10) | -| `OTC_IDENTITY_ENDPOINT` | Identity endpoint URL | +| `OTC_IDENTITY_ENDPOINT` | Identity endpoint URL (default: https://iam.eu-de.otc.t-systems.com:443/v3/auth/tokens) | | `OTC_POLLING_INTERVAL` | Time between DNS propagation check in seconds (Default: 2) | | `OTC_PRIVATE_ZONE` | Set to true to use private zones only (default: use public zones only) | | `OTC_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation in seconds (Default: 60) | diff --git a/providers/dns/otc/otc.toml b/providers/dns/otc/otc.toml index 4f2f4ac0e..91f9f5455 100644 --- a/providers/dns/otc/otc.toml +++ b/providers/dns/otc/otc.toml @@ -4,7 +4,13 @@ URL = "https://cloud.telekom.de/en" Code = "otc" Since = "v0.4.1" -Example = '''''' +Example = ''' +OTC_DOMAIN_NAME=domain_name \ +OTC_USER_NAME=user_name \ +OTC_PASSWORD=password \ +OTC_PROJECT_NAME=project_name \ +lego --email you@example.com --dns otc -d '*.example.com' -d example.com run +''' [Configuration] [Configuration.Credentials] @@ -13,7 +19,7 @@ Example = '''''' OTC_PROJECT_NAME = "Project name" OTC_DOMAIN_NAME = "Domain name" [Configuration.Additional] - OTC_IDENTITY_ENDPOINT = "Identity endpoint URL" + OTC_IDENTITY_ENDPOINT = "Identity endpoint URL (default: https://iam.eu-de.otc.t-systems.com:443/v3/auth/tokens)" OTC_PRIVATE_ZONE = "Set to true to use private zones only (default: use public zones only)" OTC_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)" OTC_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation in seconds (Default: 60)"