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

Backport of Update docs for the release of Consul API Gateway v0.5 into stable-website #15450

Conversation

hc-github-team-consul-core
Copy link
Collaborator

Backport

This PR is auto-generated from #15015 to be assessed for backporting due to the inclusion of the label type/docs-cherrypick.

WARNING automatic cherry-pick of commits failed. Commits will require human attention.

merge conflict error: POST https://api.github.com/repos/hashicorp/consul/merges: 409 Merge conflict []

The below text is copied from the body of the original PR.


Description

This PR updates the Consul API Gateway documentation for 0.5. It covers added support for

  • routing traffic to services imported from a peered cluster
  • deploying the API gateway controller and gateways in a secondary federated datacenter
  • specifying Tolerations in the GatewayClassConfig
  • Kubernetes 1.24

It also breaks our single large usage page up into an extendable directory containing multiple use cases, one page for each.

PR Checklist

  • updated test coverage
  • external facing docs updated
  • not a security concern

Overview of commits

@hashicorp-cla
Copy link

hashicorp-cla commented Nov 17, 2022

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes


1 out of 2 committers have signed the CLA.

  • trujillo-adam
  • temp

temp seems not to be a GitHub user.
You need a GitHub account to be able to sign the CLA. If you already have a GitHub account, please add the email address used for this commit to your account.

Have you signed the CLA already but the status is still pending? Recheck it.

* added usage folder to organize use case docs for CAPIgw

* Add peer field to MeshService configuration page

* Add first pass at guide for routing to peered services

* Add exception to same-datacenter restriction for referenced Consul service

* Add example HTTPRoute referencing the MeshService as backendRef

* Add example ServiceResolver

* Add note about current ServiceResolver requirement

ServiceResolver may eventually be created implicitly by the API gateway controller, but that decision is pending.

* tweaks to the usage page for routing to peered services

* tweaks to the  description in the  configuration reference

* resolved TO-DOs from previous iteration

* Remove datacenter federation from limited support matrix

* added tolerations doc

* Remove note excluding k8s 1.24 since we now support it

* Reorder sections to maintain alphabetical sort

* Add example configuration for MeshService resource

* Adjust wording + indentation of other docs

* Use consistent "example-" prefix for resource names in example code

* reframed the tolerations documentation; STILL A WIP

* add helm chart documentation

* removed tolerations from gwcconfig configuration model reference

* 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>

* update version to 0.5.0

* Update install.mdx

* added release notes for v.0.5.x

Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>
Co-authored-by: Sarah Alsmiller <sarah.alsmiller@hashicorp.com>
Co-authored-by: Jeff Boruszak <104028618+boruszak@users.noreply.github.com>
Co-authored-by: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com>

manual cherry-pick because backport to stable website failed
@trujillo-adam trujillo-adam marked this pull request as ready for review November 18, 2022 15:24
@trujillo-adam trujillo-adam requested a review from a team as a code owner November 18, 2022 15:24
@trujillo-adam trujillo-adam added type/docs-cherrypick pr/no-changelog PR does not need a corresponding .changelog entry labels Nov 18, 2022
@trujillo-adam trujillo-adam merged commit ada15b9 into stable-website Nov 18, 2022
@trujillo-adam trujillo-adam deleted the backport/docs/capigw-v0.5-peered-services-support/poorly-eternal-goldfish branch November 18, 2022 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr/no-changelog PR does not need a corresponding .changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants