From 6001372a915095d752bc00ca412465d6ec10666f Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Thu, 9 Jan 2020 09:12:27 +0100 Subject: [PATCH] doc: improve Route53 documentation. (#1036) --- cmd/zz_gen_cmd_dnshelp.go | 6 +++--- docs/content/dns/zz_gen_route53.md | 11 +++++++---- providers/dns/route53/route53.toml | 11 +++++++---- 3 files changed, 17 insertions(+), 11 deletions(-) diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index 021d3868..430ca0f1 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -1200,10 +1200,10 @@ func displayDNSHelp(name string) error { ew.writeln() ew.writeln(`Credentials:`) - ew.writeln(` - "AWS_ACCESS_KEY_ID": Managed by the AWS client`) + ew.writeln(` - "AWS_ACCESS_KEY_ID": Managed by the AWS client ('AWS_ACCESS_KEY_ID_FILE' is not supported)`) ew.writeln(` - "AWS_HOSTED_ZONE_ID": Override the hosted zone ID`) - ew.writeln(` - "AWS_REGION": Managed by the AWS client`) - ew.writeln(` - "AWS_SECRET_ACCESS_KEY": Managed by the AWS client`) + ew.writeln(` - "AWS_REGION": Managed by the AWS client ('AWS_REGION_FILE' is not supported)`) + ew.writeln(` - "AWS_SECRET_ACCESS_KEY": Managed by the AWS client ('AWS_SECRET_ACCESS_KEY_FILE' is not supported)`) ew.writeln() ew.writeln(`Additional Configuration:`) diff --git a/docs/content/dns/zz_gen_route53.md b/docs/content/dns/zz_gen_route53.md index eb1f73f3..91c538f0 100644 --- a/docs/content/dns/zz_gen_route53.md +++ b/docs/content/dns/zz_gen_route53.md @@ -29,10 +29,10 @@ _Please contribute by adding a CLI example._ | Environment Variable Name | Description | |-----------------------|-------------| -| `AWS_ACCESS_KEY_ID` | Managed by the AWS client | +| `AWS_ACCESS_KEY_ID` | Managed by the AWS client (`AWS_ACCESS_KEY_ID_FILE` is not supported) | | `AWS_HOSTED_ZONE_ID` | Override the hosted zone ID | -| `AWS_REGION` | Managed by the AWS client | -| `AWS_SECRET_ACCESS_KEY` | Managed by the AWS client | +| `AWS_REGION` | Managed by the AWS client (`AWS_REGION_FILE` is not supported) | +| `AWS_SECRET_ACCESS_KEY` | Managed by the AWS client (`AWS_SECRET_ACCESS_KEY_FILE` is not supported) | The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information [here](/lego/dns/#configuration-and-credentials). @@ -60,7 +60,10 @@ AWS Credentials are automatically detected in the following locations and priori If `AWS_HOSTED_ZONE_ID` is not set, Lego tries to determine the correct public hosted zone via the FQDN. -See also: [sessions](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/sessions.html) +See also: + +- [sessions](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/sessions.html) +- [Setting AWS Credentials](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html#setup-credentials-setting) ## Policy diff --git a/providers/dns/route53/route53.toml b/providers/dns/route53/route53.toml index b6e8776f..7fd70937 100644 --- a/providers/dns/route53/route53.toml +++ b/providers/dns/route53/route53.toml @@ -17,7 +17,10 @@ AWS Credentials are automatically detected in the following locations and priori If `AWS_HOSTED_ZONE_ID` is not set, Lego tries to determine the correct public hosted zone via the FQDN. -See also: [sessions](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/sessions.html) +See also: + +- [sessions](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/sessions.html) +- [Setting AWS Credentials](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html#setup-credentials-setting) ## Policy @@ -54,9 +57,9 @@ The following AWS IAM policy document describes the permissions required for leg [Configuration] [Configuration.Credentials] - AWS_ACCESS_KEY_ID = "Managed by the AWS client" - AWS_SECRET_ACCESS_KEY = "Managed by the AWS client" - AWS_REGION = "Managed by the AWS client" + AWS_ACCESS_KEY_ID = "Managed by the AWS client (`AWS_ACCESS_KEY_ID_FILE` is not supported)" + AWS_SECRET_ACCESS_KEY = "Managed by the AWS client (`AWS_SECRET_ACCESS_KEY_FILE` is not supported)" + AWS_REGION = "Managed by the AWS client (`AWS_REGION_FILE` is not supported)" AWS_HOSTED_ZONE_ID = "Override the hosted zone ID" [Configuration.Additional] AWS_MAX_RETRIES = "The number of maximum returns the service will use to make an individual API request"