docs(openshift): expand OpenShift guide into multi-page section with TLS, OIDC, and ingress - #2094
docs(openshift): expand OpenShift guide into multi-page section with TLS, OIDC, and ingress#2094akram wants to merge 1 commit into
Conversation
|
@TaylorMutch can you PTAL ? |
|
@TaylorMutch I took into account the review comments and made changes. Let me know if squash+rebase is needed. |
|
/ok to test 2090fb7 |
TaylorMutch
left a comment
There was a problem hiding this comment.
I've thought about this PR a bit more, and here's what I am thinking:
Platform deployers of OpenShell on Kubernetes or OpenShift will want a single page describing the ingress, identity, OIDC and TLS specifics needed for deploying OpenShell. I think splitting these out into OpenShift specific docs and then the other Kubernetes docs makes docs navigation more complicated.
If you are up for it, I would be open to incorporating OpenShift specifics into the overall Kubernetes docs pages, so that those pages are focused on the specific features of Ingress, Identity, OIDC, etc., rather than a specific platform like OpenShift. Then any OpenShift-specifics can be highlighted within the context of that feature.
What do you think @akram ? I am very much in favor of expanding OpenShift specific documentation, but I think this PR in it's current state dilutes and possibly duplicates information across our docs.
Agree @TaylorMutch ; I was hesitating as well to have this specific section, or to have specific paragraphs for each case. I will rework it entirely then. |
Rework per review feedback: instead of separate OpenShift pages, add OpenShift-specific sections (TLS tabs, OIDC/Keycloak, reencrypt Route, Gateway API with Istio) into the existing access-control, ingress, and openshift pages. Also add OpenShift-optimized Dockerfiles for gateway and supervisor. Signed-off-by: Akram Ben Aissi <abenaissi@redhat.com>
2090fb7 to
1626004
Compare
|
Hey @TaylorMutch, apologies for the delay — I was on PTO. I've reworked the PR per your feedback — OpenShift specifics are now integrated into the existing K8s docs pages (access-control, ingress, openshift) instead of separate pages. I also validated the full install path end-to-end on a fresh ROSA HCP 4.22.8 cluster:
Ready for another look when you get a chance. |
440ede3 to
1626004
Compare
|
hey @akram Taylor is OOO, but I can try and help. can you rebase? |
BlockedHead SHA: Gator is blocked because PR #2094 currently has merge conflicts with Taylor Mutch's main documentation request appears substantially addressed in this head: the OpenShift-specific guidance is integrated into the existing Kubernetes feature pages ( Thanks @johntmyers for identifying the immediate next step. Next action: @akram, please rebase this branch onto current |
Summary
Replace the single-page plaintext-only OpenShift guide with a multi-page section covering TLS-enabled installation, external gateway access (reencrypt Route and Gateway API with Istio), Keycloak OIDC authentication with the required protocol mappers, and OpenShift identity federation. All Keycloak commands are provided in both
kcadm.shand REST API tabs.Related Issue
Addresses #2091
Changes
openshift.mdx→openshift/index.mdx: landing page with Cards linking to four sub-pagesopenshift/install.mdx: TLS-enabled installation with SCC overrides, preserves all original content (namespace creation, SCC binding, Helm overrides table, deployment rollout tip)openshift/gateway-connection.mdx: three connection methods — local port-forward, reencrypt Route (with explanation of why edge and passthrough break gRPC), and Gateway API with Istio (includingDestinationRulefor TLS origination)openshift/oidc-keycloak.mdx: Keycloak realm/client setup, the three required protocol mappers (sub,aud,realm_access.roles), realm roles, Helm OIDC values, and CLI registration with--oidc-issueropenshift/identity-federation.mdx: OpenShift OAuth as a Keycloakopenshift-v4identity provider, with the ROSA HCPbaseUrlcaveat and federated user role assignmentTesting
kcadm.shcommands end-to-end from a clean realm (--config /tmp/kcadm.configrequired for non-root Keycloak containers)mise run pre-commit— passes (helm:lint fails on main too: missing postgresql dependency, pre-existing)Checklist