docs: add dns setup #767
docs: add dns setup #767
Conversation
| {{% alert-note %}} | ||
| These service annotations and their values are subject to change. Please reference documentation from your cloud provider to ensure their validity. | ||
| {{% /alert-note %}} |
There was a problem hiding this comment.
Not sure if this is the right place or necessary, but thoughts on adding a note about static IPs to reduce effects of LBs cycling? Maybe too cloud provider specific though...
There was a problem hiding this comment.
That's great callout and a good best-practice. I'm not sure if we want to get into cloud-specific deployment best practices in this document though. Unless we disagree that most folks reading this documentation are aware of this behavior, I'm leaning towards keeping this out.
There was a problem hiding this comment.
Maybe we should just remove this callout altogether, it feels unnecessary the more I think about it.
There was a problem hiding this comment.
Yeah might be fine to just delete this note - since it's just meant to be an example anyways?
| - *.<DOMAIN> / Tenant Gateway | ||
| - *.admin.<DOMAIN> / Admin Gateway |
There was a problem hiding this comment.
These get clobbered on the docs site preview - could either escape the < and > characters, or just wrap in code backticks.
There was a problem hiding this comment.
Oops! how did you render this out?
There was a problem hiding this comment.
Using the docs repo, if you have hugo installed locally you can just run hugo serve. You will want to clone or copy core into the ./repo-docs folder first (I use a symlink locally for this), see the script we use to manage this: https://github.com/defenseunicorns/uds-docs/blob/main/scripts/integrated-docs.sh#L22
There was a problem hiding this comment.
Would love to better integrate/task-ify this flow: #712
| {{% alert-note %}} | ||
| These service annotations and their values are subject to change. Please reference documentation from your cloud provider to ensure their validity. | ||
| {{% /alert-note %}} |
There was a problem hiding this comment.
Yeah might be fine to just delete this note - since it's just meant to be an example anyways?
| istio-tenant-gateway tenant-ingressgateway LoadBalancer 10.43.47.182 k8s-istioten-tenant...elb.us-east-1.amazonaws.com 15021:31222/TCP,80:30456/TCP,443:32508/TCP 1h | ||
| ``` | ||
|
|
||
| From here, DNS records can be created for the environment. You can create A records that associate your top-level domain to the Public IP Addresses of your Load Balancers. For subdomains, CNAME records can be used. For more information on how to configure DNS in AWS, see this [documentation](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-elb-load-balancer.html). |
There was a problem hiding this comment.
For more information on how to configure DNS in AWS, see this documentation.
I think we can leave it if you think it would be valuable, but want to be careful about giving the impression that this only works/has been tested with AWS. Unfortunately I think most docs we could link would be provider specific (i.e. Route53, Cloudflare, ...). Maybe sufficient to just drop the last line and reference "refer to your DNS provider's documentation"?
Description
Adding documentation on the DNS assumptions in UDS Core and added example for deploying in a non-dev environment.
Related Issue
Fixes #730
Type of change
Checklist before merging