This repository was archived by the owner on Jul 9, 2025. It is now read-only.
Update docs for upstream resolution patterns #950
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-950.surge.sh 🎊 |
joe4dev
suggested changes
Dec 6, 2023
| @@ -309,7 +309,8 @@ To learn more about these configuration options, see [DNS Server]({{< ref "dns-s | |||
| | `DNS_ADDRESS` | `0.0.0.0` (default) | Address the LocalStack should bind the DNS server on (port 53 tcp/udp). Value `0` to disable. | |||
| | `DNS_SERVER` | Default upstream DNS or `8.8.8.8` (default) | Fallback DNS server for queries not handled by LocalStack. | |||
| | `DNS_RESOLVE_IP` | `127.0.0.1` (default) | IP address the DNS server should return as A record for queries handled by LocalStack. If customized, this value will be returned in preference to the DNS server response. | |||
| | `DNS_LOCAL_NAME_PATTERNS` | `.*(ecr\|lambda).*.amazonaws.com` (example) | Skiplist of hostnames that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
| | `DNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAM` | | Skiplist of domain names that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
| | `DNS_LOCAL_NAME_PATTERNS` | `.*(ecr\|lambda).*.amazonaws.com` (example) | **Deprecated since 3.0.0** Skiplist of domain names that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
There was a problem hiding this comment.
shouldn't it be 3.0.2 (technically 🤔 )
(sidenote: It would be useful to add the version since it is supported in the future. Lots of 🚧 in config management ...)
| @@ -309,7 +309,8 @@ To learn more about these configuration options, see [DNS Server]({{< ref "dns-s | |||
| | `DNS_ADDRESS` | `0.0.0.0` (default) | Address the LocalStack should bind the DNS server on (port 53 tcp/udp). Value `0` to disable. | |||
| | `DNS_SERVER` | Default upstream DNS or `8.8.8.8` (default) | Fallback DNS server for queries not handled by LocalStack. | |||
| | `DNS_RESOLVE_IP` | `127.0.0.1` (default) | IP address the DNS server should return as A record for queries handled by LocalStack. If customized, this value will be returned in preference to the DNS server response. | |||
| | `DNS_LOCAL_NAME_PATTERNS` | `.*(ecr\|lambda).*.amazonaws.com` (example) | Skiplist of hostnames that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
| | `DNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAM` | | Skiplist of domain names that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
| | `DNS_LOCAL_NAME_PATTERNS` | `.*(ecr\|lambda).*.amazonaws.com` (example) | **Deprecated since 3.0.0** Skiplist of domain names that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
There was a problem hiding this comment.
Can we add a migration path?
Renamed to DNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAM
| @@ -309,7 +309,8 @@ To learn more about these configuration options, see [DNS Server]({{< ref "dns-s | |||
| | `DNS_ADDRESS` | `0.0.0.0` (default) | Address the LocalStack should bind the DNS server on (port 53 tcp/udp). Value `0` to disable. | |||
| | `DNS_SERVER` | Default upstream DNS or `8.8.8.8` (default) | Fallback DNS server for queries not handled by LocalStack. | |||
| | `DNS_RESOLVE_IP` | `127.0.0.1` (default) | IP address the DNS server should return as A record for queries handled by LocalStack. If customized, this value will be returned in preference to the DNS server response. | |||
| | `DNS_LOCAL_NAME_PATTERNS` | `.*(ecr\|lambda).*.amazonaws.com` (example) | Skiplist of hostnames that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
| | `DNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAM` | | Skiplist of domain names that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
There was a problem hiding this comment.
Consider linking to the DNS server page for more details: https://docs.localstack.cloud/user-guide/tools/dns-server/#skip-localstack-dns-resolution
| @@ -309,7 +309,8 @@ To learn more about these configuration options, see [DNS Server]({{< ref "dns-s | |||
| | `DNS_ADDRESS` | `0.0.0.0` (default) | Address the LocalStack should bind the DNS server on (port 53 tcp/udp). Value `0` to disable. | |||
| | `DNS_SERVER` | Default upstream DNS or `8.8.8.8` (default) | Fallback DNS server for queries not handled by LocalStack. | |||
| | `DNS_RESOLVE_IP` | `127.0.0.1` (default) | IP address the DNS server should return as A record for queries handled by LocalStack. If customized, this value will be returned in preference to the DNS server response. | |||
| | `DNS_LOCAL_NAME_PATTERNS` | `.*(ecr\|lambda).*.amazonaws.com` (example) | Skiplist of hostnames that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
| | `DNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAM` | | Skiplist of domain names that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
There was a problem hiding this comment.
Missing example value (better provide the example with the current config)
| @@ -309,7 +309,8 @@ To learn more about these configuration options, see [DNS Server]({{< ref "dns-s | |||
| | `DNS_ADDRESS` | `0.0.0.0` (default) | Address the LocalStack should bind the DNS server on (port 53 tcp/udp). Value `0` to disable. | |||
| | `DNS_SERVER` | Default upstream DNS or `8.8.8.8` (default) | Fallback DNS server for queries not handled by LocalStack. | |||
| | `DNS_RESOLVE_IP` | `127.0.0.1` (default) | IP address the DNS server should return as A record for queries handled by LocalStack. If customized, this value will be returned in preference to the DNS server response. | |||
| | `DNS_LOCAL_NAME_PATTERNS` | `.*(ecr\|lambda).*.amazonaws.com` (example) | Skiplist of hostnames that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
| | `DNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAM` | | Skiplist of domain names that should *NOT* be resolved to the LocalStack container, as a comma-separated list of Python-flavored regex patterns. | |||
There was a problem hiding this comment.
nit: ideally, we adjust the explanation to the new naming (rather than skip, explain that these are always resolved by upstream)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
With localstack/localstack#9692 we deprecated the use of
DNS_LOCAL_NAME_PATTERNSsince it had a confusing name. Instead of adding domain name patterns to resolve to LocalStack, it added domain names to the skiplist of names that should always be resolved upstream. In particular, with transparent endpoint injection enabled,s3.amazonaws.comwould resolve to LocalStack, andDNS_LOCAL_NAME_PATTERNScould force LocalStack to resolve the name from its upstream resolver.Changes
DNS_LOCAL_NAME_PATTERNSto use the newDNS_NAME_PATTERNS_TO_RESOLVE_UPSTREAMvariableTODO