CE-655 - Moving DNS forwading tutorial to docs by danielehc · Pull Request #21348 · hashicorp/consul

danielehc · 2024-06-18T13:32:55Z

Description

Preview: https://consul-git-ce-655-hashicorp.vercel.app/consul/docs/services/discovery/dns-forwarding

When merging this PR also https://github.com/hashicorp/tutorials/pull/2145 should be merged.

Testing & Reproduction steps

Links

PR Checklist

updated test coverage
external facing docs updated
appropriate backport labels added
not a security concern

website/content/docs/services/discovery/dns-forwarding.mdx

boruszak

All of the suggestions I left are sentence/style improvements. I also left a couple of comments with questions.

website/content/docs/services/discovery/dns-forwarding/enable.mdx

boruszak · 2024-07-15T23:34:35Z

website/content/docs/services/discovery/dns-forwarding/enable.mdx

+You can replace the `1.1.1.1` address in the example with another DNS server address. This is suitable for situations where an external DNS
+service is already running in your infrastructure and is used as the recursor.


What's the "this" in the second sentence? Replacing the DNS server address or the 1.1.1.1 address?

Replacing the DNS server address

website/content/docs/services/discovery/dns-forwarding/enable.mdx

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

website/content/docs/services/discovery/dns-forwarding/enable.mdx

boruszak

Suggestions to flesh out the language around Conditional DNS Forwarding

boruszak · 2024-08-01T22:24:04Z

website/content/docs/services/discovery/dns-forwarding/index.mdx

+
+We recommend the conditional DNS forwarding approach. 
+
+![Consul DNS conditional forwarding - Only .consul requests are routed to Consul](/img/consul-dns-conditional-forwarding.png)


Needs Dark Mode image

boruszak · 2024-08-01T22:24:11Z

website/content/docs/services/discovery/dns-forwarding/index.mdx

+
+This approach can be useful in scenarios where the Consul agent nodes have low resources, and you want to avoid the overhead of running a local DNS server. In this configuration, Consul serves all DNS queries for all domains and forwards the ones outside the `.consul` domain to one or more configured forwarder servers.
+
+![Consul DNS forwarding - All requests are routed to Consul](/img/consul-dns-forwarding.png)


Needs Dark Mode image

website/content/docs/services/discovery/dns-forwarding/index.mdx

website/content/docs/services/discovery/dns-forwarding/enable.mdx

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

website/content/docs/services/discovery/dns-forwarding/index.mdx

* First commit * Add page to navigation * test new doc page * Update website/content/docs/services/discovery/dns-forwarding.mdx * Update website/content/docs/services/discovery/dns-forwarding.mdx * fix push build atttempt * Draft * Draft * empty line * Draft * empty lines * Draft * First draft * Create documentation for Argo Rollouts Plugin. (#20680) * Create documentation for Argo Rollouts Plugin. * Create documentation for Argo Rollouts Plugin. * Apply suggestions from code review Co-authored-by: David Yu <dyu@hashicorp.com> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update docs based on feedback * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update website/content/docs/k8s/deployment-configurations/argo-rollouts-configuration.mdx * Update website/content/docs/k8s/deployment-configurations/argo-rollouts-configuration.mdx --------- Co-authored-by: David Yu <dyu@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com> * Split content and add images * Fix navigation * Add links and context * Restructure changes * Fix enable documentation * Fix enable documentation * Fix index documentation * Add troubleshooting and fix codeblocks * Add troubleshooting and fix codeblocks * Typos and last checks * Apply suggestions from code review Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update website/content/docs/services/discovery/dns-forwarding/enable.mdx * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Add dark mode images * Add dark mode images * Apply suggestions from code review --------- Co-authored-by: boruszak <jeffrey.boruszak@hashicorp.com> Co-authored-by: Ashwin Venkatesh <ashwin@hashicorp.com> Co-authored-by: David Yu <dyu@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com> Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com>

…21673) * CE-655 - Moving DNS forwading tutorial to docs (#21348) * First commit * Add page to navigation * test new doc page * Update website/content/docs/services/discovery/dns-forwarding.mdx * Update website/content/docs/services/discovery/dns-forwarding.mdx * fix push build atttempt * Draft * Draft * empty line * Draft * empty lines * Draft * First draft * Create documentation for Argo Rollouts Plugin. (#20680) * Create documentation for Argo Rollouts Plugin. * Create documentation for Argo Rollouts Plugin. * Apply suggestions from code review Co-authored-by: David Yu <dyu@hashicorp.com> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update docs based on feedback * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update website/content/docs/k8s/deployment-configurations/argo-rollouts-configuration.mdx * Update website/content/docs/k8s/deployment-configurations/argo-rollouts-configuration.mdx --------- Co-authored-by: David Yu <dyu@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com> * Split content and add images * Fix navigation * Add links and context * Restructure changes * Fix enable documentation * Fix enable documentation * Fix index documentation * Add troubleshooting and fix codeblocks * Add troubleshooting and fix codeblocks * Typos and last checks * Apply suggestions from code review Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update website/content/docs/services/discovery/dns-forwarding/enable.mdx * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Add dark mode images * Add dark mode images * Apply suggestions from code review --------- Co-authored-by: boruszak <jeffrey.boruszak@hashicorp.com> Co-authored-by: Ashwin Venkatesh <ashwin@hashicorp.com> Co-authored-by: David Yu <dyu@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com> Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com> * CE-657 - Move Application leader election tutorial to docs (#21366) * First commit * Fix navigation * Add some commands * Structure draft * Complete usage doc structure * Fix link * Apply suggestions from code review Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Apply suggestions from code review * Replace tutorial path * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> --------- Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: boruszak <jeffrey.boruszak@hashicorp.com> --------- Co-authored-by: danielehc <40759828+danielehc@users.noreply.github.com> Co-authored-by: Ashwin Venkatesh <ashwin@hashicorp.com> Co-authored-by: David Yu <dyu@hashicorp.com> Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com> Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com>

* First commit * Add page to navigation * test new doc page * Update website/content/docs/services/discovery/dns-forwarding.mdx * Update website/content/docs/services/discovery/dns-forwarding.mdx * fix push build atttempt * Draft * Draft * empty line * Draft * empty lines * Draft * First draft * Create documentation for Argo Rollouts Plugin. (#20680) * Create documentation for Argo Rollouts Plugin. * Create documentation for Argo Rollouts Plugin. * Apply suggestions from code review Co-authored-by: David Yu <dyu@hashicorp.com> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update docs based on feedback * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update website/content/docs/k8s/deployment-configurations/argo-rollouts-configuration.mdx * Update website/content/docs/k8s/deployment-configurations/argo-rollouts-configuration.mdx --------- Co-authored-by: David Yu <dyu@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com> * Split content and add images * Fix navigation * Add links and context * Restructure changes * Fix enable documentation * Fix enable documentation * Fix index documentation * Add troubleshooting and fix codeblocks * Add troubleshooting and fix codeblocks * Typos and last checks * Apply suggestions from code review Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com> * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Update website/content/docs/services/discovery/dns-forwarding/enable.mdx * Apply suggestions from code review Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> * Add dark mode images * Add dark mode images * Apply suggestions from code review --------- Co-authored-by: boruszak <jeffrey.boruszak@hashicorp.com> Co-authored-by: Ashwin Venkatesh <ashwin@hashicorp.com> Co-authored-by: David Yu <dyu@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: Michael Wilkerson <62034708+wilkermichael@users.noreply.github.com> Co-authored-by: Aimee Ukasick <aimee.ukasick@hashicorp.com>

First commit

e2f53f7

danielehc added the pr/do-not-merge PR cannot be merged in its current form. label Jun 18, 2024

danielehc self-assigned this Jun 18, 2024

danielehc requested a review from a team as a code owner June 18, 2024 13:32

github-actions bot added the type/docs Documentation needs to be created/updated/clarified label Jun 18, 2024

danielehc changed the title ~~CE-655 - Moving DNS forwading totorial to docs~~ CE-655 - Moving DNS forwading tutorial to docs Jun 18, 2024

Add page to navigation

f2a7a3e

danielehc added the pr/no-backport label Jun 18, 2024

danielehc and others added 2 commits June 20, 2024 14:36

test new doc page

689c25a

Merge branch 'main' into CE-655

b116396

danielehc commented Jun 20, 2024

View reviewed changes

website/content/docs/services/discovery/dns-forwarding.mdx Outdated Show resolved Hide resolved

Update website/content/docs/services/discovery/dns-forwarding.mdx

d38a6fd

danielehc added pr/no-changelog PR does not need a corresponding .changelog entry theme/dns Using Consul as a DNS provider, DNS related issues labels Jun 20, 2024

danielehc commented Jun 20, 2024

View reviewed changes

website/content/docs/services/discovery/dns-forwarding.mdx Outdated Show resolved Hide resolved

Update website/content/docs/services/discovery/dns-forwarding.mdx

4d0310e

boruszak removed the pr/do-not-merge PR cannot be merged in its current form. label Jun 20, 2024

fix push build atttempt

e099611

vercel bot deployed to Preview – consul June 20, 2024 15:15 View deployment

danielehc and others added 3 commits June 20, 2024 17:52

Draft

344307d

Draft

5f5b70d

empty line

484ea76

vercel bot had a problem deploying to Preview – consul June 20, 2024 16:05 Failure

danielehc and others added 2 commits June 20, 2024 18:10

Draft

a1b4fc2

empty lines

0b4e01e

vercel bot had a problem deploying to Preview – consul June 20, 2024 16:19 Failure

boruszak removed the theme/dns Using Consul as a DNS provider, DNS related issues label Jun 20, 2024

zchsh mentioned this pull request Jun 20, 2024

test fixes in mdx for deploy preview #21353

Closed

Draft

0819eb8

vercel bot deployed to Preview – consul June 20, 2024 22:53 View deployment

aimeeu approved these changes Jul 9, 2024

View reviewed changes

boruszak reviewed Jul 15, 2024

View reviewed changes

danielehc commented Jul 16, 2024

View reviewed changes

website/content/docs/services/discovery/dns-forwarding/enable.mdx Outdated Show resolved Hide resolved

danielehc commented Jul 16, 2024

View reviewed changes

website/content/docs/services/discovery/dns-forwarding/enable.mdx Outdated Show resolved Hide resolved

danielehc and others added 2 commits July 16, 2024 15:55

Apply suggestions from code review

f05b497

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

Merge branch 'main' into CE-655

25c8169

vercel bot had a problem deploying to Preview – consul July 16, 2024 14:07 Failure

danielehc commented Jul 16, 2024

View reviewed changes

website/content/docs/services/discovery/dns-forwarding/enable.mdx Outdated Show resolved Hide resolved

Update website/content/docs/services/discovery/dns-forwarding/enable.mdx

c46a2ba

vercel bot deployed to Preview – consul July 16, 2024 15:30 View deployment

boruszak reviewed Aug 1, 2024

View reviewed changes

Merge branch 'main' into CE-655

0b3cd01

vercel bot deployed to Preview – consul August 6, 2024 12:57 View deployment

Apply suggestions from code review

609a59b

Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>

vercel bot deployed to Preview – consul August 13, 2024 09:19 View deployment

danielehc and others added 3 commits August 13, 2024 11:24

Add dark mode images

d758f6b

Merge branch 'main' into CE-655

adf209f

Add dark mode images

a74664d

vercel bot deployed to Preview – consul August 13, 2024 10:22 View deployment

danielehc commented Aug 13, 2024

View reviewed changes

website/content/docs/services/discovery/dns-forwarding/index.mdx Outdated Show resolved Hide resolved

Apply suggestions from code review

e4abe13

vercel bot deployed to Preview – consul August 13, 2024 10:30 View deployment

danielehc merged commit 89618f9 into main Aug 13, 2024

danielehc deleted the CE-655 branch August 13, 2024 12:52

boruszak mentioned this pull request Aug 27, 2024

docs: Backport for DNS Forwarding/Application leader election docs #21673

Merged

4 tasks

This was referenced Sep 25, 2024

docs: Backport for DNS Forwarding/Application leader election docs dhiaayachi/consul#132

Open

test fixes in mdx for deploy preview dhiaayachi/consul#321

Open

		You can replace the `1.1.1.1` address in the example with another DNS server address. This is suitable for situations where an external DNS
		service is already running in your infrastructure and is used as the recursor.


		We recommend the conditional DNS forwarding approach.

		![Consul DNS conditional forwarding - Only .consul requests are routed to Consul](/img/consul-dns-conditional-forwarding.png)


		This approach can be useful in scenarios where the Consul agent nodes have low resources, and you want to avoid the overhead of running a local DNS server. In this configuration, Consul serves all DNS queries for all domains and forwards the ones outside the `.consul` domain to one or more configured forwarder servers.

		![Consul DNS forwarding - All requests are routed to Consul](/img/consul-dns-forwarding.png)

Comments

Conversation

danielehc commented Jun 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing & Reproduction steps

Links

PR Checklist

Uh oh!

Uh oh!

Uh oh!

boruszak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

boruszak Jul 15, 2024

Choose a reason for hiding this comment

Uh oh!

danielehc Jul 16, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

boruszak left a comment

Choose a reason for hiding this comment

Uh oh!

boruszak Aug 1, 2024

Choose a reason for hiding this comment

Uh oh!

boruszak Aug 1, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

danielehc commented Jun 18, 2024 •

edited

Loading