Skip to content

Fix removed service-to-service peering links#17221

Merged
trujillo-adam merged 5 commits intohashicorp:mainfrom
karras:fix_broken_peering_doc_links
Jul 5, 2023
Merged

Fix removed service-to-service peering links#17221
trujillo-adam merged 5 commits intohashicorp:mainfrom
karras:fix_broken_peering_doc_links

Conversation

@karras
Copy link
Copy Markdown
Contributor

@karras karras commented May 4, 2023

Description

In the PR #16291 the Mesh Gateway service-to-service peering page was removed (website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers.mdx). Though it looks like not all links to that page were replaced. This PR tries to fix those occurrences.

I tried to find the best matching replacements to capture the intentions of the affected sections. Please feel free to suggest better alternatives and your raise concerns where you see fit. :)

Testing & Reproduction steps

  1. Navigate to https://developer.hashicorp.com/consul/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers
  2. 404 is presented

Links

Affected pages:

PR Checklist

  • updated test coverage (n/a)
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

@karras karras requested a review from a team as a code owner May 4, 2023 19:07
@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label May 4, 2023
@trujillo-adam trujillo-adam added pr/no-changelog PR does not need a corresponding .changelog entry backport/1.15 This release series is no longer active on CE. Use backport/ent/1.15. labels May 8, 2023
Copy link
Copy Markdown
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.

Thanks for fixing these links. I added one suggestion, but pre-approving so that you aren't blocked.

# Enabling Peering Control Plane Traffic

In addition to [service-to-service traffic routing](/consul/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers),
In addition to [service-to-service traffic routing](/consul/docs/connect/gateways/mesh-gateway/service-to-service-traffic-partitions),
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
In addition to [service-to-service traffic routing](/consul/docs/connect/gateways/mesh-gateway/service-to-service-traffic-partitions),
This topic describes how to configure a mesh gateway to route control plane traffic between Consul clusters that share a peer connection. For information about routing service traffic between cluster peers through a mesh gateway, refer to [Enabling Service-to-service Traffic Across Admin Partitions](/consul/docs/connect/gateways/mesh-gateway/service-to-service-traffic-partitions).

I know that it's not in the scope of this PR, but we should take this opportunity while editing this page to add some clarity about the what this page is about.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks a lot for the suggestion, I've extended the section accordingly.

@karras
Copy link
Copy Markdown
Contributor Author

karras commented May 26, 2023

@trujillo-adam Should be ready to be merged, what do you think?

@karras
Copy link
Copy Markdown
Contributor Author

karras commented Jul 4, 2023

@trujillo-adam What's the status here? I guess this PR starts to become obsolete with more and more changes being applied to the docs, which is a bummer considering the invested effort.

@trujillo-adam
Copy link
Copy Markdown
Contributor

@trujillo-adam What's the status here? I guess this PR starts to become obsolete with more and more changes being applied to the docs, which is a bummer considering the invested effort.

Ah, apologies, I didn't realize that you weren't able to merge. I'll push through.

@trujillo-adam trujillo-adam added the backport/1.16 This release series is no longer active on CE. Use backport/ent/1.16. label Jul 5, 2023
@trujillo-adam trujillo-adam merged commit 2c2e628 into hashicorp:main Jul 5, 2023
trujillo-adam added a commit that referenced this pull request Jul 7, 2023
* docs: fix removed service-to-service peering links

* docs: extend peering-via-mesh-gateways intro (thanks @trujillo-adam)

---------

Co-authored-by: trujillo-adam <[email protected]>
trujillo-adam added a commit that referenced this pull request Jul 7, 2023
* docs: fix removed service-to-service peering links

* docs: extend peering-via-mesh-gateways intro (thanks @trujillo-adam)

---------

Co-authored-by: trujillo-adam <[email protected]>
trujillo-adam added a commit that referenced this pull request Jul 7, 2023
…/1.15.x (#18018)

* no-op commit due to failed cherry-picking

* Fix removed service-to-service peering links (#17221)

* docs: fix removed service-to-service peering links

* docs: extend peering-via-mesh-gateways intro (thanks @trujillo-adam)

---------

Co-authored-by: trujillo-adam <[email protected]>

---------

Co-authored-by: temp <[email protected]>
Co-authored-by: Michael Hofer <[email protected]>
Co-authored-by: trujillo-adam <[email protected]>
trujillo-adam added a commit that referenced this pull request Jul 7, 2023
…/1.16.x (#18019)

* no-op commit due to failed cherry-picking

* Fix removed service-to-service peering links (#17221)

* docs: fix removed service-to-service peering links

* docs: extend peering-via-mesh-gateways intro (thanks @trujillo-adam)

---------

Co-authored-by: trujillo-adam <[email protected]>

---------

Co-authored-by: temp <[email protected]>
Co-authored-by: Michael Hofer <[email protected]>
Co-authored-by: trujillo-adam <[email protected]>
hc-github-team-consul-core added a commit that referenced this pull request Jul 21, 2023
…nto release/1.16.x (#18229)

* [OSS] Post Consul 1.16 updates (#17606)

* chore: update dev build to 1.17

* chore(ci): add nightly 1.16 test

Drop the oldest and add the newest running release branch to nightly
builds.

* Add writeAuditRPCEvent to agent_oss (#17607)

* Add writeAuditRPCEvent to agent_oss

* fix the other diffs

* backport change log

* Add Envoy and Consul version constraints to Envoy extensions (#17612)

* [API Gateway] Fix trust domain for external peered services in synthesis code (#17609)

* [API Gateway] Fix trust domain for external peered services in synthesis code

* Add changelog

* backport ent changes to oss (#17614)

* backport ent changes to oss

* Update .changelog/_5669.txt

Co-authored-by: Michael Zalimeni <[email protected]>

---------

Co-authored-by: Michael Zalimeni <[email protected]>

* Update intentions.mdx (#17619)

Make behaviour of L7 intentions clearer

* enterprise changelog update for audit (#17625)

* Update list of Envoy versions (#17546)

* [API Gateway] Fix rate limiting for API gateways (#17631)

* [API Gateway] Fix rate limiting for API gateways

* Add changelog

* Fix failing unit tests

* Fix operator usage tests for api package

* sort some imports that are wonky between oss and ent (#17637)

* PmTLS and tproxy improvements with failover and L7 traffic mgmt for k8s (#17624)

* porting over changes from enterprise repo to oss

* applied feedback on service mesh for k8s overview

* fixed typo

* removed ent-only build script file

* Apply suggestions from code review

Co-authored-by: Jeff Boruszak <[email protected]>

* Apply suggestions from code review

Co-authored-by: David Yu <[email protected]>
Co-authored-by: Jeff Boruszak <[email protected]>

---------

Co-authored-by: Jeff Boruszak <[email protected]>
Co-authored-by: David Yu <[email protected]>

* Delete check-legacy-links-format.yml (#17647)

* docs: Reference doc updates for permissive mTLS settings (#17371)

* Reference doc updates for permissive mTLS settings
* Document config entry filtering
* Fix minor doc errors (double slashes in link url paths)

---------

Co-authored-by: trujillo-adam <[email protected]>

* Add generic experiments configuration and use it to enable catalog v2 resources (#17604)

* Add generic experiments configuration and use it to enable catalog v2 resources

* Run formatting with -s as CI will validate that this has been done

* api-gateway: stop adding all header filters to virtual host when generating xDS (#17644)

* Add header filter to api-gateway xDS golden test

* Stop adding all header filters to virtual host when generating xDS for api-gateway

* Regenerate xDS golden file for api-gateway w/ header filter

* fix: add agent info reporting log (#17654)

* Add new Consul 1.16 docs (