Skip to content

Document external Gateway (BYO Gateway) support #2184

Open
adoi wants to merge 6 commits into
kubermatic:mainfrom
adoi:document-byo-gateway
Open

Document external Gateway (BYO Gateway) support #2184
adoi wants to merge 6 commits into
kubermatic:mainfrom
adoi:document-byo-gateway

Conversation

@adoi
Copy link
Copy Markdown
Contributor

@adoi adoi commented May 14, 2026

Add documentation for using a user-managed Gateway with Gateway API migration, including configuration requirements, external Gateway ownership, route attachment rules, migration behavior, verification steps, and troubleshooting guidance.

xref: kubermatic/kubermatic#15862

adoi added 3 commits May 14, 2026 09:28
Add documentation for using a user-managed Gateway with Gateway API
migration, including configuration requirements, external Gateway
ownership, route attachment rules, migration behavior, verification
steps, and troubleshooting guidance.

Signed-off-by: Adonis Murati <adonismurati@gmail.com>
…synced

Signed-off-by: Adonis Murati <adonismurati@gmail.com>
Signed-off-by: Adonis Murati <adonismurati@gmail.com>
@kubermatic-bot kubermatic-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. labels May 14, 2026
@kubermatic-bot
Copy link
Copy Markdown
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@kubermatic-bot kubermatic-bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label May 14, 2026
adoi added 2 commits May 25, 2026 16:17
Clarify how external Gateway migrations are handled during Gateway API
cleanup, including the external Gateway readiness checks, HTTPRoute
Accepted requirements, and Dex skip behavior.

Document the managed Gateway fallback and the
kubermatic.io/gateway-route=true label contract introduced for
migration readiness, so operators understand when the old managed Gateway is
kept or removed.

Signed-off-by: Adonis Murati <adonismurati@gmail.com>
Remove the detailed CRD version inspection command from the external
Gateway requirements section and keep the main flow focused on the
required user-facing behavior.

Add troubleshooting guidance for switching back from a user-managed
Gateway to the KKP-managed Gateway when newer Gateway API CRDs or the
safe-upgrades.gateway.networking.k8s.io admission policy block
applying the bundled CRDs.

Signed-off-by: Adonis Murati <adonismurati@gmail.com>
@adoi adoi marked this pull request as ready for review May 25, 2026 14:36
@kubermatic-bot kubermatic-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 25, 2026
@adoi
Copy link
Copy Markdown
Contributor Author

adoi commented May 25, 2026

/hold
/assign

It's ready for review, I will unhold after the patches are out.

@kubermatic-bot kubermatic-bot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label May 25, 2026
Copy link
Copy Markdown
Contributor

@buraksekili buraksekili left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve


Use `http://` instead of `https://` if TLS is not configured yet.

### Local kind Considerations
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.

I think, we do not need to mention local-kind setup tricks on kkp docs, as this page is dedicated to product and feature in general. what do you think?

@kubermatic-bot kubermatic-bot added the lgtm Indicates that a PR is ready to be merged. label May 25, 2026
@kubermatic-bot
Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: cc81c00350ba1bf900c9771cac2afa2ca0b0fc11

@kubermatic-bot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: buraksekili

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubermatic-bot kubermatic-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 25, 2026
Signed-off-by: Adonis Murati <adonismurati@gmail.com>
@kubermatic-bot kubermatic-bot removed the lgtm Indicates that a PR is ready to be merged. label May 26, 2026
@buraksekili
Copy link
Copy Markdown
Contributor

/lgtm

@kubermatic-bot kubermatic-bot added the lgtm Indicates that a PR is ready to be merged. label May 26, 2026
@kubermatic-bot
Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: 74e8ae7726ee6f7d4646acefe9e4ebf1dc54bdda

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants