update mcp-gateway authn/authz guides#110677
Open
Patryk-Stefanski wants to merge 1 commit intoopenshift:mcp-gateway-docs-tpfrom
Open
update mcp-gateway authn/authz guides#110677Patryk-Stefanski wants to merge 1 commit intoopenshift:mcp-gateway-docs-tpfrom
Patryk-Stefanski wants to merge 1 commit intoopenshift:mcp-gateway-docs-tpfrom
Conversation
openshift-ci
Bot
added
the
size/M
|
🤖 Thu Apr 23 15:47:53 - Prow CI generated the docs preview: https://110677--ocpdocs-pr.netlify.app/rhcl/latest/mcp_gateway_config/mcp-gateway-authentication.html |
Signed-off-by: Patryk Stefanski <pstefans@redhat.com>
Patryk-Stefanski
force-pushed
the
fix-auth-authz-docs
branch
from
2f17d5e to
cd1c260
Compare
|
@Patryk-Stefanski: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
ShaunaDiaz
reviewed
Apr 23, 2026
| + | ||
| [source,json,subs="+quotes"] | ||
| ---- | ||
| $ oc patch gateway _<mcp_gateway>_ -n _<gateway_system>_ --type json -p '[ |
Contributor
There was a problem hiding this comment.
should this section, lines 44-50 in the install doc be updated to match this?
- we can make the listener a prereq to this procedure
- add a note to the install doc that you need to config this listener to create authorization
- then we can remove the step from this procedure
WDYT?
ShaunaDiaz
reviewed
Apr 23, 2026
| ---- | ||
| + | ||
| * The `"mcp-ns/arithmetic-mcp-server"` specification must match the namespaced name of the `MCPServerRegistration` CR. | ||
| * The `"mcp-ns/arithmetic-mcp-server"` specification must match the namespaced name of the `MCPServerRegistration` CR in the format `{namespace}/{name}`. For example, if your `MCPServerRegistration` is named `arithmetic-mcp-server` in the `mcp-ns` namespace, the {keycloak} client ID must be `mcp-ns/arithmetic-mcp-server`. |
Contributor
There was a problem hiding this comment.
Suggested change
| * The `"mcp-ns/arithmetic-mcp-server"` specification must match the namespaced name of the `MCPServerRegistration` CR in the format `{namespace}/{name}`. For example, if your `MCPServerRegistration` is named `arithmetic-mcp-server` in the `mcp-ns` namespace, the {keycloak} client ID must be `mcp-ns/arithmetic-mcp-server`. | |
| * The `"mcp-ns/arithmetic-mcp-server"` specification must match the namespaced name of the `MCPServerRegistration` CR in the format `{namespace}/{name}`. For example, if your `MCPServerRegistration` CR is named `arithmetic-mcp-server` and is applied in the `mcp-ns` namespace, the {keycloak} client ID must be `mcp-ns/arithmetic-mcp-server`. |
ShaunaDiaz
reviewed
Apr 23, 2026
| + | ||
| [IMPORTANT] | ||
| ==== | ||
| The authorization `AuthPolicy` must target the `mcps` listener, not the `mcp` listener. The `mcp` listener handles public traffic (`initialize`, `tools/list`, `/.well-known`) and has the authentication-only `AuthPolicy`. |
Contributor
There was a problem hiding this comment.
Suggested change
| The authorization `AuthPolicy` must target the `mcps` listener, not the `mcp` listener. The `mcp` listener handles public traffic (`initialize`, `tools/list`, `/.well-known`) and has the authentication-only `AuthPolicy`. | |
| The authorization `AuthPolicy` CR must target the `mcps` listener, not the `mcp` listener. The `mcp` listener only handles public traffic and has an authentication-only `AuthPolicy` CR. |
ShaunaDiaz
reviewed
Apr 23, 2026
| * Replace `spec.targetRef.name:` with the name of the `Gateway` CR. | ||
| * The `spec.targetRef.sectionName:` value targets the MCP server listener. | ||
| * Authentication: Validates the JWT token using the configured issuer URL | ||
| * The `spec.targetRef.sectionName:` value must be `mcps`, the internal listener for tool-call authorization. This listener must exist on your `Gateway` object. |
Contributor
There was a problem hiding this comment.
Suggested change
| * The `spec.targetRef.sectionName:` value must be `mcps`, the internal listener for tool-call authorization. This listener must exist on your `Gateway` object. | |
| * The `spec.targetRef.sectionName:` value must be `mcps`, which is the internal listener for `tool/call` authorization. This listener must exist on your `Gateway` object. |
ShaunaDiaz
reviewed
Apr 23, 2026
| ---- | ||
| $ oc apply -f _<mcp_tool_auth_policy.yaml>_ | ||
| $ oc apply -f - <<EOF | ||
| <AuthPolicy CR from the previous step> |
Contributor
There was a problem hiding this comment.
Suggested change
| <AuthPolicy CR from the previous step> | |
| _<mcp_tool_auth_policy.yaml>_ |
user-replaceable values can only look like this
I also don't think the EOF works when we separate file creation from application? (having the yaml in one step and application of the resource in a second step is preferred in docs)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Version(s):
mcp-gateway-docs-tp
Issue:
OSDOCS-17719
OSDOCS-17718
Link to docs preview:
https://110677--ocpdocs-pr.netlify.app/rhcl/latest/mcp_gateway_config/mcp-gateway-authentication.html
https://110677--ocpdocs-pr.netlify.app/rhcl/latest/mcp_gateway_config/mcp-gateway-authorization.html
QE review:
Additional information:
See #109794 and #109672 for context.