pogpp/lego
1
0
Fork 0
forked from TrueCloudLab/lego
Code Pull requests Activity

doc: enhance Route53 documentation. (#853)

Browse source
This commit is contained in:
Ludovic Fernandez 2019-04-17 20:58:34 +02:00 committed by GitHub
parent cc19ab810c
commit 6878dbbeba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
cmd/zz_gen_cmd_dnshelp.go
View file

@ -988,13 +988,14 @@ func displayDNSHelp(name string) {
fmt.Fprintln(w)
fmt.Fprintln(w, `Credentials:`)
fmt.Fprintln(w, ` - "AWS_ACCESS_KEY_ID": `)
fmt.Fprintln(w, ` - "AWS_HOSTED_ZONE_ID": `)
fmt.Fprintln(w, ` - "AWS_REGION": `)
fmt.Fprintln(w, ` - "AWS_SECRET_ACCESS_KEY": `)
fmt.Fprintln(w, ` - "AWS_ACCESS_KEY_ID": Managed by the AWS client`)
fmt.Fprintln(w, ` - "AWS_HOSTED_ZONE_ID": Override the hosted zone ID`)
fmt.Fprintln(w, ` - "AWS_REGION": Managed by the AWS client`)
fmt.Fprintln(w, ` - "AWS_SECRET_ACCESS_KEY": Managed by the AWS client`)
fmt.Fprintln(w)
fmt.Fprintln(w, `Additional Configuration:`)
fmt.Fprintln(w, ` - "AWS_MAX_RETRIES": The number of maximum returns the service will use to make an individual API request`)
fmt.Fprintln(w, ` - "AWS_POLLING_INTERVAL": Time between DNS propagation check`)
fmt.Fprintln(w, ` - "AWS_PROPAGATION_TIMEOUT": Maximum waiting time for DNS propagation`)
fmt.Fprintln(w, ` - "AWS_TTL": The TTL of the TXT record used for the DNS challenge`)

11
docs/content/dns/zz_gen_route53.md
View file

@ -28,10 +28,10 @@ _Please contribute by adding a CLI example._
| Environment Variable Name | Description |
|-----------------------|-------------|
| `AWS_ACCESS_KEY_ID` | |
| `AWS_HOSTED_ZONE_ID` | |
| `AWS_REGION` | |
| `AWS_SECRET_ACCESS_KEY` | |
| `AWS_ACCESS_KEY_ID` | Managed by the AWS client |
| `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 |
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).
@ -41,6 +41,7 @@ More information [here](/lego/dns/#configuration-and-credentials).
| Environment Variable Name | Description |
|--------------------------------|-------------|
| `AWS_MAX_RETRIES` | The number of maximum returns the service will use to make an individual API request |
| `AWS_POLLING_INTERVAL` | Time between DNS propagation check |
| `AWS_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
| `AWS_TTL` | The TTL of the TXT record used for the DNS challenge |
@ -58,7 +59,7 @@ 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: [configuring-sdk](https://github.com/aws/aws-sdk-go/wiki/configuring-sdk)
See also: [sessions](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/sessions.html)
## Policy

11
providers/dns/route53/route53.toml
View file

@ -16,7 +16,7 @@ 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: [configuring-sdk](https://github.com/aws/aws-sdk-go/wiki/configuring-sdk)
See also: [sessions](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/sessions.html)
## Policy
@ -53,11 +53,12 @@ The following AWS IAM policy document describes the permissions required for leg
[Configuration]
[Configuration.Credentials]
AWS_ACCESS_KEY_ID = ""
AWS_SECRET_ACCESS_KEY = ""
AWS_REGION = ""
AWS_HOSTED_ZONE_ID = ""
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_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"
AWS_POLLING_INTERVAL = "Time between DNS propagation check"
AWS_PROPAGATION_TIMEOUT = "Maximum waiting time for DNS propagation"
AWS_TTL = "The TTL of the TXT record used for the DNS challenge"