Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: all enterprise locality labels now optional #14679

Merged
merged 2 commits into from
Sep 21, 2022

Conversation

jkirschner-hashicorp
Copy link
Contributor

@jkirschner-hashicorp jkirschner-hashicorp commented Sep 19, 2022

Documenting capabilities introduced by a Consul Enterprise PR (3072).

Preview: https://consul-cuhodfsls-hashicorp.vercel.app/docs/discovery/dns#service-lookups-for-consul-enterprise

@jkirschner-hashicorp jkirschner-hashicorp added the type/docs Documentation needs to be created/updated/clarified label Sep 19, 2022
@jkirschner-hashicorp jkirschner-hashicorp requested a review from a team as a code owner September 19, 2022 21:33
@jkirschner-hashicorp jkirschner-hashicorp force-pushed the docs/improve-ent-dns-flexibility-oss branch 2 times, most recently from ff9a3c0 to e234987 Compare September 19, 2022 21:50
@jkirschner-hashicorp jkirschner-hashicorp force-pushed the docs/improve-ent-dns-flexibility-oss branch 2 times, most recently from 1429019 to b24b802 Compare September 19, 2022 21:59
@jkirschner-hashicorp
Copy link
Contributor Author

@trujillo-adam : tagging you, since you were involved in the recent review of this section: #14389

This PR is a change of the existing section to account for new functionality targeting release in 1.14.

Copy link
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few suggestions and corrections.

website/content/docs/agent/config/config-files.mdx Outdated Show resolved Hide resolved
website/content/docs/discovery/dns.mdx Outdated Show resolved Hide resolved
```text
[<tag>.]<service>.service[.<namespace>.ns][.<partition>.ap][.<datacenter>.dc]<domain>
```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Use the [prepared query lookup format](#prepared-query-lookups) for `.query` lookups.

Correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the suggestion. It's best to redirect people to where they need to go.

Unfortunately, my understanding is that prepared queries don't support enterprise locality labels at all. And if that's true, maybe that's what needs to be stated explicitly.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll avoid making this change in this PR.

I'll make it in a follow-up PR because it requires some updates to the prepared query docs as well, and I don't want to delay the merging of the enterprise code PR for that follow-up PR.

website/content/docs/discovery/dns.mdx Outdated Show resolved Hide resolved
website/content/docs/discovery/dns.mdx Outdated Show resolved Hide resolved
website/content/docs/discovery/dns.mdx Outdated Show resolved Hide resolved
@jkirschner-hashicorp
Copy link
Contributor Author

@trujillo-adam : I believe I've addressed your feedback. Ready for re-review!

Copy link
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@jkirschner-hashicorp jkirschner-hashicorp merged commit 7f0498d into main Sep 21, 2022
@jkirschner-hashicorp jkirschner-hashicorp deleted the docs/improve-ent-dns-flexibility-oss branch September 21, 2022 04:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants