Skip to content

[WIP]OSDOCS-19695: adds X.509 auth support to RCHL#111690

Open
ShaunaDiaz wants to merge 2 commits into
openshift:rhcl-docs-mainfrom
ShaunaDiaz:OSDOCS-19695
Open

[WIP]OSDOCS-19695: adds X.509 auth support to RCHL#111690
ShaunaDiaz wants to merge 2 commits into
openshift:rhcl-docs-mainfrom
ShaunaDiaz:OSDOCS-19695

Conversation

@ShaunaDiaz
Copy link
Copy Markdown
Contributor

@ShaunaDiaz ShaunaDiaz commented May 14, 2026

Version(s):
rhcl-docs-main
rhcl-docs.1.4

Issue:
OSDOCS-19695

Link to docs preview:
https://111690--ocpdocs-pr.netlify.app/rhcl/latest/deployment/rhcl-using-x509-crypt-id-verify.html

QE review:

  • QE has approved this change.

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 14, 2026
@openshift-ci-robot
Copy link
Copy Markdown

openshift-ci-robot commented May 14, 2026

@ShaunaDiaz: This pull request references OSDOCS-19695 which is a valid jira issue.

Details

In response to this:

Version(s):
rhcl-docs-main
rhcl-docs.1.4

Issue:
OSDOCS-19695

Link to docs preview:

QE review:

  • QE has approved this change.

Instructions 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 openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci Bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label May 14, 2026
@ShaunaDiaz ShaunaDiaz changed the title OSDOCS-19695: adds X.509certificate support to RCHL [WIP]OSDOCS-19695: adds X.509certificate support to RCHL May 14, 2026
@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 14, 2026
@ocpdocs-previewbot
Copy link
Copy Markdown

ocpdocs-previewbot commented May 14, 2026

Comment thread modules/proc-create-gateway.adoc Outdated
Comment thread deployment/rhcl-using-x509-crypt-id-verify.adoc Outdated

//Q: would we create this filter manually on OpenShift, or just use the Gateway or AuthPolicy?

Create an EnvoyFilter to configure Envoy's DownstreamTlsContext for client certificate validation:
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

We're missing a step before this one: mounting the CA cert from the ConfigMap into the gateway pods: https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/user-guides/auth/x509-tier2-provider-specific.md#step-4-mount-ca-certificate-into-gateway-pods

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.

Ah, but that appears to be something we would not do manually on core OpenShift (your own warning there). Should we instead show the Gateway using clientCertificateRefs in an Istio setup? Alternately, should we use a passthrough route for clusters that are using standard OpenShift ingress + Connectivity Link?

Comment thread deployment/rhcl-using-x509-crypt-id-verify.adoc Outdated
Comment thread deployment/rhcl-using-x509-crypt-id-verify.adoc Outdated
Comment thread deployment/rhcl-using-x509-crypt-id-verify.adoc Outdated
[id="rhcl-x509-auth-prep-cas-and-certs"]
= Prepare certificate authorites and client certificates

//Q: downstream, would we use cert-manager or Service CA for some or all of this procedure?
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

IDK for sure, but I was wondering about the instructions to create a TLS-enabled gateway anyway.

The upstream user guide provides top-to-bottom instructions to enable this feature, from defining a gateway, to testing the authentication using a test client cert. We have documentation about how to enable TLS on a Gateway using the TLSPolicy. For the "Using X.509 cryptographic identity verification" guide, because this is focused on Tier 2, if you prefer, we could skip the procedure for defining the Gateway object, which includes the cert-manager CR and the TLSPolicy, to just refer to this other doc and mention that gateway is assumed to be called mtls-gateway, in the gateway-system namespace, for the next steps.

Please let me know what you prefer.

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.

This content is from Step 3, https://github.com/Kuadrant/kuadrant-operator/blob/main/doc/user-guides/auth/x509-tier2-provider-specific.md#step-3-configure-gateway. I just pulled in the YAMLs from the link.

I'm pretty sure we don't give instructions anywhere in the current docs for the cert-manager CR. We probably want it here, right?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The cert-manager CR is only for the TLSPolicy to work. If we have a page where we explain about the TLSPolicy and how to use it, that's the one.

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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Yes. It's not explicitly mentioned as a prerequisite in section 1.2.2, but spread all over the doc. In fact, section 1.2.1 is all about using cert-manager in preparation for a TLSPolicy. And as you can see from the example TLSPolicy resource provided further below, there's a issuerRef field that references a cert-manager object (of Issuer or ClusterIssuer kind).

Comment thread deployment/rhcl-using-x509-crypt-id-verify.adoc Outdated
Comment thread deployment/rhcl-using-x509-crypt-id-verify.adoc Outdated
Comment thread deployment/rhcl-using-x509-crypt-id-verify.adoc Outdated
Comment thread deployment/rhcl-using-x509-crypt-id-verify.adoc Outdated
[id="rhcl-verifying-x509-auth"]
= Verifying X.509 authentication

//Q: would we test this way on OpenShift?
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This feature is covered by our automated tests from our test suite that run on OpenShift: Kuadrant/testsuite#894.

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 18, 2026

@ShaunaDiaz: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions 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 ShaunaDiaz changed the title [WIP]OSDOCS-19695: adds X.509certificate support to RCHL [WIP]OSDOCS-19695: adds X.509 certificate support to RCHL May 19, 2026
@ShaunaDiaz ShaunaDiaz changed the title [WIP]OSDOCS-19695: adds X.509 certificate support to RCHL [WIP]OSDOCS-19695: adds X.509 auth support to RCHL May 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. 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.

4 participants