docs: connect-service-upstreams annotation fixes by boruszak · Pull Request #17312 · hashicorp/consul

boruszak · 2023-05-11T18:47:24Z

Description

Several issues in the description for using the consul.hashicorp.com/connect-service-upstreams annotation were creating confusion. These issues included broken links, unexplained terms, and incorectly formatted nested lists.

These edits add clarity to the description, and are especially invested in making it easier to locate syntax for formatting services when using cluster peering.

Links

Direct link to content in deployment preview

PR Checklist

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

trujillo-adam

I left a few minor suggestions that you can take or leave. BTW, I think this is OK for now, but we will probably want to replace this information with links to the appropriate DNS section for when we finish reorganizing that content so that we aren't embedding usage information into the reference.

website/content/docs/k8s/annotations-and-labels.mdx

jkirschner-hashicorp

Hi @boruszak,

Thanks for cleaning this up! It's much easier to follow now. I have a few suggestions to enhance accuracy and steer people towards the labeled format.

website/content/docs/k8s/annotations-and-labels.mdx

jkirschner-hashicorp · 2023-05-12T05:01:42Z

website/content/docs/k8s/annotations-and-labels.mdx

+          'consul.hashicorp.com/connect-service-upstreams': 'prepared_query:[query name]:[port]'
+        ```
+
+    - **Labeled** (requires Consul for Kubernetes v0.45.0+):


Move this above the Unlabeled section

website/content/docs/k8s/annotations-and-labels.mdx

jkirschner-hashicorp · 2023-05-12T05:12:34Z

but we will probably want to replace this information with links to the appropriate DNS section

My understanding is that upstream annotations have nothing to do with Consul DNS, though there are similarities in the syntax between labeled annotations and Consul DNS lookup suffixes. So I don't think there's a need to revisit this content after the DNS docs updates are made.

Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

boruszak · 2023-05-12T17:27:09Z

@jkirschner-hashicorp: your comment was in a conversation that I resolved, but I wanted to address it explicitly as well:

Adam and I just discussed how we treat versions with versioned docs, and whether we want to change references as we find them or wait until we can address the pages as a whole. There's still some questions to resolve around how we reference versions, so for the sake of tracking work and technical accuracy, we're going to leave references to previous versions (esp. reference to versions older than v1.8, which aren't selectable for versioned docs) and address them at a later point.

Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>

* corrections * fixes * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Switching order of labeled/unlabeled --------- Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

…ease/1.14.x (#17337) * no-op commit due to failed cherry-picking * docs: connect-service-upstreams annotation fixes (#17312) * corrections * fixes * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Switching order of labeled/unlabeled --------- Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --------- Co-authored-by: temp <temp@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

…ease/1.15.x (#17338) * no-op commit due to failed cherry-picking * docs: connect-service-upstreams annotation fixes (#17312) * corrections * fixes * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Switching order of labeled/unlabeled --------- Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> --------- Co-authored-by: temp <temp@hashicorp.com> Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com> Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* no-op commit due to failed cherry-picking * docs: connect-service-upstreams annotation fixes (#17312) * corrections * fixes * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Switching order of labeled/unlabeled --------- Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Git Head fixes --------- Co-authored-by: temp <temp@hashicorp.com> Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

* no-op commit due to failed cherry-picking * docs: connect-service-upstreams annotation fixes (#17312) * corrections * fixes * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Update website/content/docs/k8s/annotations-and-labels.mdx Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> * Switching order of labeled/unlabeled --------- Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com> * Fix merge conflict --------- Co-authored-by: temp <temp@hashicorp.com> Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com> Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

corrections

72fbc3d

github-actions bot added the type/docs Documentation needs to be created/updated/clarified label May 11, 2023

boruszak added pr/no-changelog PR does not need a corresponding .changelog entry backport/1.14 backport/1.15 This release series is no longer active on CE. Use backport/ent/1.15. labels May 11, 2023

fixes

de3ff12

boruszak marked this pull request as ready for review May 11, 2023 20:37

boruszak requested a review from a team as a code owner May 11, 2023 20:37

vercel bot deployed to Preview – consul May 11, 2023 20:43 View deployment

boruszak requested review from jkirschner-hashicorp and joshwolfer May 11, 2023 21:03

trujillo-adam approved these changes May 11, 2023

View reviewed changes

website/content/docs/k8s/annotations-and-labels.mdx Outdated Show resolved Hide resolved

website/content/docs/k8s/annotations-and-labels.mdx Outdated Show resolved Hide resolved

jkirschner-hashicorp reviewed May 12, 2023

View reviewed changes

boruszak and others added 5 commits May 12, 2023 09:25

Update website/content/docs/k8s/annotations-and-labels.mdx

bcf52b9

Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>

Update website/content/docs/k8s/annotations-and-labels.mdx

c0b10aa

Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>

Update website/content/docs/k8s/annotations-and-labels.mdx

10f6c5d

Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>

Update website/content/docs/k8s/annotations-and-labels.mdx

419799c

Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>

Update website/content/docs/k8s/annotations-and-labels.mdx

aa3e262

Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>

vercel bot deployed to Preview – consul May 12, 2023 16:35 View deployment

Update website/content/docs/k8s/annotations-and-labels.mdx

a20c1ed

Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>

vercel bot deployed to Preview – consul May 12, 2023 17:27 View deployment

boruszak and others added 2 commits May 12, 2023 10:28

Update website/content/docs/k8s/annotations-and-labels.mdx

adea53f

Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>

Update website/content/docs/k8s/annotations-and-labels.mdx

53adb60

Co-authored-by: Jared Kirschner <85913323+jkirschner-hashicorp@users.noreply.github.com>

vercel bot deployed to Preview – consul May 12, 2023 17:36 View deployment

Switching order of labeled/unlabeled

d34a79d

vercel bot deployed to Preview – consul May 12, 2023 21:53 View deployment

Merge branch 'main' into docs/annotations-page-structure-fixes

893bc9b

boruszak enabled auto-merge (squash) May 12, 2023 21:58

vercel bot deployed to Preview – consul May 12, 2023 22:00 View deployment

boruszak merged commit 8dce0ba into main May 12, 2023

boruszak deleted the docs/annotations-page-structure-fixes branch May 12, 2023 22:07

This was referenced May 12, 2023

Backport of docs: connect-service-upstreams annotation fixes into release/1.14.x #17337

Merged

Backport of docs: connect-service-upstreams annotation fixes into release/1.15.x #17338

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: connect-service-upstreams annotation fixes#17312

docs: connect-service-upstreams annotation fixes#17312
boruszak merged 12 commits intomainfrom
docs/annotations-page-structure-fixes

boruszak commented May 11, 2023 •

edited

Loading

Uh oh!

trujillo-adam left a comment

Uh oh!

Uh oh!

Uh oh!

jkirschner-hashicorp left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jkirschner-hashicorp May 12, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jkirschner-hashicorp commented May 12, 2023

Uh oh!

boruszak commented May 12, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

boruszak commented May 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Links

PR Checklist

Uh oh!

trujillo-adam left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jkirschner-hashicorp left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jkirschner-hashicorp May 12, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jkirschner-hashicorp commented May 12, 2023

Uh oh!

boruszak commented May 12, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

boruszak commented May 11, 2023 •

edited

Loading